WsfParsePassthrough Class Reference

#include <WsfParseRule.hpp>

Inheritance diagram for WsfParsePassthrough:

Collaboration diagram for WsfParsePassthrough:

Public Types
enum	Kind { cERROR_RULE , cNO_CHANGE }
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
	WsfParsePassthrough (WsfParseRuleMemory &aMem)
bool	Read (WsfParser &aParser, WsfParseNode *&aNode) override
bool	ReadRange (WsfParser &aParser, UtTextDocumentRange &aRange, WsfParseNode *&aNode, bool aCreateNode) override
WsfParseRule *	GetPassthrough () override
void	ProcessNode (WsfParseNode &aNode)
void	SetPassthroughRule (WsfParseRule *aRulePtr)
std::vector< WsfParseRule * >	GetSequence () override
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 void	Initialize (int aSequence)
virtual std::vector< WsfParseRule * >	GetAlternates ()
virtual WsfParseRuleDictionary *	GetNestedRules ()
virtual WsfParseNamedRule *	GetContext () const
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
Kind	mKind
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.

Additional Inherited Members
Protected Attributes inherited from WsfParseRule
WsfParseRule *	mSubordinateRulePtr

Member Enumeration Documentation

Kind

enum WsfParsePassthrough::Kind

Enumerator
cERROR_RULE
cNO_CHANGE

Constructor & Destructor Documentation

WsfParsePassthrough()

WsfParsePassthrough::WsfParsePassthrough ( WsfParseRuleMemory & aMem )

inline

References WsfParseRule::cIS_PASSTHROUGH, cNO_CHANGE, WsfParseRule::cPASSTHROUGH, mKind, WsfParseRule::mReaderFlags, and WsfParseRule::WsfParseRule().

Member Function Documentation

GetPassthrough()

WsfParseRule * WsfParsePassthrough::GetPassthrough ( )

inlineoverridevirtual

Reimplemented from WsfParseRule.

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

GetSequence()

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

inlineoverridevirtual

Reimplemented from WsfParseRule.

References WsfParseRule::mSubordinateRulePtr.

ProcessNode()

void WsfParsePassthrough::ProcessNode

(

WsfParseNode &

aNode

)

References WsfParseNode::cERROR_INCOMPLETE, cERROR_RULE, WsfParseNode::mFlags, mKind, and WsfParseNode::mRulePtr.

Referenced by Read(), and ReadRange().

Read()

bool WsfParsePassthrough::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 WsfParseRule::mSubordinateRulePtr, and ProcessNode().

ReadRange()

bool WsfParsePassthrough::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 WsfParseRule::mSubordinateRulePtr, and ProcessNode().

SetPassthroughRule()

void WsfParsePassthrough::SetPassthroughRule

(

WsfParseRule *

aRulePtr

)

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

Member Data Documentation

mKind

Kind WsfParsePassthrough::mKind

Referenced by ProcessNode(), and WsfParsePassthrough().

---

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

• WsfParseRule.hpp
• WsfParseRule.cpp