1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
//===-- SymbolInfoTests.cpp -----------------------*- C++ -*--------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "Annotations.h"
#include "ParsedAST.h"
#include "TestTU.h"
#include "XRefs.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <optional>
namespace clang {
namespace clangd {
namespace {
using ::testing::UnorderedElementsAreArray;
// Partial SymbolDetails with the rest filled in at testing time.
struct ExpectedSymbolDetails {
std::string Name;
std::string Container;
std::string USR;
const char *DeclMarker = nullptr;
const char *DefMarker = nullptr;
};
TEST(SymbolInfoTests, All) {
std::pair<const char *, std::vector<ExpectedSymbolDetails>>
TestInputExpectedOutput[] = {
{
R"cpp( // Simple function reference - declaration
void $decl[[foo]]();
int bar() {
fo^o();
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@F@foo#", "decl"}}},
{
R"cpp( // Simple function reference - definition
void $def[[foo]]() {}
int bar() {
fo^o();
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@F@foo#", "def", "def"}}},
{
R"cpp( // Simple function reference - decl and def
void $decl[[foo]]();
void $def[[foo]]() {}
int bar() {
fo^o();
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@F@foo#", "decl", "def"}}},
{
R"cpp( // Simple class reference - decl and def
@interface $decl[[Foo]]
@end
@implementation $def[[Foo]]
@end
void doSomething(F^oo *obj) {}
)cpp",
{ExpectedSymbolDetails{"Foo", "", "c:objc(cs)Foo", "decl",
"def"}}},
{
R"cpp( // Simple method reference - decl and def
@interface Foo
- (void)$decl[[foo]];
@end
@implementation Foo
- (void)$def[[fo^o]] {}
@end
)cpp",
{ExpectedSymbolDetails{"foo", "Foo::", "c:objc(cs)Foo(im)foo",
"decl", "def"}}},
{
R"cpp( // Function in namespace reference
namespace bar {
void $decl[[foo]]();
int baz() {
fo^o();
}
}
)cpp",
{ExpectedSymbolDetails{"foo", "bar::", "c:@N@bar@F@foo#",
"decl"}}},
{
R"cpp( // Function in different namespace reference
namespace bar {
void $decl[[foo]]();
}
namespace barbar {
int baz() {
bar::fo^o();
}
}
)cpp",
{ExpectedSymbolDetails{"foo", "bar::", "c:@N@bar@F@foo#",
"decl"}}},
{
R"cpp( // Function in global namespace reference
void $decl[[foo]]();
namespace Nbar {
namespace Nbaz {
int baz() {
::fo^o();
}
}
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@F@foo#", "decl"}}},
{
R"cpp( // Function in anonymous namespace reference
namespace {
void $decl[[foo]]();
}
namespace barbar {
int baz() {
fo^o();
}
}
)cpp",
{ExpectedSymbolDetails{"foo", "(anonymous)",
"c:TestTU.cpp@aN@F@foo#", "decl"}}},
{
R"cpp( // Function reference - ADL
namespace bar {
struct BarType {};
void $decl[[foo]](const BarType&);
}
namespace barbar {
int baz() {
bar::BarType b;
fo^o(b);
}
}
)cpp",
{ExpectedSymbolDetails{
"foo", "bar::", "c:@N@bar@F@foo#&1$@N@bar@S@BarType#",
"decl"}}},
{
R"cpp( // Global value reference
int $def[[value]];
void foo(int) { }
void bar() {
foo(val^ue);
}
)cpp",
{ExpectedSymbolDetails{"value", "", "c:@value", "def", "def"}}},
{
R"cpp( // Local value reference
void foo() { int $def[[aaa]]; int bbb = aa^a; }
)cpp",
{ExpectedSymbolDetails{"aaa", "foo", "c:TestTU.cpp@49@F@foo#@aaa",
"def", "def"}}},
{
R"cpp( // Function param
void bar(int $def[[aaa]]) {
int bbb = a^aa;
}
)cpp",
{ExpectedSymbolDetails{
"aaa", "bar", "c:TestTU.cpp@38@F@bar#I#@aaa", "def", "def"}}},
{
R"cpp( // Lambda capture
void foo() {
int $def[[ii]];
auto lam = [ii]() {
return i^i;
};
}
)cpp",
{ExpectedSymbolDetails{"ii", "foo", "c:TestTU.cpp@54@F@foo#@ii",
"def", "def"}}},
{
R"cpp( // Macro reference
#define MACRO 5\nint i = MAC^RO;
)cpp",
{ExpectedSymbolDetails{"MACRO", "",
"c:TestTU.cpp@38@macro@MACRO"}}},
{
R"cpp( // Macro reference
#define MACRO 5\nint i = MACRO^;
)cpp",
{ExpectedSymbolDetails{"MACRO", "",
"c:TestTU.cpp@38@macro@MACRO"}}},
{
R"cpp( // Multiple symbols returned - using overloaded function name
void $def[[foo]]() {}
void $def_bool[[foo]](bool) {}
void $def_int[[foo]](int) {}
namespace bar {
using ::$decl[[fo^o]];
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@F@foo#", "def", "def"},
ExpectedSymbolDetails{"foo", "", "c:@F@foo#b#", "def_bool",
"def_bool"},
ExpectedSymbolDetails{"foo", "", "c:@F@foo#I#", "def_int",
"def_int"},
ExpectedSymbolDetails{"foo", "bar::", "c:@N@bar@UD@foo",
"decl"}}},
{
R"cpp( // Multiple symbols returned - implicit conversion
struct foo {};
struct bar {
bar(const foo&) {}
};
void func_baz1(bar) {}
void func_baz2() {
foo $def[[ff]];
func_baz1(f^f);
}
)cpp",
{ExpectedSymbolDetails{"ff", "func_baz2",
"c:TestTU.cpp@218@F@func_baz2#@ff", "def",
"def"}}},
{
R"cpp( // Type reference - declaration
struct $decl[[foo]];
void bar(fo^o*);
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@S@foo", "decl"}}},
{
R"cpp( // Type reference - definition
struct $def[[foo]] {};
void bar(fo^o*);
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@S@foo", "def", "def"}}},
{
R"cpp( // Type Reference - template argument
struct $def[[foo]] {};
template<class T> struct bar {};
void baz() {
bar<fo^o> b;
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@S@foo", "def", "def"}}},
{
R"cpp( // Template parameter reference - type param
template<class $def[[TT]]> struct bar {
T^T t;
};
)cpp",
{ExpectedSymbolDetails{"TT", "bar::", "c:TestTU.cpp@65", "def",
"def"}}},
{
R"cpp( // Template parameter reference - type param
template<int $def[[NN]]> struct bar {
int a = N^N;
};
)cpp",
{ExpectedSymbolDetails{"NN", "bar::", "c:TestTU.cpp@65", "def",
"def"}}},
{
R"cpp( // Class member reference - objec
struct foo {
int $def[[aa]];
};
void bar() {
foo f;
f.a^a;
}
)cpp",
{ExpectedSymbolDetails{"aa", "foo::", "c:@S@foo@FI@aa", "def",
"def"}}},
{
R"cpp( // Class member reference - pointer
struct foo {
int $def[[aa]];
};
void bar() {
&foo::a^a;
}
)cpp",
{ExpectedSymbolDetails{"aa", "foo::", "c:@S@foo@FI@aa", "def",
"def"}}},
{
R"cpp( // Class method reference - objec
struct foo {
void $def[[aa]]() {}
};
void bar() {
foo f;
f.a^a();
}
)cpp",
{ExpectedSymbolDetails{"aa", "foo::", "c:@S@foo@F@aa#", "def",
"def"}}},
{
R"cpp( // Class method reference - pointer
struct foo {
void $def[[aa]]() {}
};
void bar() {
&foo::a^a;
}
)cpp",
{ExpectedSymbolDetails{"aa", "foo::", "c:@S@foo@F@aa#", "def",
"def"}}},
{
R"cpp( // Typedef
typedef int $decl[[foo]];
void bar() {
fo^o a;
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:TestTU.cpp@T@foo", "decl"}}},
{
R"cpp( // Type alias
using $decl[[foo]] = int;
void bar() {
fo^o a;
}
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@foo", "decl"}}},
{
R"cpp( // Namespace reference
namespace $decl[[foo]] {}
using namespace fo^o;
)cpp",
{ExpectedSymbolDetails{"foo", "", "c:@N@foo", "decl"}}},
{
R"cpp( // Enum value reference
enum foo { $def[[bar]], baz };
void f() {
foo fff = ba^r;
}
)cpp",
{ExpectedSymbolDetails{"bar", "foo", "c:@E@foo@bar", "def",
"def"}}},
{
R"cpp( // Enum class value reference
enum class foo { $def[[bar]], baz };
void f() {
foo fff = foo::ba^r;
}
)cpp",
{ExpectedSymbolDetails{"bar", "foo::", "c:@E@foo@bar", "def",
"def"}}},
{
R"cpp( // Parameters in declarations
void foo(int $def[[ba^r]]);
)cpp",
{ExpectedSymbolDetails{
"bar", "foo", "c:TestTU.cpp@50@F@foo#I#@bar", "def", "def"}}},
{
R"cpp( // Type inference with auto keyword
struct foo {};
foo getfoo() { return foo{}; }
void f() {
au^to a = getfoo();
}
)cpp",
{/* not implemented */}},
{
R"cpp( // decltype
struct foo {};
void f() {
foo f;
declt^ype(f);
}
)cpp",
{/* not implemented */}},
};
for (const auto &T : TestInputExpectedOutput) {
Annotations TestInput(T.first);
TestTU TU;
TU.Code = std::string(TestInput.code());
TU.ExtraArgs.push_back("-xobjective-c++");
auto AST = TU.build();
std::vector<SymbolDetails> Expected;
for (const auto &Sym : T.second) {
std::optional<Location> Decl, Def;
if (Sym.DeclMarker)
Decl = Location{URIForFile::canonicalize(testPath(TU.Filename), ""),
TestInput.range(Sym.DeclMarker)};
if (Sym.DefMarker)
Def = Location{URIForFile::canonicalize(testPath(TU.Filename), ""),
TestInput.range(Sym.DefMarker)};
Expected.push_back(
{Sym.Name, Sym.Container, Sym.USR, SymbolID(Sym.USR), Decl, Def});
}
EXPECT_THAT(getSymbolInfo(AST, TestInput.point()),
UnorderedElementsAreArray(Expected))
<< T.first;
}
}
} // namespace
} // namespace clangd
} // namespace clang
|