WsfParseQuotedStringRule Class Reference

#include <WsfParseBasicRules.hpp>

Inheritance diagram for WsfParseQuotedStringRule:

Collaboration diagram for WsfParseQuotedStringRule:

Public Member Functions
	WsfParseQuotedStringRule (WsfParseRuleMemory &aMem, bool aQuotesOptional)
bool	Read (WsfParser &aParser, WsfParseNode *&aNode) override
void	SetFileReference (const std::string &aFilePath, WsfParser &aParser, WsfParseNode *aNodePtr)
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	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 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
bool	mQuotesOptional
bool	mFileReference
bool	mFileSearchPaths
UtStringRef	mFileType
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

Constructor & Destructor Documentation

WsfParseQuotedStringRule()

WsfParseQuotedStringRule::WsfParseQuotedStringRule ( WsfParseRuleMemory & aMem, bool aQuotesOptional )

inline

References WsfParseRule::cQUOTED_STRING, mFileReference, mFileSearchPaths, mQuotesOptional, and WsfParseRule::WsfParseRule().

Member Function Documentation

Read()

bool WsfParseQuotedStringRule::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 mFileReference, mQuotesOptional, WsfParser::NewNode(), WsfParser::ReadWord(), SetFileReference(), and WsfParser::UndoRead().

SetFileReference()

void WsfParseQuotedStringRule::SetFileReference	(	const std::string &	aFilePath,
		WsfParser &	aParser,
		WsfParseNode *	aNodePtr )

References WsfParser::AddAuxiliaryValue(), WsfParser::FindSource(), WsfParseNode::GetAuxiliaryValue(), WsfParser::GetParseIndex(), WsfParser::GetWorkingDirectory(), mFileSearchPaths, WsfParseNode::SetAuxiliaryValue(), and WsfParseIndex::SubstitutePathVariables().

Referenced by Read().

Member Data Documentation

mFileReference

bool WsfParseQuotedStringRule::mFileReference

Referenced by Read(), WsfParseDefinitions::WsfParseDefinitions(), and WsfParseQuotedStringRule().

mFileSearchPaths

bool WsfParseQuotedStringRule::mFileSearchPaths

Referenced by SetFileReference(), WsfParseDefinitions::WsfParseDefinitions(), and WsfParseQuotedStringRule().

mFileType

UtStringRef WsfParseQuotedStringRule::mFileType

mQuotesOptional

bool WsfParseQuotedStringRule::mQuotesOptional

Referenced by Read(), and WsfParseQuotedStringRule().

---

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

• WsfParseBasicRules.hpp
• WsfParseBasicRules.cpp