diff options
Diffstat (limited to 'clang-tools-extra/clangd')
| -rw-r--r-- | clang-tools-extra/clangd/index/FileIndex.cpp | 5 | ||||
| -rw-r--r-- | clang-tools-extra/clangd/index/SymbolCollector.cpp | 39 | ||||
| -rw-r--r-- | clang-tools-extra/clangd/index/SymbolCollector.h | 9 |
3 files changed, 32 insertions, 21 deletions
diff --git a/clang-tools-extra/clangd/index/FileIndex.cpp b/clang-tools-extra/clangd/index/FileIndex.cpp index 8a8d179557a..4f1f10a44c0 100644 --- a/clang-tools-extra/clangd/index/FileIndex.cpp +++ b/clang-tools-extra/clangd/index/FileIndex.cpp @@ -20,11 +20,6 @@ std::unique_ptr<SymbolSlab> indexAST(ASTContext &Ctx, std::shared_ptr<Preprocessor> PP, llvm::ArrayRef<const Decl *> Decls) { SymbolCollector::Options CollectorOpts; - // Although we do not index symbols in main files (e.g. cpp file), information - // in main files like definition locations of class declarations will still be - // collected; thus, the index works for go-to-definition. - // FIXME(ioeric): get rid of `IndexMainFiles` as this is always set to false. - CollectorOpts.IndexMainFiles = false; // FIXME(ioeric): we might also want to collect include headers. We would need // to make sure all includes are canonicalized (with CanonicalIncludes), which // is not trivial given the current way of collecting symbols: we only have diff --git a/clang-tools-extra/clangd/index/SymbolCollector.cpp b/clang-tools-extra/clangd/index/SymbolCollector.cpp index f8fb2c29570..c75184010ee 100644 --- a/clang-tools-extra/clangd/index/SymbolCollector.cpp +++ b/clang-tools-extra/clangd/index/SymbolCollector.cpp @@ -115,9 +115,7 @@ bool shouldFilterDecl(const NamedDecl *ND, ASTContext *ASTCtx, // * enum constants in unscoped enum decl (e.g. "red" in "enum {red};") auto InTopLevelScope = hasDeclContext( anyOf(namespaceDecl(), translationUnitDecl(), linkageSpecDecl())); - if (match(decl(allOf(Opts.IndexMainFiles - ? decl() - : decl(unless(isExpansionInMainFile())), + if (match(decl(allOf(unless(isExpansionInMainFile()), anyOf(InTopLevelScope, hasDeclContext(enumDecl(InTopLevelScope, unless(isScoped())))))), @@ -177,11 +175,9 @@ getIncludeHeader(const SourceManager &SM, SourceLocation Loc, // For symbols defined inside macros: // * use expansion location, if the symbol is formed via macro concatenation. // * use spelling location, otherwise. -llvm::Optional<SymbolLocation> -getSymbolLocation(const NamedDecl &D, SourceManager &SM, - const SymbolCollector::Options &Opts, - const clang::LangOptions& LangOpts, - std::string &FileURIStorage) { +llvm::Optional<SymbolLocation> getSymbolLocation( + const NamedDecl &D, SourceManager &SM, const SymbolCollector::Options &Opts, + const clang::LangOptions &LangOpts, std::string &FileURIStorage) { SourceLocation SpellingLoc = SM.getSpellingLoc(D.getLocation()); if (D.getLocation().isMacroID()) { std::string PrintLoc = SpellingLoc.printToString(SM); @@ -209,6 +205,19 @@ getSymbolLocation(const NamedDecl &D, SourceManager &SM, return std::move(Result); } +// Checks whether \p ND is a definition of a TagDecl (class/struct/enum/union) +// in a header file, in which case clangd would prefer to use ND as a canonical +// declaration. +// FIXME: handle symbol types that are not TagDecl (e.g. functions), if using +// the the first seen declaration as canonical declaration is not a good enough +// heuristic. +bool isPreferredDeclaration(const NamedDecl &ND, index::SymbolRoleSet Roles) { + using namespace clang::ast_matchers; + return (Roles & static_cast<unsigned>(index::SymbolRole::Definition)) && + llvm::isa<TagDecl>(&ND) && + match(decl(isExpansionInMainFile()), ND, ND.getASTContext()).empty(); +} + } // namespace SymbolCollector::SymbolCollector(Options Opts) : Opts(std::move(Opts)) {} @@ -241,12 +250,20 @@ bool SymbolCollector::handleDeclOccurence( if (index::generateUSRForDecl(ND, USR)) return true; + const NamedDecl &OriginalDecl = *cast<NamedDecl>(ASTNode.OrigD); auto ID = SymbolID(USR); - const Symbol* BasicSymbol = Symbols.find(ID); + const Symbol *BasicSymbol = Symbols.find(ID); if (!BasicSymbol) // Regardless of role, ND is the canonical declaration. BasicSymbol = addDeclaration(*ND, std::move(ID)); + else if (isPreferredDeclaration(OriginalDecl, Roles)) + // If OriginalDecl is preferred, replace the existing canonical + // declaration (e.g. a class forward declaration). There should be at most + // one duplicate as we expect to see only one preferred declaration per + // TU, because in practice they are definitions. + BasicSymbol = addDeclaration(OriginalDecl, std::move(ID)); + if (Roles & static_cast<unsigned>(index::SymbolRole::Definition)) - addDefinition(*cast<NamedDecl>(ASTNode.OrigD), *BasicSymbol); + addDefinition(OriginalDecl, *BasicSymbol); } return true; } @@ -271,8 +288,6 @@ const Symbol *SymbolCollector::addDeclaration(const NamedDecl &ND, std::tie(S.Scope, S.Name) = splitQualifiedName(QName); S.SymInfo = index::getSymbolInfo(&ND); std::string FileURI; - // FIXME: we may want a different "canonical" heuristic than clang chooses. - // Clang seems to choose the first, which may not have the most information. if (auto DeclLoc = getSymbolLocation(ND, SM, Opts, ASTCtx->getLangOpts(), FileURI)) S.CanonicalDeclaration = *DeclLoc; diff --git a/clang-tools-extra/clangd/index/SymbolCollector.h b/clang-tools-extra/clangd/index/SymbolCollector.h index a39c70779bd..c18f74a8362 100644 --- a/clang-tools-extra/clangd/index/SymbolCollector.h +++ b/clang-tools-extra/clangd/index/SymbolCollector.h @@ -20,7 +20,11 @@ namespace clangd { /// \brief Collect top-level symbols from an AST. These are symbols defined /// immediately inside a namespace or a translation unit scope. For example, -/// symbols in classes or functions are not collected. +/// symbols in classes or functions are not collected. Note that this only +/// collects symbols that declared in at least one file that is not a main +/// file (i.e. the source file corresponding to a TU). These are symbols that +/// can be imported by other files by including the file where symbols are +/// declared. /// /// Clients (e.g. clangd) can use SymbolCollector together with /// index::indexTopLevelDecls to retrieve all symbols when the source file is @@ -28,9 +32,6 @@ namespace clangd { class SymbolCollector : public index::IndexDataConsumer { public: struct Options { - /// Whether to collect symbols in main files (e.g. the source file - /// corresponding to a TU). - bool IndexMainFiles = false; /// When symbol paths cannot be resolved to absolute paths (e.g. files in /// VFS that does not have absolute path), combine the fallback directory /// with symbols' paths to get absolute paths. This must be an absolute |
