WsfParseStruct Class Reference

#include <WsfParseRule.hpp>

Inheritance diagram for WsfParseStruct:

Collaboration diagram for WsfParseStruct:

Classes
struct	ScriptVariable

Public Member Functions
	WsfParseStruct (WsfParseRuleMemory &aMem, const std::string &aRuleName)
	~WsfParseStruct () override
WsfParseAttribute *	FindAttribute (const std::string &aName)
size_t	FindAttributeIndex (const std::string &aName)
void	Initialize (int aSequence) override
WsfParseAttribute &	GetAttribute (size_t aIndex)
size_t	GetAttributeCount ()
void	SetBase (WsfParseStruct *aBasePtr)
WsfParseStruct *	GetBase ()
bool	IsType (WsfParseStruct *aBasePtr)
WsfParseValueType *	GetType () override
	If the rule is also a type, return the type.
std::vector< ScriptVariable >	GetAllScriptVariables ()
Public Member Functions inherited from WsfParseNamedRule
	WsfParseNamedRule (WsfParseRuleMemory &aMem)
	WsfParseNamedRule (WsfParseRuleMemory &aMem, const std::string &aName, WsfParseRule *aRulePtr)
	~WsfParseNamedRule () override
bool	InitializeInputsOutputs ()
WsfParseStruct *	FindStruct (const std::string &aRuleName)
WsfParseNamedRule *	Find (const std::string &aRuleName)
WsfParseNamedRule *	FindImmediate (const std::string &aRuleName)
WsfParseValue *	FindValue (const std::string &aTypeName)
bool	HasNestedRules () const
WsfParseRuleDictionary *	GetNestedRules () override
WsfParseRuleDictionary *	GetNested ()
bool	Read (WsfParser &aParser, WsfParseNode *&aNode) override
bool	ReadRange (WsfParser &aParser, UtTextDocumentRange &aRange, WsfParseNode *&aNode, bool aCreateNode) override
void	SetDefinition (WsfParseRule *aRulePtr)
std::string	GetFullName () const
WsfParseRule *	GetDefinition () const
WsfParseRule *&	GetDefinition ()
std::vector< WsfParseRule * >	GetSequence () override
WsfParseNamedRule *	GetContext () const override
WsfParseRule *	GetPassthrough () override
std::string	GetRuleDescription () override
WsfParseValue *	GetRuleValue ()
bool	IsPartValueRule ()
void	Swap (WsfParseNamedRule &aRhs)
Public Member Functions inherited from WsfParseRule
	WsfParseRule (WsfParseRuleMemory &aMem, RuleType aType)
virtual	~WsfParseRule ()=default
	WsfParseRule (const WsfParseRule &)=default
void	Swap (WsfParseRule &aRhs)
RuleType	Type () const
	Returns an enumeration specifying the derived type of the reader.
virtual void	Undo (WsfParser &aParser)
virtual void	Resolve (WsfParser &aParser, WsfParseNode *aNodePtr)
virtual std::vector< WsfParseRule * >	GetAlternates ()
WsfParseStruct *	GetContainingStruct () const
WsfParseStruct *	GetStruct ()
WsfParseNamedRule *	GetEntryType ()
WsfParseNamedRule *	GetInputType ()
WsfParseNamedRule *	GetOutputType ()
WsfParseNamedRule *	GetBestContext ()
WsfParseNamedRule *	GetVarContext ()
bool	IsNamedRule () const
int	GetReaderFlags () const
WsfParseRule *	GetSubordinateRule () const
void	SetSubordinateRule (WsfParseRule *aRulePtr)

Public Attributes
size_t	mBaseAttributeCount
std::vector< WsfParseAttribute >	mAttributes
std::string	mBaseName
std::vector< ScriptVariable >	mScriptVariables
std::vector< WsfParseAction * >	mInitialActions
Public Attributes inherited from WsfParseNamedRule
WsfParseNamedRule *	mContextParent
	The rule inside of which this rule is nested.
std::string	mName
std::string	mInputTypeName
WsfParseNamedRule *	mInputTypePtr
std::string	mOutputTypeName
WsfParseNamedRule *	mOutputTypePtr
std::vector< WsfParseRule * >	mReferencingRules
Public Attributes inherited from WsfParseRule
RuleType	mRuleType
int	mReaderFlags
int	mUserId
WsfParseRule *	mParentRulePtr
	Pointer to the parent rule. This should be valid for unnamed rules.

Protected Attributes
WsfParseStruct *	mBasePtr
WsfParseValueType *	mTypePtr
Protected Attributes inherited from WsfParseNamedRule
WsfParseRuleDictionary *	mNestedRules
Protected Attributes inherited from WsfParseRule
WsfParseRule *	mSubordinateRulePtr

Additional Inherited Members
Public Types inherited from WsfParseRule
enum	RuleType {   cNAMED_RULE , cVALUE , cSTRUCT , cSEQUENCE ,   cALTERNATE , cRECURRENCE , cRULE_REFERENCE , cREAL ,   cINT , cSTRING , cLINE_STRING , cQUOTED_STRING ,   cLITERAL , cDELIMITED , cTYPE_LOAD , cTYPE_COMMAND ,   cPASSTHROUGH , cSCRIPT_BLOCK }
enum	ReaderFlags {   cCAN_RESOLVE = 1 , cCAN_UNDO = 2 , cIS_SINGLE_TOKEN = 4 , cIS_PASSTHROUGH = 8 ,   cIS_VALUE_RULE = 0x10 }

Constructor & Destructor Documentation

WsfParseStruct()

WsfParseStruct::WsfParseStruct	(	WsfParseRuleMemory &	aMem,
		const std::string &	aRuleName )

References WsfParseRule::cSTRUCT, mBaseAttributeCount, mBasePtr, WsfParseNamedRule::mInputTypeName, WsfParseNamedRule::mInputTypePtr, WsfParseNamedRule::mName, WsfParseRule::mRuleType, mTypePtr, and WsfParseNamedRule::WsfParseNamedRule().

Referenced by GetBase(), IsType(), and SetBase().

~WsfParseStruct()

WsfParseStruct::~WsfParseStruct ( )

override

References mInitialActions.

Member Function Documentation

FindAttribute()

WsfParseAttribute * WsfParseStruct::FindAttribute

(

const std::string &

aName

)

References mAttributes, mBasePtr, and WsfParseNamedRule::mName.

FindAttributeIndex()

size_t WsfParseStruct::FindAttributeIndex

(

const std::string &

aName

)

References mAttributes, mBaseAttributeCount, and mBasePtr.

GetAllScriptVariables()

std::vector< WsfParseStruct::ScriptVariable > WsfParseStruct::GetAllScriptVariables

(

)

References mBasePtr, and mScriptVariables.

Referenced by wizard::WsfScriptContainer::CreateContext().

GetAttribute()

WsfParseAttribute & WsfParseStruct::GetAttribute ( size_t aIndex )

inline

References mAttributes, mBaseAttributeCount, and mBasePtr.

GetAttributeCount()

size_t WsfParseStruct::GetAttributeCount

(

)

References mAttributes, and mBaseAttributeCount.

GetBase()

WsfParseStruct * WsfParseStruct::GetBase ( )

inline

References mBasePtr, and WsfParseStruct().

Referenced by WsfPProxyRegistry::CreateDefaultStruct(), WsfPProxyRegistry::GetStruct(), and SetBase().

GetType()

WsfParseValueType * WsfParseStruct::GetType ( )

overridevirtual

If the rule is also a type, return the type.

Reimplemented from WsfParseRule.

References mTypePtr.

Initialize()

void WsfParseStruct::Initialize ( int aSequence )

overridevirtual

Reimplemented from WsfParseNamedRule.

References WsfParseRule::Initialize().

IsType()

bool WsfParseStruct::IsType ( WsfParseStruct * aBasePtr )

inline

References mBasePtr, and WsfParseStruct().

SetBase()

void WsfParseStruct::SetBase

(

WsfParseStruct *

aBasePtr

)

References GetBase(), mAttributes, mBaseAttributeCount, mBasePtr, and WsfParseStruct().

Member Data Documentation

mAttributes

std::vector<WsfParseAttribute> WsfParseStruct::mAttributes

Referenced by WsfPProxyRegistry::CreateDefaultStruct(), FindAttribute(), FindAttributeIndex(), GetAttribute(), GetAttributeCount(), WsfPProxyRegistry::GetStruct(), SetBase(), and std::swap().

mBaseAttributeCount

size_t WsfParseStruct::mBaseAttributeCount

Referenced by FindAttributeIndex(), GetAttribute(), GetAttributeCount(), SetBase(), and WsfParseStruct().

mBaseName

std::string WsfParseStruct::mBaseName

mBasePtr

WsfParseStruct* WsfParseStruct::mBasePtr

protected

Referenced by FindAttribute(), FindAttributeIndex(), GetAllScriptVariables(), GetAttribute(), GetBase(), IsType(), SetBase(), and WsfParseStruct().

mInitialActions

std::vector<WsfParseAction*> WsfParseStruct::mInitialActions

Referenced by WsfPProxyRegistry::CreateDefaultStruct(), WsfPProxyDeserialize::ExecuteInitialActions(), and ~WsfParseStruct().

mScriptVariables

std::vector<ScriptVariable> WsfParseStruct::mScriptVariables

Referenced by GetAllScriptVariables().

mTypePtr

WsfParseValueType* WsfParseStruct::mTypePtr

protected

Referenced by GetType(), and WsfParseStruct().

---

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

• WsfParseRule.hpp
• WsfParseRule.cpp