clang::clangd::SymbolCollector Class Reference

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

#include <SymbolCollector.h>

Inheritance diagram for clang::clangd::SymbolCollector:

Classes
class	HeaderFileURICache
struct	Options

Public Member Functions
	SymbolCollector (Options Opts)
	~SymbolCollector ()
void	initialize (ASTContext &Ctx) override
void	setPreprocessor (std::shared_ptr< Preprocessor > PP) override
void	setPreprocessor (Preprocessor &PP)
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.
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.
static const Decl *	getRefContainer (const Decl *Enclosing, const SymbolCollector::Options &Opts)

Detailed Description

Collect declarations (symbols) from an AST.

It collects most declarations except:

• Implicit declarations
• Anonymous declarations (anonymous enum/class/struct, etc)
• Declarations in anonymous namespaces in headers
• Local declarations (in function bodies, blocks, etc)
• Template specializations
• Library-specific private declarations (e.g. private declaration generated by protobuf compiler)

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 58 of file SymbolCollector.h.

Constructor & Destructor Documentation

SymbolCollector()

clang::clangd::SymbolCollector::SymbolCollector

(

Options

Opts

)

Definition at line 450 of file SymbolCollector.cpp.

~SymbolCollector()

clang::clangd::SymbolCollector::~SymbolCollector ( )

default

Member Function Documentation

finish()

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

override

Definition at line 858 of file SymbolCollector.cpp.

References clang::clangd::SymbolCollector::Options::CollectMacro, clang::clangd::SymbolSlab::Builder::erase(), clang::clangd::SymbolSlab::Builder::find(), clang::clangd::getStdHeader(), ID, clang::clangd::Symbol::Import, clang::clangd::Symbol::Include, clang::clangd::SymbolSlab::Builder::insert(), clang::clangd::Symbol::Invalid, and clang::clangd::References.

getRefContainer()

const Decl * clang::clangd::SymbolCollector::getRefContainer ( const Decl *  Enclosing, const SymbolCollector::Options &  Opts  )

static

Definition at line 518 of file SymbolCollector.cpp.

References shouldCollectSymbol().

Referenced by handleDeclOccurrence().

handleDeclOccurrence()

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

override

Definition at line 531 of file SymbolCollector.cpp.

References clang::clangd::SymbolCollector::Options::CollectMainFileRefs, clang::clangd::SymbolCollector::Options::CountReferences, clang::clangd::SymbolSlab::Builder::find(), getRefContainer(), ID, clang::clangd::isHeaderFile(), Loc, clang::clangd::SymbolCollector::Options::RefFilter, clang::clangd::SymbolCollector::Options::RefsInHeaders, and shouldCollectSymbol().

handleMacroOccurrence()

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

override

Definition at line 697 of file SymbolCollector.cpp.

References clang::clangd::SymbolCollector::Options::CollectMacro, clang::clangd::SymbolCollector::Options::CollectMainFileSymbols, clang::clangd::SymbolCollector::Options::CountReferences, clang::clangd::SymbolSlab::Builder::find(), clang::clangd::getSignature(), ID, clang::clangd::Symbol::IndexedForCodeCompletion, clang::clangd::SymbolSlab::Builder::insert(), clang::clangd::isHeaderFile(), Loc, Name, clang::clangd::SymbolCollector::Options::Origin, clang::clangd::SymbolCollector::Options::RefFilter, clang::clangd::SymbolCollector::Options::RefsInHeaders, shouldIndexFile(), Signature, SnippetSuffix, and clang::clangd::Symbol::VisibleOutsideFile.

handleMacros()

void clang::clangd::SymbolCollector::handleMacros

(

const MainFileMacros &

MacroRefsToIndex

)

Definition at line 653 of file SymbolCollector.cpp.

References clang::clangd::Position::character, clang::clangd::Definition, clang::clangd::SymbolLocation::End, clang::clangd::Range::end, clang::clangd::SymbolLocation::FileURI, clang::clangd::Symbol::IndexedForCodeCompletion, clang::clangd::SymbolSlab::Builder::insert(), clang::clangd::RefSlab::Builder::insert(), clang::clangd::Ref::Kind, clang::clangd::Position::line, clang::clangd::Ref::Location, clang::clangd::MainFileMacros::MacroRefs, clang::clangd::SymbolCollector::Options::Origin, clang::clangd::Reference, clang::clangd::SymbolLocation::Position::setColumn(), clang::clangd::SymbolLocation::Position::setLine(), clang::clangd::sourceLocationInMainFile(), clang::clangd::SymbolLocation::Start, clang::clangd::Range::start, clang::clangd::toSourceCode(), and clang::clangd::Symbol::VisibleOutsideFile.

initialize()

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

override

Definition at line 453 of file SymbolCollector.cpp.

setPreprocessor() [1/2]

void clang::clangd::SymbolCollector::setPreprocessor ( Preprocessor &  PP )

inline

Definition at line 136 of file SymbolCollector.h.

setPreprocessor() [2/2]

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

inlineoverride

Definition at line 133 of file SymbolCollector.h.

shouldCollectSymbol()

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

static

Returns true is ND should be collected.

Definition at line 462 of file SymbolCollector.cpp.

References clang::clangd::hasReservedName(), and clang::clangd::hasReservedScope().

Referenced by clang::clangd::getIndexableLocalDecls(), getRefContainer(), and handleDeclOccurrence().

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

References clang::clangd::SymbolCollector::Options::FileFilter.

Referenced by handleMacroOccurrence().

takeRefs()

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

inline

Definition at line 151 of file SymbolCollector.h.

takeRelations()

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

inline

Definition at line 152 of file SymbolCollector.h.

takeSymbols()

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

inline

Definition at line 150 of file SymbolCollector.h.

---

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

• SymbolCollector.h
• SymbolCollector.cpp