kbobyrev created this revision.
kbobyrev added a reviewer: sammccall.
Herald added subscribers: cfe-commits, usaxena95, kadircet, arphaman, jkorous,
MaskRay, ilya-biryukov.
Herald added a project: clang.
DocumentSymbol ranges were not previously tested and, as a result, had invalid
end location. This patch addresses the issue.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D83668
Files:
clang-tools-extra/clangd/FindSymbols.cpp
clang-tools-extra/clangd/unittests/FindSymbolsTests.cpp
Index: clang-tools-extra/clangd/unittests/FindSymbolsTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/FindSymbolsTests.cpp
+++ clang-tools-extra/clangd/unittests/FindSymbolsTests.cpp
@@ -35,7 +35,7 @@
}
MATCHER_P(WithName, N, "") { return arg.name == N; }
MATCHER_P(WithKind, Kind, "") { return arg.kind == Kind; }
-MATCHER_P(SymRange, Range, "") { return arg.location.range == Range; }
+MATCHER_P(SymRange, Range, "") { return arg.range == Range; }
// GMock helpers for matching DocumentSymbol.
MATCHER_P(SymNameRange, Range, "") { return arg.selectionRange == Range; }
@@ -712,6 +712,72 @@
WithName("Foo_type::method3")));
}
+TEST(DocumentSymbolsTest, Ranges) {
+ TestTU TU;
+ Annotations Main(R"(
+ $foo[[int foo(bool Argument) {
+ return 42;
+ }]]
+
+ char $variable[[GLOBAL_VARIABLE]];
+
+ $ns[[namespace ns {
+ $bar[[class Bar {
+ public:
+ $ctor[[Bar() {}]]
+ $dtor[[~Bar()]];
+
+ private:
+ unsigned $field[[Baz]];
+
+ $getbaz[[unsigned getBaz() { return Baz; }]]
+ }]];
+ }]] // namespace ns
+
+ $forwardclass[[class ForwardClassDecl]];
+
+ $struct[[struct StructDefinition {
+ int *$structfield[[Pointer]];
+ }]];
+ $forwardstruct[[struct StructDeclaration]];
+
+ $forwardfunc[[void forwardFunctionDecl(int Something)]];
+ )");
+ TU.Code = Main.code().str();
+ EXPECT_THAT(
+ getSymbols(TU.build()),
+ UnorderedElementsAre(
+ AllOf(WithName("foo"), WithKind(SymbolKind::Function),
+ SymRange(Main.range("foo"))),
+ AllOf(WithName("GLOBAL_VARIABLE"), WithKind(SymbolKind::Variable),
+ SymRange(Main.range("variable"))),
+ AllOf(
+ WithName("ns"), WithKind(SymbolKind::Namespace),
+ SymRange(Main.range("ns")),
+ Children(AllOf(
+ WithName("Bar"), WithKind(SymbolKind::Class),
+ SymRange(Main.range("bar")),
+ Children(
+ AllOf(WithName("Bar"), WithKind(SymbolKind::Constructor),
+ SymRange(Main.range("ctor"))),
+ AllOf(WithName("~Bar"), WithKind(SymbolKind::Constructor),
+ SymRange(Main.range("dtor"))),
+ AllOf(WithName("Baz"), WithKind(SymbolKind::Field),
+ SymRange(Main.range("field"))),
+ AllOf(WithName("getBaz"), WithKind(SymbolKind::Method),
+ SymRange(Main.range("getbaz"))))))),
+ AllOf(WithName("ForwardClassDecl"), WithKind(SymbolKind::Class),
+ SymRange(Main.range("forwardclass"))),
+ AllOf(WithName("StructDefinition"), WithKind(SymbolKind::Struct),
+ SymRange(Main.range("struct")),
+ Children(AllOf(WithName("Pointer"), WithKind(SymbolKind::Field),
+ SymRange(Main.range("structfield"))))),
+ AllOf(WithName("StructDeclaration"), WithKind(SymbolKind::Struct),
+ SymRange(Main.range("forwardstruct"))),
+ AllOf(WithName("forwardFunctionDecl"), WithKind(SymbolKind::Function),
+ SymRange(Main.range("forwardfunc")))));
+}
+
} // namespace
} // namespace clangd
} // namespace clang
Index: clang-tools-extra/clangd/FindSymbols.cpp
===================================================================
--- clang-tools-extra/clangd/FindSymbols.cpp
+++ clang-tools-extra/clangd/FindSymbols.cpp
@@ -162,8 +162,20 @@
SI.name = printName(Ctx, ND);
SI.kind = SK;
SI.deprecated = ND.isDeprecated();
- SI.range =
- Range{sourceLocToPosition(SM, BeginLoc), sourceLocToPosition(SM, EndLoc)};
+ if (SK == SymbolKind::Class || SK == SymbolKind::Struct ||
+ SK == SymbolKind::Function || SK == SymbolKind::Method ||
+ SK == SymbolKind::Constructor || SK == SymbolKind::Enum ||
+ SK == SymbolKind::Operator || SK == SymbolKind::Namespace) {
+ const auto HalfOpenRange =
+ toHalfOpenFileRange(SM, Ctx.getLangOpts(), {BeginLoc, EndLoc});
+ if (!HalfOpenRange)
+ return llvm::None;
+ SI.range = Range{sourceLocToPosition(SM, HalfOpenRange->getBegin()),
+ sourceLocToPosition(SM, HalfOpenRange->getEnd())};
+ } else {
+ SI.range = Range{sourceLocToPosition(SM, BeginLoc),
+ sourceLocToPosition(SM, EndLoc)};
+ }
SI.selectionRange = Range{NameBegin, NameEnd};
if (!SI.range.contains(SI.selectionRange)) {
// 'selectionRange' must be contained in 'range', so in cases where clang
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
