ITxnManager.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    "ElementAgenda.h"
#include    <stack>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

//=======================================================================================
//=======================================================================================
struct ChangeTrackInfo
{
    ChangeTrackAction    action;            
    Int32                processNumber;     
    Int16                funcname;          
    Int32                idNumber;          
};

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct TxnPos {Int32 m_pos;};

struct TxnFilter;

/*=================================================================================**/
//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct  TxnMonitor : IRefCounted
{
    virtual void _OnElementChanged (MSElementDescrCP newDscr, MSElementDescrCP oldDscr, ChangeTrackInfoCP info, bool* cantBeUndoneFlag) {}
    virtual void _OnXAttributeChanged (XAttributeHandleCR attr, ChangeTrackInfoCP info, bool* cantBeUndoneFlag) {}
    virtual void _OnElementUndoRedo (MSElementDescrCP afterUndoRedo, MSElementDescrCP beforeUndoRedo, ChangeTrackAction originalChange, bool isUndo, ChangeTrackSource, ChangeTrackInfoCP info) {}
    virtual void _OnXAttributeUndoRedo (XAttributeHandleCR xattr, ChangeTrackAction originalChange, bool isUndo, ChangeTrackSource, ChangeTrackInfoCP info) {}
    virtual void _OnUndoRedoFinished (bool isUndo) {}
    virtual void _OnTxnValidate () {}
    virtual void _OnTxnClose () {}
    virtual void _OnTxnBoundary () {}
    virtual void _OnModelChange (DgnModelP model, ModelInfoCP modelInfo, bool isPreChange, ChangeTrackInfoCR info, bool* cantBeUndoneFlag) {}
    virtual void _OnModelUndoRedo (DgnModelP model, ModelInfoCP modelInfo, bool reverseSettingsChanges, bool isUndo, bool isPreChange, ChangeTrackSource, ChangeTrackInfoCR) {}

    virtual void _OnUndoInvalidated() {} 
};

/*=================================================================================**/
struct TxnElementWriteOptions
    {
  protected:
    enum Flags {FLAG_AllOff=0, FLAG_CallAsynchs=1, FLAG_SaveInUndo=2, FLAG_OverrideIdCheck=4};
    Flags   m_flags;
    void    SetFlag (Flags f, bool b) {if (b) m_flags = (Flags)(m_flags|f); else m_flags = (Flags)(m_flags &~f);}
  public:
    TxnElementWriteOptions() : m_flags ((Flags)(FLAG_CallAsynchs|FLAG_SaveInUndo)) {}
    void SetCallAsynchs (bool b) {SetFlag (FLAG_CallAsynchs, b);}
    bool GetCallAsynchs () const {return (m_flags&FLAG_CallAsynchs) != 0;}
    void SetSaveInUndo (bool b) {SetFlag (FLAG_SaveInUndo, b);}
    bool GetSaveInUndo () const {return (m_flags&FLAG_SaveInUndo) != 0;}

    };


/*=================================================================================**/
struct TxnElementAddOptions : TxnElementWriteOptions
{
    TxnElementAddOptions() : TxnElementWriteOptions () {}

    explicit TxnElementAddOptions (TxnElementWriteOptions const& r) : TxnElementWriteOptions(r) {}
};


/*=================================================================================**/
struct          TxnXAttributeWriteOptions
{
protected:
    bool    m_dummy;

public:
    TxnXAttributeWriteOptions() : m_dummy(false) {}
};

/*=================================================================================**/
struct          TxnXAttributeAddOptions : TxnXAttributeWriteOptions
{
    TxnXAttributeAddOptions() : TxnXAttributeWriteOptions() {}
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct ITxn : NonCopyableClass
{
struct ICustomEntry;
typedef RefCountedPtr<ICustomEntry> (*DeserializeCustomItemFunc) (byte const* data, size_t numBytes);

private:
    virtual void MakeClassAbstract() = 0;
public:
public:


DGNPLATFORM_EXPORT StatusInt AddXAttribute (ElementRefP elRef, XAttributeHandlerId handlerId, UInt32 xAttrId, void const* xAttrData, UInt32 length, UInt32* outXAttrId=NULL, TxnXAttributeAddOptions const& opts = TxnXAttributeAddOptions());

DGNPLATFORM_EXPORT StatusInt DeleteXAttribute (XAttributeHandleR xAttr, TxnXAttributeWriteOptions const& opts = TxnXAttributeWriteOptions());

DGNPLATFORM_EXPORT StatusInt ModifyXAttributeData (XAttributeHandleCR xAttr, void const* data, UInt32 start, UInt32 length, TxnXAttributeWriteOptions const& opts = TxnXAttributeWriteOptions());

DGNPLATFORM_EXPORT StatusInt ReplaceXAttributeData (XAttributeHandleCR xAttr, void const* data, UInt32 newSize = 0, TxnXAttributeWriteOptions const& opts = TxnXAttributeWriteOptions());



DGNPLATFORM_EXPORT StatusInt DeleteElement (ElementRefP elem, TxnElementWriteOptions const& opts = TxnElementWriteOptions());

DGNPLATFORM_EXPORT StatusInt AddElement (EditElementHandleR newEl, TxnElementAddOptions const& opts = TxnElementAddOptions());

DGNPLATFORM_EXPORT StatusInt ReplaceElement (EditElementHandleR el, ElementRefP in, TxnElementWriteOptions const& opts = TxnElementWriteOptions());



DGNPLATFORM_EXPORT DgnModelP CreateNewModel (DgnModelStatus* error, DgnFileR file, WCharCP name, DgnModelType type, bool is3D, DgnModelCP seedModel=NULL, ModelId modelId = INVALID_MODELID);

DGNPLATFORM_EXPORT DgnModelP CreateNewModel (DgnModelStatus* error, DgnFileR file, ModelInfoCR modelInfo, ModelId modelId = INVALID_MODELID);

DGNPLATFORM_EXPORT StatusInt DeleteModel (DgnModelR dgnModel);

//           DgnModel::SetModelInfo(). SetModelInfo will then call Txn::SaveModelProperties if the properties have changed. Note that you must eventually call
DGNPLATFORM_EXPORT StatusInt SaveModelProperties (DgnModelR model, bool bSaveSettings = false, bool forceSave = false);




#if defined (OLD_WAY)
struct ICustomEntry : IRefCounted 
{
private:
    virtual void _OnReverse ()   {}
    virtual void _OnReinstate () {}
    virtual void _OnCancel ()    {}
    virtual void _Dump ()        {}
public: 
    DGNPLATFORM_EXPORT void OnReverse ();
    DGNPLATFORM_EXPORT void OnReinstate ();
    DGNPLATFORM_EXPORT void OnCancel ();
    DGNPLATFORM_EXPORT void Dump ();
};

DGNPLATFORM_EXPORT void SaveCustomEntryInUndo (ICustomEntry& entry);
#else

struct ICustomEntry : IRefCounted
{
virtual void _OnReverse ()   {}
virtual void _OnReinstate () {}
virtual void _OnCancel ()    {}
virtual void _Dump ()        {}
};

DGNPLATFORM_EXPORT void SaveCustomEntryInUndo (byte const* data, size_t numBytes, DeserializeCustomItemFunc func);
#endif



};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct ITxnManager : DgnHost::HostObjectBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT static ITxnManagerR GetManager ();




DGNPLATFORM_EXPORT void ValidateCurrentTxn ();

DGNPLATFORM_EXPORT void CloseCurrentTxn (bool doValidate);

DGNPLATFORM_EXPORT void UpdateDisplay (bool andDraw=true);

DGNPLATFORM_EXPORT static ITxn& GetCurrentTxn();

DGNPLATFORM_EXPORT ITxn& SetCurrentTxn (ITxn& newTxn);

DGNPLATFORM_EXPORT StatusInt FindElement (DgnModelP model, ElementId eid, TxnPos start, TxnPos end, ChangeTrackAction action);



DGNPLATFORM_EXPORT void AddTxnMonitor (TxnMonitor& monitor);

DGNPLATFORM_EXPORT void DropTxnMonitor (TxnMonitor& monitor);




DGNPLATFORM_EXPORT bool IsActive ();

DGNPLATFORM_EXPORT void Activate ();

DGNPLATFORM_EXPORT void Deactivate ();



DGNPLATFORM_EXPORT void StartTxnGroup (bool startNewTxn);

DGNPLATFORM_EXPORT void EndTxnGroup ();

DGNPLATFORM_EXPORT size_t GetTxnGroupCount ();

DGNPLATFORM_EXPORT TxnPos GetCurrGroupStartPos();



DGNPLATFORM_EXPORT bool HasEntries ();

DGNPLATFORM_EXPORT bool RedoIsPossible ();

DGNPLATFORM_EXPORT void ReverseTxns (int numActions, bool warnIfNotActiveModel);

DGNPLATFORM_EXPORT void ReverseSingleTxn (bool callRestartFunc=true);

DGNPLATFORM_EXPORT void ReverseToMark ();

DGNPLATFORM_EXPORT void ReverseAll (bool prompt);

DGNPLATFORM_EXPORT StatusInt ReverseToPos (TxnPos pos);

DGNPLATFORM_EXPORT TxnPos GetCurrTxnPos ();

DGNPLATFORM_EXPORT StatusInt CancelToPos (TxnPos pos, bool callRestartFunc=true);

DGNPLATFORM_EXPORT void ClearReversedTxns ();

DGNPLATFORM_EXPORT StatusInt ReinstateTxn ();

DGNPLATFORM_EXPORT bool IsUndoInProgress ();


};

END_BENTLEY_DGNPLATFORM_NAMESPACE