https://github.com/HighCommander4 updated https://github.com/llvm/llvm-project/pull/133681
>From 451a88947bda87daa5934cc5c2d55f9e57a5cfda Mon Sep 17 00:00:00 2001 From: Nathan Ridge <zeratul...@hotmail.com> Date: Mon, 31 Mar 2025 02:25:45 -0400 Subject: [PATCH] [clangd] Store documentation when indexing standard library Fixes https://github.com/clangd/clangd/issues/2344 --- clang-tools-extra/clangd/ClangdServer.h | 3 ++ clang-tools-extra/clangd/index/FileIndex.cpp | 21 ++++++----- clang-tools-extra/clangd/index/FileIndex.h | 3 +- clang-tools-extra/clangd/index/StdLib.cpp | 37 +++++++++---------- .../clangd/unittests/StdLibTests.cpp | 37 +++++++++++++++++++ clang-tools-extra/clangd/unittests/TestTU.cpp | 3 +- 6 files changed, 73 insertions(+), 31 deletions(-) diff --git a/clang-tools-extra/clangd/ClangdServer.h b/clang-tools-extra/clangd/ClangdServer.h index 1e612e2ba618e..4a149688fa494 100644 --- a/clang-tools-extra/clangd/ClangdServer.h +++ b/clang-tools-extra/clangd/ClangdServer.h @@ -466,6 +466,9 @@ class ClangdServer { [[nodiscard]] bool blockUntilIdleForTest(std::optional<double> TimeoutSeconds = 10); + // Expose the (combined) index for test use. + const SymbolIndex *getIndexForTest() { return Index; } + /// Builds a nested representation of memory used by components. void profile(MemoryTree &MT) const; diff --git a/clang-tools-extra/clangd/index/FileIndex.cpp b/clang-tools-extra/clangd/index/FileIndex.cpp index aa573e312a756..de88edd0c7a0b 100644 --- a/clang-tools-extra/clangd/index/FileIndex.cpp +++ b/clang-tools-extra/clangd/index/FileIndex.cpp @@ -48,13 +48,12 @@ SlabTuple indexSymbols(ASTContext &AST, Preprocessor &PP, const MainFileMacros *MacroRefsToIndex, const include_cleaner::PragmaIncludes &PI, bool IsIndexMainAST, llvm::StringRef Version, - bool CollectMainFileRefs) { + bool CollectMainFileRefs, SymbolOrigin Origin) { SymbolCollector::Options CollectorOpts; CollectorOpts.CollectIncludePath = true; CollectorOpts.PragmaIncludes = &PI; CollectorOpts.CountReferences = false; - CollectorOpts.Origin = - IsIndexMainAST ? SymbolOrigin::Open : SymbolOrigin::Preamble; + CollectorOpts.Origin = Origin; CollectorOpts.CollectMainFileRefs = CollectMainFileRefs; // We want stdlib implementation details in the index only if we've opened the // file in question. This does means xrefs won't work, though. @@ -221,22 +220,24 @@ FileShardedIndex::getShard(llvm::StringRef Uri) const { } SlabTuple indexMainDecls(ParsedAST &AST) { - return indexSymbols( - AST.getASTContext(), AST.getPreprocessor(), AST.getLocalTopLevelDecls(), - &AST.getMacros(), AST.getPragmaIncludes(), - /*IsIndexMainAST=*/true, AST.version(), /*CollectMainFileRefs=*/true); + return indexSymbols(AST.getASTContext(), AST.getPreprocessor(), + AST.getLocalTopLevelDecls(), &AST.getMacros(), + AST.getPragmaIncludes(), + /*IsIndexMainAST=*/true, AST.version(), + /*CollectMainFileRefs=*/true, SymbolOrigin::Open); } SlabTuple indexHeaderSymbols(llvm::StringRef Version, ASTContext &AST, Preprocessor &PP, - const include_cleaner::PragmaIncludes &PI) { + const include_cleaner::PragmaIncludes &PI, + SymbolOrigin Origin) { std::vector<Decl *> DeclsToIndex( AST.getTranslationUnitDecl()->decls().begin(), AST.getTranslationUnitDecl()->decls().end()); return indexSymbols(AST, PP, DeclsToIndex, /*MainFileMacros=*/nullptr, PI, /*IsIndexMainAST=*/false, Version, - /*CollectMainFileRefs=*/false); + /*CollectMainFileRefs=*/false, Origin); } FileSymbols::FileSymbols(IndexContents IdxContents, bool SupportContainedRefs) @@ -463,7 +464,7 @@ void FileIndex::updatePreamble(PathRef Path, llvm::StringRef Version, const include_cleaner::PragmaIncludes &PI) { IndexFileIn IF; std::tie(IF.Symbols, std::ignore, IF.Relations) = - indexHeaderSymbols(Version, AST, PP, PI); + indexHeaderSymbols(Version, AST, PP, PI, SymbolOrigin::Preamble); updatePreamble(std::move(IF)); } diff --git a/clang-tools-extra/clangd/index/FileIndex.h b/clang-tools-extra/clangd/index/FileIndex.h index 8e88dc9712996..86af5ee3723f6 100644 --- a/clang-tools-extra/clangd/index/FileIndex.h +++ b/clang-tools-extra/clangd/index/FileIndex.h @@ -164,7 +164,8 @@ SlabTuple indexMainDecls(ParsedAST &AST); /// included headers. SlabTuple indexHeaderSymbols(llvm::StringRef Version, ASTContext &AST, Preprocessor &PP, - const include_cleaner::PragmaIncludes &PI); + const include_cleaner::PragmaIncludes &PI, + SymbolOrigin Origin); /// Takes slabs coming from a TU (multiple files) and shards them per /// declaration location. diff --git a/clang-tools-extra/clangd/index/StdLib.cpp b/clang-tools-extra/clangd/index/StdLib.cpp index d34838a45048d..483589365eace 100644 --- a/clang-tools-extra/clangd/index/StdLib.cpp +++ b/clang-tools-extra/clangd/index/StdLib.cpp @@ -15,12 +15,15 @@ #include "Compiler.h" #include "Config.h" #include "SymbolCollector.h" +#include "clang-include-cleaner/Record.h" +#include "index/FileIndex.h" #include "index/IndexAction.h" #include "support/Logger.h" #include "support/ThreadsafeFS.h" #include "support/Trace.h" #include "clang/Basic/LangOptions.h" #include "clang/Frontend/CompilerInvocation.h" +#include "clang/Frontend/FrontendActions.h" #include "clang/Lex/PreprocessorOptions.h" #include "clang/Tooling/Inclusions/StandardLibrary.h" #include "llvm/ADT/IntrusiveRefCntPtr.h" @@ -223,33 +226,29 @@ SymbolSlab indexStandardLibrary(llvm::StringRef HeaderSources, return Symbols; } - SymbolCollector::Options IndexOpts; - IndexOpts.Origin = SymbolOrigin::StdLib; - IndexOpts.CollectMainFileSymbols = false; - IndexOpts.CollectMainFileRefs = false; - IndexOpts.CollectMacro = true; - IndexOpts.StoreAllDocumentation = true; - // Sadly we can't use IndexOpts.FileFilter to restrict indexing scope. - // Files from outside the StdLibLocation may define true std symbols anyway. - // We end up "blessing" such headers, and can only do that by indexing - // everything first. - - // Refs, relations, include graph in the stdlib mostly aren't useful. - auto Action = createStaticIndexingAction( - IndexOpts, [&](SymbolSlab S) { Symbols = std::move(S); }, nullptr, - nullptr, nullptr); - - if (!Action->BeginSourceFile(*Clang, Input)) { + SyntaxOnlyAction Action; + + if (!Action.BeginSourceFile(*Clang, Input)) { elog("Standard Library Index: BeginSourceFile() failed"); return Symbols; } - if (llvm::Error Err = Action->Execute()) { + if (llvm::Error Err = Action.Execute()) { elog("Standard Library Index: Execute failed: {0}", std::move(Err)); return Symbols; } - Action->EndSourceFile(); + // We don't care about include graph for stdlib headers, so provide a no-op + // PI. + include_cleaner::PragmaIncludes PI; + auto Slabs = + indexHeaderSymbols("", Clang->getASTContext(), Clang->getPreprocessor(), + PI, SymbolOrigin::StdLib); + Symbols = std::move(std::get<0>(Slabs)); + + // Run EndSourceFile() after indexing completes, so ensure the AST and + // preprocessor state is alive during indexing. + Action.EndSourceFile(); unsigned SymbolsBeforeFilter = Symbols.size(); Symbols = filter(std::move(Symbols), Loc); diff --git a/clang-tools-extra/clangd/unittests/StdLibTests.cpp b/clang-tools-extra/clangd/unittests/StdLibTests.cpp index a7a33f78303d3..4c9a2e7778816 100644 --- a/clang-tools-extra/clangd/unittests/StdLibTests.cpp +++ b/clang-tools-extra/clangd/unittests/StdLibTests.cpp @@ -13,6 +13,7 @@ #include "Config.h" #include "SyncAPI.h" #include "TestFS.h" +#include "index/Index.h" #include "index/StdLib.h" #include "clang/Basic/LangOptions.h" #include "clang/Basic/SourceManager.h" @@ -158,6 +159,42 @@ TEST(StdLibTests, EndToEnd) { UnorderedElementsAre(StdlibSymbol("list"), StdlibSymbol("vector"))); } +TEST(StdLibTests, StdLibDocComments) { + Config Cfg; + Cfg.Index.StandardLibrary = true; + WithContextValue Enabled(Config::Key, std::move(Cfg)); + + MockFS FS; + FS.Files["stdlib/vector"] = R"cpp( + namespace std { + struct vector { + /**doc comment*/ + struct inner {}; + }; + } + )cpp"; + MockCompilationDatabase CDB; + CDB.ExtraClangFlags.push_back("-isystem" + testPath("stdlib")); + ClangdServer::Options Opts = ClangdServer::optsForTest(); + Opts.BuildDynamicSymbolIndex = true; // also used for stdlib index + ClangdServer Server(CDB, FS, Opts); + + // Open an empty file. <vector> will not be part of the preamble index, + // but it will be part of the stdlib index. + Server.addDocument(testPath("foo.cc"), ""); + + // Wait for the stdlib index to be built. + ASSERT_TRUE(Server.blockUntilIdleForTest()); + + // Check that the index contains the doc comment. + FuzzyFindRequest Req; + Req.Query = "inner"; + Req.Scopes = {"std::vector::"}; + SymbolSlab Result = runFuzzyFind(*Server.getIndexForTest(), Req); + ASSERT_EQ(Result.size(), 1u); + EXPECT_EQ(Result.begin()->Documentation, "doc comment"); +} + } // namespace } // namespace clangd } // namespace clang diff --git a/clang-tools-extra/clangd/unittests/TestTU.cpp b/clang-tools-extra/clangd/unittests/TestTU.cpp index 3f8990c86f714..a733fac932bf4 100644 --- a/clang-tools-extra/clangd/unittests/TestTU.cpp +++ b/clang-tools-extra/clangd/unittests/TestTU.cpp @@ -12,6 +12,7 @@ #include "Diagnostics.h" #include "TestFS.h" #include "index/FileIndex.h" +#include "index/SymbolOrigin.h" #include "clang/AST/RecursiveASTVisitor.h" #include "clang/Basic/Diagnostic.h" #include "clang/Frontend/CompilerInvocation.h" @@ -164,7 +165,7 @@ SymbolSlab TestTU::headerSymbols() const { auto AST = build(); return std::get<0>(indexHeaderSymbols( /*Version=*/"null", AST.getASTContext(), AST.getPreprocessor(), - AST.getPragmaIncludes())); + AST.getPragmaIncludes(), SymbolOrigin::Preamble)); } RefSlab TestTU::headerRefs() const { _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
