clang-tools 23.0.0git
CodeCompleteTests.cpp
Go to the documentation of this file.
1//===-- CodeCompleteTests.cpp -----------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "ASTSignals.h"
10#include "Annotations.h"
11#include "ClangdServer.h"
12#include "CodeComplete.h"
13#include "Compiler.h"
14#include "Config.h"
15#include "Feature.h"
16#include "Matchers.h"
17#include "Protocol.h"
18#include "Quality.h"
19#include "SourceCode.h"
20#include "SyncAPI.h"
21#include "TestFS.h"
22#include "TestIndex.h"
23#include "TestTU.h"
24#include "index/Index.h"
25#include "index/MemIndex.h"
26#include "index/SymbolOrigin.h"
27#include "support/Threading.h"
28#include "clang/Sema/CodeCompleteConsumer.h"
29#include "clang/Tooling/CompilationDatabase.h"
30#include "llvm/ADT/StringRef.h"
31#include "llvm/Support/Error.h"
32#include "llvm/Support/Path.h"
33#include "llvm/Testing/Annotations/Annotations.h"
34#include "llvm/Testing/Support/Error.h"
35#include "llvm/Testing/Support/SupportHelpers.h"
36#include "gmock/gmock.h"
37#include "gtest/gtest.h"
38#include <condition_variable>
39#include <functional>
40#include <mutex>
41#include <vector>
42
43namespace clang {
44namespace clangd {
45
46namespace {
47using ::llvm::Failed;
48using ::testing::AllOf;
49using ::testing::Contains;
50using ::testing::ElementsAre;
51using ::testing::Field;
52using ::testing::HasSubstr;
53using ::testing::IsEmpty;
54using ::testing::Not;
55using ::testing::UnorderedElementsAre;
56using ContextKind = CodeCompletionContext::Kind;
57
58// GMock helpers for matching completion items.
59MATCHER_P(named, Name, "") { return arg.Name == Name; }
60MATCHER_P(mainFileRefs, Refs, "") { return arg.MainFileRefs == Refs; }
61MATCHER_P(scopeRefs, Refs, "") { return arg.ScopeRefsInFile == Refs; }
62MATCHER_P(nameStartsWith, Prefix, "") {
63 return llvm::StringRef(arg.Name).starts_with(Prefix);
64}
65MATCHER_P(filterText, F, "") { return arg.FilterText == F; }
66MATCHER_P(scope, S, "") { return arg.Scope == S; }
67MATCHER_P(qualifier, Q, "") { return arg.RequiredQualifier == Q; }
68MATCHER_P(labeled, Label, "") {
69 return arg.RequiredQualifier + arg.Name + arg.Signature == Label;
70}
71MATCHER_P(sigHelpLabeled, Label, "") { return arg.label == Label; }
72MATCHER_P(kind, K, "") { return arg.Kind == K; }
73MATCHER_P(doc, D, "") {
74 return arg.Documentation && arg.Documentation->asPlainText() == D;
75}
76MATCHER_P(returnType, D, "") { return arg.ReturnType == D; }
77MATCHER_P(hasInclude, IncludeHeader, "") {
78 return !arg.Includes.empty() && arg.Includes[0].Header == IncludeHeader;
79}
80MATCHER_P(insertInclude, IncludeHeader, "") {
81 return !arg.Includes.empty() && arg.Includes[0].Header == IncludeHeader &&
82 bool(arg.Includes[0].Insertion);
83}
84MATCHER_P(insertIncludeText, InsertedText, "") {
85 return !arg.Includes.empty() && arg.Includes[0].Insertion &&
86 arg.Includes[0].Insertion->newText == InsertedText;
87}
88MATCHER(insertInclude, "") {
89 return !arg.Includes.empty() && bool(arg.Includes[0].Insertion);
90}
91MATCHER_P(snippetSuffix, Text, "") { return arg.SnippetSuffix == Text; }
92MATCHER_P(origin, OriginSet, "") { return arg.Origin == OriginSet; }
93MATCHER_P(signature, S, "") { return arg.Signature == S; }
94MATCHER_P(replacesRange, Range, "") {
95 return arg.CompletionTokenRange == Range;
96}
97
98// Shorthand for Contains(named(Name)).
99Matcher<const std::vector<CodeCompletion> &> has(std::string Name) {
100 return Contains(named(std::move(Name)));
101}
102Matcher<const std::vector<CodeCompletion> &> has(std::string Name,
104 return Contains(AllOf(named(std::move(Name)), kind(K)));
105}
106MATCHER(isDocumented, "") { return arg.Documentation.has_value(); }
107MATCHER(deprecated, "") { return arg.Deprecated; }
108
109std::unique_ptr<SymbolIndex> memIndex(std::vector<Symbol> Symbols) {
111 for (const auto &Sym : Symbols)
112 Slab.insert(Sym);
113 return MemIndex::build(std::move(Slab).build(), RefSlab(), RelationSlab());
114}
115
116// Runs code completion.
117// If IndexSymbols is non-empty, an index will be built and passed to opts.
118CodeCompleteResult completions(const TestTU &TU, Position Point,
119 std::vector<Symbol> IndexSymbols = {},
120 clangd::CodeCompleteOptions Opts = {}) {
121 std::unique_ptr<SymbolIndex> OverrideIndex;
122 if (!IndexSymbols.empty()) {
123 assert(!Opts.Index && "both Index and IndexSymbols given!");
124 OverrideIndex = memIndex(std::move(IndexSymbols));
125 Opts.Index = OverrideIndex.get();
126 }
127
128 MockFS FS;
129 auto Inputs = TU.inputs(FS);
130 IgnoreDiagnostics Diags;
131 auto CI = buildCompilerInvocation(Inputs, Diags);
132 if (!CI) {
133 ADD_FAILURE() << "Couldn't build CompilerInvocation";
134 return {};
135 }
136 auto Preamble = buildPreamble(testPath(TU.Filename), *CI, Inputs,
137 /*InMemory=*/true, /*Callback=*/nullptr);
138 return codeComplete(testPath(TU.Filename), Point, Preamble.get(), Inputs,
139 Opts);
140}
141
142// Runs code completion.
143CodeCompleteResult completions(llvm::StringRef Text,
144 std::vector<Symbol> IndexSymbols = {},
145 clangd::CodeCompleteOptions Opts = {},
146 PathRef FilePath = "foo.cpp") {
147 Annotations Test(Text);
148 auto TU = TestTU::withCode(Test.code());
149 // To make sure our tests for completiopns inside templates work on Windows.
150 TU.Filename = FilePath.str();
151 return completions(TU, Test.point(), std::move(IndexSymbols),
152 std::move(Opts));
153}
154
155// Runs code completion without the clang parser.
156CodeCompleteResult completionsNoCompile(llvm::StringRef Text,
157 std::vector<Symbol> IndexSymbols = {},
158 clangd::CodeCompleteOptions Opts = {},
159 PathRef FilePath = "foo.cpp") {
160 std::unique_ptr<SymbolIndex> OverrideIndex;
161 if (!IndexSymbols.empty()) {
162 assert(!Opts.Index && "both Index and IndexSymbols given!");
163 OverrideIndex = memIndex(std::move(IndexSymbols));
164 Opts.Index = OverrideIndex.get();
165 }
166
167 MockFS FS;
168 Annotations Test(Text);
169 ParseInputs ParseInput{tooling::CompileCommand(), &FS, Test.code().str()};
170 return codeComplete(FilePath, Test.point(), /*Preamble=*/nullptr, ParseInput,
171 Opts);
172}
173
174Symbol withReferences(int N, Symbol S) {
175 S.References = N;
176 return S;
177}
178
179#if CLANGD_DECISION_FOREST
180TEST(DecisionForestRankingModel, NameMatchSanityTest) {
181 clangd::CodeCompleteOptions Opts;
182 Opts.RankingModel = CodeCompleteOptions::DecisionForest;
183 auto Results = completions(
184 R"cpp(
185struct MemberAccess {
186 int ABG();
187 int AlphaBetaGamma();
188};
189int func() { MemberAccess().ABG^ }
190)cpp",
191 /*IndexSymbols=*/{}, Opts);
192 EXPECT_THAT(Results.Completions,
193 ElementsAre(named("ABG"), named("AlphaBetaGamma")));
194}
195
196TEST(DecisionForestRankingModel, ReferencesAffectRanking) {
197 clangd::CodeCompleteOptions Opts;
198 Opts.RankingModel = CodeCompleteOptions::DecisionForest;
199 constexpr int NumReferences = 100000;
200 EXPECT_THAT(
201 completions("int main() { clang^ }",
202 {ns("clangA"), withReferences(NumReferences, func("clangD"))},
203 Opts)
204 .Completions,
205 ElementsAre(named("clangD"), named("clangA")));
206 EXPECT_THAT(
207 completions("int main() { clang^ }",
208 {withReferences(NumReferences, ns("clangA")), func("clangD")},
209 Opts)
210 .Completions,
211 ElementsAre(named("clangA"), named("clangD")));
212}
213#endif // CLANGD_DECISION_FOREST
214
215TEST(DecisionForestRankingModel, DecisionForestScorerCallbackTest) {
216 clangd::CodeCompleteOptions Opts;
217 constexpr float MagicNumber = 1234.5678f;
218 Opts.RankingModel = CodeCompleteOptions::DecisionForest;
219 Opts.DecisionForestScorer = [&](const SymbolQualitySignals &,
220 const SymbolRelevanceSignals &, float Base) {
222 Scores.Total = MagicNumber;
223 Scores.ExcludingName = MagicNumber;
224 return Scores;
225 };
226 llvm::StringRef Code = "int func() { int xyz; xy^ }";
227 auto Results = completions(Code,
228 /*IndexSymbols=*/{}, Opts);
229 ASSERT_EQ(Results.Completions.size(), 1u);
230 EXPECT_EQ(Results.Completions[0].Score.Total, MagicNumber);
231 EXPECT_EQ(Results.Completions[0].Score.ExcludingName, MagicNumber);
232
233 // Do not use DecisionForestScorer for heuristics model.
234 Opts.RankingModel = CodeCompleteOptions::Heuristics;
235 Results = completions(Code,
236 /*IndexSymbols=*/{}, Opts);
237 ASSERT_EQ(Results.Completions.size(), 1u);
238 EXPECT_NE(Results.Completions[0].Score.Total, MagicNumber);
239 EXPECT_NE(Results.Completions[0].Score.ExcludingName, MagicNumber);
240}
241
242TEST(CompletionTest, Limit) {
243 clangd::CodeCompleteOptions Opts;
244 Opts.Limit = 2;
245 auto Results = completions(R"cpp(
246struct ClassWithMembers {
247 int AAA();
248 int BBB();
249 int CCC();
250};
251
252int main() { ClassWithMembers().^ }
253 )cpp",
254 /*IndexSymbols=*/{}, Opts);
255
256 EXPECT_TRUE(Results.HasMore);
257 EXPECT_THAT(Results.Completions, ElementsAre(named("AAA"), named("BBB")));
258}
259
260TEST(CompletionTest, Filter) {
261 std::string Body = R"cpp(
262 #define MotorCar
263 int Car;
264 struct S {
265 int FooBar;
266 int FooBaz;
267 int Qux;
268 };
269 )cpp";
270
271 // Only items matching the fuzzy query are returned.
272 EXPECT_THAT(completions(Body + "int main() { S().Foba^ }").Completions,
273 AllOf(has("FooBar"), has("FooBaz"), Not(has("Qux"))));
274
275 // Macros require prefix match, either from index or AST.
276 Symbol Sym = var("MotorCarIndex");
277 Sym.SymInfo.Kind = index::SymbolKind::Macro;
278 EXPECT_THAT(
279 completions(Body + "int main() { C^ }", {Sym}).Completions,
280 AllOf(has("Car"), Not(has("MotorCar")), Not(has("MotorCarIndex"))));
281 EXPECT_THAT(completions(Body + "int main() { M^ }", {Sym}).Completions,
282 AllOf(has("MotorCar"), has("MotorCarIndex")));
283}
284
285void testAfterDotCompletion(clangd::CodeCompleteOptions Opts) {
286 auto Results = completions(
287 R"cpp(
288 int global_var;
289
290 int global_func();
291
292 // Make sure this is not in preamble.
293 #define MACRO X
294
295 struct GlobalClass {};
296
297 struct ClassWithMembers {
298 /// doc for method.
299 int method();
300
301 int field;
302 private:
303 int private_field;
304 };
305
306 int test() {
307 struct LocalClass {};
308
309 /// doc for local_var.
310 int local_var;
311
312 ClassWithMembers().^
313 }
314 )cpp",
315 {cls("IndexClass"), var("index_var"), func("index_func")}, Opts);
316
317 EXPECT_TRUE(Results.RanParser);
318 // Class members. The only items that must be present in after-dot
319 // completion.
320 EXPECT_THAT(Results.Completions,
321 AllOf(has("method"), has("field"), Not(has("ClassWithMembers")),
322 Not(has("operator=")), Not(has("~ClassWithMembers"))));
323 EXPECT_IFF(Opts.IncludeIneligibleResults, Results.Completions,
324 has("private_field"));
325 // Global items.
326 EXPECT_THAT(
327 Results.Completions,
328 Not(AnyOf(has("global_var"), has("index_var"), has("global_func"),
329 has("global_func()"), has("index_func"), has("GlobalClass"),
330 has("IndexClass"), has("MACRO"), has("LocalClass"))));
331 // There should be no code patterns (aka snippets) in after-dot
332 // completion. At least there aren't any we're aware of.
333 EXPECT_THAT(Results.Completions,
334 Not(Contains(kind(CompletionItemKind::Snippet))));
335 // Check documentation.
336 EXPECT_THAT(Results.Completions, Contains(isDocumented()));
337}
338
339void testGlobalScopeCompletion(clangd::CodeCompleteOptions Opts) {
340 auto Results = completions(
341 R"cpp(
342 int global_var;
343 int global_func();
344
345 // Make sure this is not in preamble.
346 #define MACRO X
347
348 struct GlobalClass {};
349
350 struct ClassWithMembers {
351 /// doc for method.
352 int method();
353 };
354
355 int test() {
356 struct LocalClass {};
357
358 /// doc for local_var.
359 int local_var;
360
361 ^
362 }
363 )cpp",
364 {cls("IndexClass"), var("index_var"), func("index_func")}, Opts);
365
366 EXPECT_TRUE(Results.RanParser);
367 // Class members. Should never be present in global completions.
368 EXPECT_THAT(Results.Completions,
369 Not(AnyOf(has("method"), has("method()"), has("field"))));
370 // Global items.
371 EXPECT_THAT(Results.Completions,
372 AllOf(has("global_var"), has("index_var"), has("global_func"),
373 has("index_func" /* our fake symbol doesn't include () */),
374 has("GlobalClass"), has("IndexClass")));
375 // A macro.
376 EXPECT_THAT(Results.Completions, has("MACRO"));
377 // Local items. Must be present always.
378 EXPECT_THAT(Results.Completions,
379 AllOf(has("local_var"), has("LocalClass"),
380 Contains(kind(CompletionItemKind::Snippet))));
381 // Check documentation.
382 EXPECT_THAT(Results.Completions, Contains(isDocumented()));
383}
384
385TEST(CompletionTest, CompletionOptions) {
386 auto Test = [&](const clangd::CodeCompleteOptions &Opts) {
387 testAfterDotCompletion(Opts);
388 testGlobalScopeCompletion(Opts);
389 };
390 // We used to test every combination of options, but that got too slow (2^N).
391 auto Flags = {
392 &clangd::CodeCompleteOptions::IncludeIneligibleResults,
393 };
394 // Test default options.
395 Test({});
396 // Test with one flag flipped.
397 for (auto &F : Flags) {
398 clangd::CodeCompleteOptions O;
399 O.*F ^= true;
400 Test(O);
401 }
402}
403
404TEST(CompletionTest, Accessible) {
405 auto Internal = completions(R"cpp(
406 class Foo {
407 public: void pub();
408 protected: void prot();
409 private: void priv();
410 };
411 void Foo::pub() { this->^ }
412 )cpp");
413 EXPECT_THAT(Internal.Completions,
414 AllOf(has("priv"), has("prot"), has("pub")));
415
416 auto External = completions(R"cpp(
417 class Foo {
418 public: void pub();
419 protected: void prot();
420 private: void priv();
421 };
422 void test() {
423 Foo F;
424 F.^
425 }
426 )cpp");
427 EXPECT_THAT(External.Completions,
428 AllOf(has("pub"), Not(has("prot")), Not(has("priv"))));
429
430 auto Results = completions(R"cpp(
431 struct Foo {
432 public: void pub();
433 protected: void prot();
434 private: void priv();
435 };
436 struct Bar : public Foo {
437 private: using Foo::pub;
438 };
439 void test() {
440 Bar B;
441 B.^
442 }
443 )cpp");
444 EXPECT_THAT(Results.Completions,
445 AllOf(Not(has("priv")), Not(has("prot")), Not(has("pub"))));
446}
447
448TEST(CompletionTest, Qualifiers) {
449 auto Results = completions(R"cpp(
450 class Foo {
451 public: int foo() const;
452 int bar() const;
453 };
454 class Bar : public Foo {
455 int foo() const;
456 };
457 void test() { Bar().^ }
458 )cpp");
459 EXPECT_THAT(Results.Completions,
460 Contains(AllOf(qualifier(""), named("bar"))));
461 // Hidden members are not shown.
462 EXPECT_THAT(Results.Completions,
463 Not(Contains(AllOf(qualifier("Foo::"), named("foo")))));
464 // Private members are not shown.
465 EXPECT_THAT(Results.Completions,
466 Not(Contains(AllOf(qualifier(""), named("foo")))));
467}
468
469// https://github.com/clangd/clangd/issues/1451
470TEST(CompletionTest, QualificationWithInlineNamespace) {
471 auto Results = completions(R"cpp(
472 namespace a { inline namespace b {} }
473 using namespace a::b;
474 void f() { Foo^ }
475 )cpp",
476 {cls("a::Foo")});
477 EXPECT_THAT(Results.Completions,
478 UnorderedElementsAre(AllOf(qualifier("a::"), named("Foo"))));
479}
480
481TEST(CompletionTest, InjectedTypename) {
482 // These are suppressed when accessed as a member...
483 EXPECT_THAT(completions("struct X{}; void foo(){ X().^ }").Completions,
484 Not(has("X")));
485 EXPECT_THAT(completions("struct X{ void foo(){ this->^ } };").Completions,
486 Not(has("X")));
487 // ...but accessible in other, more useful cases.
488 EXPECT_THAT(completions("struct X{ void foo(){ ^ } };").Completions,
489 has("X"));
490 EXPECT_THAT(
491 completions("struct Y{}; struct X:Y{ void foo(){ ^ } };").Completions,
492 has("Y"));
493 EXPECT_THAT(
494 completions(
495 "template<class> struct Y{}; struct X:Y<int>{ void foo(){ ^ } };")
496 .Completions,
497 has("Y"));
498 // This case is marginal (`using X::X` is useful), we allow it for now.
499 EXPECT_THAT(completions("struct X{}; void foo(){ X::^ }").Completions,
500 has("X"));
501}
502
503TEST(CompletionTest, SkipInjectedWhenUnqualified) {
504 EXPECT_THAT(completions("struct X { void f() { X^ }};").Completions,
505 ElementsAre(named("X"), named("~X")));
506}
507
508TEST(CompletionTest, Snippets) {
509 clangd::CodeCompleteOptions Opts;
510 auto Results = completions(
511 R"cpp(
512 struct fake {
513 int a;
514 int f(int i, const float f) const;
515 };
516 int main() {
517 fake f;
518 f.^
519 }
520 )cpp",
521 /*IndexSymbols=*/{}, Opts);
522 EXPECT_THAT(
523 Results.Completions,
524 HasSubsequence(named("a"),
525 snippetSuffix("(${1:int i}, ${2:const float f})")));
526}
527
528TEST(CompletionTest, HeuristicsForMemberFunctionCompletion) {
529 clangd::CodeCompleteOptions Opts;
530 Opts.EnableSnippets = true;
531
532 Annotations Code(R"cpp(
533 struct Foo {
534 static int staticMethod(int name);
535 int method(int name) const;
536 template <typename T, typename U, typename V = int>
537 T generic(U nameU, V nameV);
538 template <typename T, int U>
539 static T staticGeneric();
540 Foo() {
541 this->$canBeCallNoStatic^
542 $canBeCall^
543 Foo::$canBeCall^
544 }
545 };
546
547 int Foo::$isDefinition^ {
548 }
549 ;
550
551 int i = Foo::$canBeCallStaticOnly^
552 ;
553
554 struct Derived : Foo {
555 using Foo::method;
556 using Foo::generic;
557 Derived() {
558 Foo::$canBeCall^
559 }
560 };
561
562 struct OtherClass {
563 OtherClass() {
564 Foo f;
565 Derived d;
566 f.$canBeCallNoStatic^
567 ; // Prevent parsing as 'f.f'
568 f.Foo::$canBeCall^
569 ;
570 &Foo::$canNotBeCall^
571 ;
572 d.Foo::$canBeCall^
573 ;
574 d.Derived::$canBeCall^
575 }
576 };
577
578 int main() {
579 Foo f;
580 Derived d;
581 f.$canBeCall^
582 ; // Prevent parsing as 'f.f'
583 f.Foo::$canBeCall^
584 ;
585 &Foo::$canNotBeCall^
586 ;
587 d.Foo::$canBeCall^
588 ;
589 d.Derived::$canBeCall^
590 }
591 )cpp");
592 auto TU = TestTU::withCode(Code.code());
593
594 for (const auto &P : Code.points("canNotBeCall")) {
595 auto Results = completions(TU, P, /*IndexSymbols*/ {}, Opts);
596 EXPECT_THAT(Results.Completions,
597 Contains(AllOf(named("method"), signature("(int name) const"),
598 snippetSuffix(""))));
599 // We don't have any arguments to deduce against if this isn't a call.
600 EXPECT_THAT(
601 Results.Completions,
602 Contains(AllOf(named("generic"),
603 signature("<typename T, typename U>(U nameU, V nameV)"),
604 snippetSuffix("<${1:typename T}, ${2:typename U}>"))));
605 EXPECT_THAT(Results.Completions,
606 Contains(AllOf(named("staticMethod"), signature("(int name)"),
607 snippetSuffix(""))));
608 EXPECT_THAT(Results.Completions,
609 Contains(AllOf(
610 named("staticGeneric"), signature("<typename T, int U>()"),
611 snippetSuffix("<${1:typename T}, ${2:int U}>"))));
612 }
613
614 for (const auto &P : Code.points("canBeCall")) {
615 auto Results = completions(TU, P, /*IndexSymbols*/ {}, Opts);
616 EXPECT_THAT(Results.Completions,
617 Contains(AllOf(named("method"), signature("(int name) const"),
618 snippetSuffix("(${1:int name})"))));
619 EXPECT_THAT(
620 Results.Completions,
621 Contains(AllOf(
622 named("generic"), signature("<typename T>(U nameU, V nameV)"),
623 snippetSuffix("<${1:typename T}>(${2:U nameU}, ${3:V nameV})"))));
624 EXPECT_THAT(Results.Completions,
625 Contains(AllOf(named("staticMethod"), signature("(int name)"),
626 snippetSuffix("(${1:int name})"))));
627 EXPECT_THAT(Results.Completions,
628 Contains(AllOf(
629 named("staticGeneric"), signature("<typename T, int U>()"),
630 snippetSuffix("<${1:typename T}, ${2:int U}>()"))));
631 }
632
633 for (const auto &P : Code.points("canBeCallNoStatic")) {
634 auto Results = completions(TU, P, /*IndexSymbols*/ {}, Opts);
635 EXPECT_THAT(Results.Completions,
636 Contains(AllOf(named("method"), signature("(int name) const"),
637 snippetSuffix("(${1:int name})"))));
638 EXPECT_THAT(
639 Results.Completions,
640 Contains(AllOf(
641 named("generic"), signature("<typename T>(U nameU, V nameV)"),
642 snippetSuffix("<${1:typename T}>(${2:U nameU}, ${3:V nameV})"))));
643 }
644
645 for (const auto &P : Code.points("canBeCallStaticOnly")) {
646 auto Results = completions(TU, P, /*IndexSymbols*/ {}, Opts);
647 EXPECT_THAT(Results.Completions,
648 Contains(AllOf(named("method"), signature("(int name) const"),
649 snippetSuffix(""))));
650 EXPECT_THAT(
651 Results.Completions,
652 Contains(AllOf(named("generic"),
653 signature("<typename T, typename U>(U nameU, V nameV)"),
654 snippetSuffix("<${1:typename T}, ${2:typename U}>"))));
655 EXPECT_THAT(Results.Completions,
656 Contains(AllOf(named("staticMethod"), signature("(int name)"),
657 snippetSuffix("(${1:int name})"))));
658 EXPECT_THAT(Results.Completions,
659 Contains(AllOf(
660 named("staticGeneric"), signature("<typename T, int U>()"),
661 snippetSuffix("<${1:typename T}, ${2:int U}>()"))));
662 }
663
664 for (const auto &P : Code.points("isDefinition")) {
665 auto Results = completions(TU, P, /*IndexSymbols*/ {}, Opts);
666
667 EXPECT_THAT(Results.Completions,
668 Contains(AllOf(named("method"), signature("(int name) const"),
669 snippetSuffix("(int name) const"))));
670 EXPECT_THAT(
671 Results.Completions,
672 Contains(AllOf(named("generic"),
673 signature("<typename T, typename U>(U nameU, V nameV)"),
674 snippetSuffix("(U nameU, V nameV)"))));
675 EXPECT_THAT(Results.Completions,
676 Contains(AllOf(named("staticMethod"), signature("(int name)"),
677 snippetSuffix("(int name)"))));
678 EXPECT_THAT(Results.Completions,
679 Contains(AllOf(named("staticGeneric"),
680 signature("<typename T, int U>()"),
681 snippetSuffix("()"))));
682 }
683}
684
685TEST(CompletionTest, PrivateMemberDefinition) {
686 clangd::CodeCompleteOptions Opts;
687 Opts.EnableSnippets = true;
688 auto Results = completions(
689 R"cpp(
690 class Foo {
691 int func(int a, int b);
692 };
693 int Foo::func^
694 )cpp",
695 /*IndexSymbols=*/{}, Opts);
696 EXPECT_THAT(Results.Completions,
697 Contains(AllOf(named("func"), signature("(int a, int b)"),
698 snippetSuffix("(int a, int b)"))));
699}
700
701TEST(CompletionTest, DefaultArgsWithValues) {
702 clangd::CodeCompleteOptions Opts;
703 Opts.EnableSnippets = true;
704 auto Results = completions(
705 R"cpp(
706 struct Arg {
707 Arg(int a, int b);
708 };
709 struct Foo {
710 void foo(int x = 42, int y = 0, Arg arg = Arg(42, 0));
711 };
712 void Foo::foo^
713 )cpp",
714 /*IndexSymbols=*/{}, Opts);
715 EXPECT_THAT(Results.Completions,
716 Contains(AllOf(
717 named("foo"),
718 signature("(int x = 42, int y = 0, Arg arg = Arg(42, 0))"),
719 snippetSuffix("(int x, int y, Arg arg)"))));
720}
721
722TEST(CompletionTest, NoSnippetsInUsings) {
723 clangd::CodeCompleteOptions Opts;
724 Opts.EnableSnippets = true;
725 auto Results = completions(
726 R"cpp(
727 namespace ns {
728 int func(int a, int b);
729 }
730
731 using ns::^;
732 )cpp",
733 /*IndexSymbols=*/{}, Opts);
734 EXPECT_THAT(Results.Completions,
735 ElementsAre(AllOf(named("func"), labeled("func(int a, int b)"),
736 snippetSuffix(""))));
737
738 // Check index completions too.
739 auto Func = func("ns::func");
740 Func.CompletionSnippetSuffix = "(${1:int a}, ${2: int b})";
741 Func.Signature = "(int a, int b)";
742 Func.ReturnType = "void";
743
744 Results = completions(R"cpp(
745 namespace ns {}
746 using ns::^;
747 )cpp",
748 /*IndexSymbols=*/{Func}, Opts);
749 EXPECT_THAT(Results.Completions,
750 ElementsAre(AllOf(named("func"), labeled("func(int a, int b)"),
751 snippetSuffix(""))));
752
753 // Check all-scopes completions too.
754 Opts.AllScopes = true;
755 Results = completions(R"cpp(
756 using ^;
757 )cpp",
758 /*IndexSymbols=*/{Func}, Opts);
759 EXPECT_THAT(Results.Completions,
760 Contains(AllOf(named("func"), labeled("ns::func(int a, int b)"),
761 snippetSuffix(""))));
762}
763
764TEST(CompletionTest, Kinds) {
765 auto Results = completions(
766 R"cpp(
767 int variable;
768 struct Struct {};
769 int function();
770 // make sure MACRO is not included in preamble.
771 #define MACRO 10
772 int X = ^
773 )cpp",
774 {func("indexFunction"), var("indexVariable"), cls("indexClass"),
775 macro("indexObjMacro"), macro("indexFuncMacro", "(x, y)")});
776 EXPECT_THAT(Results.Completions,
777 AllOf(has("function", CompletionItemKind::Function),
778 has("variable", CompletionItemKind::Variable),
779 has("int", CompletionItemKind::Keyword),
780 has("Struct", CompletionItemKind::Struct),
781 has("MACRO", CompletionItemKind::Constant),
782 has("indexFunction", CompletionItemKind::Function),
783 has("indexVariable", CompletionItemKind::Variable),
784 has("indexClass", CompletionItemKind::Class),
785 has("indexObjMacro", CompletionItemKind::Constant),
786 has("indexFuncMacro", CompletionItemKind::Function)));
787
788 Results = completions("nam^");
789 EXPECT_THAT(Results.Completions,
790 has("namespace", CompletionItemKind::Snippet));
791
792 // Members of anonymous unions are of kind 'field'.
793 Results = completions(
794 R"cpp(
795 struct X{
796 union {
797 void *a;
798 };
799 };
800 auto u = X().^
801 )cpp");
802 EXPECT_THAT(
803 Results.Completions,
804 UnorderedElementsAre(AllOf(named("a"), kind(CompletionItemKind::Field))));
805
806 // Completion kinds for templates should not be unknown.
807 Results = completions(
808 R"cpp(
809 template <class T> struct complete_class {};
810 template <class T> void complete_function();
811 template <class T> using complete_type_alias = int;
812 template <class T> int complete_variable = 10;
813
814 struct X {
815 template <class T> static int complete_static_member = 10;
816
817 static auto x = complete_^
818 }
819 )cpp");
820 EXPECT_THAT(
821 Results.Completions,
822 UnorderedElementsAre(
823 AllOf(named("complete_class"), kind(CompletionItemKind::Class)),
824 AllOf(named("complete_function"), kind(CompletionItemKind::Function)),
825 AllOf(named("complete_type_alias"),
827 AllOf(named("complete_variable"), kind(CompletionItemKind::Variable)),
828 AllOf(named("complete_static_member"),
830
831 Results = completions(
832 R"cpp(
833 enum Color {
834 Red
835 };
836 Color u = ^
837 )cpp");
838 EXPECT_THAT(
839 Results.Completions,
840 Contains(AllOf(named("Red"), kind(CompletionItemKind::EnumMember))));
841}
842
843TEST(CompletionTest, NoDuplicates) {
844 auto Results = completions(
845 R"cpp(
846 class Adapter {
847 };
848
849 void f() {
850 Adapter^
851 }
852 )cpp",
853 {cls("Adapter")});
854
855 // Make sure there are no duplicate entries of 'Adapter'.
856 EXPECT_THAT(Results.Completions, ElementsAre(named("Adapter")));
857}
858
859TEST(CompletionTest, ScopedNoIndex) {
860 auto Results = completions(
861 R"cpp(
862 namespace fake { int BigBang, Babble, Box; };
863 int main() { fake::ba^ }
864 ")cpp");
865 // Babble is a better match than BigBang. Box doesn't match at all.
866 EXPECT_THAT(Results.Completions,
867 ElementsAre(named("Babble"), named("BigBang")));
868}
869
870TEST(CompletionTest, Scoped) {
871 auto Results = completions(
872 R"cpp(
873 namespace fake { int Babble, Box; };
874 int main() { fake::ba^ }
875 ")cpp",
876 {var("fake::BigBang")});
877 EXPECT_THAT(Results.Completions,
878 ElementsAre(named("Babble"), named("BigBang")));
879}
880
881TEST(CompletionTest, ScopedWithFilter) {
882 auto Results = completions(
883 R"cpp(
884 void f() { ns::x^ }
885 )cpp",
886 {cls("ns::XYZ"), func("ns::foo")});
887 EXPECT_THAT(Results.Completions, UnorderedElementsAre(named("XYZ")));
888}
889
890TEST(CompletionTest, ReferencesAffectRanking) {
891 EXPECT_THAT(completions("int main() { abs^ }", {func("absA"), func("absB")})
892 .Completions,
893 HasSubsequence(named("absA"), named("absB")));
894 EXPECT_THAT(completions("int main() { abs^ }",
895 {func("absA"), withReferences(1000, func("absB"))})
896 .Completions,
897 HasSubsequence(named("absB"), named("absA")));
898}
899
900TEST(CompletionTest, ContextWords) {
901 auto Results = completions(R"cpp(
902 enum class Color { RED, YELLOW, BLUE };
903
904 // (blank lines so the definition above isn't "context")
905
906 // "It was a yellow car," he said. "Big yellow car, new."
907 auto Finish = Color::^
908 )cpp");
909 // Yellow would normally sort last (alphabetic).
910 // But the recent mention should bump it up.
911 ASSERT_THAT(Results.Completions,
912 HasSubsequence(named("YELLOW"), named("BLUE")));
913}
914
915TEST(CompletionTest, GlobalQualified) {
916 auto Results = completions(
917 R"cpp(
918 void f() { ::^ }
919 )cpp",
920 {cls("XYZ")});
921 EXPECT_THAT(Results.Completions,
922 AllOf(has("XYZ", CompletionItemKind::Class),
924}
925
926TEST(CompletionTest, FullyQualified) {
927 auto Results = completions(
928 R"cpp(
929 namespace ns { void bar(); }
930 void f() { ::ns::^ }
931 )cpp",
932 {cls("ns::XYZ")});
933 EXPECT_THAT(Results.Completions,
934 AllOf(has("XYZ", CompletionItemKind::Class),
935 has("bar", CompletionItemKind::Function)));
936}
937
938TEST(CompletionTest, SemaIndexMerge) {
939 auto Results = completions(
940 R"cpp(
941 namespace ns { int local; void both(); }
942 void f() { ::ns::^ }
943 )cpp",
944 {func("ns::both"), cls("ns::Index")});
945 // We get results from both index and sema, with no duplicates.
946 EXPECT_THAT(Results.Completions,
947 UnorderedElementsAre(
948 AllOf(named("local"), origin(SymbolOrigin::AST)),
949 AllOf(named("Index"), origin(SymbolOrigin::Static)),
950 AllOf(named("both"),
952}
953
954TEST(CompletionTest, SemaIndexMergeWithLimit) {
955 clangd::CodeCompleteOptions Opts;
956 Opts.Limit = 1;
957 auto Results = completions(
958 R"cpp(
959 namespace ns { int local; void both(); }
960 void f() { ::ns::^ }
961 )cpp",
962 {func("ns::both"), cls("ns::Index")}, Opts);
963 EXPECT_EQ(Results.Completions.size(), Opts.Limit);
964 EXPECT_TRUE(Results.HasMore);
965}
966
967TEST(CompletionTest, IncludeInsertionPreprocessorIntegrationTests) {
968 TestTU TU;
969 TU.ExtraArgs.push_back("-I" + testPath("sub"));
970 TU.AdditionalFiles["sub/bar.h"] = "";
971 auto BarURI = URI::create(testPath("sub/bar.h")).toString();
972
973 Symbol Sym = cls("ns::X");
974 Sym.CanonicalDeclaration.FileURI = BarURI.c_str();
975 Sym.IncludeHeaders.emplace_back(BarURI, 1, Symbol::Include);
976 // Shorten include path based on search directory and insert.
977 Annotations Test("int main() { ns::^ }");
978 TU.Code = Test.code().str();
979 auto Results = completions(TU, Test.point(), {Sym});
980 EXPECT_THAT(Results.Completions,
981 ElementsAre(AllOf(named("X"), insertInclude("\"bar.h\""))));
982 // Can be disabled via option.
983 CodeCompleteOptions NoInsertion;
984 NoInsertion.InsertIncludes = Config::HeaderInsertionPolicy::NeverInsert;
985 Results = completions(TU, Test.point(), {Sym}, NoInsertion);
986 EXPECT_THAT(Results.Completions,
987 ElementsAre(AllOf(named("X"), Not(insertInclude()))));
988 // Duplicate based on inclusions in preamble.
989 Test = Annotations(R"cpp(
990 #include "sub/bar.h" // not shortest, so should only match resolved.
991 int main() { ns::^ }
992 )cpp");
993 TU.Code = Test.code().str();
994 Results = completions(TU, Test.point(), {Sym});
995 EXPECT_THAT(Results.Completions, ElementsAre(AllOf(named("X"), labeled("X"),
996 Not(insertInclude()))));
997}
998
999TEST(CompletionTest, NoIncludeInsertionWhenDeclFoundInFile) {
1000 Symbol SymX = cls("ns::X");
1001 Symbol SymY = cls("ns::Y");
1002 std::string BarHeader = testPath("bar.h");
1003 auto BarURI = URI::create(BarHeader).toString();
1004 SymX.CanonicalDeclaration.FileURI = BarURI.c_str();
1005 SymY.CanonicalDeclaration.FileURI = BarURI.c_str();
1006 SymX.IncludeHeaders.emplace_back("<bar>", 1, Symbol::Include);
1007 SymY.IncludeHeaders.emplace_back("<bar>", 1, Symbol::Include);
1008 // Shorten include path based on search directory and insert.
1009 auto Results = completions(R"cpp(
1010 namespace ns {
1011 class X;
1012 class Y {};
1013 }
1014 int main() { ns::^ }
1015 )cpp",
1016 {SymX, SymY});
1017 EXPECT_THAT(Results.Completions,
1018 ElementsAre(AllOf(named("X"), Not(insertInclude())),
1019 AllOf(named("Y"), Not(insertInclude()))));
1020}
1021
1022TEST(CompletionTest, IncludeInsertionRespectsQuotedAngledConfig) {
1023 TestTU TU;
1024 TU.ExtraArgs.push_back("-I" + testPath("sub"));
1025 TU.AdditionalFiles["sub/bar.h"] = "";
1026 auto BarURI = URI::create(testPath("sub/bar.h")).toString();
1027
1028 Symbol Sym = cls("ns::X");
1029 Sym.CanonicalDeclaration.FileURI = BarURI.c_str();
1030 Sym.IncludeHeaders.emplace_back(BarURI, 1, Symbol::Include);
1031 Annotations Test("int main() { ns::^ }");
1032 TU.Code = Test.code().str();
1033 auto Results = completions(TU, Test.point(), {Sym});
1034 // Default for a local path is quoted include
1035 EXPECT_THAT(Results.Completions,
1036 ElementsAre(AllOf(named("X"), insertInclude("\"bar.h\""))));
1037 {
1038 Config C;
1039 C.Style.AngledHeaders.push_back(
1040 [](auto header) { return header.contains("bar.h"); });
1041 WithContextValue WithCfg(Config::Key, std::move(C));
1042 Results = completions(TU, Test.point(), {Sym});
1043 EXPECT_THAT(Results.Completions,
1044 ElementsAre(AllOf(named("X"), insertInclude("<bar.h>"))));
1045 }
1046 {
1047 Config C;
1048 C.Style.QuotedHeaders.push_back(
1049 [](auto header) { return header.contains("bar.h"); });
1050 WithContextValue WithCfg(Config::Key, std::move(C));
1051 Results = completions(TU, Test.point(), {Sym});
1052 EXPECT_THAT(Results.Completions,
1053 ElementsAre(AllOf(named("X"), insertInclude("\"bar.h\""))));
1054 }
1055}
1056
1057TEST(CompletionTest, IndexSuppressesPreambleCompletions) {
1058 Annotations Test(R"cpp(
1059 #include "bar.h"
1060 namespace ns { int local; }
1061 void f() { ns::^; }
1062 void f2() { ns::preamble().$2^; }
1063 )cpp");
1064 auto TU = TestTU::withCode(Test.code());
1065 TU.AdditionalFiles["bar.h"] =
1066 R"cpp(namespace ns { struct preamble { int member; }; })cpp";
1067
1068 clangd::CodeCompleteOptions Opts = {};
1069 auto I = memIndex({var("ns::index")});
1070 Opts.Index = I.get();
1071 auto WithIndex = completions(TU, Test.point(), {}, Opts);
1072 EXPECT_THAT(WithIndex.Completions,
1073 UnorderedElementsAre(named("local"), named("index")));
1074 auto ClassFromPreamble = completions(TU, Test.point("2"), {}, Opts);
1075 EXPECT_THAT(ClassFromPreamble.Completions, Contains(named("member")));
1076
1077 Opts.Index = nullptr;
1078 auto WithoutIndex = completions(TU, Test.point(), {}, Opts);
1079 EXPECT_THAT(WithoutIndex.Completions,
1080 UnorderedElementsAre(named("local"), named("preamble")));
1081}
1082
1083// This verifies that we get normal preprocessor completions in the preamble.
1084// This is a regression test for an old bug: if we override the preamble and
1085// try to complete inside it, clang kicks our completion point just outside the
1086// preamble, resulting in always getting top-level completions.
1087TEST(CompletionTest, CompletionInPreamble) {
1088 auto Results = completions(R"cpp(
1089 #ifnd^ef FOO_H_
1090 #define BAR_H_
1091 #include <bar.h>
1092 int foo() {}
1093 #endif
1094 )cpp")
1095 .Completions;
1096 EXPECT_THAT(Results, ElementsAre(named("ifndef")));
1097}
1098
1099TEST(CompletionTest, CompletionRecoveryASTType) {
1100 auto Results = completions(R"cpp(
1101 struct S { int member; };
1102 S overloaded(int);
1103 void foo() {
1104 // No overload matches, but we have recovery-expr with the correct type.
1105 overloaded().^
1106 })cpp")
1107 .Completions;
1108 EXPECT_THAT(Results, ElementsAre(named("member")));
1109}
1110
1111TEST(CompletionTest, DynamicIndexIncludeInsertion) {
1112 MockFS FS;
1115 Opts.BuildDynamicSymbolIndex = true;
1116 ClangdServer Server(CDB, FS, Opts);
1117
1118 FS.Files[testPath("foo_header.h")] = R"cpp(
1119 #pragma once
1120 struct Foo {
1121 // Member doc
1122 int foo();
1123 };
1124 )cpp";
1125 const std::string FileContent(R"cpp(
1126 #include "foo_header.h"
1127 int Foo::foo() {
1128 return 42;
1129 }
1130 )cpp");
1131 Server.addDocument(testPath("foo_impl.cpp"), FileContent);
1132 // Wait for the dynamic index being built.
1133 ASSERT_TRUE(Server.blockUntilIdleForTest());
1134
1135 auto File = testPath("foo.cpp");
1136 Annotations Test("Foo^ foo;");
1137 runAddDocument(Server, File, Test.code());
1138 auto CompletionList =
1139 llvm::cantFail(runCodeComplete(Server, File, Test.point(), {}));
1140
1141 EXPECT_THAT(CompletionList.Completions,
1142 ElementsAre(AllOf(named("Foo"), hasInclude("\"foo_header.h\""),
1143 insertInclude())));
1144}
1145
1146TEST(CompletionTest, DynamicIndexMultiFile) {
1147 MockFS FS;
1149 auto Opts = ClangdServer::optsForTest();
1150 Opts.BuildDynamicSymbolIndex = true;
1151 ClangdServer Server(CDB, FS, Opts);
1152
1153 FS.Files[testPath("foo.h")] = R"cpp(
1154 namespace ns { class XYZ {}; void foo(int x) {} }
1155 )cpp";
1156 runAddDocument(Server, testPath("foo.cpp"), R"cpp(
1157 #include "foo.h"
1158 )cpp");
1159
1160 auto File = testPath("bar.cpp");
1161 Annotations Test(R"cpp(
1162 namespace ns {
1163 class XXX {};
1164 /// Doooc
1165 void fooooo() {}
1166 }
1167 void f() { ns::^ }
1168 )cpp");
1169 runAddDocument(Server, File, Test.code());
1170
1171 auto Results = cantFail(runCodeComplete(Server, File, Test.point(), {}));
1172 // "XYZ" and "foo" are not included in the file being completed but are still
1173 // visible through the index.
1174 EXPECT_THAT(Results.Completions, has("XYZ", CompletionItemKind::Class));
1175 EXPECT_THAT(Results.Completions, has("foo", CompletionItemKind::Function));
1176 EXPECT_THAT(Results.Completions, has("XXX", CompletionItemKind::Class));
1177 EXPECT_THAT(Results.Completions,
1178 Contains((named("fooooo"), kind(CompletionItemKind::Function),
1179 doc("Doooc"), returnType("void"))));
1180}
1181
1182TEST(CompletionTest, Documentation) {
1183 auto Results = completions(
1184 R"cpp(
1185 // Non-doxygen comment.
1186 __attribute__((annotate("custom_annotation"))) int foo();
1187 /// Doxygen comment.
1188 /// \param int a
1189 int bar(int a);
1190 /* Multi-line
1191 block comment
1192 */
1193 int baz();
1194
1195 int x = ^
1196 )cpp");
1197 EXPECT_THAT(
1198 Results.Completions,
1199 Contains(
1200 AllOf(named("foo"),
1201 doc("Annotation: custom_annotation\n\nNon-doxygen comment."))));
1202 EXPECT_THAT(
1203 Results.Completions,
1204 Contains(AllOf(named("bar"), doc("Doxygen comment.\n\\param int a"))));
1205 EXPECT_THAT(Results.Completions,
1206 Contains(AllOf(named("baz"), doc("Multi-line block comment"))));
1207}
1208
1209TEST(CompletionTest, CommentsFromSystemHeaders) {
1210 MockFS FS;
1212
1213 auto Opts = ClangdServer::optsForTest();
1214 Opts.BuildDynamicSymbolIndex = true;
1215
1216 ClangdServer Server(CDB, FS, Opts);
1217
1218 FS.Files[testPath("foo.h")] = R"cpp(
1219 #pragma GCC system_header
1220
1221 // This comment should be retained!
1222 int foo();
1223 )cpp";
1224
1225 auto File = testPath("foo.cpp");
1226 Annotations Test(R"cpp(
1227#include "foo.h"
1228int x = foo^
1229 )cpp");
1230 runAddDocument(Server, File, Test.code());
1231 auto CompletionList =
1232 llvm::cantFail(runCodeComplete(Server, File, Test.point(), {}));
1233
1234 EXPECT_THAT(
1235 CompletionList.Completions,
1236 Contains(AllOf(named("foo"), doc("This comment should be retained!"))));
1237}
1238
1239TEST(CompletionTest, CommentsOnMembersFromHeader) {
1240 MockFS FS;
1242
1243 auto Opts = ClangdServer::optsForTest();
1244 Opts.BuildDynamicSymbolIndex = true;
1245
1246 ClangdServer Server(CDB, FS, Opts);
1247
1248 FS.Files[testPath("foo.h")] = R"cpp(
1249 struct alpha {
1250 /// This is a member field.
1251 int gamma;
1252
1253 /// This is a member function.
1254 int delta();
1255 };
1256
1257 template <typename T>
1258 struct beta {
1259 /// This is a member field inside a template.
1260 int omega;
1261
1262 /// This is a member function inside a template.
1263 int epsilon();
1264 };
1265 )cpp";
1266
1267 auto File = testPath("foo.cpp");
1268 Annotations Test(R"cpp(
1269#include "foo.h"
1270alpha a;
1271beta<int> b;
1272int x = a.$p1^;
1273int y = b.$p2^;
1274 )cpp");
1275 runAddDocument(Server, File, Test.code());
1276 auto CompletionList =
1277 llvm::cantFail(runCodeComplete(Server, File, Test.point("p1"), {}));
1278
1279 EXPECT_THAT(CompletionList.Completions,
1280 Contains(AllOf(named("gamma"), doc("This is a member field."))));
1281 EXPECT_THAT(
1282 CompletionList.Completions,
1283 Contains(AllOf(named("delta"), doc("This is a member function."))));
1284
1286 llvm::cantFail(runCodeComplete(Server, File, Test.point("p2"), {}));
1287
1288 EXPECT_THAT(CompletionList.Completions,
1289 Contains(AllOf(named("omega")
1290 /* FIXME: Doc retrieval does not work yet*/)));
1291 EXPECT_THAT(
1292 CompletionList.Completions,
1293 Contains(AllOf(named("epsilon"),
1294 doc("This is a member function inside a template."))));
1295}
1296
1297TEST(CompletionTest, CommentsOnMembersFromHeaderOverloadBundling) {
1298 using testing::AnyOf;
1299 MockFS FS;
1301
1302 auto Opts = ClangdServer::optsForTest();
1303 Opts.BuildDynamicSymbolIndex = true;
1304
1305 ClangdServer Server(CDB, FS, Opts);
1306
1307 FS.Files[testPath("foo.h")] = R"cpp(
1308 struct alpha {
1309 /// bool overload.
1310 int delta(bool b);
1311
1312 /// int overload.
1313 int delta(int i);
1314
1315 void epsilon(long l);
1316
1317 /// This one has a comment.
1318 void epsilon(int i);
1319 };
1320 )cpp";
1321
1322 auto File = testPath("foo.cpp");
1323 Annotations Test(R"cpp(
1324#include "foo.h"
1325alpha a;
1326int x = a.^
1327 )cpp");
1328 runAddDocument(Server, File, Test.code());
1329 clangd::CodeCompleteOptions CCOpts;
1330 CCOpts.BundleOverloads = true;
1331 auto CompletionList =
1332 llvm::cantFail(runCodeComplete(Server, File, Test.point(), CCOpts));
1333
1334 EXPECT_THAT(
1335 CompletionList.Completions,
1336 Contains(AllOf(named("epsilon"), doc("This one has a comment."))));
1337 EXPECT_THAT(CompletionList.Completions,
1338 Contains(AllOf(named("delta"), AnyOf(doc("bool overload."),
1339 doc("int overload.")))));
1340}
1341
1342TEST(CompletionTest, GlobalCompletionFiltering) {
1343
1344 Symbol Class = cls("XYZ");
1345 Class.Flags = static_cast<Symbol::SymbolFlag>(
1347 Symbol Func = func("XYZ::foooo");
1348 Func.Flags = static_cast<Symbol::SymbolFlag>(
1349 Func.Flags & ~(Symbol::IndexedForCodeCompletion));
1350
1351 auto Results = completions(R"(// void f() {
1352 XYZ::foooo^
1353 })",
1354 {Class, Func});
1355 EXPECT_THAT(Results.Completions, IsEmpty());
1356}
1357
1358TEST(CodeCompleteTest, DisableTypoCorrection) {
1359 auto Results = completions(R"cpp(
1360 namespace clang { int v; }
1361 void f() { clangd::^
1362 )cpp");
1363 EXPECT_TRUE(Results.Completions.empty());
1364}
1365
1366TEST(CodeCompleteTest, NoColonColonAtTheEnd) {
1367 auto Results = completions(R"cpp(
1368 namespace clang { }
1369 void f() {
1370 clan^
1371 }
1372 )cpp");
1373
1374 EXPECT_THAT(Results.Completions, Contains(labeled("clang")));
1375 EXPECT_THAT(Results.Completions, Not(Contains(labeled("clang::"))));
1376}
1377
1378TEST(CompletionTests, EmptySnippetDoesNotCrash) {
1379 // See https://github.com/clangd/clangd/issues/1216
1380 auto Results = completions(R"cpp(
1381 int main() {
1382 auto w = [&](auto &&f) { return f(f); };
1383 auto f = w([&](auto &&f) {
1384 return [&](auto &&n) {
1385 if (n == 0) {
1386 return 1;
1387 }
1388 return n * ^(f)(n - 1);
1389 };
1390 })(10);
1391 }
1392 )cpp");
1393}
1394
1395TEST(CompletionTest, Issue1427Crash) {
1396 // Need to provide main file signals to ensure that the branch in
1397 // SymbolRelevanceSignals::computeASTSignals() that tries to
1398 // compute a symbol ID is taken.
1399 ASTSignals MainFileSignals;
1401 Opts.MainFileSignals = &MainFileSignals;
1402 completions(R"cpp(
1403 auto f = []() {
1404 1.0_^
1405 };
1406 )cpp",
1407 {}, Opts);
1408}
1409
1410TEST(CompletionTest, BacktrackCrashes) {
1411 // Sema calls code completion callbacks twice in these cases.
1412 auto Results = completions(R"cpp(
1413 namespace ns {
1414 struct FooBarBaz {};
1415 } // namespace ns
1416
1417 int foo(ns::FooBar^
1418 )cpp");
1419
1420 EXPECT_THAT(Results.Completions, ElementsAre(labeled("FooBarBaz")));
1421
1422 // Check we don't crash in that case too.
1423 completions(R"cpp(
1424 struct FooBarBaz {};
1425 void test() {
1426 if (FooBarBaz * x^) {}
1427 }
1428)cpp");
1429}
1430
1431TEST(CompletionTest, CompleteInMacroWithStringification) {
1432 auto Results = completions(R"cpp(
1433void f(const char *, int x);
1434#define F(x) f(#x, x)
1435
1436namespace ns {
1437int X;
1438int Y;
1439} // namespace ns
1440
1441int f(int input_num) {
1442 F(ns::^)
1443}
1444)cpp");
1445
1446 EXPECT_THAT(Results.Completions,
1447 UnorderedElementsAre(named("X"), named("Y")));
1448}
1449
1450TEST(CompletionTest, CompleteInMacroAndNamespaceWithStringification) {
1451 auto Results = completions(R"cpp(
1452void f(const char *, int x);
1453#define F(x) f(#x, x)
1454
1455namespace ns {
1456int X;
1457
1458int f(int input_num) {
1459 F(^)
1460}
1461} // namespace ns
1462)cpp");
1463
1464 EXPECT_THAT(Results.Completions, Contains(named("X")));
1465}
1466
1467TEST(CompletionTest, IgnoreCompleteInExcludedPPBranchWithRecoveryContext) {
1468 auto Results = completions(R"cpp(
1469 int bar(int param_in_bar) {
1470 }
1471
1472 int foo(int param_in_foo) {
1473#if 0
1474 // In recovery mode, "param_in_foo" will also be suggested among many other
1475 // unrelated symbols; however, this is really a special case where this works.
1476 // If the #if block is outside of the function, "param_in_foo" is still
1477 // suggested, but "bar" and "foo" are missing. So the recovery mode doesn't
1478 // really provide useful results in excluded branches.
1479 par^
1480#endif
1481 }
1482)cpp");
1483
1484 EXPECT_TRUE(Results.Completions.empty());
1485}
1486
1487TEST(CompletionTest, DefaultArgs) {
1488 clangd::CodeCompleteOptions Opts;
1489 std::string Context = R"cpp(
1490 int X(int A = 0);
1491 int Y(int A, int B = 0);
1492 int Z(int A, int B = 0, int C = 0, int D = 0);
1493 )cpp";
1494 EXPECT_THAT(completions(Context + "int y = X^", {}, Opts).Completions,
1495 UnorderedElementsAre(labeled("X(int A = 0)")));
1496 EXPECT_THAT(completions(Context + "int y = Y^", {}, Opts).Completions,
1497 UnorderedElementsAre(AllOf(labeled("Y(int A, int B = 0)"),
1498 snippetSuffix("(${1:int A})"))));
1499 EXPECT_THAT(completions(Context + "int y = Z^", {}, Opts).Completions,
1500 UnorderedElementsAre(
1501 AllOf(labeled("Z(int A, int B = 0, int C = 0, int D = 0)"),
1502 snippetSuffix("(${1:int A})"))));
1503}
1504
1505TEST(CompletionTest, NoCrashWithTemplateParamsAndPreferredTypes) {
1506 auto Completions = completions(R"cpp(
1507template <template <class> class TT> int foo() {
1508 int a = ^
1509}
1510)cpp")
1511 .Completions;
1512 EXPECT_THAT(Completions, Contains(named("TT")));
1513}
1514
1515TEST(CompletionTest, NestedTemplateHeuristics) {
1516 auto Completions = completions(R"cpp(
1517struct Plain { int xxx; };
1518template <typename T> class Templ { Plain ppp; };
1519template <typename T> void foo(Templ<T> &t) {
1520 // Formally ppp has DependentTy, because Templ may be specialized.
1521 // However we sholud be able to see into it using the primary template.
1522 t.ppp.^
1523}
1524)cpp")
1525 .Completions;
1526 EXPECT_THAT(Completions, Contains(named("xxx")));
1527}
1528
1529TEST(CompletionTest, RecordCCResultCallback) {
1530 std::vector<CodeCompletion> RecordedCompletions;
1532 Opts.RecordCCResult = [&RecordedCompletions](const CodeCompletion &CC,
1533 const SymbolQualitySignals &,
1534 const SymbolRelevanceSignals &,
1535 float Score) {
1536 RecordedCompletions.push_back(CC);
1537 };
1538
1539 completions("int xy1, xy2; int a = xy^", /*IndexSymbols=*/{}, Opts);
1540 EXPECT_THAT(RecordedCompletions,
1541 UnorderedElementsAre(named("xy1"), named("xy2")));
1542}
1543
1544TEST(CompletionTest, ASTSignals) {
1545 struct Completion {
1546 std::string Name;
1547 unsigned MainFileRefs;
1548 unsigned ScopeRefsInFile;
1549 };
1551 std::vector<Completion> RecordedCompletions;
1552 Opts.RecordCCResult = [&RecordedCompletions](const CodeCompletion &CC,
1553 const SymbolQualitySignals &,
1554 const SymbolRelevanceSignals &R,
1555 float Score) {
1556 RecordedCompletions.push_back({CC.Name, R.MainFileRefs, R.ScopeRefsInFile});
1557 };
1558 ASTSignals MainFileSignals;
1559 MainFileSignals.ReferencedSymbols[var("xy1").ID] = 3;
1560 MainFileSignals.ReferencedSymbols[var("xy2").ID] = 1;
1561 MainFileSignals.ReferencedSymbols[var("xyindex").ID] = 10;
1562 MainFileSignals.RelatedNamespaces["tar::"] = 5;
1563 MainFileSignals.RelatedNamespaces["bar::"] = 3;
1564 Opts.MainFileSignals = &MainFileSignals;
1565 Opts.AllScopes = true;
1566 completions(
1567 R"cpp(
1568 int xy1;
1569 int xy2;
1570 namespace bar {
1571 int xybar = 1;
1572 int a = xy^
1573 }
1574 )cpp",
1575 /*IndexSymbols=*/{var("xyindex"), var("tar::xytar"), var("bar::xybar")},
1576 Opts);
1577 EXPECT_THAT(RecordedCompletions,
1578 UnorderedElementsAre(
1579 AllOf(named("xy1"), mainFileRefs(3u), scopeRefs(0u)),
1580 AllOf(named("xy2"), mainFileRefs(1u), scopeRefs(0u)),
1581 AllOf(named("xyindex"), mainFileRefs(10u), scopeRefs(0u)),
1582 AllOf(named("xytar"), mainFileRefs(0u), scopeRefs(5u)),
1583 AllOf(/*both from sema and index*/ named("xybar"),
1584 mainFileRefs(0u), scopeRefs(3u))));
1585}
1586
1588signatures(llvm::StringRef Text, Position Point,
1589 std::vector<Symbol> IndexSymbols = {},
1590 MarkupKind DocumentationFormat = MarkupKind::PlainText) {
1591 std::unique_ptr<SymbolIndex> Index;
1592 if (!IndexSymbols.empty())
1593 Index = memIndex(IndexSymbols);
1594
1595 auto TU = TestTU::withCode(Text);
1596 MockFS FS;
1597 auto Inputs = TU.inputs(FS);
1598 Inputs.Index = Index.get();
1599 IgnoreDiagnostics Diags;
1600 auto CI = buildCompilerInvocation(Inputs, Diags);
1601 if (!CI) {
1602 ADD_FAILURE() << "Couldn't build CompilerInvocation";
1603 return {};
1604 }
1605 auto Preamble = buildPreamble(testPath(TU.Filename), *CI, Inputs,
1606 /*InMemory=*/true, /*Callback=*/nullptr);
1607 if (!Preamble) {
1608 ADD_FAILURE() << "Couldn't build Preamble";
1609 return {};
1610 }
1611 return signatureHelp(testPath(TU.Filename), Point, *Preamble, Inputs,
1612 DocumentationFormat);
1613}
1614
1616signatures(llvm::StringRef Text, std::vector<Symbol> IndexSymbols = {},
1617 MarkupKind DocumentationFormat = MarkupKind::PlainText) {
1618 Annotations Test(Text);
1619 return signatures(Test.code(), Test.point(), std::move(IndexSymbols),
1620 DocumentationFormat);
1621}
1622
1623struct ExpectedParameter {
1624 std::string Text;
1625 std::pair<unsigned, unsigned> Offsets;
1626};
1627llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
1628 const ExpectedParameter &P) {
1629 return OS << P.Text;
1630}
1631MATCHER_P(paramsAre, P, "") {
1632 if (P.size() != arg.parameters.size())
1633 return false;
1634 for (unsigned I = 0; I < P.size(); ++I) {
1635 if (P[I].Text != arg.parameters[I].labelString ||
1636 P[I].Offsets != arg.parameters[I].labelOffsets)
1637 return false;
1638 }
1639 return true;
1640}
1641MATCHER_P(sigDoc, doc, "") { return arg.documentation.value == doc; }
1642
1643/// \p AnnotatedLabel is a signature label with ranges marking parameters, e.g.
1644/// foo([[int p1]], [[double p2]]) -> void
1645Matcher<SignatureInformation> sig(llvm::StringRef AnnotatedLabel) {
1646 llvm::Annotations A(AnnotatedLabel);
1647 std::string Label = std::string(A.code());
1648 std::vector<ExpectedParameter> Parameters;
1649 for (auto Range : A.ranges()) {
1650 Parameters.emplace_back();
1651
1652 ExpectedParameter &P = Parameters.back();
1653 P.Text = Label.substr(Range.Begin, Range.End - Range.Begin);
1654 P.Offsets.first = lspLength(llvm::StringRef(Label).substr(0, Range.Begin));
1655 P.Offsets.second = lspLength(llvm::StringRef(Label).substr(1, Range.End));
1656 }
1657 return AllOf(sigHelpLabeled(Label), paramsAre(Parameters));
1658}
1659
1660TEST(SignatureHelpTest, Overloads) {
1661 auto Results = signatures(R"cpp(
1662 void foo(int x, int y);
1663 void foo(int x, float y);
1664 void foo(float x, int y);
1665 void foo(float x, float y);
1666 void bar(int x, int y = 0);
1667 int main() { foo(^); }
1668 )cpp");
1669 EXPECT_THAT(Results.signatures,
1670 UnorderedElementsAre(sig("foo([[float x]], [[float y]]) -> void"),
1671 sig("foo([[float x]], [[int y]]) -> void"),
1672 sig("foo([[int x]], [[float y]]) -> void"),
1673 sig("foo([[int x]], [[int y]]) -> void")));
1674 // We always prefer the first signature.
1675 EXPECT_EQ(0, Results.activeSignature);
1676 EXPECT_EQ(0, Results.activeParameter);
1677}
1678
1679TEST(SignatureHelpTest, FunctionPointers) {
1680 llvm::StringLiteral Tests[] = {
1681 // Variable of function pointer type
1682 R"cpp(
1683 void (*foo)(int x, int y);
1684 int main() { foo(^); }
1685 )cpp",
1686 // Wrapped in an AttributedType
1687 R"cpp(
1688 void (__stdcall *foo)(int x, int y);
1689 int main() { foo(^); }
1690 )cpp",
1691 // Another syntax for an AttributedType
1692 R"cpp(
1693 void (__attribute__(stdcall) *foo)(int x, int y);
1694 int main() { foo(^); },
1695 )cpp",
1696 // Wrapped in a typedef
1697 R"cpp(
1698 typedef void (*fn)(int x, int y);
1699 fn foo;
1700 int main() { foo(^); }
1701 )cpp",
1702 // Wrapped in both a typedef and an AttributedTyped
1703 R"cpp(
1704 typedef void (__stdcall *fn)(int x, int y);
1705 fn foo;
1706 int main() { foo(^); }
1707 )cpp",
1708 // Field of function pointer type
1709 R"cpp(
1710 struct S {
1711 void (*foo)(int x, int y);
1712 };
1713 S s;
1714 int main() { s.foo(^); }
1715 )cpp",
1716 // Field of function pointer typedef type
1717 R"cpp(
1718 typedef void (*fn)(int x, int y);
1719 struct S {
1720 fn foo;
1721 };
1722 S s;
1723 int main() { s.foo(^); }
1724 )cpp"};
1725 for (auto Test : Tests)
1726 EXPECT_THAT(signatures(Test).signatures,
1727 UnorderedElementsAre(sig("([[int x]], [[int y]]) -> void")));
1728}
1729
1730TEST(SignatureHelpTest, Constructors) {
1731 std::string Top = R"cpp(
1732 struct S {
1733 S(int);
1734 S(const S &) = delete;
1735 };
1736 )cpp";
1737
1738 auto CheckParenInit = [&](std::string Init) {
1739 EXPECT_THAT(signatures(Top + Init).signatures,
1740 UnorderedElementsAre(sig("S([[int]])")))
1741 << Init;
1742 };
1743 CheckParenInit("S s(^);");
1744 CheckParenInit("auto s = S(^);");
1745 CheckParenInit("auto s = new S(^);");
1746
1747 auto CheckBracedInit = [&](std::string Init) {
1748 EXPECT_THAT(signatures(Top + Init).signatures,
1749 UnorderedElementsAre(sig("S{[[int]]}")))
1750 << Init;
1751 };
1752 CheckBracedInit("S s{^};");
1753 CheckBracedInit("S s = {^};");
1754 CheckBracedInit("auto s = S{^};");
1755 // FIXME: doesn't work: no ExpectedType set in ParseCXXNewExpression.
1756 // CheckBracedInit("auto s = new S{^};");
1757 CheckBracedInit("int x(S); int i = x({^});");
1758}
1759
1760TEST(SignatureHelpTest, Aggregates) {
1761 std::string Top = R"cpp(
1762 struct S {
1763 int a, b, c, d;
1764 };
1765 )cpp";
1766 auto AggregateSig = sig("S{[[int a]], [[int b]], [[int c]], [[int d]]}");
1767 EXPECT_THAT(signatures(Top + "S s{^}").signatures,
1768 UnorderedElementsAre(AggregateSig, sig("S{}"),
1769 sig("S{[[const S &]]}"),
1770 sig("S{[[S &&]]}")));
1771 EXPECT_THAT(signatures(Top + "S s{1,^}").signatures,
1772 ElementsAre(AggregateSig));
1773 EXPECT_EQ(signatures(Top + "S s{1,^}").activeParameter, 1);
1774 EXPECT_THAT(signatures(Top + "S s{.c=3,^}").signatures,
1775 ElementsAre(AggregateSig));
1776 EXPECT_EQ(signatures(Top + "S s{.c=3,^}").activeParameter, 3);
1777}
1778
1779TEST(SignatureHelpTest, OverloadInitListRegression) {
1780 auto Results = signatures(R"cpp(
1781 struct A {int x;};
1782 struct B {B(A);};
1783 void f();
1784 int main() {
1785 B b({1});
1786 f(^);
1787 }
1788 )cpp");
1789 EXPECT_THAT(Results.signatures, UnorderedElementsAre(sig("f() -> void")));
1790}
1791
1792TEST(SignatureHelpTest, DefaultArgs) {
1793 auto Results = signatures(R"cpp(
1794 void bar(int x, int y = 0);
1795 void bar(float x = 0, int y = 42);
1796 int main() { bar(^
1797 )cpp");
1798 EXPECT_THAT(Results.signatures,
1799 UnorderedElementsAre(
1800 sig("bar([[int x]], [[int y = 0]]) -> void"),
1801 sig("bar([[float x = 0]], [[int y = 42]]) -> void")));
1802 EXPECT_EQ(0, Results.activeSignature);
1803 EXPECT_EQ(0, Results.activeParameter);
1804}
1805
1806TEST(SignatureHelpTest, ActiveArg) {
1807 auto Results = signatures(R"cpp(
1808 int baz(int a, int b, int c);
1809 int main() { baz(baz(1,2,3), ^); }
1810 )cpp");
1811 EXPECT_THAT(Results.signatures,
1812 ElementsAre(sig("baz([[int a]], [[int b]], [[int c]]) -> int")));
1813 EXPECT_EQ(0, Results.activeSignature);
1814 EXPECT_EQ(1, Results.activeParameter);
1815}
1816
1817TEST(SignatureHelpTest, OpeningParen) {
1818 llvm::StringLiteral Tests[] = {
1819 // Recursive function call.
1820 R"cpp(
1821 int foo(int a, int b, int c);
1822 int main() {
1823 foo(foo $p^( foo(10, 10, 10), ^ )));
1824 })cpp",
1825 // Functional type cast.
1826 R"cpp(
1827 struct Foo {
1828 Foo(int a, int b, int c);
1829 };
1830 int main() {
1831 Foo $p^( 10, ^ );
1832 })cpp",
1833 // New expression.
1834 R"cpp(
1835 struct Foo {
1836 Foo(int a, int b, int c);
1837 };
1838 int main() {
1839 new Foo $p^( 10, ^ );
1840 })cpp",
1841 // Macro expansion.
1842 R"cpp(
1843 int foo(int a, int b, int c);
1844 #define FOO foo(
1845
1846 int main() {
1847 // Macro expansions.
1848 $p^FOO 10, ^ );
1849 })cpp",
1850 // Macro arguments.
1851 R"cpp(
1852 int foo(int a, int b, int c);
1853 int main() {
1854 #define ID(X) X
1855 // FIXME: figure out why ID(foo (foo(10), )) doesn't work when preserving
1856 // the recovery expression.
1857 ID(foo $p^( 10, ^ ))
1858 })cpp",
1859 // Dependent args.
1860 R"cpp(
1861 int foo(int a, int b);
1862 template <typename T> void bar(T t) {
1863 foo$p^(t, ^t);
1864 })cpp",
1865 // Dependent args on templated func.
1866 R"cpp(
1867 template <typename T>
1868 int foo(T, T);
1869 template <typename T> void bar(T t) {
1870 foo$p^(t, ^t);
1871 })cpp",
1872 // Dependent args on member.
1873 R"cpp(
1874 struct Foo { int foo(int, int); };
1875 template <typename T> void bar(T t) {
1876 Foo f;
1877 f.foo$p^(t, ^t);
1878 })cpp",
1879 // Dependent args on templated member.
1880 R"cpp(
1881 struct Foo { template <typename T> int foo(T, T); };
1882 template <typename T> void bar(T t) {
1883 Foo f;
1884 f.foo$p^(t, ^t);
1885 })cpp",
1886 };
1887
1888 for (auto Test : Tests) {
1889 Annotations Code(Test);
1890 EXPECT_EQ(signatures(Code.code(), Code.point()).argListStart,
1891 Code.point("p"))
1892 << "Test source:" << Test;
1893 }
1894}
1895
1896TEST(SignatureHelpTest, StalePreamble) {
1897 TestTU TU;
1898 TU.Code = "";
1899 IgnoreDiagnostics Diags;
1900 MockFS FS;
1901 auto Inputs = TU.inputs(FS);
1902 auto CI = buildCompilerInvocation(Inputs, Diags);
1903 ASSERT_TRUE(CI);
1904 auto EmptyPreamble = buildPreamble(testPath(TU.Filename), *CI, Inputs,
1905 /*InMemory=*/true, /*Callback=*/nullptr);
1906 ASSERT_TRUE(EmptyPreamble);
1907
1908 TU.AdditionalFiles["a.h"] = "int foo(int x);";
1909 const Annotations Test(R"cpp(
1910 #include "a.h"
1911 void bar() { foo(^2); })cpp");
1912 TU.Code = Test.code().str();
1913 auto Results =
1914 signatureHelp(testPath(TU.Filename), Test.point(), *EmptyPreamble,
1915 TU.inputs(FS), MarkupKind::PlainText);
1916 EXPECT_THAT(Results.signatures, ElementsAre(sig("foo([[int x]]) -> int")));
1917 EXPECT_EQ(0, Results.activeSignature);
1918 EXPECT_EQ(0, Results.activeParameter);
1919}
1920
1921class IndexRequestCollector : public SymbolIndex {
1922public:
1923 IndexRequestCollector(std::vector<Symbol> Syms = {}) : Symbols(Syms) {}
1924
1925 bool
1926 fuzzyFind(const FuzzyFindRequest &Req,
1927 llvm::function_ref<void(const Symbol &)> Callback) const override {
1928 std::unique_lock<std::mutex> Lock(Mut);
1929 Requests.push_back(Req);
1930 ReceivedRequestCV.notify_one();
1931 for (const auto &Sym : Symbols)
1932 Callback(Sym);
1933 return true;
1934 }
1935
1936 void lookup(const LookupRequest &,
1937 llvm::function_ref<void(const Symbol &)>) const override {}
1938
1939 bool refs(const RefsRequest &,
1940 llvm::function_ref<void(const Ref &)>) const override {
1941 return false;
1942 }
1943
1944 bool containedRefs(
1945 const ContainedRefsRequest &,
1946 llvm::function_ref<void(const ContainedRefsResult &)>) const override {
1947 return false;
1948 }
1949
1950 void relations(const RelationsRequest &,
1951 llvm::function_ref<void(const SymbolID &, const Symbol &)>)
1952 const override {}
1953
1954 void
1955 reverseRelations(const RelationsRequest &,
1956 llvm::function_ref<void(const SymbolID &, const Symbol &)>)
1957 const override {}
1958
1959 llvm::unique_function<IndexContents(llvm::StringRef) const>
1960 indexedFiles() const override {
1961 return [](llvm::StringRef) { return IndexContents::None; };
1962 }
1963
1964 // This is incorrect, but IndexRequestCollector is not an actual index and it
1965 // isn't used in production code.
1966 size_t estimateMemoryUsage() const override { return 0; }
1967
1968 const std::vector<FuzzyFindRequest> consumeRequests(size_t Num) const {
1969 std::unique_lock<std::mutex> Lock(Mut);
1970 EXPECT_TRUE(wait(Lock, ReceivedRequestCV, timeoutSeconds(30),
1971 [this, Num] { return Requests.size() == Num; }));
1972 auto Reqs = std::move(Requests);
1973 Requests = {};
1974 return Reqs;
1975 }
1976
1977private:
1978 std::vector<Symbol> Symbols;
1979 // We need a mutex to handle async fuzzy find requests.
1980 mutable std::condition_variable ReceivedRequestCV;
1981 mutable std::mutex Mut;
1982 mutable std::vector<FuzzyFindRequest> Requests;
1983};
1984
1985// Clients have to consume exactly Num requests.
1986std::vector<FuzzyFindRequest> captureIndexRequests(llvm::StringRef Code,
1987 size_t Num = 1) {
1988 clangd::CodeCompleteOptions Opts;
1989 IndexRequestCollector Requests;
1990 Opts.Index = &Requests;
1991 completions(Code, {}, Opts);
1992 const auto Reqs = Requests.consumeRequests(Num);
1993 EXPECT_EQ(Reqs.size(), Num);
1994 return Reqs;
1995}
1996
1997TEST(CompletionTest, UnqualifiedIdQuery) {
1998 auto Requests = captureIndexRequests(R"cpp(
1999 namespace std {}
2000 using namespace std;
2001 namespace ns {
2002 void f() {
2003 vec^
2004 }
2005 }
2006 )cpp");
2007
2008 EXPECT_THAT(Requests,
2009 ElementsAre(Field(&FuzzyFindRequest::Scopes,
2010 UnorderedElementsAre("", "ns::", "std::"))));
2011}
2012
2013TEST(CompletionTest, EnclosingScopeComesFirst) {
2014 auto Requests = captureIndexRequests(R"cpp(
2015 namespace std {}
2016 using namespace std;
2017 namespace nx {
2018 namespace ns {
2019 namespace {
2020 void f() {
2021 vec^
2022 }
2023 }
2024 }
2025 }
2026 )cpp");
2027
2028 EXPECT_THAT(Requests,
2029 ElementsAre(Field(
2031 UnorderedElementsAre("", "std::", "nx::ns::", "nx::"))));
2032 EXPECT_EQ(Requests[0].Scopes[0], "nx::ns::");
2033}
2034
2035TEST(CompletionTest, ResolvedQualifiedIdQuery) {
2036 auto Requests = captureIndexRequests(R"cpp(
2037 namespace ns1 {}
2038 namespace ns2 {} // ignore
2039 namespace ns3 { namespace nns3 {} }
2040 namespace foo {
2041 using namespace ns1;
2042 using namespace ns3::nns3;
2043 }
2044 namespace ns {
2045 void f() {
2046 foo::^
2047 }
2048 }
2049 )cpp");
2050
2051 EXPECT_THAT(Requests,
2052 ElementsAre(Field(
2054 UnorderedElementsAre("foo::", "ns1::", "ns3::nns3::"))));
2055}
2056
2057TEST(CompletionTest, UnresolvedQualifierIdQuery) {
2058 auto Requests = captureIndexRequests(R"cpp(
2059 namespace a {}
2060 using namespace a;
2061 namespace ns {
2062 void f() {
2063 bar::^
2064 }
2065 } // namespace ns
2066 )cpp");
2067
2068 EXPECT_THAT(Requests,
2069 ElementsAre(Field(
2071 UnorderedElementsAre("a::bar::", "ns::bar::", "bar::"))));
2072}
2073
2074TEST(CompletionTest, UnresolvedNestedQualifierIdQuery) {
2075 auto Requests = captureIndexRequests(R"cpp(
2076 namespace a {}
2077 using namespace a;
2078 namespace ns {
2079 void f() {
2080 ::a::bar::^
2081 }
2082 } // namespace ns
2083 )cpp");
2084
2085 EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes,
2086 UnorderedElementsAre("a::bar::"))));
2087}
2088
2089TEST(CompletionTest, EmptyQualifiedQuery) {
2090 auto Requests = captureIndexRequests(R"cpp(
2091 namespace ns {
2092 void f() {
2093 ^
2094 }
2095 } // namespace ns
2096 )cpp");
2097
2098 EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes,
2099 UnorderedElementsAre("", "ns::"))));
2100}
2101
2102TEST(CompletionTest, GlobalQualifiedQuery) {
2103 auto Requests = captureIndexRequests(R"cpp(
2104 namespace ns {
2105 void f() {
2106 ::^
2107 }
2108 } // namespace ns
2109 )cpp");
2110
2111 EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes,
2112 UnorderedElementsAre(""))));
2113}
2114
2115TEST(CompletionTest, NoDuplicatedQueryScopes) {
2116 auto Requests = captureIndexRequests(R"cpp(
2117 namespace {}
2118
2119 namespace na {
2120 namespace {}
2121 namespace nb {
2122 ^
2123 } // namespace nb
2124 } // namespace na
2125 )cpp");
2126
2127 EXPECT_THAT(Requests,
2128 ElementsAre(Field(&FuzzyFindRequest::Scopes,
2129 UnorderedElementsAre("na::", "na::nb::", ""))));
2130}
2131
2132TEST(CompletionTest, NoIndexCompletionsInsideClasses) {
2133 auto Completions = completions(
2134 R"cpp(
2135 struct Foo {
2136 int SomeNameOfField;
2137 typedef int SomeNameOfTypedefField;
2138 };
2139
2140 Foo::^)cpp",
2141 {func("::SomeNameInTheIndex"), func("::Foo::SomeNameInTheIndex")});
2142
2143 EXPECT_THAT(Completions.Completions,
2144 AllOf(Contains(labeled("SomeNameOfField")),
2145 Contains(labeled("SomeNameOfTypedefField")),
2146 Not(Contains(labeled("SomeNameInTheIndex")))));
2147}
2148
2149TEST(CompletionTest, NoIndexCompletionsInsideDependentCode) {
2150 {
2151 auto Completions = completions(
2152 R"cpp(
2153 template <class T>
2154 void foo() {
2155 T::^
2156 }
2157 )cpp",
2158 {func("::SomeNameInTheIndex")});
2159
2160 EXPECT_THAT(Completions.Completions,
2161 Not(Contains(labeled("SomeNameInTheIndex"))));
2162 }
2163
2164 {
2165 auto Completions = completions(
2166 R"cpp(
2167 template <class T>
2168 void foo() {
2169 T::template Y<int>::^
2170 }
2171 )cpp",
2172 {func("::SomeNameInTheIndex")});
2173
2174 EXPECT_THAT(Completions.Completions,
2175 Not(Contains(labeled("SomeNameInTheIndex"))));
2176 }
2177
2178 {
2179 auto Completions = completions(
2180 R"cpp(
2181 template <class T>
2182 void foo() {
2183 T::foo::^
2184 }
2185 )cpp",
2186 {func("::SomeNameInTheIndex")});
2187
2188 EXPECT_THAT(Completions.Completions,
2189 Not(Contains(labeled("SomeNameInTheIndex"))));
2190 }
2191}
2192
2193TEST(CompletionTest, OverloadBundling) {
2194 clangd::CodeCompleteOptions Opts;
2195 Opts.BundleOverloads = true;
2196
2197 std::string Context = R"cpp(
2198 struct X {
2199 // Overload with int
2200 int a(int) __attribute__((deprecated("", "")));
2201 // Overload with bool
2202 int a(bool);
2203 int b(float);
2204
2205 X(int);
2206 X(float);
2207 };
2208 int GFuncC(int);
2209 int GFuncD(int);
2210 )cpp";
2211
2212 // Member completions are bundled.
2213 EXPECT_THAT(completions(Context + "int y = X().^", {}, Opts).Completions,
2214 UnorderedElementsAre(labeled("a(…)"), labeled("b(float)")));
2215
2216 // Constructor completions are bundled.
2217 EXPECT_THAT(completions(Context + "X z = X^", {}, Opts).Completions,
2218 UnorderedElementsAre(labeled("X"), labeled("X(…)")));
2219
2220 // Non-member completions are bundled, including index+sema.
2221 Symbol NoArgsGFunc = func("GFuncC");
2222 EXPECT_THAT(
2223 completions(Context + "int y = GFunc^", {NoArgsGFunc}, Opts).Completions,
2224 UnorderedElementsAre(labeled("GFuncC(…)"), labeled("GFuncD(int)")));
2225
2226 // Differences in header-to-insert suppress bundling.
2227 std::string DeclFile = URI::create(testPath("foo")).toString();
2228 NoArgsGFunc.CanonicalDeclaration.FileURI = DeclFile.c_str();
2229 NoArgsGFunc.IncludeHeaders.emplace_back("<foo>", 1, Symbol::Include);
2230 EXPECT_THAT(
2231 completions(Context + "int y = GFunc^", {NoArgsGFunc}, Opts).Completions,
2232 UnorderedElementsAre(AllOf(named("GFuncC"), insertInclude("<foo>")),
2233 labeled("GFuncC(int)"), labeled("GFuncD(int)")));
2234
2235 // Examine a bundled completion in detail.
2236 auto A =
2237 completions(Context + "int y = X().a^", {}, Opts).Completions.front();
2238 EXPECT_EQ(A.Name, "a");
2239 EXPECT_EQ(A.Signature, "(…)");
2240 EXPECT_EQ(A.BundleSize, 2u);
2241 EXPECT_EQ(A.Kind, CompletionItemKind::Method);
2242 EXPECT_EQ(A.ReturnType, "int"); // All overloads return int.
2243 // For now we just return one of the doc strings arbitrarily.
2244 ASSERT_TRUE(A.Documentation);
2245 ASSERT_FALSE(A.Deprecated); // Not all overloads deprecated.
2246 EXPECT_THAT(
2247 A.Documentation->asPlainText(),
2248 AnyOf(HasSubstr("Overload with int"), HasSubstr("Overload with bool")));
2249 EXPECT_EQ(A.SnippetSuffix, "($0)");
2250}
2251
2252TEST(CompletionTest, OverloadBundlingSameFileDifferentURI) {
2253 clangd::CodeCompleteOptions Opts;
2254 Opts.BundleOverloads = true;
2255
2256 Symbol SymX = sym("ns::X", index::SymbolKind::Function, "@F@\\0#");
2257 Symbol SymY = sym("ns::X", index::SymbolKind::Function, "@F@\\0#I#");
2258 std::string BarHeader = testPath("bar.h");
2259 auto BarURI = URI::create(BarHeader).toString();
2260 SymX.CanonicalDeclaration.FileURI = BarURI.c_str();
2261 SymY.CanonicalDeclaration.FileURI = BarURI.c_str();
2262 // The include header is different, but really it's the same file.
2263 SymX.IncludeHeaders.emplace_back("\"bar.h\"", 1, Symbol::Include);
2264 SymY.IncludeHeaders.emplace_back(BarURI.c_str(), 1, Symbol::Include);
2265
2266 auto Results = completions("void f() { ::ns::^ }", {SymX, SymY}, Opts);
2267 // Expect both results are bundled, despite the different-but-same
2268 // IncludeHeader.
2269 ASSERT_EQ(1u, Results.Completions.size());
2270 const auto &R = Results.Completions.front();
2271 EXPECT_EQ("X", R.Name);
2272 EXPECT_EQ(2u, R.BundleSize);
2273}
2274
2275TEST(CompletionTest, DocumentationFromChangedFileCrash) {
2276 MockFS FS;
2277 auto FooH = testPath("foo.h");
2278 auto FooCpp = testPath("foo.cpp");
2279 FS.Files[FooH] = R"cpp(
2280 // this is my documentation comment.
2281 int func();
2282 )cpp";
2283 FS.Files[FooCpp] = "";
2284
2286 ClangdServer Server(CDB, FS, ClangdServer::optsForTest());
2287
2288 Annotations Source(R"cpp(
2289 #include "foo.h"
2290 int func() {
2291 // This makes sure we have func from header in the AST.
2292 }
2293 int a = fun^
2294 )cpp");
2295 Server.addDocument(FooCpp, Source.code(), "null", WantDiagnostics::Yes);
2296 // We need to wait for preamble to build.
2297 ASSERT_TRUE(Server.blockUntilIdleForTest());
2298
2299 // Change the header file. Completion will reuse the old preamble!
2300 FS.Files[FooH] = R"cpp(
2301 int func();
2302 )cpp";
2303
2304 clangd::CodeCompleteOptions Opts;
2305 CodeCompleteResult Completions =
2306 cantFail(runCodeComplete(Server, FooCpp, Source.point(), Opts));
2307 // We shouldn't crash. Unfortunately, current workaround is to not produce
2308 // comments for symbols from headers.
2309 EXPECT_THAT(Completions.Completions,
2310 Contains(AllOf(Not(isDocumented()), named("func"))));
2311}
2312
2313TEST(CompletionTest, NonDocComments) {
2314 const char *Text = R"cpp(
2315 // We ignore namespace comments, for rationale see CodeCompletionStrings.h.
2316 namespace comments_ns {
2317 }
2318
2319 // ------------------
2320 int comments_foo();
2321
2322 // A comment and a decl are separated by newlines.
2323 // Therefore, the comment shouldn't show up as doc comment.
2324
2325 int comments_bar();
2326
2327 // this comment should be in the results.
2328 int comments_baz();
2329
2330
2331 template <class T>
2332 struct Struct {
2333 int comments_qux();
2334 int comments_quux();
2335 };
2336
2337
2338 // This comment should not be there.
2339
2340 template <class T>
2341 int Struct<T>::comments_qux() {
2342 }
2343
2344 // This comment **should** be in results.
2345 template <class T>
2346 int Struct<T>::comments_quux() {
2347 int a = comments^;
2348 }
2349 )cpp";
2350
2351 // We should not get any of those comments in completion.
2352 EXPECT_THAT(
2353 completions(Text).Completions,
2354 UnorderedElementsAre(AllOf(Not(isDocumented()), named("comments_foo")),
2355 AllOf(isDocumented(), named("comments_baz")),
2356 AllOf(isDocumented(), named("comments_quux")),
2357 AllOf(Not(isDocumented()), named("comments_ns")),
2358 // FIXME(ibiryukov): the following items should have
2359 // empty documentation, since they are separated from
2360 // a comment with an empty line. Unfortunately, I
2361 // couldn't make Sema tests pass if we ignore those.
2362 AllOf(isDocumented(), named("comments_bar")),
2363 AllOf(isDocumented(), named("comments_qux"))));
2364}
2365
2366TEST(CompletionTest, CompleteOnInvalidLine) {
2367 auto FooCpp = testPath("foo.cpp");
2368
2370 MockFS FS;
2371 FS.Files[FooCpp] = "// empty file";
2372
2373 ClangdServer Server(CDB, FS, ClangdServer::optsForTest());
2374 // Run completion outside the file range.
2375 Position Pos;
2376 Pos.line = 100;
2377 Pos.character = 0;
2378 EXPECT_THAT_EXPECTED(
2379 runCodeComplete(Server, FooCpp, Pos, clangd::CodeCompleteOptions()),
2380 Failed());
2381}
2382
2383TEST(CompletionTest, QualifiedNames) {
2384 auto Results = completions(
2385 R"cpp(
2386 namespace ns { int local; void both(); }
2387 void f() { ::ns::^ }
2388 )cpp",
2389 {func("ns::both"), cls("ns::Index")});
2390 // We get results from both index and sema, with no duplicates.
2391 EXPECT_THAT(
2392 Results.Completions,
2393 UnorderedElementsAre(scope("ns::"), scope("ns::"), scope("ns::")));
2394}
2395
2396TEST(CompletionTest, Render) {
2397 CodeCompletion C;
2398 C.Name = "x";
2399 C.FilterText = "x";
2400 C.Signature = "(bool) const";
2401 C.SnippetSuffix = "(${0:bool})";
2402 C.ReturnType = "int";
2403 C.RequiredQualifier = "Foo::";
2404 C.Scope = "ns::Foo::";
2405 C.Documentation.emplace();
2406 C.Documentation->addParagraph().appendText("This is ").appendCode("x()");
2407 C.Includes.emplace_back();
2408 auto &Include = C.Includes.back();
2409 Include.Header = "\"foo.h\"";
2411 C.Score.Total = 1.0;
2412 C.Score.ExcludingName = .5;
2414
2416 Opts.IncludeIndicator.Insert = "^";
2417 Opts.IncludeIndicator.NoInsert = "";
2418 Opts.EnableSnippets = false;
2419
2420 auto R = C.render(Opts);
2421 EXPECT_EQ(R.label, "Foo::x");
2422 EXPECT_EQ(R.labelDetails->detail, "(bool) const");
2423 EXPECT_EQ(R.insertText, "Foo::x");
2424 EXPECT_EQ(R.insertTextFormat, InsertTextFormat::PlainText);
2425 EXPECT_EQ(R.filterText, "x");
2426 EXPECT_EQ(R.detail, "int");
2427 EXPECT_EQ(R.documentation->value, "From \"foo.h\"\n\nThis is x()");
2428 EXPECT_THAT(R.additionalTextEdits, IsEmpty());
2429 EXPECT_EQ(R.sortText, sortText(1.0, "x"));
2430 EXPECT_FALSE(R.deprecated);
2431 EXPECT_EQ(R.score, .5f);
2432
2433 C.FilterText = "xtra";
2434 R = C.render(Opts);
2435 EXPECT_EQ(R.filterText, "xtra");
2436 EXPECT_EQ(R.sortText, sortText(1.0, "xtra"));
2437
2438 Opts.EnableSnippets = true;
2439 R = C.render(Opts);
2440 EXPECT_EQ(R.insertText, "Foo::x(${0:bool})");
2441 EXPECT_EQ(R.insertTextFormat, InsertTextFormat::Snippet);
2442
2443 C.SnippetSuffix = "";
2444 R = C.render(Opts);
2445 EXPECT_EQ(R.insertText, "Foo::x");
2446 EXPECT_EQ(R.insertTextFormat, InsertTextFormat::PlainText);
2447
2448 Include.Insertion.emplace();
2449 R = C.render(Opts);
2450 EXPECT_EQ(R.label, "^Foo::x");
2451 EXPECT_EQ(R.labelDetails->detail, "(bool) const");
2452 EXPECT_THAT(R.additionalTextEdits, Not(IsEmpty()));
2453
2454 Opts.ShowOrigins = true;
2455 R = C.render(Opts);
2456 EXPECT_EQ(R.label, "^[AS]Foo::x");
2457 EXPECT_EQ(R.labelDetails->detail, "(bool) const");
2458
2459 C.BundleSize = 2;
2460 R = C.render(Opts);
2461 EXPECT_EQ(R.detail, "[2 overloads]");
2462 EXPECT_EQ(R.documentation->value, "From \"foo.h\"\n\nThis is x()");
2463
2464 C.Deprecated = true;
2465 R = C.render(Opts);
2466 EXPECT_TRUE(R.deprecated);
2467
2468 Opts.DocumentationFormat = MarkupKind::Markdown;
2469 R = C.render(Opts);
2470 EXPECT_EQ(R.documentation->value, "From `\"foo.h\"`\n\nThis is `x()`");
2471}
2472
2473TEST(CompletionTest, IgnoreRecoveryResults) {
2474 auto Results = completions(
2475 R"cpp(
2476 namespace ns { int NotRecovered() { return 0; } }
2477 void f() {
2478 // Sema enters recovery mode first and then normal mode.
2479 if (auto x = ns::NotRecover^)
2480 }
2481 )cpp");
2482 EXPECT_THAT(Results.Completions, UnorderedElementsAre(named("NotRecovered")));
2483}
2484
2485TEST(CompletionTest, ScopeOfClassFieldInConstructorInitializer) {
2486 auto Results = completions(
2487 R"cpp(
2488 namespace ns {
2489 class X { public: X(); int x_; };
2490 X::X() : x_^(0) {}
2491 }
2492 )cpp");
2493 EXPECT_THAT(Results.Completions,
2494 UnorderedElementsAre(AllOf(scope("ns::X::"), named("x_"))));
2495}
2496
2497// Like other class members, constructor init lists have to parse what's below,
2498// after the completion point.
2499// But recovering from an incomplete constructor init list is particularly
2500// tricky because the bulk of the list is not surrounded by brackets.
2501TEST(CompletionTest, ConstructorInitListIncomplete) {
2502 auto Results = completions(
2503 R"cpp(
2504 namespace ns {
2505 struct X {
2506 X() : x^
2507 int xyz_;
2508 };
2509 }
2510 )cpp");
2511 EXPECT_THAT(Results.Completions, ElementsAre(named("xyz_")));
2512
2513 Results = completions(
2514 R"cpp(
2515 int foo();
2516
2517 namespace ns {
2518 struct X {
2519 X() : xyz_(fo^
2520 int xyz_;
2521 };
2522 }
2523 )cpp");
2524 EXPECT_THAT(Results.Completions, ElementsAre(named("foo")));
2525}
2526
2527TEST(CompletionTest, CodeCompletionContext) {
2528 auto Results = completions(
2529 R"cpp(
2530 namespace ns {
2531 class X { public: X(); int x_; };
2532 void f() {
2533 X x;
2534 x.^;
2535 }
2536 }
2537 )cpp");
2538
2539 EXPECT_THAT(Results.Context, CodeCompletionContext::CCC_DotMemberAccess);
2540}
2541
2542TEST(CompletionTest, FixItForArrowToDot) {
2543 MockFS FS;
2545
2547 Opts.IncludeFixIts = true;
2548 const char *Code =
2549 R"cpp(
2550 class Auxilary {
2551 public:
2552 void AuxFunction();
2553 };
2554 class ClassWithPtr {
2555 public:
2556 void MemberFunction();
2557 Auxilary* operator->() const;
2558 Auxilary* Aux;
2559 };
2560 void f() {
2561 ClassWithPtr x;
2562 x[[->]]^;
2563 }
2564 )cpp";
2565 auto Results = completions(Code, {}, Opts);
2566 EXPECT_EQ(Results.Completions.size(), 3u);
2567
2568 TextEdit ReplacementEdit;
2569 ReplacementEdit.range = Annotations(Code).range();
2570 ReplacementEdit.newText = ".";
2571 for (const auto &C : Results.Completions) {
2572 EXPECT_TRUE(C.FixIts.size() == 1u || C.Name == "AuxFunction");
2573 if (!C.FixIts.empty()) {
2574 EXPECT_THAT(C.FixIts, ElementsAre(ReplacementEdit));
2575 }
2576 }
2577}
2578
2579TEST(CompletionTest, FixItForDotToArrow) {
2581 Opts.IncludeFixIts = true;
2582 const char *Code =
2583 R"cpp(
2584 class Auxilary {
2585 public:
2586 void AuxFunction();
2587 };
2588 class ClassWithPtr {
2589 public:
2590 void MemberFunction();
2591 Auxilary* operator->() const;
2592 Auxilary* Aux;
2593 };
2594 void f() {
2595 ClassWithPtr x;
2596 x[[.]]^;
2597 }
2598 )cpp";
2599 auto Results = completions(Code, {}, Opts);
2600 EXPECT_EQ(Results.Completions.size(), 3u);
2601
2602 TextEdit ReplacementEdit;
2603 ReplacementEdit.range = Annotations(Code).range();
2604 ReplacementEdit.newText = "->";
2605 for (const auto &C : Results.Completions) {
2606 EXPECT_TRUE(C.FixIts.empty() || C.Name == "AuxFunction");
2607 if (!C.FixIts.empty()) {
2608 EXPECT_THAT(C.FixIts, ElementsAre(ReplacementEdit));
2609 }
2610 }
2611}
2612
2613TEST(CompletionTest, RenderWithFixItMerged) {
2614 TextEdit FixIt;
2615 FixIt.range.end.character = 5;
2616 FixIt.newText = "->";
2617
2618 CodeCompletion C;
2619 C.Name = "x";
2620 C.RequiredQualifier = "Foo::";
2621 C.FixIts = {FixIt};
2622 C.CompletionTokenRange.start.character = 5;
2623
2625 Opts.IncludeFixIts = true;
2626
2627 auto R = C.render(Opts);
2628 EXPECT_TRUE(R.textEdit);
2629 EXPECT_EQ(R.textEdit->newText, "->Foo::x");
2630 EXPECT_TRUE(R.additionalTextEdits.empty());
2631}
2632
2633TEST(CompletionTest, RenderWithFixItNonMerged) {
2634 TextEdit FixIt;
2635 FixIt.range.end.character = 4;
2636 FixIt.newText = "->";
2637
2638 CodeCompletion C;
2639 C.Name = "x";
2640 C.RequiredQualifier = "Foo::";
2641 C.FixIts = {FixIt};
2642 C.CompletionTokenRange.start.character = 5;
2643
2645 Opts.IncludeFixIts = true;
2646
2647 auto R = C.render(Opts);
2648 EXPECT_TRUE(R.textEdit);
2649 EXPECT_EQ(R.textEdit->newText, "Foo::x");
2650 EXPECT_THAT(R.additionalTextEdits, UnorderedElementsAre(FixIt));
2651}
2652
2653TEST(CompletionTest, CompletionTokenRange) {
2654 MockFS FS;
2656 TestTU TU;
2657 TU.AdditionalFiles["foo/abc/foo.h"] = "";
2658
2659 constexpr const char *TestCodes[] = {
2660 R"cpp(
2661 class Auxilary {
2662 public:
2663 void AuxFunction();
2664 };
2665 void f() {
2666 Auxilary x;
2667 x.[[Aux]]^;
2668 }
2669 )cpp",
2670 R"cpp(
2671 class Auxilary {
2672 public:
2673 void AuxFunction();
2674 };
2675 void f() {
2676 Auxilary x;
2677 x.[[]]^;
2678 }
2679 )cpp",
2680 R"cpp(
2681 #include "foo/[[a^/]]foo.h"
2682 )cpp",
2683 R"cpp(
2684 #include "foo/abc/[[fo^o.h"]]
2685 )cpp",
2686 };
2687 for (const auto &Text : TestCodes) {
2688 Annotations TestCode(Text);
2689 TU.Code = TestCode.code().str();
2690 auto Results = completions(TU, TestCode.point());
2691 if (Results.Completions.size() != 1) {
2692 ADD_FAILURE() << "Results.Completions.size() != 1" << Text;
2693 continue;
2694 }
2695 EXPECT_THAT(Results.Completions.front().CompletionTokenRange,
2696 TestCode.range());
2697 }
2698}
2699
2700TEST(SignatureHelpTest, OverloadsOrdering) {
2701 const auto Results = signatures(R"cpp(
2702 void foo(int x);
2703 void foo(int x, float y);
2704 void foo(float x, int y);
2705 void foo(float x, float y);
2706 void foo(int x, int y = 0);
2707 int main() { foo(^); }
2708 )cpp");
2709 EXPECT_THAT(Results.signatures,
2710 ElementsAre(sig("foo([[int x]]) -> void"),
2711 sig("foo([[int x]], [[int y = 0]]) -> void"),
2712 sig("foo([[float x]], [[int y]]) -> void"),
2713 sig("foo([[int x]], [[float y]]) -> void"),
2714 sig("foo([[float x]], [[float y]]) -> void")));
2715 // We always prefer the first signature.
2716 EXPECT_EQ(0, Results.activeSignature);
2717 EXPECT_EQ(0, Results.activeParameter);
2718}
2719
2720TEST(SignatureHelpTest, InstantiatedSignatures) {
2721 StringRef Sig0 = R"cpp(
2722 template <class T>
2723 void foo(T, T, T);
2724
2725 int main() {
2726 foo<int>(^);
2727 }
2728 )cpp";
2729
2730 EXPECT_THAT(signatures(Sig0).signatures,
2731 ElementsAre(sig("foo([[T]], [[T]], [[T]]) -> void")));
2732
2733 StringRef Sig1 = R"cpp(
2734 template <class T>
2735 void foo(T, T, T);
2736
2737 int main() {
2738 foo(10, ^);
2739 })cpp";
2740
2741 EXPECT_THAT(signatures(Sig1).signatures,
2742 ElementsAre(sig("foo([[T]], [[T]], [[T]]) -> void")));
2743
2744 StringRef Sig2 = R"cpp(
2745 template <class ...T>
2746 void foo(T...);
2747
2748 int main() {
2749 foo<int>(^);
2750 }
2751 )cpp";
2752
2753 EXPECT_THAT(signatures(Sig2).signatures,
2754 ElementsAre(sig("foo([[T...]]) -> void")));
2755
2756 // It is debatable whether we should substitute the outer template parameter
2757 // ('T') in that case. Currently we don't substitute it in signature help, but
2758 // do substitute in code complete.
2759 // FIXME: make code complete and signature help consistent, figure out which
2760 // way is better.
2761 StringRef Sig3 = R"cpp(
2762 template <class T>
2763 struct X {
2764 template <class U>
2765 void foo(T, U);
2766 };
2767
2768 int main() {
2769 X<int>().foo<double>(^)
2770 }
2771 )cpp";
2772
2773 EXPECT_THAT(signatures(Sig3).signatures,
2774 ElementsAre(sig("foo([[T]], [[U]]) -> void")));
2775}
2776
2777TEST(SignatureHelpTest, IndexDocumentation) {
2778 Symbol Foo0 = sym("foo", index::SymbolKind::Function, "@F@\\0#");
2779 Foo0.Documentation = "doc from the index";
2780 Symbol Foo1 = sym("foo", index::SymbolKind::Function, "@F@\\0#I#");
2781 Foo1.Documentation = "doc from the index";
2782 Symbol Foo2 = sym("foo", index::SymbolKind::Function, "@F@\\0#I#I#");
2783
2784 StringRef Sig0 = R"cpp(
2785 int foo();
2786 int foo(double);
2787
2788 void test() {
2789 foo(^);
2790 }
2791 )cpp";
2792
2793 EXPECT_THAT(
2794 signatures(Sig0, {Foo0}).signatures,
2795 ElementsAre(AllOf(sig("foo() -> int"), sigDoc("doc from the index")),
2796 AllOf(sig("foo([[double]]) -> int"), sigDoc(""))));
2797
2798 StringRef Sig1 = R"cpp(
2799 int foo();
2800 // Overriden doc from sema
2801 int foo(int);
2802 // doc from sema
2803 int foo(int, int);
2804
2805 void test() {
2806 foo(^);
2807 }
2808 )cpp";
2809
2810 EXPECT_THAT(
2811 signatures(Sig1, {Foo0, Foo1, Foo2}).signatures,
2812 ElementsAre(
2813 AllOf(sig("foo() -> int"), sigDoc("doc from the index")),
2814 AllOf(sig("foo([[int]]) -> int"), sigDoc("Overriden doc from sema")),
2815 AllOf(sig("foo([[int]], [[int]]) -> int"), sigDoc("doc from sema"))));
2816}
2817
2818TEST(SignatureHelpTest, DynamicIndexDocumentation) {
2819 MockFS FS;
2822 Opts.BuildDynamicSymbolIndex = true;
2823 ClangdServer Server(CDB, FS, Opts);
2824
2825 FS.Files[testPath("foo.h")] = R"cpp(
2826 struct Foo {
2827 // Member doc
2828 int foo();
2829 };
2830 )cpp";
2831 Annotations FileContent(R"cpp(
2832 #include "foo.h"
2833 void test() {
2834 Foo f;
2835 f.foo(^);
2836 }
2837 )cpp");
2838 auto File = testPath("test.cpp");
2839 Server.addDocument(File, FileContent.code());
2840 // Wait for the dynamic index being built.
2841 ASSERT_TRUE(Server.blockUntilIdleForTest());
2842 EXPECT_THAT(llvm::cantFail(runSignatureHelp(Server, File, FileContent.point(),
2844 .signatures,
2845 ElementsAre(AllOf(sig("foo() -> int"), sigDoc("Member doc"))));
2846}
2847
2848TEST(CompletionTest, ArgumentListsPolicy) {
2850 Opts.EnableSnippets = true;
2851 Opts.ArgumentLists = Config::ArgumentListsPolicy::Delimiters;
2852
2853 {
2854 auto Results = completions(
2855 R"cpp(
2856 void xfoo();
2857 void xfoo(int x, int y);
2858 void f() { xfo^ })cpp",
2859 {}, Opts);
2860 EXPECT_THAT(
2861 Results.Completions,
2862 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix("()")),
2863 AllOf(named("xfoo"), snippetSuffix("($0)"))));
2864 }
2865 {
2866 auto Results = completions(
2867 R"cpp(
2868 void xbar();
2869 void f() { xba^ })cpp",
2870 {}, Opts);
2871 EXPECT_THAT(Results.Completions, UnorderedElementsAre(AllOf(
2872 named("xbar"), snippetSuffix("()"))));
2873 }
2874 {
2875 Opts.BundleOverloads = true;
2876 auto Results = completions(
2877 R"cpp(
2878 void xfoo();
2879 void xfoo(int x, int y);
2880 void f() { xfo^ })cpp",
2881 {}, Opts);
2882 EXPECT_THAT(
2883 Results.Completions,
2884 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix("($0)"))));
2885 }
2886 {
2887 auto Results = completions(
2888 R"cpp(
2889 template <class T, class U>
2890 void xfoo(int a, U b);
2891 void f() { xfo^ })cpp",
2892 {}, Opts);
2893 EXPECT_THAT(
2894 Results.Completions,
2895 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix("<$1>($0)"))));
2896 }
2897 {
2898 auto Results = completions(
2899 R"cpp(
2900 template <class T>
2901 class foo_class{};
2902 template <class T>
2903 using foo_alias = T**;
2904 template <class T>
2905 T foo_var = T{};
2906 void f() { foo_^ })cpp",
2907 {}, Opts);
2908 EXPECT_THAT(
2909 Results.Completions,
2910 UnorderedElementsAre(AllOf(named("foo_class"), snippetSuffix("<$0>")),
2911 AllOf(named("foo_alias"), snippetSuffix("<$0>")),
2912 AllOf(named("foo_var"), snippetSuffix("<$0>"))));
2913 }
2914 {
2915 auto Results = completions(
2916 R"cpp(
2917 #define FOO(x, y) x##f
2918 FO^ )cpp",
2919 {}, Opts);
2920 EXPECT_THAT(Results.Completions, UnorderedElementsAre(AllOf(
2921 named("FOO"), snippetSuffix("($0)"))));
2922 }
2923 {
2924 auto Results = completions(
2925 R"cpp(
2926 void function() {
2927 auto Lambda = [](int a, const double &b) {return 1.f;};
2928 Lam^
2929 })cpp",
2930 {}, Opts);
2931 EXPECT_THAT(
2932 Results.Completions,
2933 UnorderedElementsAre(AllOf(named("Lambda"), snippetSuffix("($0)"))));
2934 }
2935 {
2936 Opts.ArgumentLists = Config::ArgumentListsPolicy::None;
2937 auto Results = completions(
2938 R"cpp(
2939 void xfoo(int x, int y);
2940 void f() { xfo^ })cpp",
2941 {}, Opts);
2942 EXPECT_THAT(Results.Completions,
2943 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix(""))));
2944 }
2945 {
2946 Opts.ArgumentLists = Config::ArgumentListsPolicy::OpenDelimiter;
2947 auto Results = completions(
2948 R"cpp(
2949 void xfoo(int x, int y);
2950 void f() { xfo^ })cpp",
2951 {}, Opts);
2952 EXPECT_THAT(Results.Completions,
2953 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix("("))));
2954 }
2955}
2956
2957TEST(CompletionTest, SuggestOverrides) {
2958 constexpr const char *const Text(R"cpp(
2959 class A {
2960 public:
2961 virtual void vfunc(bool param);
2962 virtual void vfunc(bool param, int p);
2963 void func(bool param);
2964 };
2965 class B : public A {
2966 virtual void ttt(bool param) const;
2967 void vfunc(bool param, int p) override;
2968 };
2969 class C : public B {
2970 public:
2971 void vfunc(bool param) override;
2972 ^
2973 };
2974 )cpp");
2975 const auto Results = completions(Text);
2976 EXPECT_THAT(
2977 Results.Completions,
2978 AllOf(Contains(AllOf(labeled("void vfunc(bool param, int p) override"),
2979 nameStartsWith("vfunc"))),
2980 Contains(AllOf(labeled("void ttt(bool param) const override"),
2981 nameStartsWith("ttt"))),
2982 Not(Contains(labeled("void vfunc(bool param) override")))));
2983}
2984
2985TEST(CompletionTest, OverridesNonIdentName) {
2986 // Check the completions call does not crash.
2987 completions(R"cpp(
2988 struct Base {
2989 virtual ~Base() = 0;
2990 virtual operator int() = 0;
2991 virtual Base& operator+(Base&) = 0;
2992 };
2993
2994 struct Derived : Base {
2995 ^
2996 };
2997 )cpp");
2998}
2999
3000TEST(CompletionTest, NoCrashOnMissingNewLineAtEOF) {
3001 auto FooCpp = testPath("foo.cpp");
3002
3004 MockFS FS;
3005 Annotations F("#pragma ^ // no new line");
3006 FS.Files[FooCpp] = F.code().str();
3007 ClangdServer Server(CDB, FS, ClangdServer::optsForTest());
3008 runAddDocument(Server, FooCpp, F.code());
3009 // Run completion outside the file range.
3010 EXPECT_THAT(cantFail(runCodeComplete(Server, FooCpp, F.point(),
3011 clangd::CodeCompleteOptions()))
3012 .Completions,
3013 IsEmpty());
3014 EXPECT_THAT(cantFail(runSignatureHelp(Server, FooCpp, F.point(),
3016 .signatures,
3017 IsEmpty());
3018}
3019
3020TEST(GuessCompletionPrefix, Filters) {
3021 for (llvm::StringRef Case : {
3022 "[[scope::]][[ident]]^",
3023 "[[]][[]]^",
3024 "\n[[]][[]]^",
3025 "[[]][[ab]]^",
3026 "x.[[]][[ab]]^",
3027 "x.[[]][[]]^",
3028 "[[x::]][[ab]]^",
3029 "[[x::]][[]]^",
3030 "[[::x::]][[ab]]^",
3031 "some text [[scope::more::]][[identif]]^ier",
3032 "some text [[scope::]][[mor]]^e::identifier",
3033 "weird case foo::[[::bar::]][[baz]]^",
3034 "/* [[]][[]]^ */",
3035 }) {
3036 Annotations F(Case);
3037 auto Offset = cantFail(positionToOffset(F.code(), F.point()));
3038 auto ToStringRef = [&](Range R) {
3039 return F.code().slice(cantFail(positionToOffset(F.code(), R.start)),
3040 cantFail(positionToOffset(F.code(), R.end)));
3041 };
3042 auto WantQualifier = ToStringRef(F.ranges()[0]),
3043 WantName = ToStringRef(F.ranges()[1]);
3044
3045 auto Prefix = guessCompletionPrefix(F.code(), Offset);
3046 // Even when components are empty, check their offsets are correct.
3047 EXPECT_EQ(WantQualifier, Prefix.Qualifier) << Case;
3048 EXPECT_EQ(WantQualifier.begin(), Prefix.Qualifier.begin()) << Case;
3049 EXPECT_EQ(WantName, Prefix.Name) << Case;
3050 EXPECT_EQ(WantName.begin(), Prefix.Name.begin()) << Case;
3051 }
3052}
3053
3054TEST(CompletionTest, EnableSpeculativeIndexRequest) {
3055 MockFS FS;
3057 ClangdServer Server(CDB, FS, ClangdServer::optsForTest());
3058
3059 auto File = testPath("foo.cpp");
3060 Annotations Test(R"cpp(
3061 namespace ns1 { int abc; }
3062 namespace ns2 { int abc; }
3063 void f() { ns1::ab$1^; ns1::ab$2^; }
3064 void f2() { ns2::ab$3^; }
3065 )cpp");
3066 runAddDocument(Server, File, Test.code());
3067 clangd::CodeCompleteOptions Opts = {};
3068
3069 IndexRequestCollector Requests;
3070 Opts.Index = &Requests;
3071
3072 auto CompleteAtPoint = [&](StringRef P) {
3073 auto CCR = cantFail(runCodeComplete(Server, File, Test.point(P), Opts));
3074 EXPECT_TRUE(CCR.HasMore);
3075 };
3076
3077 CompleteAtPoint("1");
3078 auto Reqs1 = Requests.consumeRequests(1);
3079 ASSERT_EQ(Reqs1.size(), 1u);
3080 EXPECT_THAT(Reqs1[0].Scopes, UnorderedElementsAre("ns1::"));
3081
3082 CompleteAtPoint("2");
3083 auto Reqs2 = Requests.consumeRequests(1);
3084 // Speculation succeeded. Used speculative index result.
3085 ASSERT_EQ(Reqs2.size(), 1u);
3086 EXPECT_EQ(Reqs2[0], Reqs1[0]);
3087
3088 CompleteAtPoint("3");
3089 // Speculation failed. Sent speculative index request and the new index
3090 // request after sema.
3091 auto Reqs3 = Requests.consumeRequests(2);
3092 ASSERT_EQ(Reqs3.size(), 2u);
3093}
3094
3095TEST(CompletionTest, InsertTheMostPopularHeader) {
3096 std::string DeclFile = URI::create(testPath("foo")).toString();
3097 Symbol Sym = func("Func");
3098 Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
3099 Sym.IncludeHeaders.emplace_back("\"foo.h\"", 2, Symbol::Include);
3100 Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000, Symbol::Include);
3101
3102 auto Results = completions("Fun^", {Sym}).Completions;
3103 assert(!Results.empty());
3104 EXPECT_THAT(Results[0], AllOf(named("Func"), insertInclude("\"bar.h\"")));
3105 EXPECT_EQ(Results[0].Includes.size(), 2u);
3106}
3107
3108TEST(CompletionTest, InsertIncludeOrImport) {
3109 std::string DeclFile = URI::create(testPath("foo")).toString();
3110 Symbol Sym = func("Func");
3111 Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
3112 Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000,
3115 // Should only take effect in import contexts.
3116 Opts.ImportInsertions = true;
3117 auto Results = completions("Fun^", {Sym}, Opts).Completions;
3118 assert(!Results.empty());
3119 EXPECT_THAT(Results[0],
3120 AllOf(named("Func"), insertIncludeText("#include \"bar.h\"\n")));
3121
3122 ASTSignals Signals;
3124 Opts.MainFileSignals = &Signals;
3125 Results = completions("Fun^", {Sym}, Opts, "Foo.m").Completions;
3126 assert(!Results.empty());
3127 EXPECT_THAT(Results[0],
3128 AllOf(named("Func"), insertIncludeText("#import \"bar.h\"\n")));
3129
3130 Sym.IncludeHeaders[0].SupportedDirectives = Symbol::Import;
3131 Results = completions("Fun^", {Sym}).Completions;
3132 assert(!Results.empty());
3133 EXPECT_THAT(Results[0], AllOf(named("Func"), Not(insertInclude())));
3134}
3135
3136TEST(CompletionTest, NoInsertIncludeIfOnePresent) {
3137 Annotations Test(R"cpp(
3138 #include "foo.h"
3139 Fun^
3140 )cpp");
3141 auto TU = TestTU::withCode(Test.code());
3142 TU.AdditionalFiles["foo.h"] = "";
3143
3144 std::string DeclFile = URI::create(testPath("foo")).toString();
3145 Symbol Sym = func("Func");
3146 Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
3147 Sym.IncludeHeaders.emplace_back("\"foo.h\"", 2, Symbol::Include);
3148 Sym.IncludeHeaders.emplace_back("\"bar.h\"", 1000, Symbol::Include);
3149
3150 EXPECT_THAT(completions(TU, Test.point(), {Sym}).Completions,
3151 UnorderedElementsAre(AllOf(named("Func"), hasInclude("\"foo.h\""),
3152 Not(insertInclude()))));
3153}
3154
3155TEST(CompletionTest, MergeMacrosFromIndexAndSema) {
3156 Symbol Sym;
3157 Sym.Name = "Clangd_Macro_Test";
3158 Sym.ID = SymbolID("c:foo.cpp@8@macro@Clangd_Macro_Test");
3159 Sym.SymInfo.Kind = index::SymbolKind::Macro;
3161 EXPECT_THAT(completions("#define Clangd_Macro_Test\nClangd_Macro_T^", {Sym})
3162 .Completions,
3163 UnorderedElementsAre(named("Clangd_Macro_Test")));
3164}
3165
3166TEST(CompletionTest, MacroFromPreamble) {
3167 Annotations Test(R"cpp(#define CLANGD_PREAMBLE_MAIN x
3168
3169 int x = 0;
3170 #define CLANGD_MAIN x
3171 void f() { CLANGD_^ }
3172 )cpp");
3173 auto TU = TestTU::withCode(Test.code());
3174 TU.HeaderCode = "#define CLANGD_PREAMBLE_HEADER x";
3175 auto Results = completions(TU, Test.point(), {func("CLANGD_INDEX")});
3176 // We should get results from the main file, including the preamble section.
3177 // However no results from included files (the index should cover them).
3178 EXPECT_THAT(Results.Completions,
3179 UnorderedElementsAre(named("CLANGD_PREAMBLE_MAIN"),
3180 named("CLANGD_MAIN"),
3181 named("CLANGD_INDEX")));
3182}
3183
3184TEST(CompletionTest, DeprecatedResults) {
3185 std::string Body = R"cpp(
3186 void TestClangd();
3187 void TestClangc() __attribute__((deprecated("", "")));
3188 )cpp";
3189
3190 EXPECT_THAT(
3191 completions(Body + "int main() { TestClang^ }").Completions,
3192 UnorderedElementsAre(AllOf(named("TestClangd"), Not(deprecated())),
3193 AllOf(named("TestClangc"), deprecated())));
3194}
3195
3196TEST(SignatureHelpTest, PartialSpec) {
3197 const auto Results = signatures(R"cpp(
3198 template <typename T> struct Foo {};
3199 template <typename T> struct Foo<T*> { Foo(T); };
3200 Foo<int*> F(^);)cpp");
3201 EXPECT_THAT(Results.signatures, Contains(sig("Foo([[T]])")));
3202 EXPECT_EQ(0, Results.activeParameter);
3203}
3204
3205TEST(SignatureHelpTest, InsideArgument) {
3206 {
3207 const auto Results = signatures(R"cpp(
3208 void foo(int x);
3209 void foo(int x, int y);
3210 int main() { foo(1+^); }
3211 )cpp");
3212 EXPECT_THAT(Results.signatures,
3213 ElementsAre(sig("foo([[int x]]) -> void"),
3214 sig("foo([[int x]], [[int y]]) -> void")));
3215 EXPECT_EQ(0, Results.activeParameter);
3216 }
3217 {
3218 const auto Results = signatures(R"cpp(
3219 void foo(int x);
3220 void foo(int x, int y);
3221 int main() { foo(1^); }
3222 )cpp");
3223 EXPECT_THAT(Results.signatures,
3224 ElementsAre(sig("foo([[int x]]) -> void"),
3225 sig("foo([[int x]], [[int y]]) -> void")));
3226 EXPECT_EQ(0, Results.activeParameter);
3227 }
3228 {
3229 const auto Results = signatures(R"cpp(
3230 void foo(int x);
3231 void foo(int x, int y);
3232 int main() { foo(1^0); }
3233 )cpp");
3234 EXPECT_THAT(Results.signatures,
3235 ElementsAre(sig("foo([[int x]]) -> void"),
3236 sig("foo([[int x]], [[int y]]) -> void")));
3237 EXPECT_EQ(0, Results.activeParameter);
3238 }
3239 {
3240 const auto Results = signatures(R"cpp(
3241 void foo(int x);
3242 void foo(int x, int y);
3243 int bar(int x, int y);
3244 int main() { bar(foo(2, 3^)); }
3245 )cpp");
3246 EXPECT_THAT(Results.signatures,
3247 ElementsAre(sig("foo([[int x]], [[int y]]) -> void")));
3248 EXPECT_EQ(1, Results.activeParameter);
3249 }
3250}
3251
3252TEST(SignatureHelpTest, ConstructorInitializeFields) {
3253 {
3254 const auto Results = signatures(R"cpp(
3255 struct A { A(int); };
3256 struct B {
3257 B() : a_elem(^) {}
3258 A a_elem;
3259 };
3260 )cpp");
3261 EXPECT_THAT(Results.signatures,
3262 UnorderedElementsAre(sig("A([[int]])"), sig("A([[A &&]])"),
3263 sig("A([[const A &]])")));
3264 }
3265 {
3266 const auto Results = signatures(R"cpp(
3267 struct A { A(int); };
3268 struct B {
3269 B() : a_elem(^
3270 A a_elem;
3271 };
3272 )cpp");
3273 // FIXME: currently the parser skips over the decl of a_elem as part of the
3274 // (broken) init list, so we don't get signatures for the first member.
3275 EXPECT_THAT(Results.signatures, IsEmpty());
3276 }
3277 {
3278 const auto Results = signatures(R"cpp(
3279 struct A { A(int); };
3280 struct B {
3281 B() : a_elem(^
3282 int dummy_elem;
3283 A a_elem;
3284 };
3285 )cpp");
3286 EXPECT_THAT(Results.signatures,
3287 UnorderedElementsAre(sig("A([[int]])"), sig("A([[A &&]])"),
3288 sig("A([[const A &]])")));
3289 }
3290 {
3291 const auto Results = signatures(R"cpp(
3292 struct A {
3293 A(int);
3294 };
3295 struct C {
3296 C(int);
3297 C(A);
3298 };
3299 struct B {
3300 B() : c_elem(A(1^)) {}
3301 C c_elem;
3302 };
3303 )cpp");
3304 EXPECT_THAT(Results.signatures,
3305 UnorderedElementsAre(sig("A([[int]])"), sig("A([[A &&]])"),
3306 sig("A([[const A &]])")));
3307 }
3308}
3309
3310TEST(SignatureHelpTest, Variadic) {
3311 const std::string Header = R"cpp(
3312 void fun(int x, ...) {}
3313 void test() {)cpp";
3314 const std::string ExpectedSig = "fun([[int x]], [[...]]) -> void";
3315
3316 {
3317 const auto Result = signatures(Header + "fun(^);}");
3318 EXPECT_EQ(0, Result.activeParameter);
3319 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3320 }
3321 {
3322 const auto Result = signatures(Header + "fun(1, ^);}");
3323 EXPECT_EQ(1, Result.activeParameter);
3324 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3325 }
3326 {
3327 const auto Result = signatures(Header + "fun(1, 2, ^);}");
3328 EXPECT_EQ(1, Result.activeParameter);
3329 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3330 }
3331}
3332
3333TEST(SignatureHelpTest, VariadicTemplate) {
3334 const std::string Header = R"cpp(
3335 template<typename T, typename ...Args>
3336 void fun(T t, Args ...args) {}
3337 void test() {)cpp";
3338 const std::string ExpectedSig = "fun([[T t]], [[Args args...]]) -> void";
3339
3340 {
3341 const auto Result = signatures(Header + "fun(^);}");
3342 EXPECT_EQ(0, Result.activeParameter);
3343 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3344 }
3345 {
3346 const auto Result = signatures(Header + "fun(1, ^);}");
3347 EXPECT_EQ(1, Result.activeParameter);
3348 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3349 }
3350 {
3351 const auto Result = signatures(Header + "fun(1, 2, ^);}");
3352 EXPECT_EQ(1, Result.activeParameter);
3353 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3354 }
3355}
3356
3357TEST(SignatureHelpTest, VariadicMethod) {
3358 const std::string Header = R"cpp(
3359 class C {
3360 template<typename T, typename ...Args>
3361 void fun(T t, Args ...args) {}
3362 };
3363 void test() {C c; )cpp";
3364 const std::string ExpectedSig = "fun([[T t]], [[Args args...]]) -> void";
3365
3366 {
3367 const auto Result = signatures(Header + "c.fun(^);}");
3368 EXPECT_EQ(0, Result.activeParameter);
3369 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3370 }
3371 {
3372 const auto Result = signatures(Header + "c.fun(1, ^);}");
3373 EXPECT_EQ(1, Result.activeParameter);
3374 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3375 }
3376 {
3377 const auto Result = signatures(Header + "c.fun(1, 2, ^);}");
3378 EXPECT_EQ(1, Result.activeParameter);
3379 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3380 }
3381}
3382
3383TEST(SignatureHelpTest, VariadicType) {
3384 const std::string Header = R"cpp(
3385 void fun(int x, ...) {}
3386 auto get_fun() { return fun; }
3387 void test() {
3388 )cpp";
3389 const std::string ExpectedSig = "([[int]], [[...]]) -> void";
3390
3391 {
3392 const auto Result = signatures(Header + "get_fun()(^);}");
3393 EXPECT_EQ(0, Result.activeParameter);
3394 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3395 }
3396 {
3397 const auto Result = signatures(Header + "get_fun()(1, ^);}");
3398 EXPECT_EQ(1, Result.activeParameter);
3399 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3400 }
3401 {
3402 const auto Result = signatures(Header + "get_fun()(1, 2, ^);}");
3403 EXPECT_EQ(1, Result.activeParameter);
3404 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3405 }
3406}
3407
3408TEST(SignatureHelpTest, SkipExplicitObjectParameter) {
3409 Annotations Code(R"cpp(
3410 struct A {
3411 void foo(this auto&& self, int arg);
3412 void bar(this A self, int arg);
3413 };
3414 int main() {
3415 A a {};
3416 a.foo($c1^);
3417 (&A::bar)($c2^);
3418 (&A::foo)($c3^);
3419 }
3420 )cpp");
3421
3422 auto TU = TestTU::withCode(Code.code());
3423 TU.ExtraArgs = {"-std=c++23"};
3424
3425 MockFS FS;
3426 auto Inputs = TU.inputs(FS);
3427
3428 auto Preamble = TU.preamble();
3429 ASSERT_TRUE(Preamble);
3430
3431 {
3432 const auto Result = signatureHelp(testPath(TU.Filename), Code.point("c1"),
3434
3435 EXPECT_EQ(1U, Result.signatures.size());
3436
3437 EXPECT_THAT(Result.signatures[0], AllOf(sig("foo([[int arg]]) -> void")));
3438 }
3439 {
3440 const auto Result = signatureHelp(testPath(TU.Filename), Code.point("c2"),
3442
3443 EXPECT_EQ(1U, Result.signatures.size());
3444
3445 EXPECT_THAT(Result.signatures[0], AllOf(sig("([[A]], [[int]]) -> void")));
3446 }
3447 {
3448 // TODO: llvm/llvm-project/146649
3449 const auto Result = signatureHelp(testPath(TU.Filename), Code.point("c3"),
3451 // TODO: We expect 1 signature here, with this signature
3452 EXPECT_EQ(0U, Result.signatures.size());
3453 // EXPECT_THAT(Result.signatures[0], AllOf(sig("([[auto&&]], [[int]]) ->
3454 // void")));
3455 }
3456}
3457
3458TEST(CompletionTest, IncludedCompletionKinds) {
3459 Annotations Test(R"cpp(#include "^)cpp");
3460 auto TU = TestTU::withCode(Test.code());
3461 TU.AdditionalFiles["sub/bar.h"] = "";
3462 TU.ExtraArgs.push_back("-I" + testPath("sub"));
3463
3464 auto Results = completions(TU, Test.point());
3465 EXPECT_THAT(Results.Completions,
3466 AllOf(has("sub/", CompletionItemKind::Folder),
3467 has("bar.h\"", CompletionItemKind::File)));
3468}
3469
3470TEST(CompletionTest, NoCrashAtNonAlphaIncludeHeader) {
3471 completions(
3472 R"cpp(
3473 #include "./^"
3474 )cpp");
3475}
3476
3477TEST(CompletionTest, NoAllScopesCompletionWhenQualified) {
3478 clangd::CodeCompleteOptions Opts = {};
3479 Opts.AllScopes = true;
3480
3481 auto Results = completions(
3482 R"cpp(
3483 void f() { na::Clangd^ }
3484 )cpp",
3485 {cls("na::ClangdA"), cls("nx::ClangdX"), cls("Clangd3")}, Opts);
3486 EXPECT_THAT(Results.Completions,
3487 UnorderedElementsAre(
3488 AllOf(qualifier(""), scope("na::"), named("ClangdA"))));
3489}
3490
3491TEST(CompletionTest, AllScopesCompletion) {
3492 clangd::CodeCompleteOptions Opts = {};
3493 Opts.AllScopes = true;
3494
3495 auto Results = completions(
3496 R"cpp(
3497 namespace na {
3498 void f() { Clangd^ }
3499 }
3500 )cpp",
3501 {cls("nx::Clangd1"), cls("ny::Clangd2"), cls("Clangd3"),
3502 cls("na::nb::Clangd4"), enmConstant("na::C::Clangd5")},
3503 Opts);
3504 EXPECT_THAT(
3505 Results.Completions,
3506 UnorderedElementsAre(AllOf(qualifier("nx::"), named("Clangd1"),
3508 AllOf(qualifier("ny::"), named("Clangd2"),
3510 AllOf(qualifier(""), scope(""), named("Clangd3"),
3512 AllOf(qualifier("nb::"), named("Clangd4"),
3514 AllOf(qualifier("C::"), named("Clangd5"),
3516}
3517
3518TEST(CompletionTest, NoCodePatternsIfDisabled) {
3519 clangd::CodeCompleteOptions Opts = {};
3520 Opts.EnableSnippets = true;
3521 Opts.CodePatterns = Config::CodePatternsPolicy::None;
3522
3523 auto Results = completions(R"cpp(
3524 void function() {
3525 /// Trying to trigger "for (init-statement; condition; inc-expression)
3526 /// {statements}~" code pattern
3527 for^
3528 }
3529 )cpp",
3530 {}, Opts);
3531
3532 EXPECT_THAT(Results.Completions,
3533 Not(Contains(kind(CompletionItemKind::Snippet))));
3534}
3535
3536TEST(CompletionTest, CompleteIncludeIfCodePatternsNone) {
3537 clangd::CodeCompleteOptions Opts = {};
3538 Opts.EnableSnippets = true;
3539 Opts.CodePatterns = Config::CodePatternsPolicy::None;
3540
3541 Annotations Test(R"cpp(#include "^)cpp");
3542 auto TU = TestTU::withCode(Test.code());
3543 TU.AdditionalFiles["foo/bar.h"] = "";
3544 TU.ExtraArgs.push_back("-I" + testPath("foo"));
3545
3546 auto Results = completions(TU, Test.point(), {}, Opts);
3547 EXPECT_THAT(Results.Completions,
3548 AllOf(has("foo/", CompletionItemKind::Folder),
3549 has("bar.h\"", CompletionItemKind::File)));
3550}
3551
3552TEST(CompletionTest, NoQualifierIfShadowed) {
3553 clangd::CodeCompleteOptions Opts = {};
3554 Opts.AllScopes = true;
3555
3556 auto Results = completions(R"cpp(
3557 namespace nx { class Clangd1 {}; }
3558 using nx::Clangd1;
3559 void f() { Clangd^ }
3560 )cpp",
3561 {cls("nx::Clangd1"), cls("nx::Clangd2")}, Opts);
3562 // Although Clangd1 is from another namespace, Sema tells us it's in-scope and
3563 // needs no qualifier.
3564 EXPECT_THAT(Results.Completions,
3565 UnorderedElementsAre(AllOf(qualifier(""), named("Clangd1")),
3566 AllOf(qualifier("nx::"), named("Clangd2"))));
3567}
3568
3569TEST(CompletionTest, NoCompletionsForNewNames) {
3570 clangd::CodeCompleteOptions Opts;
3571 Opts.AllScopes = true;
3572 auto Results = completions(R"cpp(
3573 void f() { int n^ }
3574 )cpp",
3575 {cls("naber"), cls("nx::naber")}, Opts);
3576 EXPECT_THAT(Results.Completions, UnorderedElementsAre());
3577}
3578
3579TEST(CompletionTest, Lambda) {
3580 clangd::CodeCompleteOptions Opts = {};
3581
3582 auto Results = completions(R"cpp(
3583 void function() {
3584 auto Lambda = [](int a, const double &b) {return 1.f;};
3585 Lam^
3586 }
3587 )cpp",
3588 {}, Opts);
3589
3590 ASSERT_EQ(Results.Completions.size(), 1u);
3591 const auto &A = Results.Completions.front();
3592 EXPECT_EQ(A.Name, "Lambda");
3593 EXPECT_EQ(A.Signature, "(int a, const double &b) const");
3594 EXPECT_EQ(A.Kind, CompletionItemKind::Variable);
3595 EXPECT_EQ(A.ReturnType, "float");
3596 EXPECT_EQ(A.SnippetSuffix, "(${1:int a}, ${2:const double &b})");
3597}
3598
3599TEST(CompletionTest, StructuredBinding) {
3600 clangd::CodeCompleteOptions Opts = {};
3601
3602 auto Results = completions(R"cpp(
3603 struct S {
3604 using Float = float;
3605 int x;
3606 Float y;
3607 };
3608 void function() {
3609 const auto &[xxx, yyy] = S{};
3610 yyy^
3611 }
3612 )cpp",
3613 {}, Opts);
3614
3615 ASSERT_EQ(Results.Completions.size(), 1u);
3616 const auto &A = Results.Completions.front();
3617 EXPECT_EQ(A.Name, "yyy");
3618 EXPECT_EQ(A.Kind, CompletionItemKind::Variable);
3619 EXPECT_EQ(A.ReturnType, "const Float");
3620}
3621
3622TEST(CompletionTest, ObjectiveCMethodNoArguments) {
3623 auto Results = completions(R"objc(
3624 @interface Foo
3625 @property(nonatomic, setter=setXToIgnoreComplete:) int value;
3626 @end
3627 Foo *foo = [Foo new]; int y = [foo v^]
3628 )objc",
3629 /*IndexSymbols=*/{},
3630 /*Opts=*/{}, "Foo.m");
3631
3632 auto C = Results.Completions;
3633 EXPECT_THAT(C, ElementsAre(named("value")));
3634 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3635 EXPECT_THAT(C, ElementsAre(returnType("int")));
3636 EXPECT_THAT(C, ElementsAre(signature("")));
3637 EXPECT_THAT(C, ElementsAre(snippetSuffix("")));
3638}
3639
3640TEST(CompletionTest, ObjectiveCMethodOneArgument) {
3641 auto Results = completions(R"objc(
3642 @interface Foo
3643 - (int)valueForCharacter:(char)c;
3644 @end
3645 Foo *foo = [Foo new]; int y = [foo v^]
3646 )objc",
3647 /*IndexSymbols=*/{},
3648 /*Opts=*/{}, "Foo.m");
3649
3650 auto C = Results.Completions;
3651 EXPECT_THAT(C, ElementsAre(named("valueForCharacter:")));
3652 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3653 EXPECT_THAT(C, ElementsAre(returnType("int")));
3654 EXPECT_THAT(C, ElementsAre(signature("(char)")));
3655 EXPECT_THAT(C, ElementsAre(snippetSuffix("${1:(char)}")));
3656}
3657
3658TEST(CompletionTest, ObjectiveCMethodTwoArgumentsFromBeginning) {
3659 auto Results = completions(R"objc(
3660 @interface Foo
3661 + (id)fooWithValue:(int)value fooey:(unsigned int)fooey;
3662 @end
3663 id val = [Foo foo^]
3664 )objc",
3665 /*IndexSymbols=*/{},
3666 /*Opts=*/{}, "Foo.m");
3667
3668 auto C = Results.Completions;
3669 EXPECT_THAT(C, ElementsAre(named("fooWithValue:")));
3670 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3671 EXPECT_THAT(C, ElementsAre(returnType("id")));
3672 EXPECT_THAT(C, ElementsAre(signature("(int) fooey:(unsigned int)")));
3673 EXPECT_THAT(
3674 C, ElementsAre(snippetSuffix("${1:(int)} fooey:${2:(unsigned int)}")));
3675}
3676
3677TEST(CompletionTest, ObjectiveCMethodTwoArgumentsFromMiddle) {
3678 auto Results = completions(R"objc(
3679 @interface Foo
3680 + (id)fooWithValue:(int)value fooey:(unsigned int)fooey;
3681 @end
3682 id val = [Foo fooWithValue:10 f^]
3683 )objc",
3684 /*IndexSymbols=*/{},
3685 /*Opts=*/{}, "Foo.m");
3686
3687 auto C = Results.Completions;
3688 EXPECT_THAT(C, ElementsAre(named("fooey:")));
3689 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3690 EXPECT_THAT(C, ElementsAre(returnType("id")));
3691 EXPECT_THAT(C, ElementsAre(signature("(unsigned int)")));
3692 EXPECT_THAT(C, ElementsAre(snippetSuffix("${1:(unsigned int)}")));
3693}
3694
3695TEST(CompletionTest, ObjectiveCMethodFilterOnEntireSelector) {
3696 auto Results = completions(R"objc(
3697 @interface Foo
3698 + (id)player:(id)player willRun:(id)run;
3699 @end
3700 id val = [Foo wi^]
3701 )objc",
3702 /*IndexSymbols=*/{},
3703 /*Opts=*/{}, "Foo.m");
3704
3705 auto C = Results.Completions;
3706 EXPECT_THAT(C, ElementsAre(named("player:")));
3707 EXPECT_THAT(C, ElementsAre(filterText("player:willRun:")));
3708 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3709 EXPECT_THAT(C, ElementsAre(returnType("id")));
3710 EXPECT_THAT(C, ElementsAre(signature("(id) willRun:(id)")));
3711 EXPECT_THAT(C, ElementsAre(snippetSuffix("${1:(id)} willRun:${2:(id)}")));
3712}
3713
3714TEST(CompletionTest, ObjectiveCSimpleMethodDeclaration) {
3715 auto Results = completions(R"objc(
3716 @interface Foo
3717 - (void)foo;
3718 @end
3719 @implementation Foo
3720 fo^
3721 @end
3722 )objc",
3723 /*IndexSymbols=*/{},
3724 /*Opts=*/{}, "Foo.m");
3725
3726 auto C = Results.Completions;
3727 EXPECT_THAT(C, ElementsAre(named("foo")));
3728 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3729 EXPECT_THAT(C, ElementsAre(qualifier("- (void)")));
3730}
3731
3732TEST(CompletionTest, ObjectiveCMethodDeclaration) {
3733 auto Results = completions(R"objc(
3734 @interface Foo
3735 - (int)valueForCharacter:(char)c secondArgument:(id)object;
3736 @end
3737 @implementation Foo
3738 valueFor^
3739 @end
3740 )objc",
3741 /*IndexSymbols=*/{},
3742 /*Opts=*/{}, "Foo.m");
3743
3744 auto C = Results.Completions;
3745 EXPECT_THAT(C, ElementsAre(named("valueForCharacter:")));
3746 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3747 EXPECT_THAT(C, ElementsAre(qualifier("- (int)")));
3748 EXPECT_THAT(C, ElementsAre(signature("(char)c secondArgument:(id)object")));
3749}
3750
3751TEST(CompletionTest, ObjectiveCMethodDeclarationFilterOnEntireSelector) {
3752 auto Results = completions(R"objc(
3753 @interface Foo
3754 - (int)valueForCharacter:(char)c secondArgument:(id)object;
3755 @end
3756 @implementation Foo
3757 secondArg^
3758 @end
3759 )objc",
3760 /*IndexSymbols=*/{},
3761 /*Opts=*/{}, "Foo.m");
3762
3763 auto C = Results.Completions;
3764 EXPECT_THAT(C, ElementsAre(named("valueForCharacter:")));
3765 EXPECT_THAT(C, ElementsAre(filterText("valueForCharacter:secondArgument:")));
3766 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3767 EXPECT_THAT(C, ElementsAre(qualifier("- (int)")));
3768 EXPECT_THAT(C, ElementsAre(signature("(char)c secondArgument:(id)object")));
3769}
3770
3771TEST(CompletionTest, ObjectiveCMethodDeclarationPrefixTyped) {
3772 auto Results = completions(R"objc(
3773 @interface Foo
3774 - (int)valueForCharacter:(char)c;
3775 @end
3776 @implementation Foo
3777 - (int)valueFor^
3778 @end
3779 )objc",
3780 /*IndexSymbols=*/{},
3781 /*Opts=*/{}, "Foo.m");
3782
3783 auto C = Results.Completions;
3784 EXPECT_THAT(C, ElementsAre(named("valueForCharacter:")));
3785 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3786 EXPECT_THAT(C, ElementsAre(signature("(char)c")));
3787}
3788
3789TEST(CompletionTest, ObjectiveCMethodDeclarationFromMiddle) {
3790 auto Results = completions(R"objc(
3791 @interface Foo
3792 - (int)valueForCharacter:(char)c secondArgument:(id)object;
3793 @end
3794 @implementation Foo
3795 - (int)valueForCharacter:(char)c second^
3796 @end
3797 )objc",
3798 /*IndexSymbols=*/{},
3799 /*Opts=*/{}, "Foo.m");
3800
3801 auto C = Results.Completions;
3802 EXPECT_THAT(C, ElementsAre(named("secondArgument:")));
3803 EXPECT_THAT(C, ElementsAre(kind(CompletionItemKind::Method)));
3804 EXPECT_THAT(C, ElementsAre(signature("(id)object")));
3805}
3806
3807TEST(CompletionTest, ObjectiveCProtocolFromIndex) {
3808 Symbol FoodClass = objcClass("FoodClass");
3809 Symbol SymFood = objcProtocol("Food");
3810 Symbol SymFooey = objcProtocol("Fooey");
3811 auto Results = completions("id<Foo^>", {SymFood, FoodClass, SymFooey},
3812 /*Opts=*/{}, "Foo.m");
3813
3814 // Should only give protocols for ObjC protocol completions.
3815 EXPECT_THAT(Results.Completions,
3816 UnorderedElementsAre(
3817 AllOf(named("Food"), kind(CompletionItemKind::Interface)),
3818 AllOf(named("Fooey"), kind(CompletionItemKind::Interface))));
3819
3820 Results = completions("Fo^", {SymFood, FoodClass, SymFooey},
3821 /*Opts=*/{}, "Foo.m");
3822 // Shouldn't give protocols for non protocol completions.
3823 EXPECT_THAT(
3824 Results.Completions,
3825 ElementsAre(AllOf(named("FoodClass"), kind(CompletionItemKind::Class))));
3826}
3827
3828TEST(CompletionTest, ObjectiveCProtocolFromIndexSpeculation) {
3829 MockFS FS;
3831 ClangdServer Server(CDB, FS, ClangdServer::optsForTest());
3832
3833 auto File = testPath("Foo.m");
3834 Annotations Test(R"cpp(
3835 @protocol Food
3836 @end
3837 id<Foo$1^> foo;
3838 Foo$2^ bar;
3839 )cpp");
3840 runAddDocument(Server, File, Test.code());
3841 clangd::CodeCompleteOptions Opts = {};
3842
3843 Symbol FoodClass = objcClass("FoodClass");
3844 IndexRequestCollector Requests({FoodClass});
3845 Opts.Index = &Requests;
3846
3847 auto CompleteAtPoint = [&](StringRef P) {
3848 return cantFail(runCodeComplete(Server, File, Test.point(P), Opts))
3849 .Completions;
3850 };
3851
3852 auto C = CompleteAtPoint("1");
3853 auto Reqs1 = Requests.consumeRequests(1);
3854 ASSERT_EQ(Reqs1.size(), 1u);
3855 EXPECT_THAT(C, ElementsAre(AllOf(named("Food"),
3857
3858 C = CompleteAtPoint("2");
3859 auto Reqs2 = Requests.consumeRequests(1);
3860 // Speculation succeeded. Used speculative index result, but filtering now to
3861 // now include FoodClass.
3862 ASSERT_EQ(Reqs2.size(), 1u);
3863 EXPECT_EQ(Reqs2[0], Reqs1[0]);
3864 EXPECT_THAT(C, ElementsAre(AllOf(named("FoodClass"),
3866}
3867
3868TEST(CompletionTest, ObjectiveCCategoryFromIndexIgnored) {
3869 Symbol FoodCategory = objcCategory("FoodClass", "Extension");
3870 auto Results = completions(R"objc(
3871 @interface Foo
3872 @end
3873 @interface Foo (^)
3874 @end
3875 )objc",
3876 {FoodCategory},
3877 /*Opts=*/{}, "Foo.m");
3878 EXPECT_THAT(Results.Completions, IsEmpty());
3879}
3880
3881TEST(CompletionTest, ObjectiveCForwardDeclFromIndex) {
3882 Symbol FoodClass = objcClass("FoodClass");
3883 FoodClass.IncludeHeaders.emplace_back("\"Foo.h\"", 2, Symbol::Import);
3884 Symbol SymFood = objcProtocol("Food");
3885 auto Results = completions("@class Foo^", {SymFood, FoodClass},
3886 /*Opts=*/{}, "Foo.m");
3887
3888 // Should only give class names without any include insertion.
3889 EXPECT_THAT(Results.Completions,
3890 UnorderedElementsAre(AllOf(named("FoodClass"),
3892 Not(insertInclude()))));
3893}
3894
3895TEST(CompletionTest, CursorInSnippets) {
3896 clangd::CodeCompleteOptions Options;
3897 Options.EnableSnippets = true;
3898 auto Results = completions(
3899 R"cpp(
3900 void while_foo(int a, int b);
3901 void test() {
3902 whil^
3903 })cpp",
3904 /*IndexSymbols=*/{}, Options);
3905
3906 // Last placeholder in code patterns should be $0 to put the cursor there.
3907 EXPECT_THAT(Results.Completions,
3908 Contains(AllOf(named("while"),
3909 snippetSuffix(" (${1:condition}) {\n$0\n}"))));
3910 // However, snippets for functions must *not* end with $0.
3911 EXPECT_THAT(Results.Completions,
3912 Contains(AllOf(named("while_foo"),
3913 snippetSuffix("(${1:int a}, ${2:int b})"))));
3914
3915 Results = completions(R"cpp(
3916 struct Base {
3917 Base(int a, int b) {}
3918 };
3919
3920 struct Derived : Base {
3921 Derived() : Base^
3922 };
3923 )cpp",
3924 /*IndexSymbols=*/{}, Options);
3925 // Constructors from base classes are a kind of pattern that shouldn't end
3926 // with $0.
3927 EXPECT_THAT(Results.Completions,
3928 Contains(AllOf(named("Base"),
3929 snippetSuffix("(${1:int a}, ${2:int b})"))));
3930}
3931
3932TEST(CompletionTest, WorksWithNullType) {
3933 auto R = completions(R"cpp(
3934 int main() {
3935 for (auto [loopVar] : y ) { // y has to be unresolved.
3936 int z = loopV^;
3937 }
3938 }
3939 )cpp");
3940 EXPECT_THAT(R.Completions, ElementsAre(named("loopVar")));
3941}
3942
3943TEST(CompletionTest, UsingDecl) {
3944 const char *Header(R"cpp(
3945 void foo(int);
3946 namespace std {
3947 using ::foo;
3948 })cpp");
3949 const char *Source(R"cpp(
3950 void bar() {
3951 std::^;
3952 })cpp");
3953 auto Index = TestTU::withHeaderCode(Header).index();
3954 clangd::CodeCompleteOptions Opts;
3955 Opts.Index = Index.get();
3956 Opts.AllScopes = true;
3957 auto R = completions(Source, {}, Opts);
3958 EXPECT_THAT(R.Completions,
3959 ElementsAre(AllOf(scope("std::"), named("foo"),
3961}
3962
3963TEST(CompletionTest, Enums) {
3964 const char *Header(R"cpp(
3965 namespace ns {
3966 enum Unscoped { Clangd1 };
3967 class C {
3968 enum Unscoped { Clangd2 };
3969 };
3970 enum class Scoped { Clangd3 };
3971 })cpp");
3972 const char *Source(R"cpp(
3973 void bar() {
3974 Clangd^
3975 })cpp");
3976 auto Index = TestTU::withHeaderCode(Header).index();
3977 clangd::CodeCompleteOptions Opts;
3978 Opts.Index = Index.get();
3979 Opts.AllScopes = true;
3980 auto R = completions(Source, {}, Opts);
3981 EXPECT_THAT(R.Completions, UnorderedElementsAre(
3982 AllOf(scope("ns::"), named("Clangd1"),
3984 AllOf(scope("ns::C::"), named("Clangd2"),
3986 AllOf(scope("ns::Scoped::"), named("Clangd3"),
3988}
3989
3990TEST(CompletionTest, ScopeIsUnresolved) {
3991 clangd::CodeCompleteOptions Opts = {};
3992 Opts.AllScopes = true;
3993
3994 auto Results = completions(R"cpp(
3995 namespace a {
3996 void f() { b::X^ }
3997 }
3998 )cpp",
3999 {cls("a::b::XYZ")}, Opts);
4000 EXPECT_THAT(Results.Completions,
4001 UnorderedElementsAre(AllOf(qualifier(""), named("XYZ"))));
4002}
4003
4004TEST(CompletionTest, NestedScopeIsUnresolved) {
4005 clangd::CodeCompleteOptions Opts = {};
4006 Opts.AllScopes = true;
4007
4008 auto Results = completions(R"cpp(
4009 namespace a {
4010 namespace b {}
4011 void f() { b::c::X^ }
4012 }
4013 )cpp",
4014 {cls("a::b::c::XYZ")}, Opts);
4015 EXPECT_THAT(Results.Completions,
4016 UnorderedElementsAre(AllOf(qualifier(""), named("XYZ"))));
4017}
4018
4019// Clang parser gets confused here and doesn't report the ns:: prefix.
4020// Naive behavior is to insert it again. We examine the source and recover.
4021TEST(CompletionTest, NamespaceDoubleInsertion) {
4022 clangd::CodeCompleteOptions Opts = {};
4023
4024 auto Results = completions(R"cpp(
4025 namespace foo {
4026 namespace ns {}
4027 #define M(X) < X
4028 M(ns::ABC^
4029 }
4030 )cpp",
4031 {cls("foo::ns::ABCDE")}, Opts);
4032 EXPECT_THAT(Results.Completions,
4033 UnorderedElementsAre(AllOf(qualifier(""), named("ABCDE"))));
4034}
4035
4036TEST(CompletionTest, DerivedMethodsAreAlwaysVisible) {
4037 // Despite the fact that base method matches the ref-qualifier better,
4038 // completion results should only include the derived method.
4039 auto Completions = completions(R"cpp(
4040 struct deque_base {
4041 float size();
4042 double size() const;
4043 };
4044 struct deque : deque_base {
4045 int size() const;
4046 };
4047
4048 auto x = deque().^
4049 )cpp")
4050 .Completions;
4051 EXPECT_THAT(Completions,
4052 ElementsAre(AllOf(returnType("int"), named("size"))));
4053}
4054
4055TEST(CompletionTest, NoCrashWithIncompleteLambda) {
4056 auto Completions = completions("auto&& x = []{^").Completions;
4057 // The completion of x itself can cause a problem: in the code completion
4058 // callback, its type is not known, which affects the linkage calculation.
4059 // A bad linkage value gets cached, and subsequently updated.
4060 EXPECT_THAT(Completions, Contains(named("x")));
4061
4062 auto Signatures = signatures("auto x() { x(^").signatures;
4063 EXPECT_THAT(Signatures, Contains(sig("x() -> auto")));
4064}
4065
4066TEST(CompletionTest, DelayedTemplateParsing) {
4067 Annotations Test(R"cpp(
4068 int xxx;
4069 template <typename T> int foo() { return xx^; }
4070 )cpp");
4071 auto TU = TestTU::withCode(Test.code());
4072 // Even though delayed-template-parsing is on, we will disable it to provide
4073 // completion in templates.
4074 TU.ExtraArgs.push_back("-fdelayed-template-parsing");
4075
4076 EXPECT_THAT(completions(TU, Test.point()).Completions,
4077 Contains(named("xxx")));
4078}
4079
4080TEST(CompletionTest, CompletionRange) {
4081 const char *WithRange = "auto x = [[abc]]^";
4082 auto Completions = completions(WithRange);
4083 EXPECT_EQ(Completions.CompletionRange, Annotations(WithRange).range());
4084 Completions = completionsNoCompile(WithRange);
4085 EXPECT_EQ(Completions.CompletionRange, Annotations(WithRange).range());
4086
4087 const char *EmptyRange = "auto x = [[]]^";
4088 Completions = completions(EmptyRange);
4089 EXPECT_EQ(Completions.CompletionRange, Annotations(EmptyRange).range());
4090 Completions = completionsNoCompile(EmptyRange);
4091 EXPECT_EQ(Completions.CompletionRange, Annotations(EmptyRange).range());
4092
4093 // Sema doesn't trigger at all here, while the no-sema completion runs
4094 // heuristics as normal and reports a range. It'd be nice to be consistent.
4095 const char *NoCompletion = "/* foo [[]]^ */";
4096 Completions = completions(NoCompletion);
4097 EXPECT_EQ(Completions.CompletionRange, std::nullopt);
4098 Completions = completionsNoCompile(NoCompletion);
4099 EXPECT_EQ(Completions.CompletionRange, Annotations(NoCompletion).range());
4100}
4101
4102TEST(NoCompileCompletionTest, Basic) {
4103 auto Results = completionsNoCompile(R"cpp(
4104 void func() {
4105 int xyz;
4106 int abc;
4107 ^
4108 }
4109 )cpp");
4110 EXPECT_FALSE(Results.RanParser);
4111 EXPECT_THAT(Results.Completions,
4112 UnorderedElementsAre(named("void"), named("func"), named("int"),
4113 named("xyz"), named("abc")));
4114}
4115
4116TEST(NoCompileCompletionTest, WithFilter) {
4117 auto Results = completionsNoCompile(R"cpp(
4118 void func() {
4119 int sym1;
4120 int sym2;
4121 int xyz1;
4122 int xyz2;
4123 sy^
4124 }
4125 )cpp");
4126 EXPECT_THAT(Results.Completions,
4127 UnorderedElementsAre(named("sym1"), named("sym2")));
4128}
4129
4130TEST(NoCompileCompletionTest, WithIndex) {
4131 std::vector<Symbol> Syms = {func("xxx"), func("a::xxx"), func("ns::b::xxx"),
4132 func("c::xxx"), func("ns::d::xxx")};
4133 auto Results = completionsNoCompile(
4134 R"cpp(
4135 // Current-scopes, unqualified completion.
4136 using namespace a;
4137 namespace ns {
4138 using namespace b;
4139 void foo() {
4140 xx^
4141 }
4142 }
4143 )cpp",
4144 Syms);
4145 EXPECT_THAT(Results.Completions,
4146 UnorderedElementsAre(AllOf(qualifier(""), scope("")),
4147 AllOf(qualifier(""), scope("a::")),
4148 AllOf(qualifier(""), scope("ns::b::"))));
4150 Opts.AllScopes = true;
4151 Results = completionsNoCompile(
4152 R"cpp(
4153 // All-scopes unqualified completion.
4154 using namespace a;
4155 namespace ns {
4156 using namespace b;
4157 void foo() {
4158 xx^
4159 }
4160 }
4161 )cpp",
4162 Syms, Opts);
4163 EXPECT_THAT(Results.Completions,
4164 UnorderedElementsAre(AllOf(qualifier(""), scope("")),
4165 AllOf(qualifier(""), scope("a::")),
4166 AllOf(qualifier(""), scope("ns::b::")),
4167 AllOf(qualifier("c::"), scope("c::")),
4168 AllOf(qualifier("d::"), scope("ns::d::"))));
4169 Results = completionsNoCompile(
4170 R"cpp(
4171 // Qualified completion.
4172 using namespace a;
4173 namespace ns {
4174 using namespace b;
4175 void foo() {
4176 b::xx^
4177 }
4178 }
4179 )cpp",
4180 Syms, Opts);
4181 EXPECT_THAT(Results.Completions,
4182 ElementsAre(AllOf(qualifier(""), scope("ns::b::"))));
4183 Results = completionsNoCompile(
4184 R"cpp(
4185 // Absolutely qualified completion.
4186 using namespace a;
4187 namespace ns {
4188 using namespace b;
4189 void foo() {
4190 ::a::xx^
4191 }
4192 }
4193 )cpp",
4194 Syms, Opts);
4195 EXPECT_THAT(Results.Completions,
4196 ElementsAre(AllOf(qualifier(""), scope("a::"))));
4197}
4198
4199TEST(AllowImplicitCompletion, All) {
4200 const char *Yes[] = {
4201 "foo.^bar",
4202 "foo->^bar",
4203 "foo::^bar",
4204 " # include <^foo.h>",
4205 "#import <foo/^bar.h>",
4206 "#include_next \"^",
4207 };
4208 const char *No[] = {
4209 "foo>^bar",
4210 "foo:^bar",
4211 "foo\n^bar",
4212 "#include <foo.h> //^",
4213 "#include \"foo.h\"^",
4214 "#error <^",
4215 "#<^",
4216 };
4217 for (const char *Test : Yes) {
4218 llvm::Annotations A(Test);
4219 EXPECT_TRUE(allowImplicitCompletion(A.code(), A.point())) << Test;
4220 }
4221 for (const char *Test : No) {
4222 llvm::Annotations A(Test);
4223 EXPECT_FALSE(allowImplicitCompletion(A.code(), A.point())) << Test;
4224 }
4225}
4226
4227TEST(CompletionTest, FunctionArgsExist) {
4228 clangd::CodeCompleteOptions Opts;
4229 Opts.EnableSnippets = true;
4230 std::string Context = R"cpp(
4231 #define MACRO(x)
4232 int foo(int A);
4233 int bar();
4234 struct Object {
4235 Object(int B) {}
4236 };
4237 template <typename T>
4238 struct Container {
4239 Container(int Size) {}
4240 };
4241 )cpp";
4242 EXPECT_THAT(completions(Context + "int y = fo^", {}, Opts).Completions,
4243 UnorderedElementsAre(
4244 AllOf(labeled("foo(int A)"), snippetSuffix("(${1:int A})"))));
4245 EXPECT_THAT(
4246 completions(Context + "int y = fo^(42)", {}, Opts).Completions,
4247 UnorderedElementsAre(AllOf(labeled("foo(int A)"), snippetSuffix(""))));
4248 // FIXME(kirillbobyrev): No snippet should be produced here.
4249 EXPECT_THAT(completions(Context + "int y = fo^o(42)", {}, Opts).Completions,
4250 UnorderedElementsAre(
4251 AllOf(labeled("foo(int A)"), snippetSuffix("(${1:int A})"))));
4252 EXPECT_THAT(
4253 completions(Context + "int y = ba^", {}, Opts).Completions,
4254 UnorderedElementsAre(AllOf(labeled("bar()"), snippetSuffix("()"))));
4255 EXPECT_THAT(completions(Context + "int y = ba^()", {}, Opts).Completions,
4256 UnorderedElementsAre(AllOf(labeled("bar()"), snippetSuffix(""))));
4257 EXPECT_THAT(
4258 completions(Context + "Object o = Obj^", {}, Opts).Completions,
4259 Contains(AllOf(labeled("Object(int B)"), snippetSuffix("(${1:int B})"),
4261 EXPECT_THAT(completions(Context + "Object o = Obj^()", {}, Opts).Completions,
4262 Contains(AllOf(labeled("Object(int B)"), snippetSuffix(""),
4264 EXPECT_THAT(
4265 completions(Context + "Container c = Cont^", {}, Opts).Completions,
4266 Contains(AllOf(labeled("Container<typename T>(int Size)"),
4267 snippetSuffix("<${1:typename T}>(${2:int Size})"),
4269 EXPECT_THAT(
4270 completions(Context + "Container c = Cont^()", {}, Opts).Completions,
4271 Contains(AllOf(labeled("Container<typename T>(int Size)"),
4272 snippetSuffix("<${1:typename T}>"),
4274 EXPECT_THAT(
4275 completions(Context + "Container c = Cont^<int>()", {}, Opts).Completions,
4276 Contains(AllOf(labeled("Container<typename T>(int Size)"),
4277 snippetSuffix(""),
4279 EXPECT_THAT(completions(Context + "MAC^(2)", {}, Opts).Completions,
4280 Contains(AllOf(labeled("MACRO(x)"), snippetSuffix(""),
4282}
4283
4284TEST(CompletionTest, FunctionArgsExist_Issue1785) {
4285 // This is a scenario where the implementation of our check for
4286 // "is there a function argument list right after the cursor"
4287 // gave a bogus result.
4288 clangd::CodeCompleteOptions Opts;
4289 Opts.EnableSnippets = true;
4290 // The whitespace in this testcase is important!
4291 std::string Code = R"cpp(
4292void waldo(int);
4293
4294int main()
4295{
4296 wal^
4297
4298
4299 // ( )
4300}
4301 )cpp";
4302 EXPECT_THAT(
4303 completions(Code, {}, Opts).Completions,
4304 Contains(AllOf(labeled("waldo(int)"), snippetSuffix("(${1:int})"))));
4305}
4306
4307TEST(CompletionTest, NoCrashDueToMacroOrdering) {
4308 EXPECT_THAT(completions(R"cpp(
4309 #define ECHO(X) X
4310 #define ECHO2(X) ECHO(X)
4311 int finish_preamble = EC^HO(2);)cpp")
4312 .Completions,
4313 UnorderedElementsAre(labeled("ECHO(X)"), labeled("ECHO2(X)")));
4314}
4315
4316TEST(CompletionTest, ObjCCategoryDecls) {
4317 TestTU TU;
4318 TU.ExtraArgs.push_back("-xobjective-c");
4319 TU.HeaderCode = R"objc(
4320 @interface Foo
4321 @end
4322
4323 @interface Foo (FooExt1)
4324 @end
4325
4326 @interface Foo (FooExt2)
4327 @end
4328
4329 @interface Bar
4330 @end
4331
4332 @interface Bar (BarExt)
4333 @end)objc";
4334
4335 {
4336 Annotations Test(R"objc(
4337 @implementation Foo (^)
4338 @end
4339 )objc");
4340 TU.Code = Test.code().str();
4341 auto Results = completions(TU, Test.point());
4342 EXPECT_THAT(Results.Completions,
4343 UnorderedElementsAre(labeled("FooExt1"), labeled("FooExt2")));
4344 }
4345 {
4346 Annotations Test(R"objc(
4347 @interface Foo (^)
4348 @end
4349 )objc");
4350 TU.Code = Test.code().str();
4351 auto Results = completions(TU, Test.point());
4352 EXPECT_THAT(Results.Completions, UnorderedElementsAre(labeled("BarExt")));
4353 }
4354}
4355
4356TEST(CompletionTest, PreambleCodeComplete) {
4357 llvm::StringLiteral Baseline = "\n#define MACRO 12\nint num = MACRO;";
4358 llvm::StringLiteral ModifiedCC =
4359 "#include \"header.h\"\n#define MACRO 12\nint num = MACRO; int num2 = M^";
4360
4361 Annotations Test(ModifiedCC);
4362 auto BaselineTU = TestTU::withCode(Baseline);
4363 auto ModifiedTU = TestTU::withCode(Test.code());
4364
4365 MockFS FS;
4366 auto Inputs = ModifiedTU.inputs(FS);
4367 auto Result = codeComplete(testPath(ModifiedTU.Filename), Test.point(),
4368 BaselineTU.preamble().get(), Inputs, {});
4369 EXPECT_THAT(Result.Completions, Not(testing::IsEmpty()));
4370}
4371
4372TEST(CompletionTest, CommentParamName) {
4373 const std::string Code = R"cpp(
4374 void fun(int foo, int bar);
4375 void overloaded(int param_int);
4376 void overloaded(int param_int, int param_other);
4377 void overloaded(char param_char);
4378 int main() {
4379 )cpp";
4380
4381 EXPECT_THAT(completions(Code + "fun(/*^").Completions,
4382 UnorderedElementsAre(labeled("foo=*/")));
4383 EXPECT_THAT(completions(Code + "fun(1, /*^").Completions,
4384 UnorderedElementsAre(labeled("bar=*/")));
4385 EXPECT_THAT(completions(Code + "/*^").Completions, IsEmpty());
4386 // Test de-duplication.
4387 EXPECT_THAT(
4388 completions(Code + "overloaded(/*^").Completions,
4389 UnorderedElementsAre(labeled("param_int=*/"), labeled("param_char=*/")));
4390 // Comment already has some text in it.
4391 EXPECT_THAT(completions(Code + "fun(/* ^").Completions,
4392 UnorderedElementsAre(labeled("foo=*/")));
4393 EXPECT_THAT(completions(Code + "fun(/* f^").Completions,
4394 UnorderedElementsAre(labeled("foo=*/")));
4395 EXPECT_THAT(completions(Code + "fun(/* x^").Completions, IsEmpty());
4396 EXPECT_THAT(completions(Code + "fun(/* f ^").Completions, IsEmpty());
4397
4398 // Test ranges
4399 {
4400 std::string CompletionRangeTest(Code + "fun(/*[[^]]");
4401 auto Results = completions(CompletionRangeTest);
4402 EXPECT_THAT(Results.CompletionRange,
4403 llvm::ValueIs(Annotations(CompletionRangeTest).range()));
4404 EXPECT_THAT(
4405 Results.Completions,
4406 testing::Each(
4407 AllOf(replacesRange(Annotations(CompletionRangeTest).range()),
4409 }
4410 {
4411 std::string CompletionRangeTest(Code + "fun(/*[[fo^]]");
4412 auto Results = completions(CompletionRangeTest);
4413 EXPECT_THAT(Results.CompletionRange,
4414 llvm::ValueIs(Annotations(CompletionRangeTest).range()));
4415 EXPECT_THAT(
4416 Results.Completions,
4417 testing::Each(
4418 AllOf(replacesRange(Annotations(CompletionRangeTest).range()),
4420 }
4421}
4422
4423TEST(CompletionTest, Concepts) {
4424 Annotations Code(R"cpp(
4425 template<class T>
4426 concept A = sizeof(T) <= 8;
4427
4428 template<$tparam^A U>
4429 int foo();
4430
4431 template<typename T>
4432 int bar(T t) requires $expr^A<int>;
4433
4434 template<class T>
4435 concept b = $expr^A && $expr^sizeof(T) % 2 == 0 || $expr^A && sizeof(T) == 1;
4436
4437 $toplevel^A auto i = 19;
4438
4439 template<$toplevel^A auto i> void constrainedNTTP();
4440
4441 // FIXME: The first parameter should be dropped in this case.
4442 void abbreviated($expr^A auto x) {}
4443 )cpp");
4444 TestTU TU;
4445 TU.Code = Code.code().str();
4446 TU.ExtraArgs = {"-std=c++20"};
4447
4448 auto Sym = conceptSym("same_as");
4449 Sym.Signature = "<typename Tp, typename Up>";
4450 Sym.CompletionSnippetSuffix = "<${1:typename Tp}, ${2:typename Up}>";
4451 std::vector<Symbol> Syms = {Sym};
4452 for (auto P : Code.points("tparam")) {
4453 ASSERT_THAT(
4454 completions(TU, P, Syms).Completions,
4455 AllOf(Contains(AllOf(named("A"), signature(""), snippetSuffix(""))),
4456 Contains(AllOf(named("same_as"), signature("<typename Up>"),
4457 snippetSuffix("<${2:typename Up}>"))),
4458 Contains(named("class")), Contains(named("typename"))))
4459 << "Completing template parameter at position " << P;
4460 }
4461
4462 for (auto P : Code.points("toplevel")) {
4463 EXPECT_THAT(
4464 completions(TU, P, Syms).Completions,
4465 AllOf(Contains(AllOf(named("A"), signature(""), snippetSuffix(""))),
4466 Contains(AllOf(named("same_as"), signature("<typename Up>"),
4467 snippetSuffix("<${2:typename Up}>")))))
4468 << "Completing 'requires' expression at position " << P;
4469 }
4470
4471 for (auto P : Code.points("expr")) {
4472 EXPECT_THAT(
4473 completions(TU, P, Syms).Completions,
4474 AllOf(Contains(AllOf(named("A"), signature("<class T>"),
4475 snippetSuffix("<${1:class T}>"))),
4476 Contains(AllOf(
4477 named("same_as"), signature("<typename Tp, typename Up>"),
4478 snippetSuffix("<${1:typename Tp}, ${2:typename Up}>")))))
4479 << "Completing 'requires' expression at position " << P;
4480 }
4481}
4482
4483TEST(SignatureHelp, DocFormat) {
4484 Annotations Code(R"cpp(
4485 // Comment `with` markup.
4486 void foo(int);
4487 void bar() { foo(^); }
4488 )cpp");
4489 for (auto DocumentationFormat :
4491 auto Sigs = signatures(Code.code(), Code.point(), /*IndexSymbols=*/{},
4492 DocumentationFormat);
4493 ASSERT_EQ(Sigs.signatures.size(), 1U);
4494 EXPECT_EQ(Sigs.signatures[0].documentation.kind, DocumentationFormat);
4495 }
4496}
4497
4498TEST(SignatureHelp, TemplateArguments) {
4499 std::string Top = R"cpp(
4500 template <typename T, int> bool foo(char);
4501 template <int I, int> bool foo(float);
4502 )cpp";
4503
4504 auto First = signatures(Top + "bool x = foo<^");
4505 EXPECT_THAT(
4506 First.signatures,
4507 UnorderedElementsAre(sig("foo<[[typename T]], [[int]]>() -> bool"),
4508 sig("foo<[[int I]], [[int]]>() -> bool")));
4509 EXPECT_EQ(First.activeParameter, 0);
4510
4511 auto Second = signatures(Top + "bool x = foo<1, ^");
4512 EXPECT_THAT(Second.signatures,
4513 ElementsAre(sig("foo<[[int I]], [[int]]>() -> bool")));
4514 EXPECT_EQ(Second.activeParameter, 1);
4515}
4516
4517TEST(CompletionTest, DoNotCrash) {
4518 llvm::StringLiteral Cases[] = {
4519 R"cpp(
4520 template <typename = int> struct Foo {};
4521 auto a = [x(3)](Foo<^>){};
4522 )cpp",
4523 };
4524 for (auto Case : Cases) {
4525 SCOPED_TRACE(Case);
4526 auto Completions = completions(Case);
4527 }
4528}
4529TEST(CompletionTest, PreambleFromDifferentTarget) {
4530 constexpr std::string_view PreambleTarget = "x86_64";
4531 constexpr std::string_view Contents =
4532 "int foo(int); int num; int num2 = foo(n^";
4533
4534 Annotations Test(Contents);
4535 auto TU = TestTU::withCode(Test.code());
4536 TU.ExtraArgs.emplace_back("-target");
4537 TU.ExtraArgs.emplace_back(PreambleTarget);
4538 auto Preamble = TU.preamble();
4539 ASSERT_TRUE(Preamble);
4540 // Switch target to wasm.
4541 TU.ExtraArgs.pop_back();
4542 TU.ExtraArgs.emplace_back("wasm32");
4543
4544 MockFS FS;
4545 auto Inputs = TU.inputs(FS);
4546 auto Result = codeComplete(testPath(TU.Filename), Test.point(),
4547 Preamble.get(), Inputs, {});
4548 auto Signatures =
4549 signatureHelp(testPath(TU.Filename), Test.point(), *Preamble, Inputs, {});
4550
4551 // Make sure we don't crash.
4552 EXPECT_THAT(Result.Completions, Not(testing::IsEmpty()));
4553 EXPECT_THAT(Signatures.signatures, Not(testing::IsEmpty()));
4554}
4555
4556TEST(CompletionTest, SkipExplicitObjectParameter) {
4557 Annotations Code(R"cpp(
4558 struct A {
4559 void foo(this auto&& self, int arg);
4560 void bar(this A self, int arg);
4561 };
4562
4563 int main() {
4564 A a {};
4565 a.$c1^;
4566 (&A::fo$c2^;
4567 (&A::ba$c3^;
4568 }
4569 )cpp");
4570
4571 // TODO: llvm/llvm-project/146649
4572 // This is incorrect behavior. Correct Result should be a variant of,
4573 // c2: signature = (auto&& self, int arg)
4574 // snippet = (${1: auto&& self}, ${2: int arg})
4575 // c3: signature = (A self, int arg)
4576 // snippet = (${1: A self}, ${2: int arg})
4577
4578 auto TU = TestTU::withCode(Code.code());
4579 TU.ExtraArgs = {"-std=c++23"};
4580
4581 auto Preamble = TU.preamble();
4582 ASSERT_TRUE(Preamble);
4583
4584 CodeCompleteOptions Opts{};
4585
4586 MockFS FS;
4587 auto Inputs = TU.inputs(FS);
4588 {
4589 auto Result = codeComplete(testPath(TU.Filename), Code.point("c1"),
4590 Preamble.get(), Inputs, Opts);
4591
4592 EXPECT_THAT(Result.Completions,
4593 UnorderedElementsAre(AllOf(named("foo"), signature("(int arg)"),
4594 snippetSuffix("(${1:int arg})")),
4595 AllOf(named("bar"), signature("(int arg)"),
4596 snippetSuffix("(${1:int arg})"))));
4597 }
4598 {
4599 auto Result = codeComplete(testPath(TU.Filename), Code.point("c2"),
4600 Preamble.get(), Inputs, Opts);
4601 EXPECT_THAT(
4602 Result.Completions,
4603 ElementsAre(AllOf(named("foo"), signature("<class self:auto>(int arg)"),
4604 snippetSuffix("<${1:class self:auto}>"))));
4605 }
4606 {
4607 auto Result = codeComplete(testPath(TU.Filename), Code.point("c3"),
4608 Preamble.get(), Inputs, Opts);
4609 EXPECT_THAT(Result.Completions,
4610 ElementsAre(AllOf(named("bar"), signature("(int arg)"),
4611 snippetSuffix(""))));
4612 }
4613}
4614
4615TEST(CompletionTest, MemberAccessInExplicitObjMemfn) {
4616 Annotations Code(R"cpp(
4617 struct A {
4618 int member {};
4619 int memberFnA(int a);
4620 int memberFnA(this A&, float a);
4621
4622 void foo(this A& self) {
4623 // Should not offer any members here, since
4624 // it needs to be referenced through `self`.
4625 mem$c1^;
4626 // should offer all results
4627 self.mem$c2^;
4628
4629 [&]() {
4630 // should not offer any results
4631 mem$c3^;
4632 }();
4633 }
4634 };
4635 )cpp");
4636
4637 auto TU = TestTU::withCode(Code.code());
4638 TU.ExtraArgs = {"-std=c++23"};
4639
4640 auto Preamble = TU.preamble();
4641 ASSERT_TRUE(Preamble);
4642
4643 CodeCompleteOptions Opts{};
4644
4645 MockFS FS;
4646 auto Inputs = TU.inputs(FS);
4647
4648 {
4649 auto Result = codeComplete(testPath(TU.Filename), Code.point("c1"),
4650 Preamble.get(), Inputs, Opts);
4651
4652 EXPECT_THAT(Result.Completions, ElementsAre());
4653 }
4654 {
4655 auto Result = codeComplete(testPath(TU.Filename), Code.point("c2"),
4656 Preamble.get(), Inputs, Opts);
4657
4658 EXPECT_THAT(
4659 Result.Completions,
4660 UnorderedElementsAre(named("member"),
4661 AllOf(named("memberFnA"), signature("(int a)"),
4662 snippetSuffix("(${1:int a})")),
4663 AllOf(named("memberFnA"), signature("(float a)"),
4664 snippetSuffix("(${1:float a})"))));
4665 }
4666 {
4667 auto Result = codeComplete(testPath(TU.Filename), Code.point("c3"),
4668 Preamble.get(), Inputs, Opts);
4669
4670 EXPECT_THAT(Result.Completions, ElementsAre());
4671 }
4672}
4673
4674TEST(CompletionTest, ListExplicitObjectOverloads) {
4675 Annotations Code(R"cpp(
4676 struct S {
4677 void foo1(int a);
4678 void foo2(int a) const;
4679 void foo2(this const S& self, float a);
4680 void foo3(this const S& self, int a);
4681 void foo4(this S& self, int a);
4682 };
4683
4684 void S::foo1(int a) {
4685 this->$c1^;
4686 }
4687
4688 void S::foo2(int a) const {
4689 this->$c2^;
4690 }
4691
4692 void S::foo3(this const S& self, int a) {
4693 self.$c3^;
4694 }
4695
4696 void S::foo4(this S& self, int a) {
4697 self.$c4^;
4698 }
4699
4700 void test1(S s) {
4701 s.$c5^;
4702 }
4703
4704 void test2(const S s) {
4705 s.$c6^;
4706 }
4707 )cpp");
4708
4709 auto TU = TestTU::withCode(Code.code());
4710 TU.ExtraArgs = {"-std=c++23"};
4711
4712 auto Preamble = TU.preamble();
4713 ASSERT_TRUE(Preamble);
4714
4715 CodeCompleteOptions Opts{};
4716
4717 MockFS FS;
4718 auto Inputs = TU.inputs(FS);
4719
4720 {
4721 auto Result = codeComplete(testPath(TU.Filename), Code.point("c1"),
4722 Preamble.get(), Inputs, Opts);
4723 EXPECT_THAT(
4724 Result.Completions,
4725 UnorderedElementsAre(AllOf(named("foo1"), signature("(int a)"),
4726 snippetSuffix("(${1:int a})")),
4727 AllOf(named("foo2"), signature("(int a) const"),
4728 snippetSuffix("(${1:int a})")),
4729 AllOf(named("foo2"), signature("(float a) const"),
4730 snippetSuffix("(${1:float a})")),
4731 AllOf(named("foo3"), signature("(int a) const"),
4732 snippetSuffix("(${1:int a})")),
4733 AllOf(named("foo4"), signature("(int a)"),
4734 snippetSuffix("(${1:int a})"))));
4735 }
4736 {
4737 auto Result = codeComplete(testPath(TU.Filename), Code.point("c2"),
4738 Preamble.get(), Inputs, Opts);
4739 EXPECT_THAT(
4740 Result.Completions,
4741 UnorderedElementsAre(AllOf(named("foo2"), signature("(int a) const"),
4742 snippetSuffix("(${1:int a})")),
4743 AllOf(named("foo2"), signature("(float a) const"),
4744 snippetSuffix("(${1:float a})")),
4745 AllOf(named("foo3"), signature("(int a) const"),
4746 snippetSuffix("(${1:int a})"))));
4747 }
4748 {
4749 auto Result = codeComplete(testPath(TU.Filename), Code.point("c3"),
4750 Preamble.get(), Inputs, Opts);
4751 EXPECT_THAT(
4752 Result.Completions,
4753 UnorderedElementsAre(AllOf(named("foo2"), signature("(int a) const"),
4754 snippetSuffix("(${1:int a})")),
4755 AllOf(named("foo2"), signature("(float a) const"),
4756 snippetSuffix("(${1:float a})")),
4757 AllOf(named("foo3"), signature("(int a) const"),
4758 snippetSuffix("(${1:int a})"))));
4759 }
4760 {
4761 auto Result = codeComplete(testPath(TU.Filename), Code.point("c4"),
4762 Preamble.get(), Inputs, Opts);
4763 EXPECT_THAT(
4764 Result.Completions,
4765 UnorderedElementsAre(AllOf(named("foo1"), signature("(int a)"),
4766 snippetSuffix("(${1:int a})")),
4767 AllOf(named("foo2"), signature("(int a) const"),
4768 snippetSuffix("(${1:int a})")),
4769 AllOf(named("foo2"), signature("(float a) const"),
4770 snippetSuffix("(${1:float a})")),
4771 AllOf(named("foo3"), signature("(int a) const"),
4772 snippetSuffix("(${1:int a})")),
4773 AllOf(named("foo4"), signature("(int a)"),
4774 snippetSuffix("(${1:int a})"))));
4775 }
4776 {
4777 auto Result = codeComplete(testPath(TU.Filename), Code.point("c5"),
4778 Preamble.get(), Inputs, Opts);
4779 EXPECT_THAT(
4780 Result.Completions,
4781 UnorderedElementsAre(AllOf(named("foo1"), signature("(int a)"),
4782 snippetSuffix("(${1:int a})")),
4783 AllOf(named("foo2"), signature("(int a) const"),
4784 snippetSuffix("(${1:int a})")),
4785 AllOf(named("foo2"), signature("(float a) const"),
4786 snippetSuffix("(${1:float a})")),
4787 AllOf(named("foo3"), signature("(int a) const"),
4788 snippetSuffix("(${1:int a})")),
4789 AllOf(named("foo4"), signature("(int a)"),
4790 snippetSuffix("(${1:int a})"))));
4791 }
4792 {
4793 auto Result = codeComplete(testPath(TU.Filename), Code.point("c6"),
4794 Preamble.get(), Inputs, Opts);
4795 EXPECT_THAT(
4796 Result.Completions,
4797 UnorderedElementsAre(AllOf(named("foo2"), signature("(int a) const"),
4798 snippetSuffix("(${1:int a})")),
4799 AllOf(named("foo2"), signature("(float a) const"),
4800 snippetSuffix("(${1:float a})")),
4801 AllOf(named("foo3"), signature("(int a) const"),
4802 snippetSuffix("(${1:int a})"))));
4803 }
4804}
4805
4806TEST(CompletionTest, FuzzyMatchMacro) {
4807 Annotations Code(R"cpp(
4808 #define gl_foo() 42
4809 #define _gl_foo() 42
4810 #define glfbar() 42
4811
4812 int gl_frob();
4813 int _gl_frob();
4814
4815 int main() {
4816 int y = glf$c1^;
4817 int y = _gl$c2^;
4818 }
4819 )cpp");
4820
4821 auto TU = TestTU::withCode(Code.code());
4822
4823 // Exact prefix should match macro or symbol
4824 {
4825 CodeCompleteOptions Opts{};
4826 EXPECT_EQ(Opts.MacroFilter, Config::MacroFilterPolicy::ExactPrefix);
4827
4828 {
4829 auto Results = completions(TU, Code.point("c1"), {}, Opts);
4830 EXPECT_THAT(
4831 Results.Completions,
4832 ElementsAre(named("gl_frob"), named("_gl_frob"), named("glfbar")));
4833 }
4834
4835 {
4836 auto Results = completions(TU, Code.point("c2"), {}, Opts);
4837 EXPECT_THAT(Results.Completions,
4838 ElementsAre(named("_gl_frob"), named("_gl_foo")));
4839 }
4840 }
4841
4842 // but with fuzzy match
4843 {
4844 CodeCompleteOptions Opts{};
4845 Opts.MacroFilter = Config::MacroFilterPolicy::FuzzyMatch;
4846
4847 // don't suggest underscore macros in general,
4848 {
4849 auto Results = completions(TU, Code.point("c1"), {}, Opts);
4850 EXPECT_THAT(Results.Completions,
4851 ElementsAre(named("gl_frob"), named("_gl_frob"),
4852 named("glfbar"), named("gl_foo")));
4853 }
4854
4855 // but do suggest when macro contains exact prefix
4856 {
4857 auto Results = completions(TU, Code.point("c2"), {}, Opts);
4858 EXPECT_THAT(Results.Completions,
4859 ElementsAre(named("_gl_frob"), named("_gl_foo")));
4860 }
4861 }
4862}
4863
4864} // namespace
4865} // namespace clangd
4866} // namespace clang
#define EXPECT_IFF(condition, value, matcher)
Same as llvm::Annotations, but adjusts functions to LSP-specific types for positions and ranges.
Definition Annotations.h:23
clangd::Range range(llvm::StringRef Name="") const
Manages a collection of source files and derived data (ASTs, indexes), and provides language-aware fe...
A context is an immutable container for per-request data that must be propagated through layers that ...
Definition Context.h:69
static std::unique_ptr< SymbolIndex > build(SymbolSlab Symbols, RefSlab Refs, RelationSlab Relations)
Builds an index from slabs. The index takes ownership of the data.
Definition MemIndex.cpp:18
llvm::StringMap< std::string > Files
Definition TestFS.h:45
An efficient structure of storing large set of symbol references in memory.
Definition Ref.h:111
Interface for symbol indexes that can be used for searching or matching symbols among a set of symbol...
Definition Index.h:134
SymbolSlab::Builder is a mutable container that can 'freeze' to SymbolSlab.
Definition Symbol.h:224
void insert(const Symbol &S)
Adds a symbol, overwriting any existing one with the same ID.
Definition Symbol.cpp:52
static llvm::Expected< URI > create(llvm::StringRef AbsolutePath, llvm::StringRef Scheme)
Creates a URI for a file in the given scheme.
Definition URI.cpp:208
WithContextValue extends Context::current() with a single value.
Definition Context.h:200
FIXME: Skip testing on windows temporarily due to the different escaping code mode.
Definition AST.cpp:44
Symbol objcProtocol(llvm::StringRef Name)
Symbol objcClass(llvm::StringRef Name)
Symbol func(llvm::StringRef Name)
Definition TestIndex.cpp:62
Symbol cls(llvm::StringRef Name)
Definition TestIndex.cpp:66
Symbol objcCategory(llvm::StringRef Name, llvm::StringRef CategoryName)
std::string sortText(float Score, llvm::StringRef Name)
Returns a string that sorts in the same order as (-Score, Tiebreak), for LSP.
Definition Quality.cpp:552
Symbol conceptSym(llvm::StringRef Name)
Definition TestIndex.cpp:86
IndexContents
Describes what data is covered by an index.
Definition Index.h:114
size_t lspLength(llvm::StringRef Code)
CompletionPrefix guessCompletionPrefix(llvm::StringRef Content, unsigned Offset)
std::unique_ptr< CompilerInvocation > buildCompilerInvocation(const ParseInputs &Inputs, clang::DiagnosticConsumer &D, std::vector< std::string > *CC1Args)
Builds compiler invocation that could be used to build AST or preamble.
Definition Compiler.cpp:96
Symbol sym(llvm::StringRef QName, index::SymbolKind Kind, llvm::StringRef USRFormat, llvm::StringRef Signature)
Definition TestIndex.cpp:40
CompletionItemKind
The kind of a completion entry.
Definition Protocol.h:338
Symbol ns(llvm::StringRef Name)
Definition TestIndex.cpp:82
bool allowImplicitCompletion(llvm::StringRef Content, unsigned Offset)
llvm::unique_function< void(llvm::Expected< T >)> Callback
A Callback<T> is a void function that accepts Expected<T>.
Definition Function.h:28
llvm::raw_ostream & operator<<(llvm::raw_ostream &OS, const CodeCompletion &C)
llvm::Expected< CodeCompleteResult > runCodeComplete(ClangdServer &Server, PathRef File, Position Pos, clangd::CodeCompleteOptions Opts)
Definition SyncAPI.cpp:72
MATCHER_P(named, N, "")
llvm::Expected< SignatureHelp > runSignatureHelp(ClangdServer &Server, PathRef File, Position Pos, MarkupKind DocumentationFormat)
Definition SyncAPI.cpp:79
std::string testPath(PathRef File, llvm::sys::path::Style Style)
Definition TestFS.cpp:93
std::shared_ptr< const PreambleData > buildPreamble(PathRef FileName, CompilerInvocation CI, const ParseInputs &Inputs, bool StoreInMemory, PreambleParsedCallback PreambleCallback, PreambleBuildStats *Stats)
Build a preamble for the new inputs unless an old one can be reused.
Definition Preamble.cpp:571
TEST(BackgroundQueueTest, Priority)
void wait(std::unique_lock< std::mutex > &Lock, std::condition_variable &CV, Deadline D)
Wait once on CV for the specified duration.
llvm::Expected< size_t > positionToOffset(llvm::StringRef Code, Position P, bool AllowColumnsBeyondLineLength)
Turn a [line, column] pair into an offset in Code.
void runAddDocument(ClangdServer &Server, PathRef File, llvm::StringRef Contents, llvm::StringRef Version, WantDiagnostics WantDiags, bool ForceRebuild)
Definition SyncAPI.cpp:17
Symbol macro(llvm::StringRef Name, llvm::StringRef ArgList)
Definition TestIndex.cpp:90
llvm::StringRef PathRef
A typedef to represent a ref to file path.
Definition Path.h:29
@ No
Diagnostics must be generated for this snapshot.
Definition TUScheduler.h:55
std::vector< std::string > lookup(const SymbolIndex &I, llvm::ArrayRef< SymbolID > IDs)
Symbol enmConstant(llvm::StringRef Name)
Definition TestIndex.cpp:74
Deadline timeoutSeconds(std::optional< double > Seconds)
Makes a deadline from a timeout in seconds. std::nullopt means wait forever.
CodeCompleteResult codeComplete(PathRef FileName, Position Pos, const PreambleData *Preamble, const ParseInputs &ParseInput, CodeCompleteOptions Opts, SpeculativeFuzzyFind *SpecFuzzyFind)
Gets code completions at a specified Pos in FileName.
@ PlainText
The primary text to be inserted is treated as a plain string.
Definition Protocol.h:1310
@ Snippet
The primary text to be inserted is treated as a snippet.
Definition Protocol.h:1320
SignatureHelp signatureHelp(PathRef FileName, Position Pos, const PreambleData &Preamble, const ParseInputs &ParseInput, MarkupKind DocumentationFormat)
Get signature help at a specified Pos in FileName.
PolySubsequenceMatcher< Args... > HasSubsequence(Args &&... M)
Symbol var(llvm::StringRef Name)
Definition TestIndex.cpp:78
cppcoreguidelines::ProBoundsAvoidUncheckedContainerAccessCheck P
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Signals derived from a valid AST of a file.
Definition ASTSignals.h:27
llvm::DenseMap< SymbolID, unsigned > ReferencedSymbols
Number of occurrences of each symbol present in the file.
Definition ASTSignals.h:29
Symbol::IncludeDirective InsertionDirective
Preferred preprocessor directive to use for inclusions by the file.
Definition ASTSignals.h:34
Represents a collection of completion items to be presented in the editor.
Definition Protocol.h:1412
Settings that express user/project preferences and control clangd behavior.
Definition Config.h:44
static clangd::Key< Config > Key
Context key which can be used to set the current Config.
Definition Config.h:48
@ None
nothing, no argument list and also NO Delimiters "()" or "<>".
Definition Config.h:141
@ Delimiters
empty pair of delimiters "()" or "<>".
Definition Config.h:145
@ OpenDelimiter
open, only opening delimiter "(" or "<".
Definition Config.h:143
Same semantics as CodeComplete::Score.
Definition Quality.h:179
std::vector< std::string > Scopes
If this is non-empty, symbols must be in at least one of the scopes (e.g.
Definition Index.h:36
Information required to run clang, e.g. to parse AST or do code completion.
Definition Compiler.h:49
int line
Line position in a document (zero-based).
Definition Protocol.h:158
int character
Character offset on a line in a document (zero-based).
Definition Protocol.h:163
Position end
The range's end position.
Definition Protocol.h:190
Represents the signature of a callable.
Definition Protocol.h:1456
Attributes of a symbol that affect how much we like it.
Definition Quality.h:56
Attributes of a symbol-query pair that affect how much we like it.
Definition Quality.h:86
The class presents a C++ symbol, e.g.
Definition Symbol.h:39
@ IndexedForCodeCompletion
Whether or not this symbol is meant to be used for the code completion.
Definition Symbol.h:141
@ Include
#include "header.h"
Definition Symbol.h:93
@ Import
#import "header.h"
Definition Symbol.h:95
SymbolID ID
The ID of the symbol.
Definition Symbol.h:41
std::vector< std::string > ExtraArgs
Definition TestTU.h:60
std::string Code
Definition TestTU.h:49
static TestTU withHeaderCode(llvm::StringRef HeaderCode)
Definition TestTU.h:42
static TestTU withCode(llvm::StringRef Code)
Definition TestTU.h:36
llvm::StringMap< std::string > AdditionalFiles
Definition TestTU.h:57
std::unique_ptr< SymbolIndex > index() const
Definition TestTU.cpp:176
Range range
The range of the text document to be manipulated.
Definition Protocol.h:246