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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
|
//=== unittests/Sema/CodeCompleteTest.cpp - Code Complete tests ==============//
//
// 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 "clang/Frontend/CompilerInstance.h"
#include "clang/Frontend/FrontendActions.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Parse/ParseAST.h"
#include "clang/Sema/Sema.h"
#include "clang/Sema/SemaDiagnostic.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/Testing/Annotations/Annotations.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <cstddef>
#include <string>
namespace {
using namespace clang;
using namespace clang::tooling;
using ::testing::AllOf;
using ::testing::Contains;
using ::testing::Each;
using ::testing::UnorderedElementsAre;
const char TestCCName[] = "test.cc";
struct CompletionContext {
std::vector<std::string> VisitedNamespaces;
std::string PreferredType;
// String representation of std::ptrdiff_t on a given platform. This is a hack
// to properly account for different configurations of clang.
std::string PtrDiffType;
};
struct CompletedFunctionDecl {
std::string Name;
bool IsStatic;
bool CanBeCall;
};
MATCHER_P(named, name, "") { return arg.Name == name; }
MATCHER_P(isStatic, value, "") { return arg.IsStatic == value; }
MATCHER_P(canBeCall, value, "") { return arg.CanBeCall == value; }
class SaveCompletedFunctions : public CodeCompleteConsumer {
public:
SaveCompletedFunctions(std::vector<CompletedFunctionDecl> &CompletedFuncDecls)
: CodeCompleteConsumer(/*CodeCompleteOpts=*/{}),
CompletedFuncDecls(CompletedFuncDecls),
CCTUInfo(std::make_shared<GlobalCodeCompletionAllocator>()) {}
void ProcessCodeCompleteResults(Sema &S, CodeCompletionContext Context,
CodeCompletionResult *Results,
unsigned NumResults) override {
for (unsigned I = 0; I < NumResults; ++I) {
auto R = Results[I];
if (R.Kind == CodeCompletionResult::RK_Declaration) {
auto *ND = R.getDeclaration();
if (auto *Template = llvm::dyn_cast<FunctionTemplateDecl>(ND))
ND = Template->getTemplatedDecl();
if (const auto *FD = llvm::dyn_cast<FunctionDecl>(ND)) {
CompletedFunctionDecl D;
D.Name = FD->getNameAsString();
D.CanBeCall = R.FunctionCanBeCall;
D.IsStatic = FD->isStatic();
CompletedFuncDecls.emplace_back(std::move(D));
}
}
}
}
private:
CodeCompletionAllocator &getAllocator() override {
return CCTUInfo.getAllocator();
}
CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo; }
std::vector<CompletedFunctionDecl> &CompletedFuncDecls;
CodeCompletionTUInfo CCTUInfo;
};
class VisitedContextFinder : public CodeCompleteConsumer {
public:
VisitedContextFinder(CompletionContext &ResultCtx)
: CodeCompleteConsumer(/*CodeCompleteOpts=*/{}), ResultCtx(ResultCtx),
CCTUInfo(std::make_shared<GlobalCodeCompletionAllocator>()) {}
void ProcessCodeCompleteResults(Sema &S, CodeCompletionContext Context,
CodeCompletionResult *Results,
unsigned NumResults) override {
ResultCtx.VisitedNamespaces =
getVisitedNamespace(Context.getVisitedContexts());
ResultCtx.PreferredType = Context.getPreferredType().getAsString();
ResultCtx.PtrDiffType =
S.getASTContext().getPointerDiffType().getAsString();
}
CodeCompletionAllocator &getAllocator() override {
return CCTUInfo.getAllocator();
}
CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo; }
private:
std::vector<std::string> getVisitedNamespace(
CodeCompletionContext::VisitedContextSet VisitedContexts) const {
std::vector<std::string> NSNames;
for (const auto *Context : VisitedContexts)
if (const auto *NS = llvm::dyn_cast<NamespaceDecl>(Context))
NSNames.push_back(NS->getQualifiedNameAsString());
return NSNames;
}
CompletionContext &ResultCtx;
CodeCompletionTUInfo CCTUInfo;
};
class CodeCompleteAction : public SyntaxOnlyAction {
public:
CodeCompleteAction(ParsedSourceLocation P, CodeCompleteConsumer *Consumer)
: CompletePosition(std::move(P)), Consumer(Consumer) {}
bool BeginInvocation(CompilerInstance &CI) override {
CI.getFrontendOpts().CodeCompletionAt = CompletePosition;
CI.setCodeCompletionConsumer(Consumer);
return true;
}
private:
// 1-based code complete position <Line, Col>;
ParsedSourceLocation CompletePosition;
CodeCompleteConsumer *Consumer;
};
ParsedSourceLocation offsetToPosition(llvm::StringRef Code, size_t Offset) {
Offset = std::min(Code.size(), Offset);
StringRef Before = Code.substr(0, Offset);
int Lines = Before.count('\n');
size_t PrevNL = Before.rfind('\n');
size_t StartOfLine = (PrevNL == StringRef::npos) ? 0 : (PrevNL + 1);
return {TestCCName, static_cast<unsigned>(Lines + 1),
static_cast<unsigned>(Offset - StartOfLine + 1)};
}
CompletionContext runCompletion(StringRef Code, size_t Offset) {
CompletionContext ResultCtx;
clang::tooling::runToolOnCodeWithArgs(
std::make_unique<CodeCompleteAction>(offsetToPosition(Code, Offset),
new VisitedContextFinder(ResultCtx)),
Code, {"-std=c++11"}, TestCCName);
return ResultCtx;
}
CompletionContext runCodeCompleteOnCode(StringRef AnnotatedCode) {
llvm::Annotations A(AnnotatedCode);
return runCompletion(A.code(), A.point());
}
std::vector<std::string>
collectPreferredTypes(StringRef AnnotatedCode,
std::string *PtrDiffType = nullptr) {
llvm::Annotations A(AnnotatedCode);
std::vector<std::string> Types;
for (size_t Point : A.points()) {
auto Results = runCompletion(A.code(), Point);
if (PtrDiffType) {
assert(PtrDiffType->empty() || *PtrDiffType == Results.PtrDiffType);
*PtrDiffType = Results.PtrDiffType;
}
Types.push_back(Results.PreferredType);
}
return Types;
}
std::vector<CompletedFunctionDecl>
CollectCompletedFunctions(StringRef Code, std::size_t Point) {
std::vector<CompletedFunctionDecl> Result;
clang::tooling::runToolOnCodeWithArgs(
std::make_unique<CodeCompleteAction>(offsetToPosition(Code, Point),
new SaveCompletedFunctions(Result)),
Code, {"-std=c++11"}, TestCCName);
return Result;
}
TEST(SemaCodeCompleteTest, FunctionCanBeCall) {
llvm::Annotations Code(R"cpp(
struct Foo {
static int staticMethod();
int method() const;
template <typename T, typename U, typename V = int>
T generic(U, V);
template <typename T, int U = 3>
static T staticGeneric();
Foo() {
this->$canBeCall^
$canBeCall^
Foo::$canBeCall^
}
};
struct Derived : Foo {
using Foo::method;
using Foo::generic;
Derived() {
Foo::$canBeCall^
}
};
struct OtherClass {
OtherClass() {
Foo f;
Derived d;
f.$canBeCall^
; // Prevent parsing as 'f.f'
f.Foo::$canBeCall^
&Foo::$cannotBeCall^
;
d.Foo::$canBeCall^
;
d.Derived::$canBeCall^
}
};
int main() {
Foo f;
Derived d;
f.$canBeCall^
; // Prevent parsing as 'f.f'
f.Foo::$canBeCall^
&Foo::$cannotBeCall^
;
d.Foo::$canBeCall^
;
d.Derived::$canBeCall^
}
)cpp");
for (const auto &P : Code.points("canBeCall")) {
auto Results = CollectCompletedFunctions(Code.code(), P);
EXPECT_THAT(Results, Contains(AllOf(named("method"), isStatic(false),
canBeCall(true))));
EXPECT_THAT(Results, Contains(AllOf(named("generic"), isStatic(false),
canBeCall(true))));
}
for (const auto &P : Code.points("cannotBeCall")) {
auto Results = CollectCompletedFunctions(Code.code(), P);
EXPECT_THAT(Results, Contains(AllOf(named("method"), isStatic(false),
canBeCall(false))));
EXPECT_THAT(Results, Contains(AllOf(named("generic"), isStatic(false),
canBeCall(false))));
}
// static method can always be a call
for (const auto &P : Code.points()) {
auto Results = CollectCompletedFunctions(Code.code(), P);
EXPECT_THAT(Results, Contains(AllOf(named("staticMethod"), isStatic(true),
canBeCall(true))));
EXPECT_THAT(Results, Contains(AllOf(named("staticGeneric"), isStatic(true),
canBeCall(true))));
}
}
TEST(SemaCodeCompleteTest, VisitedNSForValidQualifiedId) {
auto VisitedNS = runCodeCompleteOnCode(R"cpp(
namespace ns1 {}
namespace ns2 {}
namespace ns3 {}
namespace ns3 { namespace nns3 {} }
namespace foo {
using namespace ns1;
namespace ns4 {} // not visited
namespace { using namespace ns2; }
inline namespace bar { using namespace ns3::nns3; }
} // foo
namespace ns { foo::^ }
)cpp")
.VisitedNamespaces;
EXPECT_THAT(VisitedNS, UnorderedElementsAre("foo", "ns1", "ns2", "ns3::nns3",
"foo::(anonymous)"));
}
TEST(SemaCodeCompleteTest, VisitedNSForInvalidQualifiedId) {
auto VisitedNS = runCodeCompleteOnCode(R"cpp(
namespace na {}
namespace ns1 {
using namespace na;
foo::^
}
)cpp")
.VisitedNamespaces;
EXPECT_THAT(VisitedNS, UnorderedElementsAre("ns1", "na"));
}
TEST(SemaCodeCompleteTest, VisitedNSWithoutQualifier) {
auto VisitedNS = runCodeCompleteOnCode(R"cpp(
namespace n1 {
namespace n2 {
void f(^) {}
}
}
)cpp")
.VisitedNamespaces;
EXPECT_THAT(VisitedNS, UnorderedElementsAre("n1", "n1::n2"));
}
TEST(PreferredTypeTest, BinaryExpr) {
// Check various operations for arithmetic types.
StringRef Code = R"cpp(
void test(int x) {
x = ^10;
x += ^10; x -= ^10; x *= ^10; x /= ^10; x %= ^10;
x + ^10; x - ^10; x * ^10; x / ^10; x % ^10;
})cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int"));
Code = R"cpp(
void test(float x) {
x = ^10;
x += ^10; x -= ^10; x *= ^10; x /= ^10; x %= ^10;
x + ^10; x - ^10; x * ^10; x / ^10; x % ^10;
})cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("float"));
// Pointer types.
Code = R"cpp(
void test(int *ptr) {
ptr - ^ptr;
ptr = ^ptr;
})cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int *"));
Code = R"cpp(
void test(int *ptr) {
ptr + ^10;
ptr += ^10;
ptr -= ^10;
})cpp";
{
std::string PtrDiff;
auto Types = collectPreferredTypes(Code, &PtrDiff);
EXPECT_THAT(Types, Each(PtrDiff));
}
// Comparison operators.
Code = R"cpp(
void test(int i) {
i <= ^1; i < ^1; i >= ^1; i > ^1; i == ^1; i != ^1;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int"));
Code = R"cpp(
void test(int *ptr) {
ptr <= ^ptr; ptr < ^ptr; ptr >= ^ptr; ptr > ^ptr;
ptr == ^ptr; ptr != ^ptr;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int *"));
// Relational operations.
Code = R"cpp(
void test(int i, int *ptr) {
i && ^1; i || ^1;
ptr && ^1; ptr || ^1;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("_Bool"));
// Bitwise operations.
Code = R"cpp(
void test(long long ll) {
ll | ^1; ll & ^1;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("long long"));
Code = R"cpp(
enum A {};
void test(A a) {
a | ^1; a & ^1;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("A"));
Code = R"cpp(
enum class A {};
void test(A a) {
// This is technically illegal with the 'enum class' without overloaded
// operators, but we pretend it's fine.
a | ^a; a & ^a;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("A"));
// Binary shifts.
Code = R"cpp(
void test(int i, long long ll) {
i << ^1; ll << ^1;
i <<= ^1; i <<= ^1;
i >> ^1; ll >> ^1;
i >>= ^1; i >>= ^1;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int"));
// Comma does not provide any useful information.
Code = R"cpp(
class Cls {};
void test(int i, int* ptr, Cls x) {
(i, ^i);
(ptr, ^ptr);
(x, ^x);
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("NULL TYPE"));
// User-defined types do not take operator overloading into account.
// However, they provide heuristics for some common cases.
Code = R"cpp(
class Cls {};
void test(Cls c) {
// we assume arithmetic and comparions ops take the same type.
c + ^c; c - ^c; c * ^c; c / ^c; c % ^c;
c == ^c; c != ^c; c < ^c; c <= ^c; c > ^c; c >= ^c;
// same for the assignments.
c = ^c; c += ^c; c -= ^c; c *= ^c; c /= ^c; c %= ^c;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("Cls"));
Code = R"cpp(
class Cls {};
void test(Cls c) {
// we assume relational ops operate on bools.
c && ^c; c || ^c;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("_Bool"));
Code = R"cpp(
class Cls {};
void test(Cls c) {
// we make no assumptions about the following operators, since they are
// often overloaded with a non-standard meaning.
c << ^c; c >> ^c; c | ^c; c & ^c;
c <<= ^c; c >>= ^c; c |= ^c; c &= ^c;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("NULL TYPE"));
}
TEST(PreferredTypeTest, Members) {
StringRef Code = R"cpp(
struct vector {
int *begin();
vector clone();
};
void test(int *a) {
a = ^vector().^clone().^begin();
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int *"));
}
TEST(PreferredTypeTest, Conditions) {
StringRef Code = R"cpp(
struct vector {
bool empty();
};
void test() {
if (^vector().^empty()) {}
while (^vector().^empty()) {}
for (; ^vector().^empty();) {}
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("_Bool"));
}
TEST(PreferredTypeTest, InitAndAssignment) {
StringRef Code = R"cpp(
struct vector {
int* begin();
};
void test() {
const int* x = ^vector().^begin();
x = ^vector().^begin();
if (const int* y = ^vector().^begin()) {}
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("const int *"));
}
TEST(PreferredTypeTest, UnaryExprs) {
StringRef Code = R"cpp(
void test(long long a) {
a = +^a;
a = -^a
a = ++^a;
a = --^a;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("long long"));
Code = R"cpp(
void test(int a, int *ptr) {
!^a;
!^ptr;
!!!^a;
a = !^a;
a = !^ptr;
a = !!!^a;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("_Bool"));
Code = R"cpp(
void test(int a) {
const int* x = &^a;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("const int"));
Code = R"cpp(
void test(int *a) {
int x = *^a;
int &r = *^a;
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("int *"));
Code = R"cpp(
void test(int a) {
*^a;
&^a;
}
)cpp";
}
TEST(PreferredTypeTest, ParenExpr) {
StringRef Code = R"cpp(
const int *i = ^(^(^(^10)));
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("const int *"));
}
TEST(PreferredTypeTest, FunctionArguments) {
StringRef Code = R"cpp(
void foo(const int*);
void bar(const int*);
void bar(const int*, int b);
struct vector {
const int *data();
};
void test() {
foo(^(^(^(^vec^tor^().^da^ta^()))));
bar(^(^(^(^vec^tor^().^da^ta^()))));
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("const int *"));
Code = R"cpp(
void bar(int, volatile double *);
void bar(int, volatile double *, int, int);
struct vector {
double *data();
};
struct class_members {
void bar(int, volatile double *);
void bar(int, volatile double *, int, int);
};
void test() {
bar(10, ^(^(^(^vec^tor^().^da^ta^()))));
class_members().bar(10, ^(^(^(^vec^tor^().^da^ta^()))));
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("volatile double *"));
Code = R"cpp(
namespace ns {
struct vector {
};
}
void accepts_vector(ns::vector);
void test() {
accepts_vector(^::^ns::^vector());
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("ns::vector"));
Code = R"cpp(
template <class T>
struct vector { using self = vector; };
void accepts_vector(vector<int>);
int foo(int);
void test() {
accepts_vector(^::^vector<decltype(foo(1))>::^self);
}
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("vector<int>"));
}
TEST(PreferredTypeTest, NoCrashOnInvalidTypes) {
StringRef Code = R"cpp(
auto x = decltype(&1)(^);
auto y = new decltype(&1)(^);
// GNU decimal type extension is not supported in clang.
auto z = new _Decimal128(^);
void foo() { (void)(foo)(^); }
)cpp";
EXPECT_THAT(collectPreferredTypes(Code), Each("NULL TYPE"));
}
} // namespace
|