clang-tools
10.0.0
|
Collect declarations (symbols) from an AST. More...
#include <SymbolCollector.h>
Classes | |
struct | Options |
Public Member Functions | |
SymbolCollector (Options Opts) | |
void | initialize (ASTContext &Ctx) override |
void | setPreprocessor (std::shared_ptr< Preprocessor > PP) override |
bool | handleDeclOccurrence (const Decl *D, index::SymbolRoleSet Roles, ArrayRef< index::SymbolRelation > Relations, SourceLocation Loc, index::IndexDataConsumer::ASTNodeInfo ASTNode) override |
bool | handleMacroOccurrence (const IdentifierInfo *Name, const MacroInfo *MI, index::SymbolRoleSet Roles, SourceLocation Loc) override |
void | handleMacros (const MainFileMacros &MacroRefsToIndex) |
SymbolSlab | takeSymbols () |
RefSlab | takeRefs () |
RelationSlab | takeRelations () |
bool | shouldIndexFile (FileID FID) |
Returns true if we are interested in references and declarations from FID . More... | |
void | finish () override |
Static Public Member Functions | |
static bool | shouldCollectSymbol (const NamedDecl &ND, const ASTContext &ASTCtx, const Options &Opts, bool IsMainFileSymbol) |
Returns true is ND should be collected. More... | |
Collect declarations (symbols) from an AST.
It collects most declarations except:
References to main-file symbols are not collected.
See also shouldCollectSymbol(...).
Clients (e.g. clangd) can use SymbolCollector together with index::indexTopLevelDecls to retrieve all symbols when the source file is changed.
Definition at line 46 of file SymbolCollector.h.
clang::clangd::SymbolCollector::SymbolCollector | ( | Options | Opts | ) |
Definition at line 193 of file SymbolCollector.cpp.
|
override |
Definition at line 495 of file SymbolCollector.cpp.
Referenced by takeRelations().
|
override |
Definition at line 248 of file SymbolCollector.cpp.
Referenced by setPreprocessor().
|
override |
Definition at line 372 of file SymbolCollector.cpp.
Referenced by setPreprocessor().
void clang::clangd::SymbolCollector::handleMacros | ( | const MainFileMacros & | MacroRefsToIndex | ) |
Definition at line 349 of file SymbolCollector.cpp.
References clang::clangd::Position::character, clang::clangd::SymbolLocation::End, clang::clangd::Range::end, clang::clangd::SymbolLocation::FileURI, clang::clangd::RefSlab::Builder::insert(), clang::clangd::Ref::Kind, clang::clangd::Position::line, clang::clangd::Ref::Location, clang::clangd::MainFileMacros::MacroRefs, clang::clangd::Reference, clang::clangd::SymbolLocation::Position::setColumn(), clang::clangd::SymbolLocation::Position::setLine(), clang::clangd::SymbolLocation::Start, and clang::clangd::Range::start.
Referenced by setPreprocessor().
|
override |
Definition at line 195 of file SymbolCollector.cpp.
References Ctx.
|
inlineoverride |
Definition at line 98 of file SymbolCollector.h.
References Decl, handleDeclOccurrence(), handleMacroOccurrence(), handleMacros(), Loc, and Name.
|
static |
Returns true is ND
should be collected.
Definition at line 202 of file SymbolCollector.cpp.
References clang::clangd::SymbolCollector::Options::CollectMainFileSymbols, clang::clangd::Enum, and clang::clangd::Namespace.
Referenced by clang::clangd::getIndexableLocalDecls().
bool clang::clangd::SymbolCollector::shouldIndexFile | ( | FileID | FID | ) |
Returns true if we are interested in references and declarations from FID
.
If this function return false, bodies of functions inside those files will be skipped to decrease indexing time.
Definition at line 775 of file SymbolCollector.cpp.
Referenced by takeRelations().
|
inline |
Definition at line 115 of file SymbolCollector.h.
|
inline |
Definition at line 116 of file SymbolCollector.h.
References finish(), and shouldIndexFile().
|
inline |
Definition at line 114 of file SymbolCollector.h.