WSF
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
WsfParseRule Class Referenceabstract

#include <WsfParseRule.hpp>

Inheritance diagram for WsfParseRule:
Inheritance graph
[legend]
Collaboration diagram for WsfParseRule:
Collaboration graph
[legend]

Public Types

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

 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 Read (WsfParser &aParser, WsfParseNode *&aNode)=0
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

RuleType mRuleType
int mReaderFlags
int mUserId
WsfParseRule * mParentRulePtr
 Pointer to the parent rule. This should be valid for unnamed rules.

Protected Attributes

WsfParseRule * mSubordinateRulePtr

Detailed Description

The base class for all parse rules. A parse rule defines rules for matching a piece of wsf core text. Parse rules are created while processing the wsf core grammar files.

Member Enumeration Documentation

◆ ReaderFlags

enum WsfParseRule::ReaderFlags
Enumerator
cCAN_RESOLVE 
cCAN_UNDO 
cIS_SINGLE_TOKEN 
cIS_PASSTHROUGH 
cIS_VALUE_RULE 

◆ RuleType

enum WsfParseRule::RuleType
Enumerator
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 

Constructor & Destructor Documentation

◆ WsfParseRule() [1/2]

WsfParseRule::WsfParseRule ( WsfParseRuleMemory & aMem,
RuleType aType )

The parse rule constructor requires a 'WsfParseRuleMemory' object to keep track of parse rules in memory and a rule type.

References mParentRulePtr, mReaderFlags, mRuleType, mSubordinateRulePtr, mUserId, and WsfParseRuleMemory::RuleAdded().

Referenced by WsfParseAlternate::AddAlternate(), WsfParseSequence::AddRule(), WsfParseSequence::CompleteDelayLoad(), WsfParseSequence::FindChildIndex(), WsfParseNamedRule::FindValue(), WsfParseNamedRule::GetDefinition(), WsfParseNamedRule::GetDefinition(), WsfParseNamedRule::GetPassthrough(), WsfParsePassthrough::GetPassthrough(), GetPassthrough(), WsfParseRuleReference::GetPassthrough(), GetSubordinateRule(), WsfParseRecurrence::Initialize(), Initialize(), WsfParseSequence::Initialize(), WsfParseAlternate::Read(), WsfParseSequence::Read(), WsfParseTypeCommandRule::Read(), WsfParseAlternate::ReaderStartsWithChar(), WsfParseSequence::ResolveChildren(), WsfParseNamedRule::SetDefinition(), WsfParsePassthrough::SetPassthroughRule(), WsfParseRecurrence::SetRecurringRule(), WsfParseRuleReference::SetReferencedRule(), SetSubordinateRule(), WsfParseNamedRule::Swap(), Swap(), WsfParseSequence::UndoChildren(), WsfParseAlternate::WsfParseAlternate(), WsfParseDelimited::WsfParseDelimited(), WsfParseIntRule::WsfParseIntRule(), WsfParseLineStringRule::WsfParseLineStringRule(), WsfParseLiteral::WsfParseLiteral(), WsfParseNamedRule::WsfParseNamedRule(), WsfParseNamedRule::WsfParseNamedRule(), WsfParsePassthrough::WsfParsePassthrough(), WsfParseQuotedStringRule::WsfParseQuotedStringRule(), WsfParseRealRule::WsfParseRealRule(), WsfParseRecurrence::WsfParseRecurrence(), WsfParseRule(), WsfParseRuleReference::WsfParseRuleReference(), WsfParseScriptRule::WsfParseScriptRule(), WsfParseSequence::WsfParseSequence(), WsfParseStringRule::WsfParseStringRule(), WsfParseTypeCommandRule::WsfParseTypeCommandRule(), and WsfParseTypeLoadRule::WsfParseTypeLoadRule().

◆ ~WsfParseRule()

virtual WsfParseRule::~WsfParseRule ( )
virtualdefault

◆ WsfParseRule() [2/2]

WsfParseRule::WsfParseRule ( const WsfParseRule & )
default

References WsfParseRule().

Member Function Documentation

◆ GetAlternates()

virtual std::vector< WsfParseRule * > WsfParseRule::GetAlternates ( )
inlinevirtual

Reimplemented in WsfParseAlternate.

Referenced by GetAllAlternates().

◆ GetBestContext()

WsfParseNamedRule * WsfParseRule::GetBestContext ( )

References cNAMED_RULE, cSTRUCT, cVALUE, mParentRulePtr, and mRuleType.

Referenced by WsfParseType::Print().

◆ GetContainingStruct()

WsfParseStruct * WsfParseRule::GetContainingStruct ( ) const

References cSTRUCT, GetContainingStruct(), GetContext(), mParentRulePtr, and Type().

Referenced by GetContainingStruct(), WsfParseNamedRule::GetFullName(), and GetStruct().

◆ GetContext()

virtual WsfParseNamedRule * WsfParseRule::GetContext ( ) const
inlinevirtual

Reimplemented in WsfParseNamedRule.

Referenced by GetContainingStruct().

◆ GetEntryType()

WsfParseNamedRule * WsfParseRule::GetEntryType ( )

References GetInputType(), and GetOutputType().

◆ GetInputType()

WsfParseNamedRule * WsfParseRule::GetInputType ( )

References IsNamedRule().

Referenced by GetEntryType().

◆ GetNestedRules()

virtual WsfParseRuleDictionary * WsfParseRule::GetNestedRules ( )
inlinevirtual

Reimplemented in WsfParseNamedRule.

Referenced by GetAllAlternates().

◆ GetOutputType()

WsfParseNamedRule * WsfParseRule::GetOutputType ( )

References IsNamedRule().

Referenced by GetEntryType().

◆ GetPassthrough()

virtual WsfParseRule * WsfParseRule::GetPassthrough ( )
inlinevirtual

Reimplemented in WsfParseNamedRule, WsfParsePassthrough, and WsfParseRuleReference.

References WsfParseRule().

Referenced by WsfPParseRuleTracer::BeginNode(), and WsfPProxySatisfy::GetRuleOutput().

◆ GetReaderFlags()

int WsfParseRule::GetReaderFlags ( ) const
inline

References mReaderFlags.

Referenced by WsfPParseRuleTracer::BeginNode(), wizard::AutoComplete::CollectSyntax(), wizard::AutoComplete::ExpandRule(), WsfPProxySatisfy::GetRuleOutput(), WsfParseSequence::Initialize(), WsfParseSequence::ResolveChildren(), and WsfParseSequence::UndoChildren().

◆ GetRuleDescription()

virtual std::string WsfParseRule::GetRuleDescription ( )
inlinevirtual

Reimplemented in WsfParseAlternate, WsfParseLiteral, WsfParseNamedRule, WsfParseRecurrence, WsfParseRuleReference, and WsfParseSequence.

Referenced by WsfParseNodePool::NewNode().

◆ GetSequence()

virtual std::vector< WsfParseRule * > WsfParseRule::GetSequence ( )
inlinevirtual

Reimplemented in WsfParseNamedRule, WsfParsePassthrough, WsfParseRecurrence, WsfParseRuleReference, and WsfParseSequence.

Referenced by GetAllAlternates().

◆ GetStruct()

WsfParseStruct * WsfParseRule::GetStruct ( )

References cSTRUCT, GetContainingStruct(), and mRuleType.

Referenced by WsfPProxyRegistry::BuildBasicRootFromBasicTypes().

◆ GetSubordinateRule()

WsfParseRule * WsfParseRule::GetSubordinateRule ( ) const
inline

References mSubordinateRulePtr, and WsfParseRule().

Referenced by wizard::AutoComplete::ExpandRule(), WsfParseRuleReference::GetPassthrough(), WsfParseRuleReference::GetRulePtr(), WsfParseRuleReference::GetSequence(), Initialize(), wizard::GrammarDocumentation::Process(), WsfPProxySatisfy::Satisfy(), WsfPProxySatisfy::SatisfyRecurrence(), and VerifyChild().

◆ GetType()

virtual WsfParseValueType * WsfParseRule::GetType ( )
inlinevirtual

If the rule is also a type, return the type.

Reimplemented in WsfParseStruct, and WsfParseValue.

◆ GetVarContext()

WsfParseNamedRule * WsfParseRule::GetVarContext ( )

References cNAMED_RULE, cSTRUCT, cVALUE, GetVarContext(), mParentRulePtr, and mRuleType.

Referenced by GetVarContext(), and WsfParseNamedRule::InitializeInputsOutputs().

◆ Initialize()

void WsfParseRule::Initialize ( int aSequence)
virtual

Reimplemented in WsfParseNamedRule, WsfParseRecurrence, WsfParseSequence, WsfParseStruct, and WsfParseValue.

References GetSubordinateRule(), IsNamedRule(), WsfParseNamedRule::mReferencingRules, and WsfParseRule().

Referenced by WsfParseNamedRule::Initialize(), WsfParseRecurrence::Initialize(), WsfParseSequence::Initialize(), WsfParseStruct::Initialize(), and WsfParseValue::Initialize().

◆ IsNamedRule()

bool WsfParseRule::IsNamedRule ( ) const
inline

References cNAMED_RULE, cSTRUCT, cVALUE, and mRuleType.

Referenced by GetInputType(), GetOutputType(), WsfPProxySatisfy::GetRuleOutput(), and Initialize().

◆ Read()

virtual bool WsfParseRule::Read ( WsfParser & aParser,
WsfParseNode *& aNode )
pure virtual

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.

Implemented in WsfParseAlternate, WsfParseDelimited, WsfParseIntRule, WsfParseLineStringRule, WsfParseLiteral, WsfParseNamedRule, WsfParsePassthrough, WsfParseQuotedStringRule, WsfParseRealRule, WsfParseRecurrence, WsfParseRuleReference, WsfParseScriptRule, WsfParseSequence, WsfParseStringRule, WsfParseStringWithExceptionsRule, WsfParseTypeCommandRule, and WsfParseTypeLoadRule.

Referenced by WsfParser::ParseFiles(), WsfParseAlternate::Read(), WsfParseSequence::Read(), and WsfParseTypeCommandRule::Read().

◆ ReadRange()

virtual bool WsfParseRule::ReadRange ( WsfParser & aParser,
UtTextDocumentRange & aRange,
WsfParseNode *& aNode,
bool aCreateNode )
inlinevirtual

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 in WsfParseAlternate, WsfParseDelimited, WsfParseIntRule, WsfParseLiteral, WsfParseNamedRule, WsfParsePassthrough, WsfParseRealRule, WsfParseRuleReference, WsfParseSequence, WsfParseStringRule, and WsfParseStringWithExceptionsRule.

◆ Resolve()

virtual void WsfParseRule::Resolve ( WsfParser & aParser,
WsfParseNode * aNodePtr )
inlinevirtual

Called by a command reader if the full command is successfully read. You must set cCAN_RESOLVE in the reader flags to receive this call.

Reimplemented in WsfParseTypeLoadRule.

Referenced by WsfParseSequence::ResolveChildren().

◆ SetSubordinateRule()

void WsfParseRule::SetSubordinateRule ( WsfParseRule * aRulePtr)
inline

References mSubordinateRulePtr, and WsfParseRule().

Referenced by WsfParseNamedRule::SetDefinition(), WsfParsePassthrough::SetPassthroughRule(), WsfParseRecurrence::SetRecurringRule(), WsfParseRuleReference::SetReferencedRule(), and WsfParseNamedRule::WsfParseNamedRule().

◆ Swap()

void WsfParseRule::Swap ( WsfParseRule & aRhs)
inline

References mParentRulePtr, mReaderFlags, mRuleType, mSubordinateRulePtr, mUserId, std::swap(), and WsfParseRule().

Referenced by std::swap().

◆ Type()

RuleType WsfParseRule::Type ( ) const
inline

Returns an enumeration specifying the derived type of the reader.

References mRuleType.

Referenced by WsfPProxyDeserializeContext::ApplyActions(), WsfPParseRuleTracer::BeginNode(), WsfParseSequence::CompleteDelayLoad(), wizard::WsfScriptContainer::CreateContext(), wizard::AutoComplete::ExpandRule(), WsfParseNamedRule::FindStruct(), WsfPProxyRegistry::FindStructs(), wizard::AutoComplete::FindSuggestionTerminator(), WsfParseNamedRule::FindValue(), WsfPProxySatisfy::FollowAction(), GetAllAlternates(), GetContainingStruct(), WsfParseNamedRule::GetRuleValue(), wizard::AutoComplete::GetSuggestions(), wizard::AutoComplete::GetSyntax(), WsfPProxyRegistry::GetType(), WsfParseNamedRule::Initialize(), WsfParseRecurrence::Initialize(), WsfParseSequence::Initialize(), wizard::GrammarDocumentation::Process(), WsfParseSequence::Read(), WsfParseAlternate::ReaderStartsWithChar(), WsfPProxySatisfy::Satisfy(), WsfPProxySatisfy::SatisfyTypeLoad(), VerifyChild(), and WsfProxy::Position::Write().

◆ Undo()

virtual void WsfParseRule::Undo ( WsfParser & aParser)
inlinevirtual

Called by a command reader if the reader just read in a value that has now been rejected due to a later failure. You must set cCAN_UNDO in the reader flags to receive this call.

Reimplemented in WsfParseTypeLoadRule.

Referenced by WsfParseSequence::UndoChildren().

Member Data Documentation

◆ mParentRulePtr

WsfParseRule* WsfParseRule::mParentRulePtr

Pointer to the parent rule. This should be valid for unnamed rules.

Referenced by WsfParseAlternate::AddAlternate(), WsfParseSequence::AddRule(), WsfParseSequence::CompleteDelayLoad(), GetBestContext(), GetContainingStruct(), WsfParseNode::GetTopLevelRule(), GetVarContext(), WsfParseRecurrence::Initialize(), WsfPProxySatisfy::SatisfyTypeLoad(), WsfParseNamedRule::SetDefinition(), Swap(), and WsfParseRule().

◆ mReaderFlags

int WsfParseRule::mReaderFlags

Referenced by GetReaderFlags(), WsfParseNamedRule::GetRuleValue(), WsfParseAlternate::Initialize(), WsfParseNamedRule::Initialize(), WsfParseSequence::Initialize(), WsfParseNamedRule::IsPartValueRule(), Swap(), WsfParseDelimited::WsfParseDelimited(), WsfParseIntRule::WsfParseIntRule(), WsfParseLiteral::WsfParseLiteral(), WsfParseNamedRule::WsfParseNamedRule(), WsfParseNamedRule::WsfParseNamedRule(), WsfParsePassthrough::WsfParsePassthrough(), WsfParseRealRule::WsfParseRealRule(), WsfParseRule(), WsfParseRuleReference::WsfParseRuleReference(), WsfParseStringRule::WsfParseStringRule(), and WsfParseTypeLoadRule::WsfParseTypeLoadRule().

◆ mRuleType

RuleType WsfParseRule::mRuleType

Referenced by GetBestContext(), GetStruct(), GetVarContext(), IsNamedRule(), Swap(), Type(), WsfParseEnumeration::WsfParseEnumeration(), WsfParseRule(), WsfParseStruct::WsfParseStruct(), and WsfParseValue::WsfParseValue().

◆ mSubordinateRulePtr

WsfParseRule* WsfParseRule::mSubordinateRulePtr
protected

Referenced by WsfParseNamedRule::GetDefinition(), WsfParseNamedRule::GetDefinition(), WsfParseNamedRule::GetPassthrough(), WsfParsePassthrough::GetPassthrough(), WsfParseRecurrence::GetRuleDescription(), WsfParseNamedRule::GetSequence(), WsfParsePassthrough::GetSequence(), WsfParseRecurrence::GetSequence(), GetSubordinateRule(), WsfParseNamedRule::Read(), WsfParsePassthrough::Read(), WsfParseRecurrence::Read(), WsfParseRuleReference::Read(), WsfParseNamedRule::ReadRange(), WsfParsePassthrough::ReadRange(), WsfParseRuleReference::ReadRange(), SetSubordinateRule(), Swap(), WsfParseNamedRule::WsfParseNamedRule(), and WsfParseRule().

◆ mUserId

int WsfParseRule::mUserId

Referenced by WsfParseRuleReference::SetReferencedRule(), Swap(), WsfProxy::Position::Write(), and WsfParseRule().

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