Author: Haojian Wu Date: 2023-02-23T10:26:26+01:00 New Revision: cbcb3eef70def3509bdffd4fe1ebfb6422afeaa2
URL: https://github.com/llvm/llvm-project/commit/cbcb3eef70def3509bdffd4fe1ebfb6422afeaa2 DIFF: https://github.com/llvm/llvm-project/commit/cbcb3eef70def3509bdffd4fe1ebfb6422afeaa2.diff LOG: [Tooling/Inclusion] Handle std::get symbol. Currently, we handle it as a symbol without a header. In general, for the include-cleaner case, the std::get comes with the type header, it is safe to ignore it. Differential Revision: https://reviews.llvm.org/D144484 Added: Modified: clang-tools-extra/clangd/index/CanonicalIncludes.cpp clang/include/clang/Tooling/Inclusions/StandardLibrary.h clang/lib/Tooling/Inclusions/Stdlib/StandardLibrary.cpp clang/lib/Tooling/Inclusions/Stdlib/StdSpecialSymbolMap.inc clang/unittests/Tooling/StandardLibraryTest.cpp Removed: ################################################################################ diff --git a/clang-tools-extra/clangd/index/CanonicalIncludes.cpp b/clang-tools-extra/clangd/index/CanonicalIncludes.cpp index 0c61a7bd7e92..4311eb9f481f 100644 --- a/clang-tools-extra/clangd/index/CanonicalIncludes.cpp +++ b/clang-tools-extra/clangd/index/CanonicalIncludes.cpp @@ -717,7 +717,8 @@ llvm::StringRef CanonicalIncludes::mapSymbol(llvm::StringRef Scope, if (Scope == "std::" && Name == "move") return "<utility>"; if (auto StdSym = tooling::stdlib::Symbol::named(Scope, Name, Lang)) - return StdSym->header().name(); + if (auto Header = StdSym->header()) + return Header->name(); return ""; } diff --git a/clang/include/clang/Tooling/Inclusions/StandardLibrary.h b/clang/include/clang/Tooling/Inclusions/StandardLibrary.h index 9d45d84a429b..a39ceb520dcf 100644 --- a/clang/include/clang/Tooling/Inclusions/StandardLibrary.h +++ b/clang/include/clang/Tooling/Inclusions/StandardLibrary.h @@ -81,7 +81,7 @@ class Symbol { llvm::StringRef name() const; llvm::StringRef qualifiedName() const; // The preferred header for this symbol (e.g. the suggested insertion). - Header header() const; + std::optional<Header> header() const; // Some symbols may be provided by multiple headers. llvm::SmallVector<Header> headers() const; diff --git a/clang/lib/Tooling/Inclusions/Stdlib/StandardLibrary.cpp b/clang/lib/Tooling/Inclusions/Stdlib/StandardLibrary.cpp index 416b53117d16..cfcb955831ad 100644 --- a/clang/lib/Tooling/Inclusions/Stdlib/StandardLibrary.cpp +++ b/clang/lib/Tooling/Inclusions/Stdlib/StandardLibrary.cpp @@ -14,6 +14,7 @@ #include "llvm/ADT/STLExtras.h" #include "llvm/ADT/StringRef.h" #include "llvm/Support/Casting.h" +#include <optional> namespace clang { namespace tooling { @@ -120,7 +121,8 @@ static int initialize(Lang Language) { } Mapping->SymbolNames[SymIndex] = { QName.data(), NSLen, static_cast<unsigned int>(QName.size() - NSLen)}; - Mapping->SymbolHeaderIDs[SymIndex].push_back(AddHeader(HeaderName)); + if (!HeaderName.empty()) + Mapping->SymbolHeaderIDs[SymIndex].push_back(AddHeader(HeaderName)); NSSymbolMap &NSSymbols = AddNS(QName.take_front(NSLen)); NSSymbols.try_emplace(QName.drop_front(NSLen), SymIndex); @@ -205,8 +207,11 @@ std::optional<Symbol> Symbol::named(llvm::StringRef Scope, llvm::StringRef Name, } return std::nullopt; } -Header Symbol::header() const { - return Header(getMappingPerLang(Language)->SymbolHeaderIDs[ID][0], Language); +std::optional<Header> Symbol::header() const { + const auto& Headers = getMappingPerLang(Language)->SymbolHeaderIDs[ID]; + if (Headers.empty()) + return std::nullopt; + return Header(Headers.front(), Language); } llvm::SmallVector<Header> Symbol::headers() const { llvm::SmallVector<Header> Results; diff --git a/clang/lib/Tooling/Inclusions/Stdlib/StdSpecialSymbolMap.inc b/clang/lib/Tooling/Inclusions/Stdlib/StdSpecialSymbolMap.inc index 3d2ea91a94d3..c9632bee1cbe 100644 --- a/clang/lib/Tooling/Inclusions/Stdlib/StdSpecialSymbolMap.inc +++ b/clang/lib/Tooling/Inclusions/Stdlib/StdSpecialSymbolMap.inc @@ -218,3 +218,8 @@ SYMBOL(ssize, std::, <string_view>) SYMBOL(ssize, std::, <unordered_map>) SYMBOL(ssize, std::, <unordered_set>) SYMBOL(ssize, std::, <vector>) + +// std::get has a few variants for diff erent types (tuple, array, pair etc) +// which is tricky to disambiguate without type information. +// Don't set any header for it, as it comes with the type header. +SYMBOL(get, std::, /*no headers*/) diff --git a/clang/unittests/Tooling/StandardLibraryTest.cpp b/clang/unittests/Tooling/StandardLibraryTest.cpp index 47d064bdd2a9..6d90bbdf3b6e 100644 --- a/clang/unittests/Tooling/StandardLibraryTest.cpp +++ b/clang/unittests/Tooling/StandardLibraryTest.cpp @@ -58,6 +58,9 @@ TEST(StdlibTest, All) { EXPECT_EQ(Vector->header(), *VectorH); EXPECT_THAT(Vector->headers(), ElementsAre(*VectorH)); + EXPECT_TRUE(stdlib::Symbol::named("std::", "get")); + EXPECT_FALSE(stdlib::Symbol::named("std::", "get")->header()); + EXPECT_THAT(stdlib::Symbol::named("std::", "basic_iostream")->headers(), ElementsAre(stdlib::Header::named("<istream>"), stdlib::Header::named("<iostream>"), _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits