WsfParseLiteral Class Reference

Matches a string of text with no whitespace. More...

#include <WsfParseRule.hpp>

Inheritance diagram for WsfParseLiteral:

Collaboration diagram for WsfParseLiteral:

Public Member Functions
	WsfParseLiteral (WsfParseRuleMemory &aMem)
bool	Read (WsfParser &aParser, WsfParseNode *&aNode) override
bool	ReadRange (WsfParser &aParser, UtTextDocumentRange &aRange, WsfParseNode *&aNode, bool aCreateNode) override
bool	MatchesString (const std::string &aString)
std::string	GetRuleDescription () 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 * >	GetSequence ()
virtual std::vector< WsfParseRule * >	GetAlternates ()
virtual WsfParseRuleDictionary *	GetNestedRules ()
virtual WsfParseNamedRule *	GetContext () const
virtual WsfParseRule *	GetPassthrough ()
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
bool	mCaseSensitive
bool	mIsTerminator
std::string	mText
unsigned int	mNodeFlags
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
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 }
Protected Attributes inherited from WsfParseRule
WsfParseRule *	mSubordinateRulePtr

Detailed Description

Matches a string of text with no whitespace.

Constructor & Destructor Documentation

WsfParseLiteral()

WsfParseLiteral::WsfParseLiteral

(

WsfParseRuleMemory &

aMem

)

References WsfParseRule::cIS_SINGLE_TOKEN, WsfParseRule::cLITERAL, mCaseSensitive, mIsTerminator, mNodeFlags, WsfParseRule::mReaderFlags, mText, and WsfParseRule::WsfParseRule().

Member Function Documentation

GetRuleDescription()

std::string WsfParseLiteral::GetRuleDescription ( )

inlineoverridevirtual

Reimplemented from WsfParseRule.

References mText.

MatchesString()

bool WsfParseLiteral::MatchesString

(

const std::string &

aString

)

References mCaseSensitive, and mText.

Referenced by WsfPProxySatisfy::Satisfy().

Read()

bool WsfParseLiteral::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 mIsTerminator, mText, ReadRange(), WsfParser::ReadTerminator(), WsfParser::ReadWord(), and WsfParser::UndoRead().

ReadRange()

bool WsfParseLiteral::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::GetFlags(), mCaseSensitive, mNodeFlags, mText, WsfParser::NewNode(), RangeEqualNoCase(), and WsfParseNode::SetFlags().

Referenced by Read().

Member Data Documentation

mCaseSensitive

bool WsfParseLiteral::mCaseSensitive

Referenced by MatchesString(), WsfParseAlternate::ReaderStartsWithChar(), ReadRange(), std::swap(), and WsfParseLiteral().

mIsTerminator

bool WsfParseLiteral::mIsTerminator

Referenced by WsfParseRecurrence::Initialize(), Read(), std::swap(), and WsfParseLiteral().

mNodeFlags

unsigned int WsfParseLiteral::mNodeFlags

Referenced by WsfParseRecurrence::Initialize(), ReadRange(), and WsfParseLiteral().

mText

std::string WsfParseLiteral::mText

Referenced by wizard::AutoComplete::ExpandRule(), GetRuleDescription(), WsfParseRecurrence::Initialize(), MatchesString(), wizard::GrammarDocumentation::Process(), Read(), ReadRange(), std::swap(), and WsfParseLiteral().

---

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

• WsfParseRule.hpp
• WsfParseBasicRules.cpp