WsfParseScriptRule Class Reference
WsfParseScriptRule collects a block of text to be parsed later by the script parser. More...
#include <WsfParseScriptRule.hpp>
Inheritance diagram for WsfParseScriptRule:
Collaboration diagram for WsfParseScriptRule:
Public Types | |
| enum | ScriptType { cFUNCTION , cIMPLICIT_FUNCTION , cSCRIPT_VARIABLES } |
| 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 | |
| WsfParseScriptRule (WsfParseRuleMemory &aMem, ScriptType aScriptType) | |
| bool | Read (WsfParser &aParser, WsfParseNode *&aNode) 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 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 | |
| ScriptType | mScriptType |
| 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 |
Detailed Description
WsfParseScriptRule collects a block of text to be parsed later by the script parser.
Member Enumeration Documentation
◆ ScriptType
Constructor & Destructor Documentation
◆ WsfParseScriptRule()
| WsfParseScriptRule::WsfParseScriptRule | ( | WsfParseRuleMemory & | aMem, |
| ScriptType | aScriptType ) |
References WsfParseRule::cSCRIPT_BLOCK, mScriptType, and WsfParseRule::WsfParseRule().
Member Function Documentation
◆ Read()
|
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 cFUNCTION, cIMPLICIT_FUNCTION, WsfParseNode::cSCRIPT_BLOCK, WsfParseNode::cSCRIPT_FUNCTION, WsfParseNode::cSCRIPT_VARIABLES, cSCRIPT_VARIABLES, mScriptType, WsfParser::NewNode(), WsfParser::ReadWord(), WsfParseNode::SetFlags(), and WsfParser::UndoRead().
Member Data Documentation
◆ mScriptType
| ScriptType WsfParseScriptRule::mScriptType |
Referenced by Read(), and WsfParseScriptRule().
The documentation for this class was generated from the following files: