WsfParseNamedRule Class Reference

#include <WsfParseRule.hpp>

Inheritance diagram for WsfParseNamedRule:

Collaboration diagram for WsfParseNamedRule:

Public Member Functions
	WsfParseNamedRule (WsfParseRuleMemory &aMem)
	WsfParseNamedRule (WsfParseRuleMemory &aMem, const std::string &aName, WsfParseRule *aRulePtr)
	~WsfParseNamedRule () override
bool	InitializeInputsOutputs ()
void	Initialize (int aSequence) override
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 ()
virtual WsfParseValueType *	GetType ()
	If the rule is also a type, return the type.
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
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
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

WsfParseNamedRule() [1/2]

WsfParseNamedRule::WsfParseNamedRule

(

WsfParseRuleMemory &

aMem

)

References WsfParseRule::cIS_PASSTHROUGH, WsfParseRule::cNAMED_RULE, mContextParent, mInputTypePtr, mNestedRules, mOutputTypePtr, WsfParseRule::mReaderFlags, WsfParseRule::mSubordinateRulePtr, and WsfParseRule::WsfParseRule().

Referenced by Find(), FindImmediate(), FindStruct(), GetContext(), GetFullName(), GetRuleValue(), Initialize(), InitializeInputsOutputs(), Swap(), WsfParseStruct::WsfParseStruct(), and WsfParseValue::WsfParseValue().

WsfParseNamedRule() [2/2]

WsfParseNamedRule::WsfParseNamedRule	(	WsfParseRuleMemory &	aMem,
		const std::string &	aName,
		WsfParseRule *	aRulePtr )

References WsfParseRule::cIS_PASSTHROUGH, WsfParseRule::cNAMED_RULE, mContextParent, mInputTypePtr, mName, mNestedRules, mOutputTypePtr, WsfParseRule::mReaderFlags, WsfParseRule::SetSubordinateRule(), and WsfParseRule::WsfParseRule().

~WsfParseNamedRule()

WsfParseNamedRule::~WsfParseNamedRule ( )

override

References mNestedRules.

Member Function Documentation

Find()

WsfParseNamedRule * WsfParseNamedRule::Find

(

const std::string &

aRuleName

)

References WsfParseRuleDictionary::Find(), mContextParent, mNestedRules, and WsfParseNamedRule().

Referenced by FindStruct(), FindValue(), WsfParseDefinitions::Initialize(), InitializeInputsOutputs(), and WsfPParseRuleTracer::WsfPParseRuleTracer().

FindImmediate()

WsfParseNamedRule * WsfParseNamedRule::FindImmediate

(

const std::string &

aRuleName

)

References mNestedRules, and WsfParseNamedRule().

FindStruct()

WsfParseStruct * WsfParseNamedRule::FindStruct

(

const std::string &

aRuleName

)

References WsfParseRule::cSTRUCT, Find(), WsfParseRule::Type(), and WsfParseNamedRule().

FindValue()

WsfParseValue * WsfParseNamedRule::FindValue

(

const std::string &

aTypeName

)

References WsfParseRule::cVALUE, Find(), WsfParseRule::Type(), and WsfParseRule::WsfParseRule().

GetContext()

WsfParseNamedRule * WsfParseNamedRule::GetContext ( ) const

inlineoverridevirtual

Reimplemented from WsfParseRule.

References mContextParent, and WsfParseNamedRule().

Referenced by WsfPProxyRegistry::Setup().

GetDefinition() [1/2]

WsfParseRule *& WsfParseNamedRule::GetDefinition ( )

inline

References WsfParseRule::mSubordinateRulePtr, and WsfParseRule::WsfParseRule().

GetDefinition() [2/2]

WsfParseRule * WsfParseNamedRule::GetDefinition ( ) const

inline

References WsfParseRule::mSubordinateRulePtr, and WsfParseRule::WsfParseRule().

Referenced by wizard::AutoComplete::ExpandRule(), and WsfParseDefinitions::Initialize().

GetFullName()

std::string WsfParseNamedRule::GetFullName

(

)

const

References WsfParseRule::GetContainingStruct(), mName, and WsfParseNamedRule().

Referenced by GetRuleDescription(), WsfPProxyRegistry::GetStruct(), WsfPProxyRegistry::GetType(), and WsfParseType::Print().

GetNested()

WsfParseRuleDictionary * WsfParseNamedRule::GetNested

(

)

References mNestedRules.

GetNestedRules()

WsfParseRuleDictionary * WsfParseNamedRule::GetNestedRules ( )

inlineoverridevirtual

Reimplemented from WsfParseRule.

References mNestedRules.

Referenced by WsfPProxyRegistry::FindStructs().

GetPassthrough()

WsfParseRule * WsfParseNamedRule::GetPassthrough ( )

inlineoverridevirtual

Reimplemented from WsfParseRule.

References WsfParseRule::mSubordinateRulePtr, and WsfParseRule::WsfParseRule().

GetRuleDescription()

std::string WsfParseNamedRule::GetRuleDescription ( )

inlineoverridevirtual

Reimplemented from WsfParseRule.

References GetFullName().

GetRuleValue()

WsfParseValue * WsfParseNamedRule::GetRuleValue

(

)

References WsfParseRule::cIS_VALUE_RULE, WsfParseRule::cVALUE, mContextParent, WsfParseRule::mReaderFlags, WsfParseRule::Type(), and WsfParseNamedRule().

Referenced by WsfPProxySatisfy::Satisfy().

GetSequence()

std::vector< WsfParseRule * > WsfParseNamedRule::GetSequence ( )

inlineoverridevirtual

Reimplemented from WsfParseRule.

References WsfParseRule::mSubordinateRulePtr.

HasNestedRules()

bool WsfParseNamedRule::HasNestedRules ( ) const

inline

References mNestedRules.

Initialize()

void WsfParseNamedRule::Initialize ( int aSequence )

overridevirtual

Reimplemented from WsfParseRule.

Reimplemented in WsfParseStruct, and WsfParseValue.

References WsfParseRule::cIS_VALUE_RULE, WsfParseRule::cVALUE, WsfParseRule::Initialize(), mContextParent, WsfParseRule::mReaderFlags, mReferencingRules, WsfParseRule::Type(), and WsfParseNamedRule().

InitializeInputsOutputs()

bool WsfParseNamedRule::InitializeInputsOutputs

(

)

References Find(), WsfParseRule::GetVarContext(), mInputTypeName, mInputTypePtr, mOutputTypeName, mOutputTypePtr, and WsfParseNamedRule().

IsPartValueRule()

bool WsfParseNamedRule::IsPartValueRule ( )

inline

References WsfParseRule::cIS_VALUE_RULE, and WsfParseRule::mReaderFlags.

Referenced by WsfPProxySatisfy::Satisfy().

Read()

bool WsfParseNamedRule::Read ( WsfParser & aParser, WsfParseNode *& aNode )

overridevirtual

Override to parse and generate a parse node. Parse nodes should be generated even on error conditions if possible.

Parameters

aParser	The parser.
aNode	Set to the resulting parse node.

Returns

'true' if a parse node was generated.

Implements WsfParseRule.

References WsfParseNode::Add(), WsfParser::FullyExpandNodes(), mName, WsfParseNode::mRulePtr, WsfParseRule::mSubordinateRulePtr, WsfParser::NewNode(), and ok.

ReadRange()

bool WsfParseNamedRule::ReadRange ( WsfParser & aParser, UtTextDocumentRange & aRange, WsfParseNode *& aNode, bool aCreateNode )

overridevirtual

Override to parse and generate a parse node given a single block of text. This method must be implemented to take part in delimited expressions.

Reimplemented from WsfParseRule.

References WsfParseNode::mRulePtr, WsfParseRule::mSubordinateRulePtr, and ok.

SetDefinition()

void WsfParseNamedRule::SetDefinition

(

WsfParseRule *

aRulePtr

)

References WsfParseRule::mParentRulePtr, WsfParseRule::SetSubordinateRule(), and WsfParseRule::WsfParseRule().

Swap()

void WsfParseNamedRule::Swap ( WsfParseNamedRule & aRhs )

inline

References mContextParent, mInputTypeName, mInputTypePtr, mName, mNestedRules, mOutputTypeName, mOutputTypePtr, mReferencingRules, std::swap(), WsfParseNamedRule(), and WsfParseRule::WsfParseRule().

Referenced by std::swap().

Member Data Documentation

mContextParent

WsfParseNamedRule* WsfParseNamedRule::mContextParent

The rule inside of which this rule is nested.

Referenced by Find(), GetContext(), WsfParseDefinitions::GetFullRuleName(), GetRuleValue(), Initialize(), Swap(), WsfParseNamedRule(), and WsfParseNamedRule().

mInputTypeName

std::string WsfParseNamedRule::mInputTypeName

Referenced by InitializeInputsOutputs(), Swap(), and WsfParseStruct::WsfParseStruct().

mInputTypePtr

WsfParseNamedRule* WsfParseNamedRule::mInputTypePtr

Referenced by InitializeInputsOutputs(), Swap(), WsfParseNamedRule(), WsfParseNamedRule(), and WsfParseStruct::WsfParseStruct().

mName

std::string WsfParseNamedRule::mName

Referenced by WsfParseRuleDictionary::Add(), WsfParseStruct::FindAttribute(), GetFullName(), WsfParseDefinitions::GetFullRuleName(), WsfPProxyRegistry::GetStruct(), Read(), Swap(), WsfParseNamedRule(), WsfParseStruct::WsfParseStruct(), and WsfParseValue::WsfParseValue().

mNestedRules

WsfParseRuleDictionary* WsfParseNamedRule::mNestedRules

protected

Referenced by Find(), FindImmediate(), GetNested(), GetNestedRules(), HasNestedRules(), Swap(), WsfParseNamedRule(), WsfParseNamedRule(), and ~WsfParseNamedRule().

mOutputTypeName

std::string WsfParseNamedRule::mOutputTypeName

Referenced by InitializeInputsOutputs(), Swap(), and WsfParseValue::WsfParseValue().

mOutputTypePtr

WsfParseNamedRule* WsfParseNamedRule::mOutputTypePtr

Referenced by InitializeInputsOutputs(), Swap(), WsfParseNamedRule(), WsfParseNamedRule(), and WsfParseValue::WsfParseValue().

mReferencingRules

std::vector<WsfParseRule*> WsfParseNamedRule::mReferencingRules

Referenced by Initialize(), WsfParseRule::Initialize(), and Swap().

---

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

• WsfParseRule.hpp
• WsfParseRule.cpp