dgoldman updated this revision to Diff 474571.
dgoldman marked an inline comment as done.
dgoldman added a comment.
Fix serialization and isSelfContainedHeader
- Keep serialization as a single var uint32
- Keep old imported logic in isSelfContainedHeader in addition to a new check
for import lines only for main files
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D128457/new/
https://reviews.llvm.org/D128457
Files:
clang-tools-extra/clangd/SourceCode.cpp
clang-tools-extra/clangd/SourceCode.h
clang-tools-extra/clangd/index/Merge.cpp
clang-tools-extra/clangd/index/Serialization.cpp
clang-tools-extra/clangd/index/Symbol.h
clang-tools-extra/clangd/index/SymbolCollector.cpp
clang-tools-extra/clangd/index/SymbolCollector.h
clang-tools-extra/clangd/index/YAMLSerialization.cpp
clang-tools-extra/clangd/index/remote/Index.proto
clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp
clang-tools-extra/clangd/test/index-serialization/Inputs/sample.idx
clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp
clang-tools-extra/clangd/unittests/DiagnosticsTests.cpp
clang-tools-extra/clangd/unittests/IndexTests.cpp
clang-tools-extra/clangd/unittests/SerializationTests.cpp
Index: clang-tools-extra/clangd/unittests/SerializationTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/SerializationTests.cpp
+++ clang-tools-extra/clangd/unittests/SerializationTests.cpp
@@ -53,8 +53,16 @@
IncludeHeaders:
- Header: 'include1'
References: 7
+ Directives: [ Include ]
- Header: 'include2'
References: 3
+ Directives: [ Import ]
+ - Header: 'include3'
+ References: 2
+ Directives: [ Include, Import ]
+ - Header: 'include4'
+ References: 1
+ Directives: [ ]
...
---
!Symbol
@@ -114,8 +122,11 @@
MATCHER_P(id, I, "") { return arg.ID == cantFail(SymbolID::fromStr(I)); }
MATCHER_P(qName, Name, "") { return (arg.Scope + arg.Name).str() == Name; }
-MATCHER_P2(IncludeHeaderWithRef, IncludeHeader, References, "") {
- return (arg.IncludeHeader == IncludeHeader) && (arg.References == References);
+MATCHER_P3(IncludeHeaderWithRefAndDirectives, IncludeHeader, References,
+ SupportedDirectives, "") {
+ return (arg.IncludeHeader == IncludeHeader) &&
+ (arg.References == References) &&
+ (arg.SupportedDirectives == SupportedDirectives);
}
auto readIndexFile(llvm::StringRef Text) {
@@ -148,9 +159,14 @@
EXPECT_EQ(static_cast<uint8_t>(Sym1.Flags), 129);
EXPECT_TRUE(Sym1.Flags & Symbol::IndexedForCodeCompletion);
EXPECT_FALSE(Sym1.Flags & Symbol::Deprecated);
- EXPECT_THAT(Sym1.IncludeHeaders,
- UnorderedElementsAre(IncludeHeaderWithRef("include1", 7u),
- IncludeHeaderWithRef("include2", 3u)));
+ EXPECT_THAT(
+ Sym1.IncludeHeaders,
+ UnorderedElementsAre(
+ IncludeHeaderWithRefAndDirectives("include1", 7u, Symbol::Include),
+ IncludeHeaderWithRefAndDirectives("include2", 3u, Symbol::Import),
+ IncludeHeaderWithRefAndDirectives(
+ "include3", 2u, Symbol::Include | Symbol::Import),
+ IncludeHeaderWithRefAndDirectives("include4", 1u, Symbol::Invalid)));
EXPECT_THAT(Sym2, qName("clang::Foo2"));
EXPECT_EQ(Sym2.Signature, "-sig");
Index: clang-tools-extra/clangd/unittests/IndexTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/IndexTests.cpp
+++ clang-tools-extra/clangd/unittests/IndexTests.cpp
@@ -567,9 +567,9 @@
L.Name = "left";
R.Name = "right";
L.ID = R.ID = SymbolID("hello");
- L.IncludeHeaders.emplace_back("common", 1);
- R.IncludeHeaders.emplace_back("common", 1);
- R.IncludeHeaders.emplace_back("new", 1);
+ L.IncludeHeaders.emplace_back("common", 1, Symbol::Include);
+ R.IncludeHeaders.emplace_back("common", 1, Symbol::Include);
+ R.IncludeHeaders.emplace_back("new", 1, Symbol::Include);
// Both have no definition.
Symbol M = mergeSymbol(L, R);
@@ -615,7 +615,7 @@
std::move(DynData), DynSize);
SymbolSlab::Builder StaticB;
- S.IncludeHeaders.push_back({"<header>", 0});
+ S.IncludeHeaders.push_back({"<header>", 0, Symbol::Include});
StaticB.insert(S);
auto StaticIndex =
MemIndex::build(std::move(StaticB).build(), RefSlab(), RelationSlab());
Index: clang-tools-extra/clangd/unittests/DiagnosticsTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/DiagnosticsTests.cpp
+++ clang-tools-extra/clangd/unittests/DiagnosticsTests.cpp
@@ -1071,7 +1071,7 @@
Sym.Flags |= Symbol::IndexedForCodeCompletion;
Sym.CanonicalDeclaration.FileURI = S.DeclaringFile.c_str();
Sym.Definition.FileURI = S.DeclaringFile.c_str();
- Sym.IncludeHeaders.emplace_back(S.IncludeHeader, 1);
+ Sym.IncludeHeaders.emplace_back(S.IncludeHeader, 1, Symbol::Include);
Slab.insert(Sym);
}
return MemIndex::build(std::move(Slab).build(), RefSlab(), RelationSlab());
@@ -1129,7 +1129,7 @@
Symbol Sym = enm("X");
Sym.Flags |= Symbol::IndexedForCodeCompletion;
Sym.CanonicalDeclaration.FileURI = Sym.Definition.FileURI = "unittest:///x.h";
- Sym.IncludeHeaders.emplace_back("\"x.h\"", 1);
+ Sym.IncludeHeaders.emplace_back("\"x.h\"", 1, Symbol::Include);
SymbolSlab::Builder Slab;
Slab.insert(Sym);
auto Index =
@@ -1172,7 +1172,7 @@
Sym.Flags |= Symbol::IndexedForCodeCompletion;
Sym.CanonicalDeclaration.FileURI = "unittest:///x.h";
Sym.Definition.FileURI = "unittest:///x.cc";
- Sym.IncludeHeaders.emplace_back("\"x.h\"", 1);
+ Sym.IncludeHeaders.emplace_back("\"x.h\"", 1, Symbol::Include);
SymbolSlab::Builder Slab;
Slab.insert(Sym);
@@ -1503,7 +1503,7 @@
Symbol Sym = func("foo");
Sym.Flags |= Symbol::IndexedForCodeCompletion;
Sym.CanonicalDeclaration.FileURI = "unittest:///foo.h";
- Sym.IncludeHeaders.emplace_back("\"foo.h\"", 1);
+ Sym.IncludeHeaders.emplace_back("\"foo.h\"", 1, Symbol::Include);
SymbolSlab::Builder Slab;
Slab.insert(Sym);
Index: clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp
+++ clang-tools-extra/clangd/unittests/CodeCompleteTests.cpp
@@ -79,6 +79,10 @@
return !arg.Includes.empty() && arg.Includes[0].Header == IncludeHeader &&
bool(arg.Includes[0].Insertion);
}
+MATCHER_P(insertIncludeText, InsertedText, "") {
+ return !arg.Includes.empty() && arg.Includes[0].Insertion &&
+ arg.Includes[0].Insertion->newText == InsertedText;
+}
MATCHER(insertInclude, "") {
return !arg.Includes.empty() && bool(arg.Includes[0].Insertion);
}
@@ -755,7 +759,7 @@
Symbol Sym = cls("ns::X");
Sym.CanonicalDeclaration.FileURI = BarURI.c_str();
- Sym.IncludeHeaders.emplace_back(BarURI, 1);
+ Sym.IncludeHeaders.emplace_back(BarURI, 1, Symbol::Include);
// Shorten include path based on search directory and insert.
Annotations Test("int main() { ns::^ }");
TU.Code = Test.code().str();
@@ -786,8 +790,8 @@
auto BarURI = URI::create(BarHeader).toString();
SymX.CanonicalDeclaration.FileURI = BarURI.c_str();
SymY.CanonicalDeclaration.FileURI = BarURI.c_str();
- SymX.IncludeHeaders.emplace_back("<bar>", 1);
- SymY.IncludeHeaders.emplace_back("<bar>", 1);
+ SymX.IncludeHeaders.emplace_back("<bar>", 1, Symbol::Include);
+ SymY.IncludeHeaders.emplace_back("<bar>", 1, Symbol::Include);
// Shorten include path based on search directory and insert.
auto Results = completions(R"cpp(
namespace ns {
@@ -1810,7 +1814,7 @@
// Differences in header-to-insert suppress bundling.
std::string DeclFile = URI::create(testPath("foo")).toString();
NoArgsGFunc.CanonicalDeclaration.FileURI = DeclFile.c_str();
- NoArgsGFunc.IncludeHeaders.emplace_back("<foo>", 1);
+ NoArgsGFunc.IncludeHeaders.emplace_back("<foo>", 1, Symbol::Include);
EXPECT_THAT(
completions(Context + "int y = GFunc^", {NoArgsGFunc}, Opts).Completions,
UnorderedElementsAre(AllOf(named("GFuncC"), insertInclude("<foo>")),
@@ -1844,8 +1848,8 @@
SymX.CanonicalDeclaration.FileURI = BarURI.c_str();
SymY.CanonicalDeclaration.FileURI = BarURI.c_str();
// The include header is different, but really it's the same file.
- SymX.IncludeHeaders.emplace_back("\"bar.h\"", 1);
- SymY.IncludeHeaders.emplace_back(BarURI.c_str(), 1);
+ SymX.IncludeHeaders.emplace_back("\"bar.h\"", 1, Symbol::Include);
+ SymY.IncludeHeaders.emplace_back(BarURI.c_str(), 1, Symbol::Include);
auto Results = completions("void f() { ::ns::^ }", {SymX, SymY}, Opts);
// Expect both results are bundled, despite the different-but-same
@@ -2642,8 +2646,8 @@
std::string DeclFile = URI::create(testPath("foo")).toString();
Symbol Sym = func("Func");
Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
- Sym.IncludeHeaders.emplace_back("\"foo.h\"", 2);
- Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000);
+ Sym.IncludeHeaders.emplace_back("\"foo.h\"", 2, Symbol::Include);
+ Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000, Symbol::Include);
auto Results = completions("Fun^", {Sym}).Completions;
assert(!Results.empty());
@@ -2651,6 +2655,33 @@
EXPECT_EQ(Results[0].Includes.size(), 2u);
}
+TEST(CompletionTest, InsertIncludeOrImport) {
+ std::string DeclFile = URI::create(testPath("foo")).toString();
+ Symbol Sym = func("Func");
+ Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
+ Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000,
+ Symbol::Include | Symbol::Import);
+
+ auto Results = completions("Fun^", {Sym}).Completions;
+ assert(!Results.empty());
+ EXPECT_THAT(Results[0],
+ AllOf(named("Func"), insertIncludeText("#include \"bar.h\"\n")));
+
+ Results = completions("Fun^", {Sym}, {}, "Foo.m").Completions;
+ assert(!Results.empty());
+ // TODO: Once #import integration support is done this should be #import.
+ EXPECT_THAT(Results[0],
+ AllOf(named("Func"), insertIncludeText("#include \"bar.h\"\n")));
+
+ Sym.IncludeHeaders[0].SupportedDirectives = Symbol::Import;
+ Results = completions("Fun^", {Sym}).Completions;
+ assert(!Results.empty());
+ // TODO: Once #import integration support is done this shouldn't include
+ // anything.
+ EXPECT_THAT(Results[0],
+ AllOf(named("Func"), insertIncludeText("#include \"bar.h\"\n")));
+}
+
TEST(CompletionTest, NoInsertIncludeIfOnePresent) {
Annotations Test(R"cpp(
#include "foo.h"
@@ -2662,8 +2693,8 @@
std::string DeclFile = URI::create(testPath("foo")).toString();
Symbol Sym = func("Func");
Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
- Sym.IncludeHeaders.emplace_back("\"foo.h\"", 2);
- Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000);
+ Sym.IncludeHeaders.emplace_back("\"foo.h\"", 2, Symbol::Include);
+ Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000, Symbol::Include);
EXPECT_THAT(completions(TU, Test.point(), {Sym}).Completions,
UnorderedElementsAre(AllOf(named("Func"), hasInclude("\"foo.h\""),
Index: clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp
===================================================================
--- clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp
+++ clang-tools-extra/clangd/index/remote/marshalling/Marshalling.cpp
@@ -406,6 +406,7 @@
const clangd::Symbol::IncludeHeaderWithReferences &IncludeHeader) {
HeaderWithReferences Result;
Result.set_references(IncludeHeader.References);
+ Result.set_supported_directives(IncludeHeader.SupportedDirectives);
const std::string Header = IncludeHeader.IncludeHeader.str();
if (isLiteralInclude(Header)) {
Result.set_header(Header);
@@ -427,8 +428,15 @@
return URIString.takeError();
Header = *URIString;
}
- return clangd::Symbol::IncludeHeaderWithReferences{Strings.save(Header),
- Message.references()};
+ auto IncludeTypes = fromProtobuf(Message.include_types());
+ if (!IncludeTypes)
+ return IncludeTypes.takeError();
+ auto Directives = clangd::Symbol::IncludeDirectives::Include;
+ if (Message.has_supported_directives())
+ Directives = static_cast<clangd::Symbol::IncludeDirectives>(
+ Message.supported_directives());
+ return clangd::Symbol::IncludeHeaderWithReferences{
+ Strings.save(Header), Message.references(), Directives};
}
} // namespace remote
Index: clang-tools-extra/clangd/index/remote/Index.proto
===================================================================
--- clang-tools-extra/clangd/index/remote/Index.proto
+++ clang-tools-extra/clangd/index/remote/Index.proto
@@ -107,6 +107,7 @@
message HeaderWithReferences {
optional string header = 1;
optional uint32 references = 2;
+ optional uint32 supported_directives = 3;
}
message RelationsRequest {
Index: clang-tools-extra/clangd/index/YAMLSerialization.cpp
===================================================================
--- clang-tools-extra/clangd/index/YAMLSerialization.cpp
+++ clang-tools-extra/clangd/index/YAMLSerialization.cpp
@@ -28,8 +28,13 @@
#include "llvm/Support/raw_ostream.h"
#include <cstdint>
+namespace {
+struct YIncludeHeaderWithReferences;
+}
+
LLVM_YAML_IS_SEQUENCE_VECTOR(clang::clangd::Symbol::IncludeHeaderWithReferences)
LLVM_YAML_IS_SEQUENCE_VECTOR(clang::clangd::Ref)
+LLVM_YAML_IS_SEQUENCE_VECTOR(YIncludeHeaderWithReferences)
namespace {
using RefBundle =
@@ -48,6 +53,21 @@
uint32_t Line;
uint32_t Column;
};
+// A class helps YAML to serialize the IncludeHeaderWithReferences as YAMLIO
+// can't directly map bitfields.
+struct YIncludeHeaderWithReferences {
+ llvm::StringRef IncludeHeader;
+ uint32_t References;
+ clang::clangd::Symbol::IncludeDirectives SupportedDirectives;
+
+ YIncludeHeaderWithReferences() = default;
+
+ YIncludeHeaderWithReferences(
+ llvm::StringRef IncludeHeader, uint32_t References,
+ clang::clangd::Symbol::IncludeDirectives SupportedDirectives)
+ : IncludeHeader(IncludeHeader), References(References),
+ SupportedDirectives(SupportedDirectives) {}
+};
// avoid ODR violation of specialization for non-owned CompileCommand
struct CompileCommandYAML : clang::tooling::CompileCommand {};
@@ -166,12 +186,40 @@
};
template <>
-struct MappingTraits<clang::clangd::Symbol::IncludeHeaderWithReferences> {
- static void mapping(IO &IO,
- clang::clangd::Symbol::IncludeHeaderWithReferences &Inc) {
+struct ScalarBitSetTraits<clang::clangd::Symbol::IncludeDirectives> {
+ static void bitset(IO &IO, clang::clangd::Symbol::IncludeDirectives &Value) {
+ IO.bitSetCase(Value, "Include", clang::clangd::Symbol::Include);
+ IO.bitSetCase(Value, "Import", clang::clangd::Symbol::Import);
+ }
+};
+
+template <> struct MappingTraits<YIncludeHeaderWithReferences> {
+ static void mapping(IO &IO, YIncludeHeaderWithReferences &Inc) {
IO.mapRequired("Header", Inc.IncludeHeader);
IO.mapRequired("References", Inc.References);
+ IO.mapOptional("Directives", Inc.SupportedDirectives,
+ clang::clangd::Symbol::Include);
+ }
+};
+
+struct NormalizedIncludeHeaders {
+ using IncludeHeader = clang::clangd::Symbol::IncludeHeaderWithReferences;
+ NormalizedIncludeHeaders(IO &) {}
+ NormalizedIncludeHeaders(
+ IO &, const llvm::SmallVector<IncludeHeader, 1> &IncludeHeaders) {
+ for (auto &I : IncludeHeaders) {
+ Headers.emplace_back(
+ I.IncludeHeader, I.References, I.supportedDirectives());
+ }
+ }
+
+ llvm::SmallVector<IncludeHeader, 1> denormalize(IO &) {
+ llvm::SmallVector<IncludeHeader, 1> Result;
+ for (auto &H : Headers)
+ Result.emplace_back(H.IncludeHeader, H.References, H.SupportedDirectives);
+ return Result;
}
+ llvm::SmallVector<YIncludeHeaderWithReferences, 1> Headers;
};
template <> struct MappingTraits<Symbol> {
@@ -179,6 +227,10 @@
MappingNormalization<NormalizedSymbolID, SymbolID> NSymbolID(IO, Sym.ID);
MappingNormalization<NormalizedSymbolFlag, Symbol::SymbolFlag> NSymbolFlag(
IO, Sym.Flags);
+ MappingNormalization<
+ NormalizedIncludeHeaders,
+ llvm::SmallVector<Symbol::IncludeHeaderWithReferences, 1>>
+ NIncludeHeaders(IO, Sym.IncludeHeaders);
IO.mapRequired("ID", NSymbolID->HexString);
IO.mapRequired("Name", Sym.Name);
IO.mapRequired("Scope", Sym.Scope);
@@ -195,7 +247,7 @@
IO.mapOptional("Documentation", Sym.Documentation);
IO.mapOptional("ReturnType", Sym.ReturnType);
IO.mapOptional("Type", Sym.Type);
- IO.mapOptional("IncludeHeaders", Sym.IncludeHeaders);
+ IO.mapOptional("IncludeHeaders", NIncludeHeaders->Headers);
}
};
Index: clang-tools-extra/clangd/index/SymbolCollector.h
===================================================================
--- clang-tools-extra/clangd/index/SymbolCollector.h
+++ clang-tools-extra/clangd/index/SymbolCollector.h
@@ -153,6 +153,9 @@
// File IDs for Symbol.IncludeHeaders.
// The final spelling is calculated in finish().
llvm::DenseMap<SymbolID, FileID> IncludeFiles;
+ // Files which contain ObjC symbols.
+ // This is finalized and used in finish().
+ llvm::DenseSet<FileID> FilesWithObjCConstructs;
void setIncludeLocation(const Symbol &S, SourceLocation);
// Indexed macros, to be erased if they turned out to be include guards.
llvm::DenseSet<const IdentifierInfo *> IndexedMacros;
Index: clang-tools-extra/clangd/index/SymbolCollector.cpp
===================================================================
--- clang-tools-extra/clangd/index/SymbolCollector.cpp
+++ clang-tools-extra/clangd/index/SymbolCollector.cpp
@@ -95,6 +95,30 @@
}
}
+// We only collect #import paths for symbols that are suitable for global code
+// completion including protocols, except for namespaces since #imports path
+// for a namespace is hard to define.
+bool shouldCollectImportPath(index::SymbolKind Kind) {
+ using SK = index::SymbolKind;
+ switch (Kind) {
+ case SK::Macro:
+ case SK::Enum:
+ case SK::Struct:
+ case SK::Class:
+ case SK::Union:
+ case SK::TypeAlias:
+ case SK::Using:
+ case SK::Function:
+ case SK::Variable:
+ case SK::EnumConstant:
+ case SK::Concept:
+ case SK::Protocol:
+ return true;
+ default:
+ return false;
+ }
+}
+
// Return the symbol range of the token at \p TokLoc.
std::pair<SymbolLocation::Position, SymbolLocation::Position>
getTokenRange(SourceLocation TokLoc, const SourceManager &SM,
@@ -804,12 +828,17 @@
}
void SymbolCollector::setIncludeLocation(const Symbol &S, SourceLocation Loc) {
- if (Opts.CollectIncludePath)
- if (shouldCollectIncludePath(S.SymInfo.Kind))
+ if (Opts.CollectIncludePath) {
+ if (shouldCollectIncludePath(S.SymInfo.Kind) ||
+ shouldCollectImportPath(S.SymInfo.Kind)) {
// Use the expansion location to get the #include header since this is
// where the symbol is exposed.
- IncludeFiles[S.ID] =
- PP->getSourceManager().getDecomposedExpansionLoc(Loc).first;
+ FileID FID = PP->getSourceManager().getDecomposedExpansionLoc(Loc).first;
+ IncludeFiles[S.ID] = FID;
+ if (S.SymInfo.Lang == index::SymbolLanguage::ObjC)
+ FilesWithObjCConstructs.insert(FID);
+ }
+ }
}
void SymbolCollector::finish() {
@@ -834,6 +863,7 @@
Symbols.erase(ID);
}
}
+ llvm::DenseMap<FileID, bool> FileToContainsImports;
// Fill in IncludeHeaders.
// We delay this until end of TU so header guards are all resolved.
llvm::SmallString<128> QName;
@@ -853,21 +883,39 @@
IncludeHeader = "<algorithm>";
}
}
+ bool ContainsImports;
+ auto It = FileToContainsImports.find(Entry.second);
+ if (It != FileToContainsImports.end()) {
+ ContainsImports = It->second;
+ } else {
+ ContainsImports =
+ fileContainsImports(Entry.second, ASTCtx->getSourceManager());
+ FileToContainsImports[Entry.second] = ContainsImports;
+ }
// Otherwise find the approprate include header for the defining file.
if (IncludeHeader.empty())
IncludeHeader = HeaderFileURIs->getIncludeHeader(Entry.second);
// Symbols in slabs aren't mutable, insert() has to walk all the strings
if (!IncludeHeader.empty()) {
- Symbol NewSym = *S;
- NewSym.IncludeHeaders.push_back({IncludeHeader, 1});
- Symbols.insert(NewSym);
+ Symbol::IncludeDirectives Directives = Symbol::Invalid;
+ if (shouldCollectIncludePath(S->SymInfo.Kind))
+ Directives |= Symbol::Include;
+ if (shouldCollectImportPath(S->SymInfo.Kind) &&
+ (ContainsImports || FilesWithObjCConstructs.contains(Entry.second)))
+ Directives |= Symbol::Import;
+ if (Directives != Symbol::Invalid) {
+ Symbol NewSym = *S;
+ NewSym.IncludeHeaders.push_back({IncludeHeader, 1, Directives});
+ Symbols.insert(NewSym);
+ }
}
}
}
ReferencedSymbols.clear();
IncludeFiles.clear();
+ FilesWithObjCConstructs.clear();
}
const Symbol *SymbolCollector::addDeclaration(const NamedDecl &ND, SymbolID ID,
Index: clang-tools-extra/clangd/index/Symbol.h
===================================================================
--- clang-tools-extra/clangd/index/Symbol.h
+++ clang-tools-extra/clangd/index/Symbol.h
@@ -13,12 +13,15 @@
#include "index/SymbolLocation.h"
#include "index/SymbolOrigin.h"
#include "clang/Index/IndexSymbol.h"
+#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/StringSaver.h"
namespace clang {
namespace clangd {
+LLVM_ENABLE_BITMASK_ENUMS_IN_NAMESPACE();
+
/// The class presents a C++ symbol, e.g. class, function.
///
/// WARNING: Symbols do not own much of their underlying data - typically
@@ -84,12 +87,24 @@
/// Only set when the symbol is indexed for completion.
llvm::StringRef Type;
+ enum IncludeDirectives : uint8_t {
+ Invalid = 0,
+ /// `#include "header.h"`
+ Include = 1,
+ /// `#import "header.h"`
+ Import = 2,
+
+ LLVM_MARK_AS_BITMASK_ENUM(Import)
+ };
+
struct IncludeHeaderWithReferences {
IncludeHeaderWithReferences() = default;
IncludeHeaderWithReferences(llvm::StringRef IncludeHeader,
- unsigned References)
- : IncludeHeader(IncludeHeader), References(References) {}
+ uint32_t References,
+ IncludeDirectives SupportedDirectives)
+ : IncludeHeader(IncludeHeader), References(References),
+ SupportedDirectives(SupportedDirectives) {}
/// This can be either a URI of the header to be #include'd
/// for this symbol, or a literal header quoted with <> or "" that is
@@ -101,7 +116,14 @@
llvm::StringRef IncludeHeader = "";
/// The number of translation units that reference this symbol and include
/// this header. This number is only meaningful if aggregated in an index.
- unsigned References = 0;
+ uint32_t References : 30;
+ /// Bitfield of supported directives (IncludeDirectives) that can be used
+ /// when including this header.
+ uint32_t SupportedDirectives : 2;
+
+ IncludeDirectives supportedDirectives() const {
+ return static_cast<IncludeDirectives>(SupportedDirectives);
+ }
};
/// One Symbol can potentially be included via different headers.
/// - If we haven't seen a definition, this covers all declarations.
Index: clang-tools-extra/clangd/index/Serialization.cpp
===================================================================
--- clang-tools-extra/clangd/index/Serialization.cpp
+++ clang-tools-extra/clangd/index/Serialization.cpp
@@ -331,7 +331,7 @@
auto WriteInclude = [&](const Symbol::IncludeHeaderWithReferences &Include) {
writeVar(Strings.index(Include.IncludeHeader), OS);
- writeVar(Include.References, OS);
+ writeVar((Include.References << 2) | Include.SupportedDirectives, OS);
};
writeVar(Sym.IncludeHeaders.size(), OS);
for (const auto &Include : Sym.IncludeHeaders)
@@ -361,7 +361,9 @@
return Sym;
for (auto &I : Sym.IncludeHeaders) {
I.IncludeHeader = Data.consumeString(Strings);
- I.References = Data.consumeVar();
+ uint32_t RefsWithDirectives = Data.consumeVar();
+ I.References = RefsWithDirectives >> 2;
+ I.SupportedDirectives = RefsWithDirectives & 0x3;
}
return Sym;
}
@@ -455,7 +457,7 @@
// The current versioning scheme is simple - non-current versions are rejected.
// If you make a breaking change, bump this version number to invalidate stored
// data. Later we may want to support some backward compatibility.
-constexpr static uint32_t Version = 17;
+constexpr static uint32_t Version = 18;
llvm::Expected<IndexFileIn> readRIFF(llvm::StringRef Data,
SymbolOrigin Origin) {
Index: clang-tools-extra/clangd/index/Merge.cpp
===================================================================
--- clang-tools-extra/clangd/index/Merge.cpp
+++ clang-tools-extra/clangd/index/Merge.cpp
@@ -248,11 +248,14 @@
if (SI.IncludeHeader == OI.IncludeHeader) {
Found = true;
SI.References += OI.References;
+ SI.SupportedDirectives =
+ SI.SupportedDirectives | OI.SupportedDirectives;
break;
}
}
if (!Found && MergeIncludes)
- S.IncludeHeaders.emplace_back(OI.IncludeHeader, OI.References);
+ S.IncludeHeaders.emplace_back(OI.IncludeHeader, OI.References,
+ OI.supportedDirectives());
}
S.Origin |= O.Origin | SymbolOrigin::Merge;
Index: clang-tools-extra/clangd/SourceCode.h
===================================================================
--- clang-tools-extra/clangd/SourceCode.h
+++ clang-tools-extra/clangd/SourceCode.h
@@ -330,6 +330,9 @@
bool isSelfContainedHeader(const FileEntry *FE, FileID ID,
const SourceManager &SM, HeaderSearch &HeaderInfo);
+/// This scans source code to see if the given file contains #imports.
+bool fileContainsImports(FileID ID, const SourceManager &SM);
+
/// Returns true if Name is reserved, like _Foo or __Vector_base.
inline bool isReservedName(llvm::StringRef Name) {
// This doesn't catch all cases, but the most common.
Index: clang-tools-extra/clangd/SourceCode.cpp
===================================================================
--- clang-tools-extra/clangd/SourceCode.cpp
+++ clang-tools-extra/clangd/SourceCode.cpp
@@ -1221,6 +1221,14 @@
return false;
}
+bool isImportLine(llvm::StringRef Line) {
+ Line = Line.ltrim();
+ if (!Line.consume_front("#"))
+ return false;
+ Line = Line.ltrim();
+ return Line.startswith("import");
+}
+
} // namespace
bool isSelfContainedHeader(const FileEntry *FE, FileID FID,
@@ -1229,12 +1237,26 @@
// self-contained? That's really a property of the includer,
// not of the file.
if (!HeaderInfo.isFileMultipleIncludeGuarded(FE) &&
- !HeaderInfo.hasFileBeenImported(FE))
+ !HeaderInfo.hasFileBeenImported(FE) &&
+ (FID != SM.getMainFileID() || !fileContainsImports(FID, SM)))
return false;
// This pattern indicates that a header can't be used without
// particular preprocessor state, usually set up by another header.
return !isDontIncludeMeHeader(SM.getBufferData(FID));
}
+bool fileContainsImports(FileID ID, const SourceManager &SM) {
+ llvm::StringRef Content = SM.getBufferData(ID);
+ llvm::StringRef Line;
+ // Only sniff up to 100 lines or 10KB.
+ Content = Content.take_front(100 * 100);
+ for (unsigned I = 0; I < 100 && !Content.empty(); ++I) {
+ std::tie(Line, Content) = Content.split('\n');
+ if (isImportLine(Line))
+ return true;
+ }
+ return false;
+}
+
} // namespace clangd
} // namespace clang
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
