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>
48using ::testing::AllOf;
49using ::testing::Contains;
50using ::testing::ElementsAre;
51using ::testing::Field;
52using ::testing::HasSubstr;
53using ::testing::IsEmpty;
55using ::testing::UnorderedElementsAre;
56using ContextKind = CodeCompletionContext::Kind;
59MATCHER_P(named, Name,
"") {
return arg.Name == Name; }
60MATCHER_P(mainFileRefs, Refs,
"") {
return arg.MainFileRefs == Refs; }
61MATCHER_P(scopeRefs, Refs,
"") {
return arg.ScopeRefsInFile == Refs; }
63 return llvm::StringRef(arg.Name).starts_with(Prefix);
65MATCHER_P(filterText, F,
"") {
return arg.FilterText == F; }
66MATCHER_P(scope, S,
"") {
return arg.Scope == S; }
67MATCHER_P(qualifier, Q,
"") {
return arg.RequiredQualifier == Q; }
69 return arg.RequiredQualifier + arg.Name + arg.Signature ==
Label;
72MATCHER_P(kind, K,
"") {
return arg.Kind == K; }
74 return arg.Documentation && arg.Documentation->asPlainText() ==
D;
76MATCHER_P(returnType, D,
"") {
return arg.ReturnType ==
D; }
78 return !arg.Includes.empty() && arg.Includes[0].Header == IncludeHeader;
80MATCHER_P(insertInclude, IncludeHeader,
"") {
81 return !arg.Includes.empty() && arg.Includes[0].Header == IncludeHeader &&
82 bool(arg.Includes[0].Insertion);
84MATCHER_P(insertIncludeText, InsertedText,
"") {
85 return !arg.Includes.empty() && arg.Includes[0].Insertion &&
86 arg.Includes[0].Insertion->newText == InsertedText;
89 return !arg.Includes.empty() && bool(arg.Includes[0].Insertion);
92MATCHER_P(origin, OriginSet,
"") {
return arg.Origin == OriginSet; }
93MATCHER_P(signature, S,
"") {
return arg.Signature == S; }
95 return arg.CompletionTokenRange ==
Range;
99Matcher<const std::vector<CodeCompletion> &> has(std::string Name) {
100 return Contains(named(std::move(Name)));
102Matcher<const std::vector<CodeCompletion> &> has(std::string Name,
104 return Contains(AllOf(named(std::move(Name)), kind(K)));
106MATCHER(isDocumented,
"") {
return arg.Documentation.has_value(); }
107MATCHER(deprecated,
"") {
return arg.Deprecated; }
109std::unique_ptr<SymbolIndex> memIndex(std::vector<Symbol>
Symbols) {
111 for (
const auto &Sym :
Symbols)
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();
129 auto Inputs = TU.inputs(FS);
133 ADD_FAILURE() <<
"Couldn't build CompilerInvocation";
143CodeCompleteResult completions(llvm::StringRef
Text,
144 std::vector<Symbol> IndexSymbols = {},
145 clangd::CodeCompleteOptions Opts = {},
146 PathRef FilePath =
"foo.cpp") {
150 TU.Filename = FilePath.str();
151 return completions(TU, Test.point(), std::move(IndexSymbols),
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();
169 ParseInputs ParseInput{tooling::CompileCommand(), &FS, Test.code().str()};
170 return codeComplete(FilePath, Test.point(),
nullptr, ParseInput,
179#if CLANGD_DECISION_FOREST
180TEST(DecisionForestRankingModel, NameMatchSanityTest) {
181 clangd::CodeCompleteOptions Opts;
182 Opts.RankingModel = CodeCompleteOptions::DecisionForest;
183 auto Results = completions(
187 int AlphaBetaGamma();
189int func() { MemberAccess().ABG^ }
192 EXPECT_THAT(Results.Completions,
193 ElementsAre(named(
"ABG"), named(
"AlphaBetaGamma")));
196TEST(DecisionForestRankingModel, ReferencesAffectRanking) {
197 clangd::CodeCompleteOptions Opts;
198 Opts.RankingModel = CodeCompleteOptions::DecisionForest;
199 constexpr int NumReferences = 100000;
201 completions(
"int main() { clang^ }",
202 {
ns(
"clangA"), withReferences(NumReferences,
func(
"clangD"))},
205 ElementsAre(named(
"clangD"), named(
"clangA")));
207 completions(
"int main() { clang^ }",
208 {withReferences(NumReferences,
ns(
"clangA")),
func(
"clangD")},
211 ElementsAre(named(
"clangA"), named(
"clangD")));
215TEST(DecisionForestRankingModel, DecisionForestScorerCallbackTest) {
216 clangd::CodeCompleteOptions Opts;
217 constexpr float MagicNumber = 1234.5678f;
218 Opts.RankingModel = CodeCompleteOptions::DecisionForest;
222 Scores.
Total = MagicNumber;
223 Scores.ExcludingName = MagicNumber;
226 llvm::StringRef Code =
"int func() { int xyz; xy^ }";
227 auto Results = completions(Code,
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);
234 Opts.RankingModel = CodeCompleteOptions::Heuristics;
235 Results = completions(Code,
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);
242TEST(CompletionTest, Limit) {
243 clangd::CodeCompleteOptions Opts;
245 auto Results = completions(R
"cpp(
246struct ClassWithMembers {
252int main() { ClassWithMembers().^ }
256 EXPECT_TRUE(Results.HasMore);
257 EXPECT_THAT(Results.Completions, ElementsAre(named(
"AAA"), named(
"BBB")));
260TEST(CompletionTest, Filter) {
261 std::string Body = R
"cpp(
272 EXPECT_THAT(completions(Body +
"int main() { S().Foba^ }").Completions,
273 AllOf(has(
"FooBar"), has(
"FooBaz"), Not(has(
"Qux"))));
277 Sym.SymInfo.Kind = index::SymbolKind::Macro;
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")));
285void testAfterDotCompletion(clangd::CodeCompleteOptions Opts) {
286 auto Results = completions(
292 // Make sure this is not in preamble.
295 struct GlobalClass {};
297 struct ClassWithMembers {
307 struct LocalClass {};
315 {
cls(
"IndexClass"),
var(
"index_var"),
func(
"index_func")}, Opts);
317 EXPECT_TRUE(Results.RanParser);
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"));
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"))));
333 EXPECT_THAT(Results.Completions,
336 EXPECT_THAT(Results.Completions, Contains(isDocumented()));
339void testGlobalScopeCompletion(clangd::CodeCompleteOptions Opts) {
340 auto Results = completions(
345 // Make sure this is not in preamble.
348 struct GlobalClass {};
350 struct ClassWithMembers {
356 struct LocalClass {};
364 {
cls(
"IndexClass"),
var(
"index_var"),
func(
"index_func")}, Opts);
366 EXPECT_TRUE(Results.RanParser);
368 EXPECT_THAT(Results.Completions,
369 Not(AnyOf(has(
"method"), has(
"method()"), has(
"field"))));
371 EXPECT_THAT(Results.Completions,
372 AllOf(has(
"global_var"), has(
"index_var"), has(
"global_func"),
374 has(
"GlobalClass"), has(
"IndexClass")));
376 EXPECT_THAT(Results.Completions, has(
"MACRO"));
378 EXPECT_THAT(Results.Completions,
379 AllOf(has(
"local_var"), has(
"LocalClass"),
382 EXPECT_THAT(Results.Completions, Contains(isDocumented()));
385TEST(CompletionTest, CompletionOptions) {
386 auto Test = [&](
const clangd::CodeCompleteOptions &Opts) {
387 testAfterDotCompletion(Opts);
388 testGlobalScopeCompletion(Opts);
392 &clangd::CodeCompleteOptions::IncludeIneligibleResults,
397 for (
auto &F : Flags) {
398 clangd::CodeCompleteOptions O;
404TEST(CompletionTest, Accessible) {
408 protected: void prot();
409 private: void priv();
411 void Foo::pub() { this->^ }
414 AllOf(has("priv"), has(
"prot"), has(
"pub")));
416 auto External = completions(R
"cpp(
419 protected: void prot();
420 private: void priv();
427 EXPECT_THAT(External.Completions,
428 AllOf(has("pub"), Not(has(
"prot")), Not(has(
"priv"))));
430 auto Results = completions(R
"cpp(
433 protected: void prot();
434 private: void priv();
436 struct Bar : public Foo {
437 private: using Foo::pub;
444 EXPECT_THAT(Results.Completions,
445 AllOf(Not(has("priv")), Not(has(
"prot")), Not(has(
"pub"))));
448TEST(CompletionTest, Qualifiers) {
449 auto Results = completions(R
"cpp(
451 public: int foo() const;
454 class Bar : public Foo {
457 void test() { Bar().^ }
459 EXPECT_THAT(Results.Completions,
460 Contains(AllOf(qualifier(""), named(
"bar"))));
462 EXPECT_THAT(Results.Completions,
463 Not(Contains(AllOf(qualifier(
"Foo::"), named(
"foo")))));
465 EXPECT_THAT(Results.Completions,
466 Not(Contains(AllOf(qualifier(
""), named(
"foo")))));
470TEST(CompletionTest, QualificationWithInlineNamespace) {
471 auto Results = completions(R
"cpp(
472 namespace a { inline namespace b {} }
473 using namespace a::b;
477 EXPECT_THAT(Results.Completions,
478 UnorderedElementsAre(AllOf(qualifier(
"a::"), named(
"Foo"))));
481TEST(CompletionTest, InjectedTypename) {
483 EXPECT_THAT(completions(
"struct X{}; void foo(){ X().^ }").Completions,
485 EXPECT_THAT(completions(
"struct X{ void foo(){ this->^ } };").Completions,
488 EXPECT_THAT(completions(
"struct X{ void foo(){ ^ } };").Completions,
491 completions(
"struct Y{}; struct X:Y{ void foo(){ ^ } };").Completions,
495 "template<class> struct Y{}; struct X:Y<int>{ void foo(){ ^ } };")
499 EXPECT_THAT(completions(
"struct X{}; void foo(){ X::^ }").Completions,
503TEST(CompletionTest, SkipInjectedWhenUnqualified) {
504 EXPECT_THAT(completions(
"struct X { void f() { X^ }};").Completions,
505 ElementsAre(named(
"X"), named(
"~X")));
508TEST(CompletionTest, Snippets) {
509 clangd::CodeCompleteOptions Opts;
510 auto Results = completions(
514 int f(int i, const float f) const;
525 snippetSuffix(
"(${1:int i}, ${2:const float f})")));
528TEST(CompletionTest, HeuristicsForMemberFunctionCompletion) {
529 clangd::CodeCompleteOptions Opts;
530 Opts.EnableSnippets =
true;
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();
541 this->$canBeCallNoStatic^
547 int Foo::$isDefinition^ {
551 int i = Foo::$canBeCallStaticOnly^
554 struct Derived : Foo {
566 f.$canBeCallNoStatic^
567 ; // Prevent parsing as 'f.f'
574 d.Derived::$canBeCall^
582 ; // Prevent parsing as 'f.f'
589 d.Derived::$canBeCall^
594 for (
const auto &P : Code.points(
"canNotBeCall")) {
595 auto Results = completions(TU, P, {}, Opts);
596 EXPECT_THAT(Results.Completions,
597 Contains(AllOf(named(
"method"), signature(
"(int name) const"),
598 snippetSuffix(
""))));
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,
610 named(
"staticGeneric"), signature(
"<typename T, int U>()"),
611 snippetSuffix(
"<${1:typename T}, ${2:int U}>"))));
614 for (
const auto &P : Code.points(
"canBeCall")) {
615 auto Results = completions(TU, P, {}, Opts);
616 EXPECT_THAT(Results.Completions,
617 Contains(AllOf(named(
"method"), signature(
"(int name) const"),
618 snippetSuffix(
"(${1:int name})"))));
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,
629 named(
"staticGeneric"), signature(
"<typename T, int U>()"),
630 snippetSuffix(
"<${1:typename T}, ${2:int U}>()"))));
633 for (
const auto &P : Code.points(
"canBeCallNoStatic")) {
634 auto Results = completions(TU, P, {}, Opts);
635 EXPECT_THAT(Results.Completions,
636 Contains(AllOf(named(
"method"), signature(
"(int name) const"),
637 snippetSuffix(
"(${1:int name})"))));
641 named(
"generic"), signature(
"<typename T>(U nameU, V nameV)"),
642 snippetSuffix(
"<${1:typename T}>(${2:U nameU}, ${3:V nameV})"))));
645 for (
const auto &P : Code.points(
"canBeCallStaticOnly")) {
646 auto Results = completions(TU, P, {}, Opts);
647 EXPECT_THAT(Results.Completions,
648 Contains(AllOf(named(
"method"), signature(
"(int name) const"),
649 snippetSuffix(
""))));
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,
660 named(
"staticGeneric"), signature(
"<typename T, int U>()"),
661 snippetSuffix(
"<${1:typename T}, ${2:int U}>()"))));
664 for (
const auto &P : Code.points(
"isDefinition")) {
665 auto Results = completions(TU, P, {}, Opts);
667 EXPECT_THAT(Results.Completions,
668 Contains(AllOf(named(
"method"), signature(
"(int name) const"),
669 snippetSuffix(
"(int name) const"))));
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(
"()"))));
685TEST(CompletionTest, PrivateMemberDefinition) {
686 clangd::CodeCompleteOptions Opts;
687 Opts.EnableSnippets =
true;
688 auto Results = completions(
691 int func(int a, int b);
696 EXPECT_THAT(Results.Completions,
697 Contains(AllOf(named(
"func"), signature(
"(int a, int b)"),
698 snippetSuffix(
"(int a, int b)"))));
701TEST(CompletionTest, DefaultArgsWithValues) {
702 clangd::CodeCompleteOptions Opts;
703 Opts.EnableSnippets =
true;
704 auto Results = completions(
710 void foo(int x = 42, int y = 0, Arg arg = Arg(42, 0));
715 EXPECT_THAT(Results.Completions,
718 signature(
"(int x = 42, int y = 0, Arg arg = Arg(42, 0))"),
719 snippetSuffix(
"(int x, int y, Arg arg)"))));
722TEST(CompletionTest, NoSnippetsInUsings) {
723 clangd::CodeCompleteOptions Opts;
724 Opts.EnableSnippets =
true;
725 auto Results = completions(
728 int func(int a, int b);
734 EXPECT_THAT(Results.Completions,
735 ElementsAre(AllOf(named(
"func"), labeled(
"func(int a, int b)"),
736 snippetSuffix(
""))));
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";
744 Results = completions(R
"cpp(
749 EXPECT_THAT(Results.Completions,
750 ElementsAre(AllOf(named(
"func"), labeled(
"func(int a, int b)"),
751 snippetSuffix(
""))));
754 Opts.AllScopes =
true;
755 Results = completions(R
"cpp(
759 EXPECT_THAT(Results.Completions,
760 Contains(AllOf(named(
"func"), labeled(
"ns::func(int a, int b)"),
761 snippetSuffix(
""))));
764TEST(CompletionTest, Kinds) {
765 auto Results = completions(
770 // make sure MACRO is not included in preamble.
774 {func("indexFunction"),
var(
"indexVariable"),
cls(
"indexClass"),
775 macro(
"indexObjMacro"),
macro(
"indexFuncMacro",
"(x, y)")});
776 EXPECT_THAT(Results.Completions,
788 Results = completions(
"nam^");
789 EXPECT_THAT(Results.Completions,
793 Results = completions(
807 Results = completions(
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;
815 template <class T> static int complete_static_member = 10;
817 static auto x = complete_^
822 UnorderedElementsAre(
825 AllOf(named(
"complete_type_alias"),
828 AllOf(named(
"complete_static_member"),
831 Results = completions(
843TEST(CompletionTest, NoDuplicates) {
844 auto Results = completions(
856 EXPECT_THAT(Results.Completions, ElementsAre(named(
"Adapter")));
859TEST(CompletionTest, ScopedNoIndex) {
860 auto Results = completions(
862 namespace fake { int BigBang, Babble, Box; };
863 int main() { fake::ba^ }
866 EXPECT_THAT(Results.Completions,
867 ElementsAre(named(
"Babble"), named(
"BigBang")));
870TEST(CompletionTest, Scoped) {
871 auto Results = completions(
873 namespace fake { int Babble, Box; };
874 int main() { fake::ba^ }
876 {var("fake::BigBang")});
877 EXPECT_THAT(Results.Completions,
878 ElementsAre(named(
"Babble"), named(
"BigBang")));
881TEST(CompletionTest, ScopedWithFilter) {
882 auto Results = completions(
886 {cls("ns::XYZ"),
func(
"ns::foo")});
887 EXPECT_THAT(Results.Completions, UnorderedElementsAre(named(
"XYZ")));
890TEST(CompletionTest, ReferencesAffectRanking) {
891 EXPECT_THAT(completions(
"int main() { abs^ }", {
func(
"absA"),
func(
"absB")})
894 EXPECT_THAT(completions(
"int main() { abs^ }",
895 {
func(
"absA"), withReferences(1000,
func(
"absB"))})
900TEST(CompletionTest, ContextWords) {
901 auto Results = completions(R
"cpp(
902 enum class Color { RED, YELLOW, BLUE };
904 // (blank lines so the definition above isn't "context")
906 // "It was a yellow car," he said. "Big yellow car, new."
907 auto Finish = Color::^
911 ASSERT_THAT(Results.Completions,
915TEST(CompletionTest, GlobalQualified) {
916 auto Results = completions(
921 EXPECT_THAT(Results.Completions,
926TEST(CompletionTest, FullyQualified) {
927 auto Results = completions(
929 namespace ns { void bar(); }
933 EXPECT_THAT(Results.Completions,
938TEST(CompletionTest, SemaIndexMerge) {
939 auto Results = completions(
941 namespace ns { int local; void both(); }
944 {func("ns::both"),
cls(
"ns::Index")});
946 EXPECT_THAT(Results.Completions,
947 UnorderedElementsAre(
954TEST(CompletionTest, SemaIndexMergeWithLimit) {
955 clangd::CodeCompleteOptions Opts;
957 auto Results = completions(
959 namespace ns { int local; void both(); }
962 {func("ns::both"),
cls(
"ns::Index")}, Opts);
963 EXPECT_EQ(Results.Completions.size(), Opts.Limit);
964 EXPECT_TRUE(Results.HasMore);
967TEST(CompletionTest, IncludeInsertionPreprocessorIntegrationTests) {
970 TU.AdditionalFiles[
"sub/bar.h"] =
"";
974 Sym.CanonicalDeclaration.FileURI = BarURI.c_str();
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\""))));
985 Results = completions(TU, Test.point(), {Sym}, NoInsertion);
986 EXPECT_THAT(Results.Completions,
987 ElementsAre(AllOf(named(
"X"), Not(insertInclude()))));
990 #include "sub/bar.h" // not shortest, so should only match resolved.
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()))));
999TEST(CompletionTest, NoIncludeInsertionWhenDeclFoundInFile) {
1002 std::string BarHeader =
testPath(
"bar.h");
1004 SymX.CanonicalDeclaration.FileURI = BarURI.c_str();
1005 SymY.CanonicalDeclaration.FileURI = BarURI.c_str();
1009 auto Results = completions(R
"cpp(
1014 int main() { ns::^ }
1017 EXPECT_THAT(Results.Completions,
1018 ElementsAre(AllOf(named("X"), Not(insertInclude())),
1019 AllOf(named(
"Y"), Not(insertInclude()))));
1022TEST(CompletionTest, IncludeInsertionRespectsQuotedAngledConfig) {
1025 TU.AdditionalFiles[
"sub/bar.h"] =
"";
1029 Sym.CanonicalDeclaration.FileURI = BarURI.c_str();
1032 TU.Code = Test.code().str();
1033 auto Results = completions(TU, Test.point(), {Sym});
1035 EXPECT_THAT(Results.Completions,
1036 ElementsAre(AllOf(named(
"X"), insertInclude(
"\"bar.h\""))));
1039 C.Style.AngledHeaders.push_back(
1040 [](
auto header) {
return header.contains(
"bar.h"); });
1042 Results = completions(TU, Test.point(), {Sym});
1043 EXPECT_THAT(Results.Completions,
1044 ElementsAre(AllOf(named(
"X"), insertInclude(
"<bar.h>"))));
1048 C.Style.QuotedHeaders.push_back(
1049 [](
auto header) {
return header.contains(
"bar.h"); });
1051 Results = completions(TU, Test.point(), {Sym});
1052 EXPECT_THAT(Results.Completions,
1053 ElementsAre(AllOf(named(
"X"), insertInclude(
"\"bar.h\""))));
1057TEST(CompletionTest, IndexSuppressesPreambleCompletions) {
1060 namespace ns { int local; }
1062 void f2() { ns::preamble().$2^; }
1065 TU.AdditionalFiles[
"bar.h"] =
1066 R
"cpp(namespace ns { struct preamble { int member; }; })cpp";
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")));
1077 Opts.Index =
nullptr;
1078 auto WithoutIndex = completions(TU, Test.point(), {}, Opts);
1079 EXPECT_THAT(WithoutIndex.Completions,
1080 UnorderedElementsAre(named(
"local"), named(
"preamble")));
1087TEST(CompletionTest, CompletionInPreamble) {
1088 auto Results = completions(R
"cpp(
1096 EXPECT_THAT(Results, ElementsAre(named("ifndef")));
1099TEST(CompletionTest, CompletionRecoveryASTType) {
1100 auto Results = completions(R
"cpp(
1101 struct S { int member; };
1104 // No overload matches, but we have recovery-expr with the correct type.
1108 EXPECT_THAT(Results, ElementsAre(named("member")));
1111TEST(CompletionTest, DynamicIndexIncludeInsertion) {
1115 Opts.BuildDynamicSymbolIndex =
true;
1118 FS.Files[
testPath(
"foo_header.h")] = R
"cpp(
1125 const std::string FileContent(R
"cpp(
1126 #include "foo_header.h"
1131 Server.addDocument(testPath("foo_impl.cpp"), FileContent);
1133 ASSERT_TRUE(Server.blockUntilIdleForTest());
1142 ElementsAre(AllOf(named(
"Foo"), hasInclude(
"\"foo_header.h\""),
1146TEST(CompletionTest, DynamicIndexMultiFile) {
1150 Opts.BuildDynamicSymbolIndex =
true;
1153 FS.Files[
testPath(
"foo.h")] = R
"cpp(
1154 namespace ns { class XYZ {}; void foo(int x) {} }
1177 EXPECT_THAT(Results.Completions,
1179 doc(
"Doooc"), returnType(
"void"))));
1182TEST(CompletionTest, Documentation) {
1183 auto Results = completions(
1185 // Non-doxygen comment.
1186 __attribute__((annotate("custom_annotation"))) int foo();
1198 Results.Completions,
1201 doc(
"Annotation: custom_annotation\n\nNon-doxygen comment."))));
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"))));
1209TEST(CompletionTest, CommentsFromSystemHeaders) {
1214 Opts.BuildDynamicSymbolIndex =
true;
1218 FS.Files[
testPath(
"foo.h")] = R
"cpp(
1219 #pragma GCC system_header
1221 // This comment should be retained!
1236 Contains(AllOf(named(
"foo"), doc(
"This comment should be retained!"))));
1239TEST(CompletionTest, CommentsOnMembersFromHeader) {
1244 Opts.BuildDynamicSymbolIndex =
true;
1248 FS.Files[
testPath(
"foo.h")] = R
"cpp(
1257 template <typename T>
1280 Contains(AllOf(named(
"gamma"), doc(
"This is a member field."))));
1283 Contains(AllOf(named(
"delta"), doc(
"This is a member function."))));
1289 Contains(AllOf(named(
"omega")
1293 Contains(AllOf(named(
"epsilon"),
1294 doc(
"This is a member function inside a template."))));
1297TEST(CompletionTest, CommentsOnMembersFromHeaderOverloadBundling) {
1298 using testing::AnyOf;
1303 Opts.BuildDynamicSymbolIndex =
true;
1307 FS.Files[
testPath(
"foo.h")] = R
"cpp(
1315 void epsilon(long l);
1318 void epsilon(int i);
1329 clangd::CodeCompleteOptions CCOpts;
1330 CCOpts.BundleOverloads = true;
1336 Contains(AllOf(named(
"epsilon"), doc(
"This one has a comment."))));
1338 Contains(AllOf(named(
"delta"), AnyOf(doc(
"bool overload."),
1339 doc(
"int overload.")))));
1342TEST(CompletionTest, GlobalCompletionFiltering) {
1351 auto Results = completions(R
"(// void f() {
1355 EXPECT_THAT(Results.Completions, IsEmpty());
1358TEST(CodeCompleteTest, DisableTypoCorrection) {
1359 auto Results = completions(R
"cpp(
1360 namespace clang { int v; }
1361 void f() { clangd::^
1363 EXPECT_TRUE(Results.Completions.empty());
1366TEST(CodeCompleteTest, NoColonColonAtTheEnd) {
1367 auto Results = completions(R
"cpp(
1374 EXPECT_THAT(Results.Completions, Contains(labeled("clang")));
1375 EXPECT_THAT(Results.Completions, Not(Contains(labeled(
"clang::"))));
1378TEST(CompletionTests, EmptySnippetDoesNotCrash) {
1380 auto Results = completions(R
"cpp(
1382 auto w = [&](auto &&f) { return f(f); };
1383 auto f = w([&](auto &&f) {
1384 return [&](auto &&n) {
1388 return n * ^(f)(n - 1);
1395TEST(CompletionTest, Issue1427Crash) {
1401 Opts.MainFileSignals = &MainFileSignals;
1410TEST(CompletionTest, BacktrackCrashes) {
1412 auto Results = completions(R
"cpp(
1414 struct FooBarBaz {};
1420 EXPECT_THAT(Results.Completions, ElementsAre(labeled("FooBarBaz")));
1424 struct FooBarBaz {};
1426 if (FooBarBaz * x^) {}
1431TEST(CompletionTest, CompleteInMacroWithStringification) {
1432 auto Results = completions(R
"cpp(
1433void f(const char *, int x);
1434#define F(x) f(#x, x)
1441int f(int input_num) {
1446 EXPECT_THAT(Results.Completions,
1447 UnorderedElementsAre(named("X"), named(
"Y")));
1450TEST(CompletionTest, CompleteInMacroAndNamespaceWithStringification) {
1451 auto Results = completions(R
"cpp(
1452void f(const char *, int x);
1453#define F(x) f(#x, x)
1458int f(int input_num) {
1464 EXPECT_THAT(Results.Completions, Contains(named("X")));
1467TEST(CompletionTest, IgnoreCompleteInExcludedPPBranchWithRecoveryContext) {
1468 auto Results = completions(R
"cpp(
1469 int bar(int param_in_bar) {
1472 int foo(int param_in_foo) {
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.
1484 EXPECT_TRUE(Results.Completions.empty());
1487TEST(CompletionTest, DefaultArgs) {
1488 clangd::CodeCompleteOptions Opts;
1491 int Y(int A, int B = 0);
1492 int Z(int A, int B = 0, int C = 0, int D = 0);
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})"))));
1505TEST(CompletionTest, NoCrashWithTemplateParamsAndPreferredTypes) {
1506 auto Completions = completions(R
"cpp(
1507template <template <class> class TT> int foo() {
1512 EXPECT_THAT(Completions, Contains(named("TT")));
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.
1526 EXPECT_THAT(Completions, Contains(named("xxx")));
1529TEST(CompletionTest, RecordCCResultCallback) {
1530 std::vector<CodeCompletion> RecordedCompletions;
1532 Opts.RecordCCResult = [&RecordedCompletions](
const CodeCompletion &CC,
1536 RecordedCompletions.push_back(CC);
1539 completions(
"int xy1, xy2; int a = xy^", {}, Opts);
1540 EXPECT_THAT(RecordedCompletions,
1541 UnorderedElementsAre(named(
"xy1"), named(
"xy2")));
1547 unsigned MainFileRefs;
1548 unsigned ScopeRefsInFile;
1551 std::vector<Completion> RecordedCompletions;
1552 Opts.RecordCCResult = [&RecordedCompletions](
const CodeCompletion &CC,
1556 RecordedCompletions.push_back({CC.Name, R.MainFileRefs, R.ScopeRefsInFile});
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;
1575 {
var(
"xyindex"),
var(
"tar::xytar"),
var(
"bar::xybar")},
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( named(
"xybar"),
1584 mainFileRefs(0u), scopeRefs(3u))));
1589 std::vector<Symbol> IndexSymbols = {},
1591 std::unique_ptr<SymbolIndex> Index;
1592 if (!IndexSymbols.empty())
1593 Index = memIndex(IndexSymbols);
1597 auto Inputs = TU.inputs(FS);
1598 Inputs.Index = Index.get();
1602 ADD_FAILURE() <<
"Couldn't build CompilerInvocation";
1608 ADD_FAILURE() <<
"Couldn't build Preamble";
1612 DocumentationFormat);
1616signatures(llvm::StringRef
Text, std::vector<Symbol> IndexSymbols = {},
1619 return signatures(Test.code(), Test.point(), std::move(IndexSymbols),
1620 DocumentationFormat);
1623struct ExpectedParameter {
1625 std::pair<unsigned, unsigned> Offsets;
1627llvm::raw_ostream &
operator<<(llvm::raw_ostream &OS,
1628 const ExpectedParameter &P) {
1629 return OS <<
P.Text;
1632 if (
P.size() != arg.parameters.size())
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)
1641MATCHER_P(sigDoc, doc,
"") {
return arg.documentation.value == doc; }
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();
1652 ExpectedParameter &
P = Parameters.back();
1657 return AllOf(sigHelpLabeled(
Label), paramsAre(Parameters));
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(^); }
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")));
1675 EXPECT_EQ(0, Results.activeSignature);
1676 EXPECT_EQ(0, Results.activeParameter);
1679TEST(SignatureHelpTest, FunctionPointers) {
1680 llvm::StringLiteral Tests[] = {
1683 void (*foo)(int x, int y);
1684 int main() { foo(^); }
1688 void (__stdcall *foo)(int x, int y);
1689 int main() { foo(^); }
1693 void (__attribute__(stdcall) *foo)(int x, int y);
1694 int main() { foo(^); },
1698 typedef void (*fn)(int x, int y);
1700 int main() { foo(^); }
1704 typedef void (__stdcall *fn)(int x, int y);
1706 int main() { foo(^); }
1711 void (*foo)(int x, int y);
1714 int main() { s.foo(^); }
1718 typedef void (*fn)(int x, int y);
1723 int main() { s.foo(^); }
1725 for (
auto Test : Tests)
1726 EXPECT_THAT(signatures(Test).signatures,
1727 UnorderedElementsAre(sig(
"([[int x]], [[int y]]) -> void")));
1730TEST(SignatureHelpTest, Constructors) {
1731 std::string Top = R
"cpp(
1734 S(const S &) = delete;
1738 auto CheckParenInit = [&](std::string Init) {
1739 EXPECT_THAT(signatures(Top + Init).signatures,
1740 UnorderedElementsAre(sig(
"S([[int]])")))
1743 CheckParenInit(
"S s(^);");
1744 CheckParenInit(
"auto s = S(^);");
1745 CheckParenInit(
"auto s = new S(^);");
1747 auto CheckBracedInit = [&](std::string Init) {
1748 EXPECT_THAT(signatures(Top + Init).signatures,
1749 UnorderedElementsAre(sig(
"S{[[int]]}")))
1752 CheckBracedInit(
"S s{^};");
1753 CheckBracedInit(
"S s = {^};");
1754 CheckBracedInit(
"auto s = S{^};");
1757 CheckBracedInit(
"int x(S); int i = x({^});");
1760TEST(SignatureHelpTest, Aggregates) {
1761 std::string Top = R
"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);
1779TEST(SignatureHelpTest, OverloadInitListRegression) {
1780 auto Results = signatures(R
"cpp(
1789 EXPECT_THAT(Results.signatures, UnorderedElementsAre(sig("f() -> void")));
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);
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);
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), ^); }
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);
1817TEST(SignatureHelpTest, OpeningParen) {
1818 llvm::StringLiteral Tests[] = {
1821 int foo(int a, int b, int c);
1823 foo(foo $p^( foo(10, 10, 10), ^ )));
1828 Foo(int a, int b, int c);
1836 Foo(int a, int b, int c);
1839 new Foo $p^( 10, ^ );
1843 int foo(int a, int b, int c);
1847 // Macro expansions.
1852 int foo(int a, int b, int c);
1855 // FIXME: figure out why ID(foo (foo(10), )) doesn't work when preserving
1856 // the recovery expression.
1857 ID(foo $p^( 10, ^ ))
1861 int foo(int a, int b);
1862 template <typename T> void bar(T t) {
1867 template <typename T>
1869 template <typename T> void bar(T t) {
1874 struct Foo { int foo(int, int); };
1875 template <typename T> void bar(T t) {
1881 struct Foo { template <typename T> int foo(T, T); };
1882 template <typename T> void bar(T t) {
1888 for (
auto Test : Tests) {
1890 EXPECT_EQ(signatures(Code.code(), Code.point()).argListStart,
1892 <<
"Test source:" << Test;
1896TEST(SignatureHelpTest, StalePreamble) {
1901 auto Inputs = TU.inputs(FS);
1906 ASSERT_TRUE(EmptyPreamble);
1908 TU.AdditionalFiles[
"a.h"] =
"int foo(int x);";
1911 void bar() { foo(^2); })cpp");
1912 TU.Code = Test.code().str();
1916 EXPECT_THAT(Results.signatures, ElementsAre(sig(
"foo([[int x]]) -> int")));
1917 EXPECT_EQ(0, Results.activeSignature);
1918 EXPECT_EQ(0, Results.activeParameter);
1923 IndexRequestCollector(std::vector<Symbol> Syms = {}) : Symbols(Syms) {}
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)
1936 void lookup(
const LookupRequest &,
1937 llvm::function_ref<
void(
const Symbol &)>)
const override {}
1939 bool refs(
const RefsRequest &,
1940 llvm::function_ref<
void(
const Ref &)>)
const override {
1945 const ContainedRefsRequest &,
1946 llvm::function_ref<
void(
const ContainedRefsResult &)>)
const override {
1950 void relations(
const RelationsRequest &,
1951 llvm::function_ref<
void(
const SymbolID &,
const Symbol &)>)
1955 reverseRelations(
const RelationsRequest &,
1956 llvm::function_ref<
void(
const SymbolID &,
const Symbol &)>)
1960 indexedFiles()
const override {
1966 size_t estimateMemoryUsage()
const override {
return 0; }
1968 const std::vector<FuzzyFindRequest> consumeRequests(
size_t Num)
const {
1969 std::unique_lock<std::mutex> Lock(Mut);
1971 [
this, Num] {
return Requests.size() == Num; }));
1972 auto Reqs = std::move(Requests);
1978 std::vector<Symbol> Symbols;
1980 mutable std::condition_variable ReceivedRequestCV;
1981 mutable std::mutex Mut;
1982 mutable std::vector<FuzzyFindRequest> Requests;
1986std::vector<FuzzyFindRequest> captureIndexRequests(llvm::StringRef Code,
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);
1997TEST(CompletionTest, UnqualifiedIdQuery) {
1998 auto Requests = captureIndexRequests(R
"cpp(
2000 using namespace std;
2008 EXPECT_THAT(Requests,
2010 UnorderedElementsAre("",
"ns::",
"std::"))));
2013TEST(CompletionTest, EnclosingScopeComesFirst) {
2014 auto Requests = captureIndexRequests(R
"cpp(
2016 using namespace std;
2028 EXPECT_THAT(Requests,
2031 UnorderedElementsAre("",
"std::",
"nx::ns::",
"nx::"))));
2032 EXPECT_EQ(Requests[0].Scopes[0],
"nx::ns::");
2035TEST(CompletionTest, ResolvedQualifiedIdQuery) {
2036 auto Requests = captureIndexRequests(R
"cpp(
2038 namespace ns2 {} // ignore
2039 namespace ns3 { namespace nns3 {} }
2041 using namespace ns1;
2042 using namespace ns3::nns3;
2051 EXPECT_THAT(Requests,
2054 UnorderedElementsAre("foo::",
"ns1::",
"ns3::nns3::"))));
2057TEST(CompletionTest, UnresolvedQualifierIdQuery) {
2058 auto Requests = captureIndexRequests(R
"cpp(
2068 EXPECT_THAT(Requests,
2071 UnorderedElementsAre("a::bar::",
"ns::bar::",
"bar::"))));
2074TEST(CompletionTest, UnresolvedNestedQualifierIdQuery) {
2075 auto Requests = captureIndexRequests(R
"cpp(
2086 UnorderedElementsAre("a::bar::"))));
2089TEST(CompletionTest, EmptyQualifiedQuery) {
2090 auto Requests = captureIndexRequests(R
"cpp(
2099 UnorderedElementsAre("",
"ns::"))));
2102TEST(CompletionTest, GlobalQualifiedQuery) {
2103 auto Requests = captureIndexRequests(R
"cpp(
2112 UnorderedElementsAre(""))));
2115TEST(CompletionTest, NoDuplicatedQueryScopes) {
2116 auto Requests = captureIndexRequests(R
"cpp(
2127 EXPECT_THAT(Requests,
2129 UnorderedElementsAre("na::",
"na::nb::",
""))));
2132TEST(CompletionTest, NoIndexCompletionsInsideClasses) {
2133 auto Completions = completions(
2136 int SomeNameOfField;
2137 typedef int SomeNameOfTypedefField;
2141 {func("::SomeNameInTheIndex"),
func(
"::Foo::SomeNameInTheIndex")});
2143 EXPECT_THAT(Completions.Completions,
2144 AllOf(Contains(labeled(
"SomeNameOfField")),
2145 Contains(labeled(
"SomeNameOfTypedefField")),
2146 Not(Contains(labeled(
"SomeNameInTheIndex")))));
2149TEST(CompletionTest, NoIndexCompletionsInsideDependentCode) {
2151 auto Completions = completions(
2158 {func("::SomeNameInTheIndex")});
2160 EXPECT_THAT(Completions.Completions,
2161 Not(Contains(labeled(
"SomeNameInTheIndex"))));
2165 auto Completions = completions(
2169 T::template Y<int>::^
2172 {func("::SomeNameInTheIndex")});
2174 EXPECT_THAT(Completions.Completions,
2175 Not(Contains(labeled(
"SomeNameInTheIndex"))));
2179 auto Completions = completions(
2186 {func("::SomeNameInTheIndex")});
2188 EXPECT_THAT(Completions.Completions,
2189 Not(Contains(labeled(
"SomeNameInTheIndex"))));
2193TEST(CompletionTest, OverloadBundling) {
2194 clangd::CodeCompleteOptions Opts;
2195 Opts.BundleOverloads =
true;
2199 // Overload with int
2200 int a(int) __attribute__((deprecated("", "")));
2201 // Overload with bool
2213 EXPECT_THAT(completions(
Context +
"int y = X().^", {}, Opts).Completions,
2214 UnorderedElementsAre(labeled(
"a(…)"), labeled(
"b(float)")));
2217 EXPECT_THAT(completions(
Context +
"X z = X^", {}, Opts).Completions,
2218 UnorderedElementsAre(labeled(
"X"), labeled(
"X(…)")));
2223 completions(
Context +
"int y = GFunc^", {NoArgsGFunc}, Opts).Completions,
2224 UnorderedElementsAre(labeled(
"GFuncC(…)"), labeled(
"GFuncD(int)")));
2228 NoArgsGFunc.CanonicalDeclaration.FileURI = DeclFile.c_str();
2231 completions(
Context +
"int y = GFunc^", {NoArgsGFunc}, Opts).Completions,
2232 UnorderedElementsAre(AllOf(named(
"GFuncC"), insertInclude(
"<foo>")),
2233 labeled(
"GFuncC(int)"), labeled(
"GFuncD(int)")));
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);
2242 EXPECT_EQ(
A.ReturnType,
"int");
2244 ASSERT_TRUE(
A.Documentation);
2245 ASSERT_FALSE(
A.Deprecated);
2247 A.Documentation->asPlainText(),
2248 AnyOf(HasSubstr(
"Overload with int"), HasSubstr(
"Overload with bool")));
2249 EXPECT_EQ(
A.SnippetSuffix,
"($0)");
2252TEST(CompletionTest, OverloadBundlingSameFileDifferentURI) {
2253 clangd::CodeCompleteOptions Opts;
2254 Opts.BundleOverloads =
true;
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");
2260 SymX.CanonicalDeclaration.FileURI = BarURI.c_str();
2261 SymY.CanonicalDeclaration.FileURI = BarURI.c_str();
2266 auto Results = completions(
"void f() { ::ns::^ }", {SymX, SymY}, Opts);
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);
2275TEST(CompletionTest, DocumentationFromChangedFileCrash) {
2279 FS.Files[FooH] = R
"cpp(
2280 // this is my documentation comment.
2283 FS.Files[FooCpp] = "";
2291 // This makes sure we have func from header in the AST.
2297 ASSERT_TRUE(Server.blockUntilIdleForTest());
2300 FS.Files[FooH] = R
"cpp(
2304 clangd::CodeCompleteOptions Opts;
2305 CodeCompleteResult Completions =
2309 EXPECT_THAT(Completions.Completions,
2310 Contains(AllOf(Not(isDocumented()), named(
"func"))));
2313TEST(CompletionTest, NonDocComments) {
2314 const char *
Text = R
"cpp(
2315 // We ignore namespace comments, for rationale see CodeCompletionStrings.h.
2316 namespace comments_ns {
2319 // ------------------
2322 // A comment and a decl are separated by newlines.
2323 // Therefore, the comment shouldn't show up as doc comment.
2327 // this comment should be in the results.
2334 int comments_quux();
2338 // This comment should not be there.
2341 int Struct<T>::comments_qux() {
2344 // This comment **should** be in results.
2346 int Struct<T>::comments_quux() {
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")),
2362 AllOf(isDocumented(), named(
"comments_bar")),
2363 AllOf(isDocumented(), named(
"comments_qux"))));
2366TEST(CompletionTest, CompleteOnInvalidLine) {
2371 FS.
Files[FooCpp] =
"// empty file";
2378 EXPECT_THAT_EXPECTED(
2383TEST(CompletionTest, QualifiedNames) {
2384 auto Results = completions(
2386 namespace ns { int local; void both(); }
2387 void f() { ::ns::^ }
2389 {func("ns::both"),
cls(
"ns::Index")});
2392 Results.Completions,
2393 UnorderedElementsAre(scope(
"ns::"), scope(
"ns::"), scope(
"ns::")));
2396TEST(CompletionTest, Render) {
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;
2416 Opts.IncludeIndicator.Insert =
"^";
2417 Opts.IncludeIndicator.NoInsert =
"";
2418 Opts.EnableSnippets =
false;
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");
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);
2433 C.FilterText =
"xtra";
2435 EXPECT_EQ(R.filterText,
"xtra");
2436 EXPECT_EQ(R.sortText,
sortText(1.0,
"xtra"));
2438 Opts.EnableSnippets =
true;
2440 EXPECT_EQ(R.insertText,
"Foo::x(${0:bool})");
2443 C.SnippetSuffix =
"";
2445 EXPECT_EQ(R.insertText,
"Foo::x");
2448 Include.Insertion.emplace();
2450 EXPECT_EQ(R.label,
"^Foo::x");
2451 EXPECT_EQ(R.labelDetails->detail,
"(bool) const");
2452 EXPECT_THAT(R.additionalTextEdits, Not(IsEmpty()));
2454 Opts.ShowOrigins =
true;
2456 EXPECT_EQ(R.label,
"^[AS]Foo::x");
2457 EXPECT_EQ(R.labelDetails->detail,
"(bool) const");
2461 EXPECT_EQ(R.detail,
"[2 overloads]");
2462 EXPECT_EQ(R.documentation->value,
"From \"foo.h\"\n\nThis is x()");
2464 C.Deprecated =
true;
2466 EXPECT_TRUE(R.deprecated);
2470 EXPECT_EQ(R.documentation->value,
"From `\"foo.h\"`\n\nThis is `x()`");
2473TEST(CompletionTest, IgnoreRecoveryResults) {
2474 auto Results = completions(
2476 namespace ns { int NotRecovered() { return 0; } }
2478 // Sema enters recovery mode first and then normal mode.
2479 if (auto x = ns::NotRecover^)
2482 EXPECT_THAT(Results.Completions, UnorderedElementsAre(named("NotRecovered")));
2485TEST(CompletionTest, ScopeOfClassFieldInConstructorInitializer) {
2486 auto Results = completions(
2489 class X { public: X(); int x_; };
2493 EXPECT_THAT(Results.Completions,
2494 UnorderedElementsAre(AllOf(scope("ns::X::"), named(
"x_"))));
2501TEST(CompletionTest, ConstructorInitListIncomplete) {
2502 auto Results = completions(
2511 EXPECT_THAT(Results.Completions, ElementsAre(named("xyz_")));
2513 Results = completions(
2524 EXPECT_THAT(Results.Completions, ElementsAre(named("foo")));
2527TEST(CompletionTest, CodeCompletionContext) {
2528 auto Results = completions(
2531 class X { public: X(); int x_; };
2539 EXPECT_THAT(Results.Context, CodeCompletionContext::CCC_DotMemberAccess);
2542TEST(CompletionTest, FixItForArrowToDot) {
2547 Opts.IncludeFixIts = true;
2554 class ClassWithPtr {
2556 void MemberFunction();
2557 Auxilary* operator->() const;
2565 auto Results = completions(Code, {}, Opts);
2566 EXPECT_EQ(Results.Completions.size(), 3u);
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));
2579TEST(CompletionTest, FixItForDotToArrow) {
2581 Opts.IncludeFixIts =
true;
2588 class ClassWithPtr {
2590 void MemberFunction();
2591 Auxilary* operator->() const;
2599 auto Results = completions(Code, {}, Opts);
2600 EXPECT_EQ(Results.Completions.size(), 3u);
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));
2613TEST(CompletionTest, RenderWithFixItMerged) {
2616 FixIt.newText =
"->";
2620 C.RequiredQualifier =
"Foo::";
2622 C.CompletionTokenRange.start.character = 5;
2625 Opts.IncludeFixIts =
true;
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());
2633TEST(CompletionTest, RenderWithFixItNonMerged) {
2636 FixIt.newText =
"->";
2640 C.RequiredQualifier =
"Foo::";
2642 C.CompletionTokenRange.start.character = 5;
2645 Opts.IncludeFixIts =
true;
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));
2653TEST(CompletionTest, CompletionTokenRange) {
2659 constexpr const char *TestCodes[] = {
2681 #include "foo/[[a^/]]foo.h"
2684 #include "foo/abc/[[fo^o.h"]]
2687 for (
const auto &
Text : TestCodes) {
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;
2695 EXPECT_THAT(Results.Completions.front().CompletionTokenRange,
2700TEST(SignatureHelpTest, OverloadsOrdering) {
2701 const auto Results = signatures(R
"cpp(
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(^); }
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")));
2716 EXPECT_EQ(0, Results.activeSignature);
2717 EXPECT_EQ(0, Results.activeParameter);
2720TEST(SignatureHelpTest, InstantiatedSignatures) {
2721 StringRef Sig0 = R
"cpp(
2730 EXPECT_THAT(signatures(Sig0).signatures,
2731 ElementsAre(sig("foo([[T]], [[T]], [[T]]) -> void")));
2733 StringRef Sig1 = R
"cpp(
2741 EXPECT_THAT(signatures(Sig1).signatures,
2742 ElementsAre(sig("foo([[T]], [[T]], [[T]]) -> void")));
2744 StringRef Sig2 = R
"cpp(
2745 template <class ...T>
2753 EXPECT_THAT(signatures(Sig2).signatures,
2754 ElementsAre(sig("foo([[T...]]) -> void")));
2761 StringRef Sig3 = R
"cpp(
2769 X<int>().foo<double>(^)
2773 EXPECT_THAT(signatures(Sig3).signatures,
2774 ElementsAre(sig("foo([[T]], [[U]]) -> void")));
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#");
2784 StringRef Sig0 = R
"cpp(
2794 signatures(Sig0, {Foo0}).signatures,
2795 ElementsAre(AllOf(sig("foo() -> int"), sigDoc(
"doc from the index")),
2796 AllOf(sig(
"foo([[double]]) -> int"), sigDoc(
""))));
2798 StringRef Sig1 = R
"cpp(
2800 // Overriden doc from sema
2811 signatures(Sig1, {Foo0, Foo1, Foo2}).signatures,
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"))));
2818TEST(SignatureHelpTest, DynamicIndexDocumentation) {
2822 Opts.BuildDynamicSymbolIndex =
true;
2825 FS.Files[
testPath(
"foo.h")] = R
"cpp(
2839 Server.addDocument(
File, FileContent.code());
2841 ASSERT_TRUE(Server.blockUntilIdleForTest());
2845 ElementsAre(AllOf(sig(
"foo() -> int"), sigDoc(
"Member doc"))));
2848TEST(CompletionTest, ArgumentListsPolicy) {
2850 Opts.EnableSnippets =
true;
2854 auto Results = completions(
2857 void xfoo(int x, int y);
2858 void f() { xfo^ })cpp",
2861 Results.Completions,
2862 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix(
"()")),
2863 AllOf(named(
"xfoo"), snippetSuffix(
"($0)"))));
2866 auto Results = completions(
2869 void f() { xba^ })cpp",
2871 EXPECT_THAT(Results.Completions, UnorderedElementsAre(AllOf(
2872 named("xbar"), snippetSuffix(
"()"))));
2875 Opts.BundleOverloads =
true;
2876 auto Results = completions(
2879 void xfoo(int x, int y);
2880 void f() { xfo^ })cpp",
2883 Results.Completions,
2884 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix(
"($0)"))));
2887 auto Results = completions(
2889 template <class T, class U>
2890 void xfoo(int a, U b);
2891 void f() { xfo^ })cpp",
2894 Results.Completions,
2895 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix(
"<$1>($0)"))));
2898 auto Results = completions(
2903 using foo_alias = T**;
2906 void f() { foo_^ })cpp",
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>"))));
2915 auto Results = completions(
2917 #define FOO(x, y) x##f
2920 EXPECT_THAT(Results.Completions, UnorderedElementsAre(AllOf(
2921 named("FOO"), snippetSuffix(
"($0)"))));
2924 auto Results = completions(
2927 auto Lambda = [](int a, const double &b) {return 1.f;};
2932 Results.Completions,
2933 UnorderedElementsAre(AllOf(named("Lambda"), snippetSuffix(
"($0)"))));
2937 auto Results = completions(
2939 void xfoo(int x, int y);
2940 void f() { xfo^ })cpp",
2942 EXPECT_THAT(Results.Completions,
2943 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix(
""))));
2947 auto Results = completions(
2949 void xfoo(int x, int y);
2950 void f() { xfo^ })cpp",
2952 EXPECT_THAT(Results.Completions,
2953 UnorderedElementsAre(AllOf(named("xfoo"), snippetSuffix(
"("))));
2957TEST(CompletionTest, SuggestOverrides) {
2958 constexpr const char *
const Text(R
"cpp(
2961 virtual void vfunc(bool param);
2962 virtual void vfunc(bool param, int p);
2963 void func(bool param);
2965 class B : public A {
2966 virtual void ttt(bool param) const;
2967 void vfunc(bool param, int p) override;
2969 class C : public B {
2971 void vfunc(bool param) override;
2975 const auto Results = completions(
Text);
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")))));
2985TEST(CompletionTest, OverridesNonIdentName) {
2989 virtual ~Base() = 0;
2990 virtual operator int() = 0;
2991 virtual Base& operator+(Base&) = 0;
2994 struct Derived : Base {
3000TEST(CompletionTest, NoCrashOnMissingNewLineAtEOF) {
3006 FS.Files[FooCpp] = F.code().str();
3011 clangd::CodeCompleteOptions()))
3020TEST(GuessCompletionPrefix, Filters) {
3021 for (llvm::StringRef Case : {
3022 "[[scope::]][[ident]]^",
3031 "some text [[scope::more::]][[identif]]^ier",
3032 "some text [[scope::]][[mor]]^e::identifier",
3033 "weird case foo::[[::bar::]][[baz]]^",
3038 auto ToStringRef = [&](
Range R) {
3042 auto WantQualifier = ToStringRef(F.ranges()[0]),
3043 WantName = ToStringRef(F.ranges()[1]);
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;
3054TEST(CompletionTest, EnableSpeculativeIndexRequest) {
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^; }
3067 clangd::CodeCompleteOptions Opts = {};
3069 IndexRequestCollector Requests;
3070 Opts.Index = &Requests;
3072 auto CompleteAtPoint = [&](StringRef
P) {
3074 EXPECT_TRUE(CCR.HasMore);
3077 CompleteAtPoint(
"1");
3078 auto Reqs1 = Requests.consumeRequests(1);
3079 ASSERT_EQ(Reqs1.size(), 1u);
3080 EXPECT_THAT(Reqs1[0].Scopes, UnorderedElementsAre(
"ns1::"));
3082 CompleteAtPoint(
"2");
3083 auto Reqs2 = Requests.consumeRequests(1);
3085 ASSERT_EQ(Reqs2.size(), 1u);
3086 EXPECT_EQ(Reqs2[0], Reqs1[0]);
3088 CompleteAtPoint(
"3");
3091 auto Reqs3 = Requests.consumeRequests(2);
3092 ASSERT_EQ(Reqs3.size(), 2u);
3095TEST(CompletionTest, InsertTheMostPopularHeader) {
3098 Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
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);
3108TEST(CompletionTest, InsertIncludeOrImport) {
3111 Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
3112 Sym.IncludeHeaders.emplace_back(
"\"bar.h\"", 1000,
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")));
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")));
3131 Results = completions(
"Fun^", {Sym}).Completions;
3132 assert(!Results.empty());
3133 EXPECT_THAT(Results[0], AllOf(named(
"Func"), Not(insertInclude())));
3136TEST(CompletionTest, NoInsertIncludeIfOnePresent) {
3142 TU.AdditionalFiles[
"foo.h"] =
"";
3146 Sym.CanonicalDeclaration.FileURI = DeclFile.c_str();
3150 EXPECT_THAT(completions(TU, Test.point(), {Sym}).Completions,
3151 UnorderedElementsAre(AllOf(named(
"Func"), hasInclude(
"\"foo.h\""),
3152 Not(insertInclude()))));
3155TEST(CompletionTest, MergeMacrosFromIndexAndSema) {
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})
3163 UnorderedElementsAre(named(
"Clangd_Macro_Test")));
3166TEST(CompletionTest, MacroFromPreamble) {
3167 Annotations Test(R
"cpp(#define CLANGD_PREAMBLE_MAIN x
3170 #define CLANGD_MAIN x
3171 void f() { CLANGD_^ }
3174 TU.HeaderCode =
"#define CLANGD_PREAMBLE_HEADER x";
3175 auto Results = completions(TU, Test.point(), {func(
"CLANGD_INDEX")});
3178 EXPECT_THAT(Results.Completions,
3179 UnorderedElementsAre(named(
"CLANGD_PREAMBLE_MAIN"),
3180 named(
"CLANGD_MAIN"),
3181 named(
"CLANGD_INDEX")));
3184TEST(CompletionTest, DeprecatedResults) {
3185 std::string Body = R
"cpp(
3187 void TestClangc() __attribute__((deprecated("", "")));
3191 completions(Body + "int main() { TestClang^ }").Completions,
3192 UnorderedElementsAre(AllOf(named(
"TestClangd"), Not(deprecated())),
3193 AllOf(named(
"TestClangc"), deprecated())));
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);
3205TEST(SignatureHelpTest, InsideArgument) {
3207 const auto Results = signatures(R
"cpp(
3209 void foo(int x, int y);
3210 int main() { foo(1+^); }
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);
3218 const auto Results = signatures(R
"cpp(
3220 void foo(int x, int y);
3221 int main() { foo(1^); }
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);
3229 const auto Results = signatures(R
"cpp(
3231 void foo(int x, int y);
3232 int main() { foo(1^0); }
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);
3240 const auto Results = signatures(R
"cpp(
3242 void foo(int x, int y);
3243 int bar(int x, int y);
3244 int main() { bar(foo(2, 3^)); }
3246 EXPECT_THAT(Results.signatures,
3247 ElementsAre(sig("foo([[int x]], [[int y]]) -> void")));
3248 EXPECT_EQ(1, Results.activeParameter);
3252TEST(SignatureHelpTest, ConstructorInitializeFields) {
3254 const auto Results = signatures(R
"cpp(
3255 struct A { A(int); };
3261 EXPECT_THAT(Results.signatures,
3262 UnorderedElementsAre(sig("A([[int]])"), sig(
"A([[A &&]])"),
3263 sig(
"A([[const A &]])")));
3266 const auto Results = signatures(R
"cpp(
3267 struct A { A(int); };
3275 EXPECT_THAT(Results.signatures, IsEmpty());
3278 const auto Results = signatures(R
"cpp(
3279 struct A { A(int); };
3286 EXPECT_THAT(Results.signatures,
3287 UnorderedElementsAre(sig("A([[int]])"), sig(
"A([[A &&]])"),
3288 sig(
"A([[const A &]])")));
3291 const auto Results = signatures(R
"cpp(
3300 B() : c_elem(A(1^)) {}
3304 EXPECT_THAT(Results.signatures,
3305 UnorderedElementsAre(sig("A([[int]])"), sig(
"A([[A &&]])"),
3306 sig(
"A([[const A &]])")));
3310TEST(SignatureHelpTest, Variadic) {
3311 const std::string Header = R
"cpp(
3312 void fun(int x, ...) {}
3314 const std::string ExpectedSig =
"fun([[int x]], [[...]]) -> void";
3317 const auto Result = signatures(Header +
"fun(^);}");
3318 EXPECT_EQ(0, Result.activeParameter);
3319 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3322 const auto Result = signatures(Header +
"fun(1, ^);}");
3323 EXPECT_EQ(1, Result.activeParameter);
3324 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3327 const auto Result = signatures(Header +
"fun(1, 2, ^);}");
3328 EXPECT_EQ(1, Result.activeParameter);
3329 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3333TEST(SignatureHelpTest, VariadicTemplate) {
3334 const std::string Header = R
"cpp(
3335 template<typename T, typename ...Args>
3336 void fun(T t, Args ...args) {}
3338 const std::string ExpectedSig =
"fun([[T t]], [[Args args...]]) -> void";
3341 const auto Result = signatures(Header +
"fun(^);}");
3342 EXPECT_EQ(0, Result.activeParameter);
3343 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3346 const auto Result = signatures(Header +
"fun(1, ^);}");
3347 EXPECT_EQ(1, Result.activeParameter);
3348 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3351 const auto Result = signatures(Header +
"fun(1, 2, ^);}");
3352 EXPECT_EQ(1, Result.activeParameter);
3353 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3357TEST(SignatureHelpTest, VariadicMethod) {
3358 const std::string Header = R
"cpp(
3360 template<typename T, typename ...Args>
3361 void fun(T t, Args ...args) {}
3363 void test() {C c; )cpp";
3364 const std::string ExpectedSig =
"fun([[T t]], [[Args args...]]) -> void";
3367 const auto Result = signatures(Header +
"c.fun(^);}");
3368 EXPECT_EQ(0, Result.activeParameter);
3369 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3372 const auto Result = signatures(Header +
"c.fun(1, ^);}");
3373 EXPECT_EQ(1, Result.activeParameter);
3374 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3377 const auto Result = signatures(Header +
"c.fun(1, 2, ^);}");
3378 EXPECT_EQ(1, Result.activeParameter);
3379 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3383TEST(SignatureHelpTest, VariadicType) {
3384 const std::string Header = R
"cpp(
3385 void fun(int x, ...) {}
3386 auto get_fun() { return fun; }
3389 const std::string ExpectedSig =
"([[int]], [[...]]) -> void";
3392 const auto Result = signatures(Header +
"get_fun()(^);}");
3393 EXPECT_EQ(0, Result.activeParameter);
3394 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3397 const auto Result = signatures(Header +
"get_fun()(1, ^);}");
3398 EXPECT_EQ(1, Result.activeParameter);
3399 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3402 const auto Result = signatures(Header +
"get_fun()(1, 2, ^);}");
3403 EXPECT_EQ(1, Result.activeParameter);
3404 EXPECT_THAT(Result.signatures, UnorderedElementsAre(sig(ExpectedSig)));
3408TEST(SignatureHelpTest, SkipExplicitObjectParameter) {
3411 void foo(this auto&& self, int arg);
3412 void bar(this A self, int arg);
3423 TU.ExtraArgs = {
"-std=c++23"};
3426 auto Inputs = TU.inputs(FS);
3435 EXPECT_EQ(1U, Result.signatures.size());
3437 EXPECT_THAT(Result.signatures[0], AllOf(sig(
"foo([[int arg]]) -> void")));
3443 EXPECT_EQ(1U, Result.signatures.size());
3445 EXPECT_THAT(Result.signatures[0], AllOf(sig(
"([[A]], [[int]]) -> void")));
3452 EXPECT_EQ(0U, Result.signatures.size());
3458TEST(CompletionTest, IncludedCompletionKinds) {
3461 TU.AdditionalFiles[
"sub/bar.h"] =
"";
3462 TU.ExtraArgs.push_back(
"-I" +
testPath(
"sub"));
3464 auto Results = completions(TU, Test.point());
3465 EXPECT_THAT(Results.Completions,
3470TEST(CompletionTest, NoCrashAtNonAlphaIncludeHeader) {
3477TEST(CompletionTest, NoAllScopesCompletionWhenQualified) {
3478 clangd::CodeCompleteOptions Opts = {};
3479 Opts.AllScopes = true;
3481 auto Results = completions(
3483 void f() { na::Clangd^ }
3485 {cls("na::ClangdA"),
cls(
"nx::ClangdX"),
cls(
"Clangd3")}, Opts);
3486 EXPECT_THAT(Results.Completions,
3487 UnorderedElementsAre(
3488 AllOf(qualifier(
""), scope(
"na::"), named(
"ClangdA"))));
3491TEST(CompletionTest, AllScopesCompletion) {
3492 clangd::CodeCompleteOptions Opts = {};
3493 Opts.AllScopes =
true;
3495 auto Results = completions(
3498 void f() { Clangd^ }
3501 {cls("nx::Clangd1"),
cls(
"ny::Clangd2"),
cls(
"Clangd3"),
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"),
3518TEST(CompletionTest, NoCodePatternsIfDisabled) {
3519 clangd::CodeCompleteOptions Opts = {};
3520 Opts.EnableSnippets =
true;
3523 auto Results = completions(R
"cpp(
3532 EXPECT_THAT(Results.Completions,
3536TEST(CompletionTest, CompleteIncludeIfCodePatternsNone) {
3537 clangd::CodeCompleteOptions Opts = {};
3538 Opts.EnableSnippets =
true;
3543 TU.AdditionalFiles[
"foo/bar.h"] =
"";
3544 TU.ExtraArgs.push_back(
"-I" +
testPath(
"foo"));
3546 auto Results = completions(TU, Test.point(), {}, Opts);
3547 EXPECT_THAT(Results.Completions,
3552TEST(CompletionTest, NoQualifierIfShadowed) {
3553 clangd::CodeCompleteOptions Opts = {};
3554 Opts.AllScopes =
true;
3556 auto Results = completions(R
"cpp(
3557 namespace nx { class Clangd1 {}; }
3559 void f() { Clangd^ }
3561 {cls("nx::Clangd1"),
cls(
"nx::Clangd2")}, Opts);
3564 EXPECT_THAT(Results.Completions,
3565 UnorderedElementsAre(AllOf(qualifier(
""), named(
"Clangd1")),
3566 AllOf(qualifier(
"nx::"), named(
"Clangd2"))));
3569TEST(CompletionTest, NoCompletionsForNewNames) {
3570 clangd::CodeCompleteOptions Opts;
3571 Opts.AllScopes =
true;
3572 auto Results = completions(R
"cpp(
3575 {cls("naber"),
cls(
"nx::naber")}, Opts);
3576 EXPECT_THAT(Results.Completions, UnorderedElementsAre());
3579TEST(CompletionTest, Lambda) {
3580 clangd::CodeCompleteOptions Opts = {};
3582 auto Results = completions(R
"cpp(
3584 auto Lambda = [](int a, const double &b) {return 1.f;};
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");
3595 EXPECT_EQ(
A.ReturnType,
"float");
3596 EXPECT_EQ(
A.SnippetSuffix,
"(${1:int a}, ${2:const double &b})");
3599TEST(CompletionTest, StructuredBinding) {
3600 clangd::CodeCompleteOptions Opts = {};
3602 auto Results = completions(R
"cpp(
3604 using Float = float;
3609 const auto &[xxx, yyy] = S{};
3615 ASSERT_EQ(Results.Completions.size(), 1u);
3616 const auto &
A = Results.Completions.front();
3617 EXPECT_EQ(
A.Name,
"yyy");
3619 EXPECT_EQ(
A.ReturnType,
"const Float");
3622TEST(CompletionTest, ObjectiveCMethodNoArguments) {
3623 auto Results = completions(R
"objc(
3625 @property(nonatomic, setter=setXToIgnoreComplete:) int value;
3627 Foo *foo = [Foo new]; int y = [foo v^]
3632 auto C = Results.Completions;
3633 EXPECT_THAT(C, ElementsAre(named(
"value")));
3635 EXPECT_THAT(C, ElementsAre(returnType(
"int")));
3636 EXPECT_THAT(C, ElementsAre(signature(
"")));
3637 EXPECT_THAT(C, ElementsAre(snippetSuffix(
"")));
3640TEST(CompletionTest, ObjectiveCMethodOneArgument) {
3641 auto Results = completions(R
"objc(
3643 - (int)valueForCharacter:(char)c;
3645 Foo *foo = [Foo new]; int y = [foo v^]
3650 auto C = Results.Completions;
3651 EXPECT_THAT(C, ElementsAre(named(
"valueForCharacter:")));
3653 EXPECT_THAT(C, ElementsAre(returnType(
"int")));
3654 EXPECT_THAT(C, ElementsAre(signature(
"(char)")));
3655 EXPECT_THAT(C, ElementsAre(snippetSuffix(
"${1:(char)}")));
3658TEST(CompletionTest, ObjectiveCMethodTwoArgumentsFromBeginning) {
3659 auto Results = completions(R
"objc(
3661 + (id)fooWithValue:(int)value fooey:(unsigned int)fooey;
3668 auto C = Results.Completions;
3669 EXPECT_THAT(C, ElementsAre(named(
"fooWithValue:")));
3671 EXPECT_THAT(C, ElementsAre(returnType(
"id")));
3672 EXPECT_THAT(C, ElementsAre(signature(
"(int) fooey:(unsigned int)")));
3674 C, ElementsAre(snippetSuffix(
"${1:(int)} fooey:${2:(unsigned int)}")));
3677TEST(CompletionTest, ObjectiveCMethodTwoArgumentsFromMiddle) {
3678 auto Results = completions(R
"objc(
3680 + (id)fooWithValue:(int)value fooey:(unsigned int)fooey;
3682 id val = [Foo fooWithValue:10 f^]
3687 auto C = Results.Completions;
3688 EXPECT_THAT(C, ElementsAre(named(
"fooey:")));
3690 EXPECT_THAT(C, ElementsAre(returnType(
"id")));
3691 EXPECT_THAT(C, ElementsAre(signature(
"(unsigned int)")));
3692 EXPECT_THAT(C, ElementsAre(snippetSuffix(
"${1:(unsigned int)}")));
3695TEST(CompletionTest, ObjectiveCMethodFilterOnEntireSelector) {
3696 auto Results = completions(R
"objc(
3698 + (id)player:(id)player willRun:(id)run;
3705 auto C = Results.Completions;
3706 EXPECT_THAT(C, ElementsAre(named(
"player:")));
3707 EXPECT_THAT(C, ElementsAre(filterText(
"player:willRun:")));
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)}")));
3714TEST(CompletionTest, ObjectiveCSimpleMethodDeclaration) {
3715 auto Results = completions(R
"objc(
3726 auto C = Results.Completions;
3727 EXPECT_THAT(C, ElementsAre(named(
"foo")));
3729 EXPECT_THAT(C, ElementsAre(qualifier(
"- (void)")));
3732TEST(CompletionTest, ObjectiveCMethodDeclaration) {
3733 auto Results = completions(R
"objc(
3735 - (int)valueForCharacter:(char)c secondArgument:(id)object;
3744 auto C = Results.Completions;
3745 EXPECT_THAT(C, ElementsAre(named(
"valueForCharacter:")));
3747 EXPECT_THAT(C, ElementsAre(qualifier(
"- (int)")));
3748 EXPECT_THAT(C, ElementsAre(signature(
"(char)c secondArgument:(id)object")));
3751TEST(CompletionTest, ObjectiveCMethodDeclarationFilterOnEntireSelector) {
3752 auto Results = completions(R
"objc(
3754 - (int)valueForCharacter:(char)c secondArgument:(id)object;
3763 auto C = Results.Completions;
3764 EXPECT_THAT(C, ElementsAre(named(
"valueForCharacter:")));
3765 EXPECT_THAT(C, ElementsAre(filterText(
"valueForCharacter:secondArgument:")));
3767 EXPECT_THAT(C, ElementsAre(qualifier(
"- (int)")));
3768 EXPECT_THAT(C, ElementsAre(signature(
"(char)c secondArgument:(id)object")));
3771TEST(CompletionTest, ObjectiveCMethodDeclarationPrefixTyped) {
3772 auto Results = completions(R
"objc(
3774 - (int)valueForCharacter:(char)c;
3783 auto C = Results.Completions;
3784 EXPECT_THAT(C, ElementsAre(named(
"valueForCharacter:")));
3786 EXPECT_THAT(C, ElementsAre(signature(
"(char)c")));
3789TEST(CompletionTest, ObjectiveCMethodDeclarationFromMiddle) {
3790 auto Results = completions(R
"objc(
3792 - (int)valueForCharacter:(char)c secondArgument:(id)object;
3795 - (int)valueForCharacter:(char)c second^
3801 auto C = Results.Completions;
3802 EXPECT_THAT(C, ElementsAre(named(
"secondArgument:")));
3804 EXPECT_THAT(C, ElementsAre(signature(
"(id)object")));
3807TEST(CompletionTest, ObjectiveCProtocolFromIndex) {
3811 auto Results = completions(
"id<Foo^>", {SymFood, FoodClass, SymFooey},
3815 EXPECT_THAT(Results.Completions,
3816 UnorderedElementsAre(
3820 Results = completions(
"Fo^", {SymFood, FoodClass, SymFooey},
3824 Results.Completions,
3828TEST(CompletionTest, ObjectiveCProtocolFromIndexSpeculation) {
3841 clangd::CodeCompleteOptions Opts = {};
3844 IndexRequestCollector Requests({FoodClass});
3845 Opts.Index = &Requests;
3847 auto CompleteAtPoint = [&](StringRef
P) {
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"),
3858 C = CompleteAtPoint(
"2");
3859 auto Reqs2 = Requests.consumeRequests(1);
3862 ASSERT_EQ(Reqs2.size(), 1u);
3863 EXPECT_EQ(Reqs2[0], Reqs1[0]);
3864 EXPECT_THAT(C, ElementsAre(AllOf(named(
"FoodClass"),
3868TEST(CompletionTest, ObjectiveCCategoryFromIndexIgnored) {
3870 auto Results = completions(R
"objc(
3878 EXPECT_THAT(Results.Completions, IsEmpty());
3881TEST(CompletionTest, ObjectiveCForwardDeclFromIndex) {
3883 FoodClass.IncludeHeaders.emplace_back(
"\"Foo.h\"", 2,
Symbol::Import);
3885 auto Results = completions(
"@class Foo^", {SymFood, FoodClass},
3889 EXPECT_THAT(Results.Completions,
3890 UnorderedElementsAre(AllOf(named(
"FoodClass"),
3892 Not(insertInclude()))));
3895TEST(CompletionTest, CursorInSnippets) {
3896 clangd::CodeCompleteOptions Options;
3897 Options.EnableSnippets =
true;
3898 auto Results = completions(
3900 void while_foo(int a, int b);
3907 EXPECT_THAT(Results.Completions,
3908 Contains(AllOf(named(
"while"),
3909 snippetSuffix(
" (${1:condition}) {\n$0\n}"))));
3911 EXPECT_THAT(Results.Completions,
3912 Contains(AllOf(named(
"while_foo"),
3913 snippetSuffix(
"(${1:int a}, ${2:int b})"))));
3915 Results = completions(R
"cpp(
3917 Base(int a, int b) {}
3920 struct Derived : Base {
3927 EXPECT_THAT(Results.Completions,
3928 Contains(AllOf(named(
"Base"),
3929 snippetSuffix(
"(${1:int a}, ${2:int b})"))));
3932TEST(CompletionTest, WorksWithNullType) {
3933 auto R = completions(R
"cpp(
3935 for (auto [loopVar] : y ) { // y has to be unresolved.
3940 EXPECT_THAT(R.Completions, ElementsAre(named("loopVar")));
3943TEST(CompletionTest, UsingDecl) {
3944 const char *Header(R
"cpp(
3949 const char *Source(R
"cpp(
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"),
3963TEST(CompletionTest, Enums) {
3964 const char *Header(R
"cpp(
3966 enum Unscoped { Clangd1 };
3968 enum Unscoped { Clangd2 };
3970 enum class Scoped { Clangd3 };
3972 const char *Source(R
"cpp(
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"),
3990TEST(CompletionTest, ScopeIsUnresolved) {
3991 clangd::CodeCompleteOptions Opts = {};
3992 Opts.AllScopes =
true;
3994 auto Results = completions(R
"cpp(
3999 {cls("a::b::XYZ")}, Opts);
4000 EXPECT_THAT(Results.Completions,
4001 UnorderedElementsAre(AllOf(qualifier(
""), named(
"XYZ"))));
4004TEST(CompletionTest, NestedScopeIsUnresolved) {
4005 clangd::CodeCompleteOptions Opts = {};
4006 Opts.AllScopes =
true;
4008 auto Results = completions(R
"cpp(
4011 void f() { b::c::X^ }
4014 {cls("a::b::c::XYZ")}, Opts);
4015 EXPECT_THAT(Results.Completions,
4016 UnorderedElementsAre(AllOf(qualifier(
""), named(
"XYZ"))));
4021TEST(CompletionTest, NamespaceDoubleInsertion) {
4022 clangd::CodeCompleteOptions Opts = {};
4024 auto Results = completions(R
"cpp(
4031 {cls("foo::ns::ABCDE")}, Opts);
4032 EXPECT_THAT(Results.Completions,
4033 UnorderedElementsAre(AllOf(qualifier(
""), named(
"ABCDE"))));
4036TEST(CompletionTest, DerivedMethodsAreAlwaysVisible) {
4039 auto Completions = completions(R
"cpp(
4042 double size() const;
4044 struct deque : deque_base {
4051 EXPECT_THAT(Completions,
4052 ElementsAre(AllOf(returnType("int"), named(
"size"))));
4055TEST(CompletionTest, NoCrashWithIncompleteLambda) {
4056 auto Completions = completions(
"auto&& x = []{^").Completions;
4060 EXPECT_THAT(Completions, Contains(named(
"x")));
4062 auto Signatures = signatures(
"auto x() { x(^").signatures;
4063 EXPECT_THAT(Signatures, Contains(sig(
"x() -> auto")));
4066TEST(CompletionTest, DelayedTemplateParsing) {
4069 template <typename T> int foo() { return xx^; }
4074 TU.ExtraArgs.push_back(
"-fdelayed-template-parsing");
4076 EXPECT_THAT(completions(TU, Test.point()).Completions,
4077 Contains(named(
"xxx")));
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());
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());
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());
4102TEST(NoCompileCompletionTest, Basic) {
4103 auto Results = completionsNoCompile(R
"cpp(
4110 EXPECT_FALSE(Results.RanParser);
4111 EXPECT_THAT(Results.Completions,
4112 UnorderedElementsAre(named("void"), named(
"func"), named(
"int"),
4113 named(
"xyz"), named(
"abc")));
4116TEST(NoCompileCompletionTest, WithFilter) {
4117 auto Results = completionsNoCompile(R
"cpp(
4126 EXPECT_THAT(Results.Completions,
4127 UnorderedElementsAre(named("sym1"), named(
"sym2")));
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(
4135 // Current-scopes, unqualified completion.
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(
4153 // All-scopes unqualified completion.
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(
4171 // Qualified completion.
4181 EXPECT_THAT(Results.Completions,
4182 ElementsAre(AllOf(qualifier(""), scope(
"ns::b::"))));
4183 Results = completionsNoCompile(
4185 // Absolutely qualified completion.
4195 EXPECT_THAT(Results.Completions,
4196 ElementsAre(AllOf(qualifier(""), scope(
"a::"))));
4199TEST(AllowImplicitCompletion,
All) {
4200 const char *
Yes[] = {
4204 " # include <^foo.h>",
4205 "#import <foo/^bar.h>",
4206 "#include_next \"^",
4208 const char *
No[] = {
4212 "#include <foo.h> //^",
4213 "#include \"foo.h\"^",
4217 for (
const char *Test :
Yes) {
4218 llvm::Annotations
A(Test);
4221 for (
const char *Test :
No) {
4222 llvm::Annotations
A(Test);
4227TEST(CompletionTest, FunctionArgsExist) {
4228 clangd::CodeCompleteOptions Opts;
4229 Opts.EnableSnippets =
true;
4237 template <typename T>
4239 Container(int Size) {}
4242 EXPECT_THAT(completions(Context + "int y = fo^", {}, Opts).Completions,
4243 UnorderedElementsAre(
4244 AllOf(labeled(
"foo(int A)"), snippetSuffix(
"(${1:int A})"))));
4246 completions(
Context +
"int y = fo^(42)", {}, Opts).Completions,
4247 UnorderedElementsAre(AllOf(labeled(
"foo(int A)"), snippetSuffix(
""))));
4249 EXPECT_THAT(completions(
Context +
"int y = fo^o(42)", {}, Opts).Completions,
4250 UnorderedElementsAre(
4251 AllOf(labeled(
"foo(int A)"), snippetSuffix(
"(${1:int A})"))));
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(
""))));
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(
""),
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})"),
4270 completions(
Context +
"Container c = Cont^()", {}, Opts).Completions,
4271 Contains(AllOf(labeled(
"Container<typename T>(int Size)"),
4272 snippetSuffix(
"<${1:typename T}>"),
4275 completions(
Context +
"Container c = Cont^<int>()", {}, Opts).Completions,
4276 Contains(AllOf(labeled(
"Container<typename T>(int Size)"),
4279 EXPECT_THAT(completions(
Context +
"MAC^(2)", {}, Opts).Completions,
4280 Contains(AllOf(labeled(
"MACRO(x)"), snippetSuffix(
""),
4284TEST(CompletionTest, FunctionArgsExist_Issue1785) {
4288 clangd::CodeCompleteOptions Opts;
4289 Opts.EnableSnippets =
true;
4291 std::string Code = R
"cpp(
4303 completions(Code, {}, Opts).Completions,
4304 Contains(AllOf(labeled("waldo(int)"), snippetSuffix(
"(${1:int})"))));
4307TEST(CompletionTest, NoCrashDueToMacroOrdering) {
4308 EXPECT_THAT(completions(R
"cpp(
4310 #define ECHO2(X) ECHO(X)
4311 int finish_preamble = EC^HO(2);)cpp")
4313 UnorderedElementsAre(labeled("ECHO(X)"), labeled(
"ECHO2(X)")));
4316TEST(CompletionTest, ObjCCategoryDecls) {
4318 TU.
ExtraArgs.push_back(
"-xobjective-c");
4319 TU.HeaderCode = R
"objc(
4323 @interface Foo (FooExt1)
4326 @interface Foo (FooExt2)
4332 @interface Bar (BarExt)
4337 @implementation Foo (^)
4340 TU.Code = Test.code().str();
4341 auto Results = completions(TU, Test.point());
4342 EXPECT_THAT(Results.Completions,
4343 UnorderedElementsAre(labeled(
"FooExt1"), labeled(
"FooExt2")));
4350 TU.Code = Test.code().str();
4351 auto Results = completions(TU, Test.point());
4352 EXPECT_THAT(Results.Completions, UnorderedElementsAre(labeled(
"BarExt")));
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^";
4366 auto Inputs = ModifiedTU.inputs(FS);
4368 BaselineTU.preamble().get(), Inputs, {});
4369 EXPECT_THAT(Result.Completions, Not(testing::IsEmpty()));
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);
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());
4388 completions(Code +
"overloaded(/*^").Completions,
4389 UnorderedElementsAre(labeled(
"param_int=*/"), labeled(
"param_char=*/")));
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());
4400 std::string CompletionRangeTest(Code +
"fun(/*[[^]]");
4401 auto Results = completions(CompletionRangeTest);
4402 EXPECT_THAT(Results.CompletionRange,
4403 llvm::ValueIs(
Annotations(CompletionRangeTest).range()));
4405 Results.Completions,
4407 AllOf(replacesRange(
Annotations(CompletionRangeTest).range()),
4411 std::string CompletionRangeTest(Code +
"fun(/*[[fo^]]");
4412 auto Results = completions(CompletionRangeTest);
4413 EXPECT_THAT(Results.CompletionRange,
4414 llvm::ValueIs(
Annotations(CompletionRangeTest).range()));
4416 Results.Completions,
4418 AllOf(replacesRange(
Annotations(CompletionRangeTest).range()),
4423TEST(CompletionTest, Concepts) {
4426 concept A = sizeof(T) <= 8;
4428 template<$tparam^A U>
4431 template<typename T>
4432 int bar(T t) requires $expr^A<int>;
4435 concept b = $expr^A && $expr^sizeof(T) % 2 == 0 || $expr^A && sizeof(T) == 1;
4437 $toplevel^A auto i = 19;
4439 template<$toplevel^A auto i> void constrainedNTTP();
4441 // FIXME: The first parameter should be dropped in this case.
4442 void abbreviated($expr^A auto x) {}
4445 TU.Code = Code.code().str();
4446 TU.ExtraArgs = {"-std=c++20"};
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")) {
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;
4462 for (
auto P : Code.points(
"toplevel")) {
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;
4471 for (
auto P : Code.points(
"expr")) {
4473 completions(TU, P, Syms).Completions,
4474 AllOf(Contains(AllOf(named(
"A"), signature(
"<class T>"),
4475 snippetSuffix(
"<${1:class T}>"))),
4477 named(
"same_as"), signature(
"<typename Tp, typename Up>"),
4478 snippetSuffix(
"<${1:typename Tp}, ${2:typename Up}>")))))
4479 <<
"Completing 'requires' expression at position " <<
P;
4485 // Comment `with` markup.
4487 void bar() { foo(^); }
4489 for (
auto DocumentationFormat :
4491 auto Sigs = signatures(Code.code(), Code.point(), {},
4492 DocumentationFormat);
4493 ASSERT_EQ(Sigs.signatures.size(), 1U);
4494 EXPECT_EQ(Sigs.signatures[0].documentation.kind, DocumentationFormat);
4499 std::string Top = R
"cpp(
4500 template <typename T, int> bool foo(char);
4501 template <int I, int> bool foo(float);
4504 auto First = signatures(Top +
"bool x = foo<^");
4507 UnorderedElementsAre(sig(
"foo<[[typename T]], [[int]]>() -> bool"),
4508 sig(
"foo<[[int I]], [[int]]>() -> bool")));
4509 EXPECT_EQ(First.activeParameter, 0);
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);
4517TEST(CompletionTest, DoNotCrash) {
4518 llvm::StringLiteral Cases[] = {
4520 template <typename = int> struct Foo {};
4521 auto a = [x(3)](Foo<^>){};
4524 for (
auto Case : Cases) {
4526 auto Completions = completions(Case);
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^";
4536 TU.ExtraArgs.emplace_back(
"-target");
4537 TU.ExtraArgs.emplace_back(PreambleTarget);
4541 TU.ExtraArgs.pop_back();
4542 TU.ExtraArgs.emplace_back(
"wasm32");
4545 auto Inputs = TU.inputs(FS);
4552 EXPECT_THAT(Result.Completions, Not(testing::IsEmpty()));
4553 EXPECT_THAT(Signatures.signatures, Not(testing::IsEmpty()));
4556TEST(CompletionTest, SkipExplicitObjectParameter) {
4559 void foo(this auto&& self, int arg);
4560 void bar(this A self, int arg);
4579 TU.ExtraArgs = {
"-std=c++23"};
4587 auto Inputs = TU.inputs(FS);
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})"))));
4603 ElementsAre(AllOf(named(
"foo"), signature(
"<class self:auto>(int arg)"),
4604 snippetSuffix(
"<${1:class self:auto}>"))));
4609 EXPECT_THAT(Result.Completions,
4610 ElementsAre(AllOf(named(
"bar"), signature(
"(int arg)"),
4611 snippetSuffix(
""))));
4615TEST(CompletionTest, MemberAccessInExplicitObjMemfn) {
4619 int memberFnA(int a);
4620 int memberFnA(this A&, float a);
4622 void foo(this A& self) {
4623 // Should not offer any members here, since
4624 // it needs to be referenced through `self`.
4626 // should offer all results
4630 // should not offer any results
4638 TU.ExtraArgs = {
"-std=c++23"};
4646 auto Inputs = TU.inputs(FS);
4652 EXPECT_THAT(Result.Completions, ElementsAre());
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})"))));
4670 EXPECT_THAT(Result.Completions, ElementsAre());
4674TEST(CompletionTest, ListExplicitObjectOverloads) {
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);
4684 void S::foo1(int a) {
4688 void S::foo2(int a) const {
4692 void S::foo3(this const S& self, int a) {
4696 void S::foo4(this S& self, int a) {
4704 void test2(const S s) {
4710 TU.ExtraArgs = {
"-std=c++23"};
4718 auto Inputs = TU.inputs(FS);
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})"))));
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})"))));
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})"))));
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})"))));
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})"))));
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})"))));
4806TEST(CompletionTest, FuzzyMatchMacro) {
4809 #define _gl_foo() 42
4829 auto Results = completions(TU, Code.point(
"c1"), {}, Opts);
4831 Results.Completions,
4832 ElementsAre(named(
"gl_frob"), named(
"_gl_frob"), named(
"glfbar")));
4836 auto Results = completions(TU, Code.point(
"c2"), {}, Opts);
4837 EXPECT_THAT(Results.Completions,
4838 ElementsAre(named(
"_gl_frob"), named(
"_gl_foo")));
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")));
4857 auto Results = completions(TU, Code.point(
"c2"), {}, Opts);
4858 EXPECT_THAT(Results.Completions,
4859 ElementsAre(named(
"_gl_frob"), named(
"_gl_foo")));
#define EXPECT_IFF(condition, value, matcher)
Same as llvm::Annotations, but adjusts functions to LSP-specific types for positions and ranges.
clangd::Range range(llvm::StringRef Name="") const
Manages a collection of source files and derived data (ASTs, indexes), and provides language-aware fe...
static Options optsForTest()
A context is an immutable container for per-request data that must be propagated through layers that ...
static std::unique_ptr< SymbolIndex > build(SymbolSlab Symbols, RefSlab Refs, RelationSlab Relations)
Builds an index from slabs. The index takes ownership of the data.
llvm::StringMap< std::string > Files
An efficient structure of storing large set of symbol references in memory.
Interface for symbol indexes that can be used for searching or matching symbols among a set of symbol...
SymbolSlab::Builder is a mutable container that can 'freeze' to SymbolSlab.
void insert(const Symbol &S)
Adds a symbol, overwriting any existing one with the same ID.
static llvm::Expected< URI > create(llvm::StringRef AbsolutePath, llvm::StringRef Scheme)
Creates a URI for a file in the given scheme.
WithContextValue extends Context::current() with a single value.
FIXME: Skip testing on windows temporarily due to the different escaping code mode.
Symbol objcProtocol(llvm::StringRef Name)
Symbol objcClass(llvm::StringRef Name)
Symbol func(llvm::StringRef Name)
Symbol cls(llvm::StringRef Name)
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.
Symbol conceptSym(llvm::StringRef Name)
IndexContents
Describes what data is covered by an index.
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.
Symbol sym(llvm::StringRef QName, index::SymbolKind Kind, llvm::StringRef USRFormat, llvm::StringRef Signature)
CompletionItemKind
The kind of a completion entry.
Symbol ns(llvm::StringRef Name)
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>.
llvm::raw_ostream & operator<<(llvm::raw_ostream &OS, const CodeCompletion &C)
llvm::Expected< CodeCompleteResult > runCodeComplete(ClangdServer &Server, PathRef File, Position Pos, clangd::CodeCompleteOptions Opts)
llvm::Expected< SignatureHelp > runSignatureHelp(ClangdServer &Server, PathRef File, Position Pos, MarkupKind DocumentationFormat)
std::string testPath(PathRef File, llvm::sys::path::Style Style)
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.
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)
Symbol macro(llvm::StringRef Name, llvm::StringRef ArgList)
llvm::StringRef PathRef
A typedef to represent a ref to file path.
@ No
Diagnostics must be generated for this snapshot.
std::vector< std::string > lookup(const SymbolIndex &I, llvm::ArrayRef< SymbolID > IDs)
Symbol enmConstant(llvm::StringRef Name)
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.
@ Snippet
The primary text to be inserted is treated as a snippet.
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)
cppcoreguidelines::ProBoundsAvoidUncheckedContainerAccessCheck P
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Signals derived from a valid AST of a file.
llvm::DenseMap< SymbolID, unsigned > ReferencedSymbols
Number of occurrences of each symbol present in the file.
Symbol::IncludeDirective InsertionDirective
Preferred preprocessor directive to use for inclusions by the file.
Represents a collection of completion items to be presented in the editor.
Settings that express user/project preferences and control clangd behavior.
static clangd::Key< Config > Key
Context key which can be used to set the current Config.
@ None
nothing, no argument list and also NO Delimiters "()" or "<>".
@ Delimiters
empty pair of delimiters "()" or "<>".
@ OpenDelimiter
open, only opening delimiter "(" or "<".
Same semantics as CodeComplete::Score.
std::vector< std::string > Scopes
If this is non-empty, symbols must be in at least one of the scopes (e.g.
int line
Line position in a document (zero-based).
int character
Character offset on a line in a document (zero-based).
Position end
The range's end position.
Represents the signature of a callable.
Attributes of a symbol that affect how much we like it.
Attributes of a symbol-query pair that affect how much we like it.
The class presents a C++ symbol, e.g.
@ IndexedForCodeCompletion
Whether or not this symbol is meant to be used for the code completion.
@ Include
#include "header.h"
@ Import
#import "header.h"
SymbolID ID
The ID of the symbol.
std::vector< std::string > ExtraArgs
static TestTU withHeaderCode(llvm::StringRef HeaderCode)
static TestTU withCode(llvm::StringRef Code)
llvm::StringMap< std::string > AdditionalFiles
std::unique_ptr< SymbolIndex > index() const
Range range
The range of the text document to be manipulated.