wizard::AutoComplete Class Reference

#include <AutoComplete.hpp>

Collaboration diagram for wizard::AutoComplete:

Classes
struct	Results
struct	SyntaxResults
struct	Entry
struct	Query

Public Types
using	Syntax = std::vector<std::string>
using	SyntaxList = std::vector<Syntax>

Public Member Functions
	AutoComplete ()
void	GetSuggestions (ParseResults &aParseData, TextSource &aSource, WsfParseNode *aNodePtr, const std::string &aText, size_t aInsertPosition, Results &aResults)
void	GetSyntax (ParseResults &aParseData, TextSource &aSource, WsfParseNode *aNodePtr, const std::string &aText, size_t aInsertPosition, SyntaxResults &aResults)

Protected Types
enum	Operation { cAUTOCOMPLETE , cSYNTAX }

Protected Member Functions
SyntaxList	CollectSyntax (Entry *aEntryTreePtr, bool aFirstWord=true)
SyntaxList	JoinSyntax (const SyntaxList &aLhs, const SyntaxList &aRhs)
void	GetIncludeSuggestions (const std::string &aText, TextSource &aSource, ParseResults &aParseData, Results &aResults)
bool	FullyExpandWord (size_t aWordIndex) const
void	DigestInput (const std::string &aText, size_t aInputPosition, size_t &aReplaceCharacters, size_t &aInsertPosition)
int	ExpandTree (Entry &aEntry, const WsfParseType *aCurrentTypePtr, int aWordIndex, int aMaxWordIndex)
bool	TextMatches (const std::string &aText, size_t aWordIndex)
bool	TextMatches (const std::string &aText, const std::string &aQuery)
WsfParseNode *	FindBlock (WsfParseNode *aNodePtr, int aInsertPosition)
bool	ExpandRule (int aWordIndex, WsfParseRule *aReaderPtr, const WsfParseType *aCurrentTypePtr, Entry &aEntry, bool aExpandBlock=false)
void	ExpandRefType (Entry &aEntry, const WsfParseType *aCurrentTypePtr, int aWordIndex)
void	Prune (int aQueryWordIndex, Entry *&aEntry)
void	CollectSuggestions (Entry *aRootEntry, size_t aWordIndex, std::vector< std::string > &aSuggestions, bool &aLastToken)
bool	FindSuggestionTerminator (Entry *aEntryWord, std::string &aTerminatorToken)
WsfParseNode *	FindNextBlock (WsfParseNode *aBlockPtr)
int	CountSuggestions (Entry *aRootEntry)
const WsfParseType *	FindCurrentType (WsfParseNode *aNodePtr)

Protected Attributes
bool	mExpanded
ParseResults *	mParseResultsPtr
const WsfParseType *	mCurrentTypeRef
bool	mExpandTypeCommand
Query	mCurrentQuery

Detailed Description

Computes suggestions for the auto-complete popup The algorithm is as follows: Given a starting containing block node B (may be null) and given a starting insert position P:

1. Combine all words, W, from P to either start of line, or end of previously parsed node.
2. Grab rule, R, used to create nodes for block B (or root rule if B is null)
3. Recursively expand and prune the tree of rules beginning at R with all possible following words for words 1..N where N is the number of words in W. While pruning words that do not match W.
4. Return the list of valid words for the last word in W.

This words in most cases, but there are a few problems:

• Extending valid commands:

  processor <internal-link> (implicit mover command)
  processor <name> <type> ... end_processor (platform command)
  

  matches:
  

  processor myproc WSF_| ('processor myproc' matches the first rule, leaving us to autocomplete only on WSF_)
  end_time 1 m| ('end_time 1 m' matches a rule, leaving no way to autocomplete for 'minutes')

Member Typedef Documentation

Syntax

using wizard::AutoComplete::Syntax = std::vector<std::string>

SyntaxList

using wizard::AutoComplete::SyntaxList = std::vector<Syntax>

Member Enumeration Documentation

Operation

enum wizard::AutoComplete::Operation

protected

Enumerator
cAUTOCOMPLETE
cSYNTAX

Constructor & Destructor Documentation

AutoComplete()

wizard::AutoComplete::AutoComplete

(

)

References mCurrentQuery, mCurrentTypeRef, mExpanded, mExpandTypeCommand, and mParseResultsPtr.

Member Function Documentation

CollectSuggestions()

void wizard::AutoComplete::CollectSuggestions ( Entry * aRootEntry, size_t aWordIndex, std::vector< std::string > & aSuggestions, bool & aLastToken )

protected

References wizard::AutoComplete::Entry::cALTERNATE, wizard::AutoComplete::Entry::cBLOCK_PLACEHOLDER, CollectSuggestions(), wizard::AutoComplete::Entry::cSEQUENCE, wizard::AutoComplete::Entry::cUNEXPANDED, wizard::AutoComplete::Entry::cWORD, FindSuggestionTerminator(), wizard::AutoComplete::Entry::mChildren, wizard::AutoComplete::Entry::mEntryType, wizard::AutoComplete::Entry::mFlags, wizard::AutoComplete::Entry::mWordIsPattern, and wizard::AutoComplete::Entry::mWordText.

Referenced by CollectSuggestions(), and GetSuggestions().

CollectSyntax()

wizard::AutoComplete::SyntaxList wizard::AutoComplete::CollectSyntax ( Entry * aEntryTreePtr, bool aFirstWord = true )

protected

References wizard::AutoComplete::Entry::cALTERNATE, WsfParseRule::cIS_SINGLE_TOKEN, CollectSyntax(), wizard::AutoComplete::Entry::cSEQUENCE, wizard::AutoComplete::Entry::cWORD, WsfParseRule::GetReaderFlags(), JoinSyntax(), wizard::AutoComplete::Entry::mChildren, wizard::AutoComplete::Entry::mEntryType, wizard::AutoComplete::Entry::mReaderPtr, wizard::AutoComplete::Entry::mRuleName, wizard::AutoComplete::Entry::mWordText, and std::swap().

Referenced by CollectSyntax(), and GetSyntax().

CountSuggestions()

int wizard::AutoComplete::CountSuggestions ( Entry * aRootEntry )

protected

References wizard::AutoComplete::Entry::cALTERNATE, CountSuggestions(), wizard::AutoComplete::Entry::cSEQUENCE, wizard::AutoComplete::Entry::cWORD, wizard::AutoComplete::Entry::mChildren, and wizard::AutoComplete::Entry::mEntryType.

Referenced by CountSuggestions().

DigestInput()

void wizard::AutoComplete::DigestInput ( const std::string & aText, size_t aInputPosition, size_t & aReplaceCharacters, size_t & aInsertPosition )

protected

References cAUTOCOMPLETE, and mCurrentQuery.

Referenced by GetSuggestions(), and GetSyntax().

ExpandRefType()

void wizard::AutoComplete::ExpandRefType ( Entry & aEntry, const WsfParseType * aCurrentTypePtr, int aWordIndex )

protected

References wizard::AutoComplete::Entry::cALTERNATE, wizard::AutoComplete::Entry::cNAMED_WORD, wizard::AutoComplete::Entry::cTYPE_REF_WORD, WsfParseType::GetAncestry(), wizard::AutoComplete::Entry::mChildren, wizard::AutoComplete::Entry::mEntryType, mExpanded, wizard::AutoComplete::Entry::mFlags, wizard::AutoComplete::Entry::mNestedLookup, mParseResultsPtr, wizard::AutoComplete::Entry::mRefType, wizard::AutoComplete::Entry::mWordText, wizard::AutoComplete::Entry::Set(), std::swap(), and wizSignals.

Referenced by ExpandTree().

ExpandRule()

bool wizard::AutoComplete::ExpandRule ( int aWordIndex, WsfParseRule * aReaderPtr, const WsfParseType * aCurrentTypePtr, Entry & aEntry, bool aExpandBlock = false )

protected

References wizard::AutoComplete::Entry::cALTERNATE, WsfParseRule::cALTERNATE, wizard::AutoComplete::Entry::cBLOCK_PLACEHOLDER, WsfParseRule::cDELIMITED, WsfParseNode::cERROR_INCOMPLETE, WsfParseRule::cINT, WsfParseRule::cIS_SINGLE_TOKEN, WsfParseNode::cLAZY_TYPE_REFERENCE_NODE, WsfParseNode::cLAZY_TYPENAME_NODE, WsfParseRule::cLINE_STRING, WsfParseRule::cLITERAL, WsfParseTypeInfoData::cLOAD_TYPE, WsfParseNode::cNAMED_NODE, WsfParseRule::cNAMED_RULE, wizard::AutoComplete::Entry::cNAMED_WORD, WsfParseRule::cQUOTED_STRING, WsfParseRule::cREAL, WsfParseRule::cRECURRENCE, WsfParseRule::cRULE_REFERENCE, wizard::AutoComplete::Entry::cSEQUENCE, WsfParseRule::cSEQUENCE, WsfParseRule::cSTRING, WsfParseRule::cSTRUCT, wizard::AutoComplete::Entry::cTYPE_CHANGE, WsfParseRule::cTYPE_COMMAND, WsfParseRule::cTYPE_LOAD, wizard::AutoComplete::Entry::cTYPE_REF_WORD, wizard::AutoComplete::Entry::cUNEXPANDED, WsfParseRule::cVALUE, ExpandRule(), WsfParseType::FindNestedSymbol(), WsfParseNamedRule::GetDefinition(), WsfParseTypeLoadRule::GetLoadType(), WsfParseTypeLoadRule::GetOperation(), WsfParseRule::GetReaderFlags(), WsfParseAlternate::GetReaders(), WsfParseType::GetRule(), WsfParseRuleReference::GetRulePtr(), WsfParseRule::GetSubordinateRule(), wizard::AutoComplete::Entry::mChildren, wizard::AutoComplete::Entry::mCommandWordIndex, wizard::AutoComplete::Entry::mComplete, wizard::AutoComplete::Entry::mCurrentTypeChangePtr, wizard::AutoComplete::Entry::mEntryType, mExpandTypeCommand, wizard::AutoComplete::Entry::mFlags, WsfParseStringRule::mFlags, WsfParseTypeLoadRule::mLoadType, WsfParseTypeName::mNestedLookup, WsfParseSequence::mNodeFlags, WsfParseStringRule::mNodeType, WsfParseTypeName::mOrdinal, wizard::AutoComplete::Entry::mParentCommandPtr, WsfParseTypeName::mPath, wizard::AutoComplete::Entry::mReaderPtr, wizard::AutoComplete::Entry::mRefType, wizard::AutoComplete::Entry::mRuleName, WsfParseLiteral::mText, wizard::AutoComplete::Entry::mWordCount, wizard::AutoComplete::Entry::mWordIsPattern, wizard::AutoComplete::Entry::mWordText, ok, WsfParseSequence::Sequence(), wizard::AutoComplete::Entry::Set(), wizard::AutoComplete::Entry::SetNameRef(), wizard::AutoComplete::Entry::SetTypeRef(), and WsfParseRule::Type().

Referenced by ExpandRule(), ExpandTree(), GetSuggestions(), and GetSyntax().

ExpandTree()

int wizard::AutoComplete::ExpandTree ( Entry & aEntry, const WsfParseType * aCurrentTypePtr, int aWordIndex, int aMaxWordIndex )

protected

References wizard::AutoComplete::Entry::cALTERNATE, wizard::AutoComplete::Entry::cSEQUENCE, wizard::AutoComplete::Entry::cTYPE_CHANGE, wizard::AutoComplete::Entry::cUNEXPANDED, wizard::AutoComplete::Entry::cWORD, ExpandRefType(), ExpandRule(), ExpandTree(), FullyExpandWord(), wizard::AutoComplete::Entry::GetWordCount(), wizard::AutoComplete::Entry::mChildren, wizard::AutoComplete::Entry::mComplete, wizard::AutoComplete::Entry::mCurrentTypeChangePtr, wizard::AutoComplete::Entry::mEntryType, mExpanded, wizard::AutoComplete::Entry::mReaderPtr, wizard::AutoComplete::Entry::mRefType, wizard::AutoComplete::Entry::mWordCount, and std::swap().

Referenced by ExpandTree(), GetSuggestions(), and GetSyntax().

FindBlock()

WsfParseNode * wizard::AutoComplete::FindBlock ( WsfParseNode * aNodePtr, int aInsertPosition )

protected

References WsfParseNode::FindChildByType(), WsfParseNode::GetBoundingRange(), WsfParseNode::GetParent(), WsfParseNode::mType, WsfParseNode::mValue, and pos.

FindCurrentType()

const WsfParseType * wizard::AutoComplete::FindCurrentType ( WsfParseNode * aNodePtr )

protected

References WsfParseNode::cLOAD_TYPE_NODE, WsfParseTypeInfoData::cNESTED_LOAD, WsfParseTypeInfoData::cNESTED_SAVE, WsfParseType::FindType(), WsfParseNode::GetAuxiliaryValue(), WsfParseNode::GetParent(), WsfParseNode::Left(), WsfParseNode::mFlags, WsfParseTypeInfoData::mFlags, WsfParseTypeInfoData::mLoadKey, mParseResultsPtr, and WsfParseTypeInfoData::mSaveKey.

Referenced by GetSuggestions(), and GetSyntax().

FindNextBlock()

WsfParseNode * wizard::AutoComplete::FindNextBlock ( WsfParseNode * aBlockPtr )

protected

References WsfParseNode::cBLOCK_NODE, WsfParseNode::GetParent(), and WsfParseNode::mFlags.

Referenced by GetSuggestions(), and GetSyntax().

FindSuggestionTerminator()

bool wizard::AutoComplete::FindSuggestionTerminator ( Entry * aEntryWord, std::string & aTerminatorToken )

protected

Attempt to find a terminator for a command. For example, given the rule: platform <name> <type> <BLOCK> end_platform
Input: plat| Suggestion-> platform...end_platform

References WsfParseRule::cRECURRENCE, wizard::AutoComplete::Entry::mCommandWordIndex, WsfParseRecurrence::mEndKeyword, wizard::AutoComplete::Entry::mParentCommandPtr, WsfParseSequence::Sequence(), and WsfParseRule::Type().

Referenced by CollectSuggestions().

FullyExpandWord()

bool wizard::AutoComplete::FullyExpandWord ( size_t aWordIndex ) const

protected

References cAUTOCOMPLETE, and mCurrentQuery.

Referenced by ExpandTree().

GetIncludeSuggestions()

void wizard::AutoComplete::GetIncludeSuggestions ( const std::string & aText, TextSource & aSource, ParseResults & aParseData, Results & aResults )

protected

References mParseResultsPtr, wizard::AutoComplete::Results::mPartialToken, wizard::ParseResultsTiny::mProjectPtr, wizard::AutoComplete::Results::mSuggestionList, and wizard::Project::WorkingDirectory().

Referenced by GetSuggestions().

GetSuggestions()

void wizard::AutoComplete::GetSuggestions	(	ParseResults &	aParseData,
		TextSource &	aSource,
		WsfParseNode *	aNodePtr,
		const std::string &	aText,
		size_t	aInsertPosition,
		Results &	aResults )

References wizard::AutoComplete::Entry::cALTERNATE, cAUTOCOMPLETE, CollectSuggestions(), WsfParseRule::cRECURRENCE, DigestInput(), ExpandRule(), ExpandTree(), FindCurrentType(), FindNextBlock(), WsfParser::GetDefinitions(), GetIncludeSuggestions(), WsfParseDefinitions::GetRoot(), wizard::AutoComplete::Entry::mChildren, mCurrentQuery, mCurrentTypeRef, wizard::AutoComplete::Entry::mEntryType, mExpanded, wizard::AutoComplete::Results::mInsertPosition, wizard::AutoComplete::Results::mLastToken, mParseResultsPtr, wizard::AutoComplete::Results::mPartialToken, wizard::AutoComplete::Results::mReplaceCharacters, WsfParseNode::mRulePtr, wizard::AutoComplete::Results::mSuggestionList, wizard::ParseResults::parser(), Prune(), and WsfParseRule::Type().

GetSyntax()

void wizard::AutoComplete::GetSyntax	(	ParseResults &	aParseData,
		TextSource &	aSource,
		WsfParseNode *	aNodePtr,
		const std::string &	aText,
		size_t	aInsertPosition,
		SyntaxResults &	aResults )

References wizard::AutoComplete::Entry::cALTERNATE, CollectSyntax(), WsfParseRule::cRECURRENCE, cSYNTAX, DigestInput(), ExpandRule(), ExpandTree(), FindCurrentType(), FindNextBlock(), WsfParser::GetDefinitions(), WsfParseDefinitions::GetRoot(), wizard::AutoComplete::Entry::mChildren, wizard::AutoComplete::SyntaxResults::mConcreteWordCount, mCurrentQuery, mCurrentTypeRef, wizard::AutoComplete::Entry::mEntryType, mExpanded, mParseResultsPtr, WsfParseNode::mRulePtr, wizard::AutoComplete::SyntaxResults::mSequences, wizard::AutoComplete::SyntaxResults::mWordIndex, wizard::ParseResults::parser(), Prune(), and WsfParseRule::Type().

Referenced by wizard::SyntaxTips::UpdateSuggestions().

JoinSyntax()

wizard::AutoComplete::SyntaxList wizard::AutoComplete::JoinSyntax ( const SyntaxList & aLhs, const SyntaxList & aRhs )

protected

Referenced by CollectSyntax().

Prune()

void wizard::AutoComplete::Prune ( int aQueryWordIndex, Entry *& aEntry )

protected

References wizard::AutoComplete::Entry::cALTERNATE, wizard::AutoComplete::Entry::cNONE, wizard::AutoComplete::Entry::cSEQUENCE, wizard::AutoComplete::Entry::cUNEXPANDED, wizard::AutoComplete::Entry::cWORD, wizard::AutoComplete::Entry::mChildren, mCurrentQuery, wizard::AutoComplete::Entry::mEntryType, wizard::AutoComplete::Entry::mWordIsPattern, wizard::AutoComplete::Entry::mWordText, Prune(), and TextMatches().

Referenced by GetSuggestions(), GetSyntax(), and Prune().

TextMatches() [1/2]

bool wizard::AutoComplete::TextMatches ( const std::string & aText, const std::string & aQuery )

protected

TextMatches() [2/2]

bool wizard::AutoComplete::TextMatches ( const std::string & aText, size_t aWordIndex )

protected

References mCurrentQuery, and TextMatches().

Referenced by Prune(), and TextMatches().

Member Data Documentation

mCurrentQuery

Query wizard::AutoComplete::mCurrentQuery

protected

Referenced by AutoComplete(), DigestInput(), FullyExpandWord(), GetSuggestions(), GetSyntax(), Prune(), and TextMatches().

mCurrentTypeRef

const WsfParseType* wizard::AutoComplete::mCurrentTypeRef

protected

Referenced by AutoComplete(), GetSuggestions(), and GetSyntax().

mExpanded

bool wizard::AutoComplete::mExpanded

protected

Referenced by AutoComplete(), ExpandRefType(), ExpandTree(), GetSuggestions(), and GetSyntax().

mExpandTypeCommand

bool wizard::AutoComplete::mExpandTypeCommand

protected

Referenced by AutoComplete(), and ExpandRule().

mParseResultsPtr

ParseResults* wizard::AutoComplete::mParseResultsPtr

protected

Referenced by AutoComplete(), ExpandRefType(), FindCurrentType(), GetIncludeSuggestions(), GetSuggestions(), and GetSyntax().

---

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

• AutoComplete.hpp
• AutoComplete.cpp