WSF
WsfParseDelimited Class Reference

#include <WsfParseBasicRules.hpp>

Inheritance diagram for WsfParseDelimited:
Collaboration diagram for WsfParseDelimited:

Classes

struct  Section

Public Member Functions

 WsfParseDelimited (WsfParseRuleMemory &aMem)
bool Read (WsfParser &aParser, WsfParseNode *&aNode) override
bool ReadRange (WsfParser &aParser, UtTextDocumentRange &aRange, WsfParseNode *&aNode, bool aCreateNode) 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 WsfParseRuleDictionaryGetNestedRules ()
virtual WsfParseNamedRuleGetContext () const
virtual WsfParseRuleGetPassthrough ()
virtual std::string GetRuleDescription ()
virtual WsfParseValueTypeGetType ()
 If the rule is also a type, return the type.
WsfParseStructGetContainingStruct () const
WsfParseStructGetStruct ()
WsfParseNamedRuleGetEntryType ()
WsfParseNamedRuleGetInputType ()
WsfParseNamedRuleGetOutputType ()
WsfParseNamedRuleGetBestContext ()
WsfParseNamedRuleGetVarContext ()
bool IsNamedRule () const
int GetReaderFlags () const
WsfParseRuleGetSubordinateRule () const
void SetSubordinateRule (WsfParseRule *aRulePtr)

Public Attributes

std::vector< SectionmSections
bool mCaseSensitive
WsfParseNodemSubnodes [10]
UtTextDocumentRange mWords [10]
Public Attributes inherited from WsfParseRule
RuleType mRuleType
int mReaderFlags
int mUserId
WsfParseRulemParentRulePtr
 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
WsfParseRulemSubordinateRulePtr

Constructor & Destructor Documentation

◆ WsfParseDelimited()

Member Function Documentation

◆ Read()

bool WsfParseDelimited::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
aParserThe parser.
aNodeSet to the resulting parse node.
Returns
'true' if a parse node was generated.

Implements WsfParseRule.

References ReadRange(), WsfParser::ReadWord(), and WsfParser::UndoRead().

◆ ReadRange()

bool WsfParseDelimited::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 mCaseSensitive, WsfParseDelimited::Section::mPreDelimiter, WsfParseDelimited::Section::mRulePtr, mSections, WsfParseNode::mValue, mWords, WsfParser::NewNode(), and ok.

Referenced by Read().

Member Data Documentation

◆ mCaseSensitive

bool WsfParseDelimited::mCaseSensitive

Referenced by ReadRange(), and WsfParseDelimited().

◆ mSections

std::vector<Section> WsfParseDelimited::mSections

Referenced by ReadRange().

◆ mSubnodes

WsfParseNode* WsfParseDelimited::mSubnodes[10]

Referenced by WsfParseDelimited().

◆ mWords

UtTextDocumentRange WsfParseDelimited::mWords[10]

Referenced by ReadRange(), and WsfParseDelimited().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved