WsfPProxy Class Reference

#include <WsfPProxy.hpp>

Collaboration diagram for WsfPProxy:

Public Types
enum	ProxyModifiedReason { cPM_CHILD_ADDED , cPM_CHILD_REMOVED , cPM_CHILD_MOVED , cPM_VALUE_CHANGED }
using	ProxyModifiedFn = std::function<void(WsfPProxy*, ProxyModifiedReason, const WsfPProxyPath&, const std::string*)>
using	BeforeModifyFn = std::function<void(WsfPProxy*, ProxyModifiedReason, const WsfPProxyPath&, const std::string*)>
using	RenameMap = std::map<WsfPProxyPath, WsfPProxyPath>

Public Member Functions
	WsfPProxy ()
	WsfPProxy (const WsfPProxy &)=delete
WsfPProxy &	operator= (const WsfPProxy &)=delete
	~WsfPProxy ()
void	SetProxyModifiedCallback (ProxyModifiedFn aFunctionPtr)
void	SetBeforeProxyModifiedCallback (BeforeModifyFn aFunctionPtr)
void	BuildPathMap ()
bool	GetChildrenPaths (const WsfPProxyPath &nodePath, WsfPProxyPathSet &childrenPaths, WsfPProxyPath &suffixPath) const
const WsfPProxyPathSet *	GetInheritedValuePaths (const WsfPProxyPath &nodePath) const
void	RecordObjectRename (const WsfPProxyPath &aOldPath, const WsfPProxyPath &aNewPath)
void	NotifyProxyModified (ProxyModifiedReason aProxyModifiedReason, const WsfPProxyPath &aPath, const std::string *aRenameName)
void	NotifyBeforeProxyModified (ProxyModifiedReason aProxyModifiedReason, const WsfPProxyPath &aPath, const std::string *aRenameName)
void	UndoPlatformRenames ()
short	SequenceNumber () const
void	IncrementSequenceNumber ()
void	SetSaveFile (const WsfPProxyPath &aPath, const std::string &aFilePath)
const std::map< WsfPProxyPath, std::string > &	SaveFiles () const
std::map< WsfPProxyPath, std::string >	RenameMappingOldToNew ()
size_t	FindAttributeIndex (const std::string &aStructName, const std::string &aAttributeName)
WsfPProxyValue	NewValue (const std::string &aTypeName)
void	PropagateNodeChange (const WsfPProxyNode &aModifiedNode)
void	PropagateNodeAddition (const WsfPProxyNode &aAddedNode)
void	PropagateNodeDeletion (const WsfPProxyNode &aRemovedNode)
void	Swap (WsfPProxy &aProxy)
const std::shared_ptr< WsfPProxyRegistry > &	GetRegistry () const
void	Registry (const std::shared_ptr< WsfPProxyRegistry > &aRegistry)

Public Attributes
bool	mHasModifications
WsfPProxyStructValue	mBasicRoot
WsfPProxyValue	mRoot
std::unique_ptr< WsfPProxyIndex >	mIndex
std::unique_ptr< WsfPProxyPathMap >	mPathMap
ProxyModifiedFn	mModifiedCallback
BeforeModifyFn	mBeforeModifiedCallback
RenameMap	mRenamedObjects

Member Typedef Documentation

BeforeModifyFn

using WsfPProxy::BeforeModifyFn = std::function<void(WsfPProxy*, ProxyModifiedReason, const WsfPProxyPath&, const std::string*)>

ProxyModifiedFn

using WsfPProxy::ProxyModifiedFn = std::function<void(WsfPProxy*, ProxyModifiedReason, const WsfPProxyPath&, const std::string*)>

RenameMap

using WsfPProxy::RenameMap = std::map<WsfPProxyPath, WsfPProxyPath>

Member Enumeration Documentation

ProxyModifiedReason

enum WsfPProxy::ProxyModifiedReason

Enumerator
cPM_CHILD_ADDED
cPM_CHILD_REMOVED
cPM_CHILD_MOVED
cPM_VALUE_CHANGED

Constructor & Destructor Documentation

WsfPProxy() [1/2]

WsfPProxy::WsfPProxy

(

)

References mBeforeModifiedCallback, mHasModifications, mIndex, mModifiedCallback, and mPathMap.

Referenced by operator=(), Swap(), and WsfPProxy().

WsfPProxy() [2/2]

WsfPProxy::WsfPProxy ( const WsfPProxy & )

delete

References WsfPProxy().

~WsfPProxy()

WsfPProxy::~WsfPProxy

(

)

References mRoot.

Member Function Documentation

BuildPathMap()

void WsfPProxy::BuildPathMap

(

)

References mPathMap, and WsfPProxyVisitor::VisitNodes().

FindAttributeIndex()

size_t WsfPProxy::FindAttributeIndex	(	const std::string &	aStructName,
		const std::string &	aAttributeName )

References WsfPProxyStructType::GetMemberIndex().

GetChildrenPaths()

bool WsfPProxy::GetChildrenPaths	(	const WsfPProxyPath &	nodePath,
		WsfPProxyPathSet &	childrenPaths,
		WsfPProxyPath &	suffixPath ) const

References WsfPProxyPath::Back(), WsfPProxyPath::Empty(), mPathMap, and WsfPProxyPath::Pop().

Referenced by PropagateNodeAddition(), PropagateNodeChange(), and PropagateNodeDeletion().

GetInheritedValuePaths()

const WsfPProxyPathSet * WsfPProxy::GetInheritedValuePaths

(

const WsfPProxyPath &

nodePath

)

const

References mPathMap.

GetRegistry()

const std::shared_ptr< WsfPProxyRegistry > & WsfPProxy::GetRegistry ( ) const

inline

Referenced by WsfPProxyNode::ToJSON().

IncrementSequenceNumber()

void WsfPProxy::IncrementSequenceNumber ( )

inline

Referenced by WsfPM_ObjectMap::Move(), and WsfPProxyNode::NotifyValueRemoved().

NewValue()

WsfPProxyValue WsfPProxy::NewValue

(

const std::string &

aTypeName

)

References WsfPProxyValue::ConstructNew(), and WsfPProxyValue::GetType().

NotifyBeforeProxyModified()

void WsfPProxy::NotifyBeforeProxyModified ( ProxyModifiedReason aProxyModifiedReason, const WsfPProxyPath & aPath, const std::string * aRenameName )

inline

References mBeforeModifiedCallback.

Referenced by WsfPM_ObjectMap::Add(), WsfPM_List::append(), WsfPM_List::insert(), WsfPM_ObjectMap::Move(), WsfPProxyNode::NotifyBeforeValueChanged(), WsfPM_ObjectMap::Remove(), and WsfPM_List::remove().

NotifyProxyModified()

void WsfPProxy::NotifyProxyModified ( ProxyModifiedReason aProxyModifiedReason, const WsfPProxyPath & aPath, const std::string * aRenameName )

inline

References mModifiedCallback.

Referenced by WsfPM_List::append(), WsfPM_List::insert(), WsfPM_ObjectMap::Move(), WsfPProxyNode::NotifyValueAdded(), WsfPProxyNode::NotifyValueChanged(), WsfPProxyNode::NotifyValueMoved(), WsfPProxyNode::NotifyValueRemoved(), and WsfPM_List::remove().

operator=()

WsfPProxy & WsfPProxy::operator= ( const WsfPProxy & )

delete

References WsfPProxy().

PropagateNodeAddition()

void WsfPProxy::PropagateNodeAddition

(

const WsfPProxyNode &

aAddedNode

)

References WsfPM_ObjectMap::Add(), WsfPProxyPath::Back(), WsfProxy::cCOPY_INHERITED, WsfPProxyValue::Copy(), GetChildrenPaths(), WsfPM_ObjectMap::GetObjectMap(), WsfPProxyNode::GetParent(), WsfPProxyNode::GetPath(), WsfPProxyValue::GetType(), WsfPProxyNode::GetValue(), WsfPProxyObjectMap::HasUserDeleted(), WsfPProxyType::IsObjectMap(), WsfPProxyNode::IsValid(), WsfPProxyValue::SetInherited(), and WsfPProxyKey::ToString().

PropagateNodeChange()

void WsfPProxy::PropagateNodeChange

(

const WsfPProxyNode &

aModifiedNode

)

References GetChildrenPaths(), WsfPProxyNode::GetPath(), WsfPProxyNode::GetValue(), WsfPProxyValue::IsInherited(), WsfPProxyNode::IsValid(), and WsfPProxyVisitor::VisitNodes().

PropagateNodeDeletion()

void WsfPProxy::PropagateNodeDeletion

(

const WsfPProxyNode &

aRemovedNode

)

References WsfPProxyPath::Back(), GetChildrenPaths(), WsfPProxyNode::GetParent(), WsfPProxyNode::GetPath(), WsfPProxyValue::GetType(), WsfPProxyNode::GetValue(), WsfPProxyValue::IsInherited(), WsfPProxyType::IsObjectMap(), WsfPM_ObjectMap::Remove(), and WsfPProxyKey::ToString().

RecordObjectRename()

void WsfPProxy::RecordObjectRename	(	const WsfPProxyPath &	aOldPath,
		const WsfPProxyPath &	aNewPath )

References mRenamedObjects.

Referenced by WsfPM_ObjectMap::Move(), and WsfPM_Zone::Rename().

Registry()

void WsfPProxy::Registry ( const std::shared_ptr< WsfPProxyRegistry > & aRegistry )

inline

RenameMappingOldToNew()

std::map< WsfPProxyPath, std::string > WsfPProxy::RenameMappingOldToNew

(

)

References mRenamedObjects.

Referenced by wizard::ProjectParseThread::SetTask().

SaveFiles()

const std::map< WsfPProxyPath, std::string > & WsfPProxy::SaveFiles ( ) const

inline

Referenced by wizard::ProjectParseThread::SetTask().

SequenceNumber()

short WsfPProxy::SequenceNumber ( ) const

inline

SetBeforeProxyModifiedCallback()

void WsfPProxy::SetBeforeProxyModifiedCallback ( BeforeModifyFn aFunctionPtr )

inline

References mBeforeModifiedCallback.

SetProxyModifiedCallback()

void WsfPProxy::SetProxyModifiedCallback ( ProxyModifiedFn aFunctionPtr )

inline

References mModifiedCallback.

SetSaveFile()

void WsfPProxy::SetSaveFile	(	const WsfPProxyPath &	aPath,
		const std::string &	aFilePath )

Swap()

void WsfPProxy::Swap

(

WsfPProxy &

aProxy

)

References mBasicRoot, mHasModifications, mIndex, mModifiedCallback, mPathMap, mRenamedObjects, mRoot, std::swap(), and WsfPProxy().

UndoPlatformRenames()

void WsfPProxy::UndoPlatformRenames

(

)

References WsfPProxyNode::IsOfType(), mRenamedObjects, and WsfPM_Platform::Rename().

Referenced by wizard::Signals::revertVisualModeChanges().

Member Data Documentation

mBasicRoot

WsfPProxyStructValue WsfPProxy::mBasicRoot

Referenced by WsfPProxySerialize::PreSerialize(), Swap(), and WsfPProxyNode::ToJSON().

mBeforeModifiedCallback

BeforeModifyFn WsfPProxy::mBeforeModifiedCallback

Referenced by NotifyBeforeProxyModified(), SetBeforeProxyModifiedCallback(), and WsfPProxy().

mHasModifications

bool WsfPProxy::mHasModifications

Referenced by wizard::Project::ProxyReady(), Swap(), and WsfPProxy().

mIndex

std::unique_ptr<WsfPProxyIndex> WsfPProxy::mIndex

Referenced by WsfPProxySerialize::PreSerialize(), Swap(), and WsfPProxy().

mModifiedCallback

ProxyModifiedFn WsfPProxy::mModifiedCallback

Referenced by NotifyProxyModified(), SetProxyModifiedCallback(), Swap(), and WsfPProxy().

mPathMap

std::unique_ptr<WsfPProxyPathMap> WsfPProxy::mPathMap

Referenced by BuildPathMap(), GetChildrenPaths(), GetInheritedValuePaths(), WsfPM_Platform::Rename(), Swap(), and WsfPProxy().

mRenamedObjects

RenameMap WsfPProxy::mRenamedObjects

Referenced by RecordObjectRename(), RenameMappingOldToNew(), Swap(), and UndoPlatformRenames().

mRoot

WsfPProxyValue WsfPProxy::mRoot

Referenced by wizard::UndoProxyChange::createUndo(), WsfPProxySerialize::PreSerialize(), Swap(), and ~WsfPProxy().

---

The documentation for this class was generated from the following files:

• WsfPProxy.hpp
• WsfPProxy.cpp