clang-tools  11.0.0git
Classes | Public Member Functions | Static Public Member Functions | List of all members
clang::clangd::SymbolCollector Class Reference

Collect declarations (symbols) from an AST. More...

#include <SymbolCollector.h>

Inheritance diagram for clang::clangd::SymbolCollector:
Inheritance graph
Collaboration diagram for clang::clangd::SymbolCollector:
Collaboration graph


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...

Detailed Description

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.

Constructor & Destructor Documentation

◆ SymbolCollector()

clang::clangd::SymbolCollector::SymbolCollector ( Options  Opts)

Definition at line 191 of file SymbolCollector.cpp.

Member Function Documentation

◆ finish()

void clang::clangd::SymbolCollector::finish ( )

Definition at line 494 of file SymbolCollector.cpp.

Referenced by takeRelations().

◆ handleDeclOccurrence()

bool clang::clangd::SymbolCollector::handleDeclOccurrence ( const Decl D,
index::SymbolRoleSet  Roles,
ArrayRef< index::SymbolRelation >  Relations,
SourceLocation  Loc,
index::IndexDataConsumer::ASTNodeInfo  ASTNode 

Definition at line 246 of file SymbolCollector.cpp.

Referenced by setPreprocessor().

◆ handleMacroOccurrence()

bool clang::clangd::SymbolCollector::handleMacroOccurrence ( const IdentifierInfo *  Name,
const MacroInfo *  MI,
index::SymbolRoleSet  Roles,
SourceLocation  Loc 

Definition at line 371 of file SymbolCollector.cpp.

Referenced by setPreprocessor().

◆ handleMacros()

void clang::clangd::SymbolCollector::handleMacros ( const MainFileMacros MacroRefsToIndex)

◆ initialize()

void clang::clangd::SymbolCollector::initialize ( ASTContext &  Ctx)

Definition at line 193 of file SymbolCollector.cpp.

References Ctx.

◆ setPreprocessor()

void clang::clangd::SymbolCollector::setPreprocessor ( std::shared_ptr< Preprocessor >  PP)

◆ shouldCollectSymbol()

bool clang::clangd::SymbolCollector::shouldCollectSymbol ( const NamedDecl &  ND,
const ASTContext &  ASTCtx,
const Options Opts,
bool  IsMainFileSymbol 

◆ shouldIndexFile()

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 796 of file SymbolCollector.cpp.

Referenced by takeRelations().

◆ takeRefs()

RefSlab clang::clangd::SymbolCollector::takeRefs ( )

Definition at line 115 of file SymbolCollector.h.

◆ takeRelations()

RelationSlab clang::clangd::SymbolCollector::takeRelations ( )

Definition at line 116 of file SymbolCollector.h.

References finish(), and shouldIndexFile().

◆ takeSymbols()

SymbolSlab clang::clangd::SymbolCollector::takeSymbols ( )

Definition at line 114 of file SymbolCollector.h.

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