Qore astparser Module 2.0.0
Loading...
Searching...
No Matches
astparser::AstTreeSearcher Class Reference

AstParser class. More...

#include <QC_AstTreeSearcher.dox.h>

Public Member Methods

 constructor ()
 Creates the AstTreeSearcher.
 
*list findMatchingSymbols (astparser::AstTree tree, string uri, string query, bool exactMatch=False, bool fixSymbols=True, bool bareNames=False)
 Find matching symbols in a document.
 
*list findReferences (astparser::AstTree tree, string uri, int line, int col, bool includeDecl)
 Find symbol references.
 
*hash findSymbolInfo (astparser::AstTree tree, int line, int col)
 Find symbol info.
 
*list findSymbols (astparser::AstTree tree, string uri, bool fixSymbols=True, bool bareNames=False)
 Find all symbols in a document.
 
*hash hoverInfo (astparser::AstTree tree, int kind, int line, int col)
 Hover info.
 

Detailed Description

AstParser class.

Lorem ipsum dolor sit amet.

Since
Qore 0.8.13

Member Function Documentation

◆ findMatchingSymbols()

*list astparser::AstTreeSearcher::findMatchingSymbols ( astparser::AstTree  tree,
string  uri,
string  query,
bool  exactMatch = False,
bool  fixSymbols = True,
bool  bareNames = False 
)

Find matching symbols in a document.

Parameters
treeAST tree structure
uridocument's uri
querysearch query
exactMatchwhether to only find exact matches
fixSymbolswhether to fix symbol infos
bareNameswhether to return bare symbol names (without namespace and class prefixes)
Returns
list of symbols

◆ findReferences()

*list astparser::AstTreeSearcher::findReferences ( astparser::AstTree  tree,
string  uri,
int  line,
int  col,
bool  includeDecl 
)

Find symbol references.

Parameters
treeAST tree structure
uridocument's uri
lineline on which the symbol lies
colcolumn at which the symbol lies
includeDeclwhether to include a reference at the passed position
Returns
list of reference locations

◆ findSymbolInfo()

*hash astparser::AstTreeSearcher::findSymbolInfo ( astparser::AstTree  tree,
int  line,
int  col 
)

Find symbol info.

Parameters
treeAST tree structure
lineon what line lies the symbol we want to get info about
colon what column lies the symbol we want to get info about
Returns
hash with hover info

◆ findSymbols()

*list astparser::AstTreeSearcher::findSymbols ( astparser::AstTree  tree,
string  uri,
bool  fixSymbols = True,
bool  bareNames = False 
)

Find all symbols in a document.

Parameters
treeAST tree structure
uridocument's uri
fixSymbolswhether to fix symbol infos
bareNameswhether to return bare symbol names (without namespace and class prefixes)
Returns
list of symbols

◆ hoverInfo()

*hash astparser::AstTreeSearcher::hoverInfo ( astparser::AstTree  tree,
int  kind,
int  line,
int  col 
)

Hover info.

Parameters
treeAST tree structure
kindsymbol kind
lineon what line lies the symbol we want to get info about
colon what column lies the symbol we want to get info about
Returns
hash with hover info

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