WsfParseTypeLoadRule Class Reference

#include <WsfParseTypeLoadRule.hpp>

Inheritance diagram for WsfParseTypeLoadRule:

Collaboration diagram for WsfParseTypeLoadRule:

Public Types
using	Operation = WsfParseTypeInfoData::Operation
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 }

Public Member Functions
	WsfParseTypeLoadRule (WsfParseRuleMemory &aMem, Operation aOperation, bool aAllowReplace=false)
bool	Read (WsfParser &aParser, WsfParseNode *&aNode) override
void	Undo (WsfParser &aParser) override
void	Resolve (WsfParser &aParser, WsfParseNode *aNodePtr) override
Operation	GetOperation () const
const WsfParseTypeName &	GetSaveType () const
const WsfParseTypeName &	GetLoadType () const
const WsfParseTypePath &	GetBackupType () const
bool	CreateTypePath (WsfParseTypePath &aPath, WsfParser &aParser, WsfParseIndex &aIndex, const WsfParseTypeName &aKey, UtTextDocumentRange &aInputRange)
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 bool	ReadRange (WsfParser &aParser, UtTextDocumentRange &aRange, WsfParseNode *&aNode, bool aCreateNode)
virtual void	Initialize (int aSequence)
virtual std::vector< WsfParseRule * >	GetSequence ()
virtual std::vector< WsfParseRule * >	GetAlternates ()
virtual WsfParseRuleDictionary *	GetNestedRules ()
virtual WsfParseNamedRule *	GetContext () const
virtual WsfParseRule *	GetPassthrough ()
virtual std::string	GetRuleDescription ()
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
WsfParseTypeName	mSaveType
WsfParseTypeName	mLoadType
WsfParseTypePath	mBackupLoadType
bool	mAllowRedefinition
bool	mGenerateNameInConflict
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 Member Functions
UtStringRef	GenerateName (WsfParser &aParser, bool aIsConflict)
WsfParseType *	FindLoadType (WsfParser &aParser, WsfParseIndex &aIndex, const WsfParseTypePath &aKey, bool aNested)
WsfParseTypeInfoData *	CreateAuxData (const WsfParseTypePath *aSaveType, const WsfParseTypePath *aLoadType)
void	SaveTypeToNode (WsfParseType *aTypePtr, WsfParseNode *aNode)
UtStringRef	GetLoadType (WsfParser &aParser, const WsfParseTypeName &aLoadType)
UtStringRef	GetSaveType (WsfParser &aParser)

Protected Attributes
Operation	mOperation
Protected Attributes inherited from WsfParseRule
WsfParseRule *	mSubordinateRulePtr

Member Typedef Documentation

Operation

using WsfParseTypeLoadRule::Operation = WsfParseTypeInfoData::Operation

Constructor & Destructor Documentation

WsfParseTypeLoadRule()

WsfParseTypeLoadRule::WsfParseTypeLoadRule	(	WsfParseRuleMemory &	aMem,
		Operation	aOperation,
		bool	aAllowReplace = false )

References WsfParseRule::cCAN_RESOLVE, WsfParseRule::cCAN_UNDO, WsfParseRule::cTYPE_LOAD, mAllowRedefinition, mGenerateNameInConflict, mOperation, WsfParseRule::mReaderFlags, and WsfParseRule::WsfParseRule().

Member Function Documentation

CreateAuxData()

WsfParseTypeInfoData * WsfParseTypeLoadRule::CreateAuxData ( const WsfParseTypePath * aSaveType, const WsfParseTypePath * aLoadType )

protected

References WsfParseTypeInfoData::cNESTED_LOAD, WsfParseTypeInfoData::cNESTED_SAVE, WsfParseTypeInfoData::mFlags, WsfParseTypeInfoData::mLoadKey, mLoadType, mOperation, WsfParseTypeInfoData::mSaveKey, and mSaveType.

Referenced by Read().

CreateTypePath()

bool WsfParseTypeLoadRule::CreateTypePath	(	WsfParseTypePath &	aPath,
		WsfParser &	aParser,
		WsfParseIndex &	aIndex,
		const WsfParseTypeName &	aKey,
		UtTextDocumentRange &	aInputRange )

References WsfParseNode::Down(), GenerateName(), WsfParser::GetCurrentSequence(), WsfParseTypeName::mOrdinal, WsfParseTypeName::mPath, WsfParseNode::mValue, and WsfParseNode::Right().

Referenced by WsfParseSequence::CompleteDelayLoad(), and Read().

FindLoadType()

WsfParseType * WsfParseTypeLoadRule::FindLoadType ( WsfParser & aParser, WsfParseIndex & aIndex, const WsfParseTypePath & aKey, bool aNested )

protected

References WsfParseType::FindNestedSymbol(), WsfParseType::FindType(), WsfParseIndex::GetCurrentType(), WsfParser::GetDefinitions(), WsfParseDefinitions::mBasicTypes, and WsfParseIndex::mUserTypes.

Referenced by Read().

GenerateName()

UtStringRef WsfParseTypeLoadRule::GenerateName ( WsfParser & aParser, bool aIsConflict )

protected

References WsfParseIndex::GenerateName(), and WsfParser::GetParseIndex().

Referenced by CreateTypePath(), and Read().

GetBackupType()

const WsfParseTypePath & WsfParseTypeLoadRule::GetBackupType ( ) const

inline

References mBackupLoadType.

GetLoadType() [1/2]

const WsfParseTypeName & WsfParseTypeLoadRule::GetLoadType ( ) const

inline

References mLoadType.

Referenced by wizard::AutoComplete::ExpandRule().

GetLoadType() [2/2]

UtStringRef WsfParseTypeLoadRule::GetLoadType ( WsfParser & aParser, const WsfParseTypeName & aLoadType )

protected

GetOperation()

Operation WsfParseTypeLoadRule::GetOperation ( ) const

inline

References mOperation.

Referenced by WsfParseSequence::CompleteDelayLoad(), wizard::AutoComplete::ExpandRule(), WsfPProxySatisfy::FollowAction(), WsfParseSequence::Initialize(), and WsfPProxySatisfy::SatisfyTypeLoad().

GetSaveType() [1/2]

const WsfParseTypeName & WsfParseTypeLoadRule::GetSaveType ( ) const

inline

References mSaveType.

GetSaveType() [2/2]

UtStringRef WsfParseTypeLoadRule::GetSaveType ( WsfParser & aParser )

protected

Read()

bool WsfParseTypeLoadRule::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 WsfParser::AddAuxiliaryValue(), WsfParseType::AddType(), WsfParseTypeInfoData::cCREATE_TYPE, WsfParseTypeInfoData::cDELETE_TYPE, WsfParseTypeInfoData::cDUPLICATE_NAME, WsfParseNode::cERROR_INCOMPLETE, WsfParseTypeInfoData::cINVALID_TYPE, WsfParseTypeInfoData::cLOAD_TYPE, WsfParseNode::cLOAD_TYPE_NODE, CreateAuxData(), CreateTypePath(), FindLoadType(), WsfParseType::FindType(), WsfParseType::FindTypeLocal(), GenerateName(), WsfParseNode::GetAuxiliaryValue(), WsfParseIndex::GetCurrentType(), WsfParser::GetParseIndex(), WsfParseType::HasSymbols(), WsfParser::IsDelayLoading(), WsfParseIndex::LoadCurrentType(), mAllowRedefinition, mBackupLoadType, WsfParseNode::mFlags, WsfParseTypeInfoData::mFlags, mGenerateNameInConflict, mLoadType, mOperation, mSaveType, WsfParseIndex::mUserTypes, WsfParser::NewNode(), WsfParseType::RemoveType(), WsfParser::Requires(), WsfParseNode::SetAuxiliaryValue(), and WsfParseType::SetSourceType().

Resolve()

void WsfParseTypeLoadRule::Resolve ( WsfParser & aParser, WsfParseNode * aNodePtr )

overridevirtual

Called by a command reader if the full command is successfully read. You must set cCAN_RESOLVE in the reader flags to receive this call.

Reimplemented from WsfParseRule.

References WsfParseNode::cTYPE_NAME_NODE, WsfParseNode::cTYPE_REFERENCE_NODE, WsfParseNode::Down(), WsfParser::GetParseIndex(), WsfParseNode::mFlags, WsfParseNode::mValue, WsfParseNode::Right(), and WsfParseIndex::UnloadCurrentType().

SaveTypeToNode()

void WsfParseTypeLoadRule::SaveTypeToNode ( WsfParseType * aTypePtr, WsfParseNode * aNode )

protected

References WsfParseNode::cLOAD_TYPE_NODE, and WsfParseNode::mFlags.

Undo()

void WsfParseTypeLoadRule::Undo ( WsfParser & aParser )

overridevirtual

Called by a command reader if the reader just read in a value that has now been rejected due to a later failure. You must set cCAN_UNDO in the reader flags to receive this call.

Reimplemented from WsfParseRule.

References WsfParser::GetParseIndex(), and WsfParseIndex::UnloadCurrentType().

Member Data Documentation

mAllowRedefinition

bool WsfParseTypeLoadRule::mAllowRedefinition

Referenced by Read(), WsfPProxySatisfy::SatisfyTypeLoad(), and WsfParseTypeLoadRule().

mBackupLoadType

WsfParseTypePath WsfParseTypeLoadRule::mBackupLoadType

Referenced by GetBackupType(), and Read().

mGenerateNameInConflict

bool WsfParseTypeLoadRule::mGenerateNameInConflict

Referenced by Read(), and WsfParseTypeLoadRule().

mLoadType

WsfParseTypeName WsfParseTypeLoadRule::mLoadType

Referenced by WsfParseSequence::CompleteDelayLoad(), CreateAuxData(), wizard::AutoComplete::ExpandRule(), WsfPProxySatisfy::FollowAction(), GetLoadType(), WsfParseSequence::Initialize(), Read(), and WsfPProxySatisfy::SatisfyTypeLoad().

mOperation

Operation WsfParseTypeLoadRule::mOperation

protected

Referenced by CreateAuxData(), GetOperation(), Read(), and WsfParseTypeLoadRule().

mSaveType

WsfParseTypeName WsfParseTypeLoadRule::mSaveType

Referenced by WsfParseSequence::CompleteDelayLoad(), CreateAuxData(), WsfPProxySatisfy::FollowAction(), GetSaveType(), WsfParseSequence::Initialize(), Read(), and WsfPProxySatisfy::SatisfyTypeLoad().

---

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

• WsfParseTypeLoadRule.hpp
• WsfParseTypeLoadRule.cpp