Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 1 | //===-- CodeCompleteTests.cpp -----------------------------------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
Eric Liu | 6f648df | 2017-12-19 16:50:37 +0000 | [diff] [blame] | 9 | |
Sam McCall | 328cbdb | 2017-12-20 16:06:05 +0000 | [diff] [blame] | 10 | #include "Annotations.h" |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 11 | #include "ClangdServer.h" |
Sam McCall | 328cbdb | 2017-12-20 16:06:05 +0000 | [diff] [blame] | 12 | #include "CodeComplete.h" |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 13 | #include "Compiler.h" |
Ilya Biryukov | 5a85b8e | 2017-12-13 12:53:16 +0000 | [diff] [blame] | 14 | #include "Matchers.h" |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 15 | #include "Protocol.h" |
Sam McCall | b536a2a | 2017-12-19 12:23:48 +0000 | [diff] [blame] | 16 | #include "SourceCode.h" |
Ilya Biryukov | cd5eb00 | 2018-02-12 11:37:28 +0000 | [diff] [blame] | 17 | #include "SyncAPI.h" |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 18 | #include "TestFS.h" |
Eric Liu | 6f648df | 2017-12-19 16:50:37 +0000 | [diff] [blame] | 19 | #include "index/MemIndex.h" |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 20 | #include "gmock/gmock.h" |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 21 | #include "gtest/gtest.h" |
| 22 | |
| 23 | namespace clang { |
| 24 | namespace clangd { |
Sam McCall | 800d437 | 2017-12-19 10:29:27 +0000 | [diff] [blame] | 25 | // Let GMock print completion items and signature help. |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 26 | void PrintTo(const CompletionItem &I, std::ostream *O) { |
| 27 | llvm::raw_os_ostream OS(*O); |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 28 | OS << I.label << " - " << toJSON(I); |
| 29 | } |
| 30 | void PrintTo(const std::vector<CompletionItem> &V, std::ostream *O) { |
| 31 | *O << "{\n"; |
| 32 | for (const auto &I : V) { |
| 33 | *O << "\t"; |
| 34 | PrintTo(I, O); |
| 35 | *O << "\n"; |
| 36 | } |
| 37 | *O << "}"; |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 38 | } |
Sam McCall | 800d437 | 2017-12-19 10:29:27 +0000 | [diff] [blame] | 39 | void PrintTo(const SignatureInformation &I, std::ostream *O) { |
| 40 | llvm::raw_os_ostream OS(*O); |
| 41 | OS << I.label << " - " << toJSON(I); |
| 42 | } |
| 43 | void PrintTo(const std::vector<SignatureInformation> &V, std::ostream *O) { |
| 44 | *O << "{\n"; |
| 45 | for (const auto &I : V) { |
| 46 | *O << "\t"; |
| 47 | PrintTo(I, O); |
| 48 | *O << "\n"; |
| 49 | } |
| 50 | *O << "}"; |
| 51 | } |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 52 | |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 53 | namespace { |
| 54 | using namespace llvm; |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 55 | using ::testing::AllOf; |
| 56 | using ::testing::Contains; |
Ilya Biryukov | 5a5e1ca | 2017-12-29 14:59:22 +0000 | [diff] [blame] | 57 | using ::testing::Each; |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 58 | using ::testing::ElementsAre; |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 59 | using ::testing::Field; |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 60 | using ::testing::Not; |
Sam McCall | 3d139c5 | 2018-01-12 18:30:08 +0000 | [diff] [blame] | 61 | using ::testing::UnorderedElementsAre; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 62 | |
| 63 | class IgnoreDiagnostics : public DiagnosticsConsumer { |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 64 | void onDiagnosticsReady(PathRef File, |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 65 | std::vector<Diag> Diagnostics) override {} |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 66 | }; |
| 67 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 68 | // GMock helpers for matching completion items. |
| 69 | MATCHER_P(Named, Name, "") { return arg.insertText == Name; } |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 70 | MATCHER_P(Labeled, Label, "") { return arg.label == Label; } |
| 71 | MATCHER_P(Kind, K, "") { return arg.kind == K; } |
Eric Liu | 6f648df | 2017-12-19 16:50:37 +0000 | [diff] [blame] | 72 | MATCHER_P(Filter, F, "") { return arg.filterText == F; } |
Eric Liu | 76f6b44 | 2018-01-09 17:32:00 +0000 | [diff] [blame] | 73 | MATCHER_P(Doc, D, "") { return arg.documentation == D; } |
| 74 | MATCHER_P(Detail, D, "") { return arg.detail == D; } |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 75 | MATCHER_P(PlainText, Text, "") { |
| 76 | return arg.insertTextFormat == clangd::InsertTextFormat::PlainText && |
| 77 | arg.insertText == Text; |
| 78 | } |
| 79 | MATCHER_P(Snippet, Text, "") { |
| 80 | return arg.insertTextFormat == clangd::InsertTextFormat::Snippet && |
| 81 | arg.insertText == Text; |
| 82 | } |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 83 | MATCHER(NameContainsFilter, "") { |
Ilya Biryukov | 5a5e1ca | 2017-12-29 14:59:22 +0000 | [diff] [blame] | 84 | if (arg.filterText.empty()) |
| 85 | return true; |
| 86 | return llvm::StringRef(arg.insertText).contains(arg.filterText); |
| 87 | } |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 88 | // Shorthand for Contains(Named(Name)). |
| 89 | Matcher<const std::vector<CompletionItem> &> Has(std::string Name) { |
| 90 | return Contains(Named(std::move(Name))); |
| 91 | } |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 92 | Matcher<const std::vector<CompletionItem> &> Has(std::string Name, |
| 93 | CompletionItemKind K) { |
| 94 | return Contains(AllOf(Named(std::move(Name)), Kind(K))); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 95 | } |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 96 | MATCHER(IsDocumented, "") { return !arg.documentation.empty(); } |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 97 | |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 98 | std::unique_ptr<SymbolIndex> memIndex(std::vector<Symbol> Symbols) { |
| 99 | SymbolSlab::Builder Slab; |
| 100 | for (const auto &Sym : Symbols) |
| 101 | Slab.insert(Sym); |
| 102 | return MemIndex::build(std::move(Slab).build()); |
| 103 | } |
| 104 | |
| 105 | // Builds a server and runs code completion. |
| 106 | // If IndexSymbols is non-empty, an index will be built and passed to opts. |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 107 | CompletionList completions(StringRef Text, |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 108 | std::vector<Symbol> IndexSymbols = {}, |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 109 | clangd::CodeCompleteOptions Opts = {}) { |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 110 | std::unique_ptr<SymbolIndex> OverrideIndex; |
| 111 | if (!IndexSymbols.empty()) { |
| 112 | assert(!Opts.Index && "both Index and IndexSymbols given!"); |
| 113 | OverrideIndex = memIndex(std::move(IndexSymbols)); |
| 114 | Opts.Index = OverrideIndex.get(); |
| 115 | } |
| 116 | |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 117 | MockFSProvider FS; |
Sam McCall | 93cd991 | 2017-12-05 07:34:35 +0000 | [diff] [blame] | 118 | MockCompilationDatabase CDB; |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 119 | IgnoreDiagnostics DiagConsumer; |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 120 | ClangdServer Server(CDB, FS, DiagConsumer, ClangdServer::optsForTest()); |
Sam McCall | c156806 | 2018-02-16 09:41:43 +0000 | [diff] [blame] | 121 | auto File = testPath("foo.cpp"); |
Sam McCall | 328cbdb | 2017-12-20 16:06:05 +0000 | [diff] [blame] | 122 | Annotations Test(Text); |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 123 | runAddDocument(Server, File, Test.code()); |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 124 | auto CompletionList = |
| 125 | cantFail(runCodeComplete(Server, File, Test.point(), Opts)); |
Ilya Biryukov | 5a5e1ca | 2017-12-29 14:59:22 +0000 | [diff] [blame] | 126 | // Sanity-check that filterText is valid. |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 127 | EXPECT_THAT(CompletionList.items, Each(NameContainsFilter())); |
Ilya Biryukov | 5a5e1ca | 2017-12-29 14:59:22 +0000 | [diff] [blame] | 128 | return CompletionList; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 129 | } |
| 130 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 131 | std::string replace(StringRef Haystack, StringRef Needle, StringRef Repl) { |
| 132 | std::string Result; |
| 133 | raw_string_ostream OS(Result); |
| 134 | std::pair<StringRef, StringRef> Split; |
| 135 | for (Split = Haystack.split(Needle); !Split.second.empty(); |
| 136 | Split = Split.first.split(Needle)) |
| 137 | OS << Split.first << Repl; |
| 138 | Result += Split.first; |
| 139 | OS.flush(); |
| 140 | return Result; |
| 141 | } |
| 142 | |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 143 | // Helpers to produce fake index symbols for memIndex() or completions(). |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 144 | // USRFormat is a regex replacement string for the unqualified part of the USR. |
| 145 | Symbol sym(StringRef QName, index::SymbolKind Kind, StringRef USRFormat) { |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 146 | Symbol Sym; |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 147 | std::string USR = "c:"; // We synthesize a few simple cases of USRs by hand! |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 148 | size_t Pos = QName.rfind("::"); |
| 149 | if (Pos == llvm::StringRef::npos) { |
| 150 | Sym.Name = QName; |
| 151 | Sym.Scope = ""; |
| 152 | } else { |
| 153 | Sym.Name = QName.substr(Pos + 2); |
Sam McCall | 8b2faee | 2018-01-19 22:18:21 +0000 | [diff] [blame] | 154 | Sym.Scope = QName.substr(0, Pos + 2); |
| 155 | USR += "@N@" + replace(QName.substr(0, Pos), "::", "@N@"); // ns:: -> @N@ns |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 156 | } |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 157 | USR += Regex("^.*$").sub(USRFormat, Sym.Name); // e.g. func -> @F@func# |
| 158 | Sym.ID = SymbolID(USR); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 159 | Sym.CompletionPlainInsertText = Sym.Name; |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 160 | Sym.CompletionSnippetInsertText = Sym.Name; |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 161 | Sym.CompletionLabel = Sym.Name; |
| 162 | Sym.SymInfo.Kind = Kind; |
| 163 | return Sym; |
| 164 | } |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 165 | Symbol func(StringRef Name) { // Assumes the function has no args. |
| 166 | return sym(Name, index::SymbolKind::Function, "@F@\\0#"); // no args |
| 167 | } |
| 168 | Symbol cls(StringRef Name) { |
| 169 | return sym(Name, index::SymbolKind::Class, "@S@\\0@S@\\0"); |
| 170 | } |
| 171 | Symbol var(StringRef Name) { |
| 172 | return sym(Name, index::SymbolKind::Variable, "@\\0"); |
| 173 | } |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 174 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 175 | TEST(CompletionTest, Limit) { |
| 176 | clangd::CodeCompleteOptions Opts; |
| 177 | Opts.Limit = 2; |
| 178 | auto Results = completions(R"cpp( |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 179 | struct ClassWithMembers { |
| 180 | int AAA(); |
| 181 | int BBB(); |
| 182 | int CCC(); |
| 183 | } |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 184 | int main() { ClassWithMembers().^ } |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 185 | )cpp", |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 186 | /*IndexSymbols=*/{}, Opts); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 187 | |
| 188 | EXPECT_TRUE(Results.isIncomplete); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 189 | EXPECT_THAT(Results.items, ElementsAre(Named("AAA"), Named("BBB"))); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 190 | } |
| 191 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 192 | TEST(CompletionTest, Filter) { |
| 193 | std::string Body = R"cpp( |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 194 | int Abracadabra; |
| 195 | int Alakazam; |
| 196 | struct S { |
| 197 | int FooBar; |
| 198 | int FooBaz; |
| 199 | int Qux; |
| 200 | }; |
| 201 | )cpp"; |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 202 | EXPECT_THAT(completions(Body + "int main() { S().Foba^ }").items, |
| 203 | AllOf(Has("FooBar"), Has("FooBaz"), Not(Has("Qux")))); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 204 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 205 | EXPECT_THAT(completions(Body + "int main() { S().FR^ }").items, |
| 206 | AllOf(Has("FooBar"), Not(Has("FooBaz")), Not(Has("Qux")))); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 207 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 208 | EXPECT_THAT(completions(Body + "int main() { S().opr^ }").items, |
| 209 | Has("operator=")); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 210 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 211 | EXPECT_THAT(completions(Body + "int main() { aaa^ }").items, |
| 212 | AllOf(Has("Abracadabra"), Has("Alakazam"))); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 213 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 214 | EXPECT_THAT(completions(Body + "int main() { _a^ }").items, |
| 215 | AllOf(Has("static_cast"), Not(Has("Abracadabra")))); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 216 | } |
| 217 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 218 | void TestAfterDotCompletion(clangd::CodeCompleteOptions Opts) { |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 219 | auto Results = completions( |
| 220 | R"cpp( |
| 221 | #define MACRO X |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 222 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 223 | int global_var; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 224 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 225 | int global_func(); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 226 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 227 | struct GlobalClass {}; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 228 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 229 | struct ClassWithMembers { |
| 230 | /// Doc for method. |
| 231 | int method(); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 232 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 233 | int field; |
| 234 | private: |
| 235 | int private_field; |
| 236 | }; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 237 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 238 | int test() { |
| 239 | struct LocalClass {}; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 240 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 241 | /// Doc for local_var. |
| 242 | int local_var; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 243 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 244 | ClassWithMembers().^ |
| 245 | } |
| 246 | )cpp", |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 247 | {cls("IndexClass"), var("index_var"), func("index_func")}, Opts); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 248 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 249 | // Class members. The only items that must be present in after-dot |
| 250 | // completion. |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 251 | EXPECT_THAT( |
| 252 | Results.items, |
| 253 | AllOf(Has(Opts.EnableSnippets ? "method()" : "method"), Has("field"))); |
| 254 | EXPECT_IFF(Opts.IncludeIneligibleResults, Results.items, |
| 255 | Has("private_field")); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 256 | // Global items. |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 257 | EXPECT_THAT( |
| 258 | Results.items, |
| 259 | Not(AnyOf(Has("global_var"), Has("index_var"), Has("global_func"), |
| 260 | Has("global_func()"), Has("index_func"), Has("GlobalClass"), |
| 261 | Has("IndexClass"), Has("MACRO"), Has("LocalClass")))); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 262 | // There should be no code patterns (aka snippets) in after-dot |
| 263 | // completion. At least there aren't any we're aware of. |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 264 | EXPECT_THAT(Results.items, Not(Contains(Kind(CompletionItemKind::Snippet)))); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 265 | // Check documentation. |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 266 | EXPECT_IFF(Opts.IncludeBriefComments, Results.items, |
| 267 | Contains(IsDocumented())); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 268 | } |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 269 | |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 270 | void TestGlobalScopeCompletion(clangd::CodeCompleteOptions Opts) { |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 271 | auto Results = completions( |
| 272 | R"cpp( |
| 273 | #define MACRO X |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 274 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 275 | int global_var; |
| 276 | int global_func(); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 277 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 278 | struct GlobalClass {}; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 279 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 280 | struct ClassWithMembers { |
| 281 | /// Doc for method. |
| 282 | int method(); |
| 283 | }; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 284 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 285 | int test() { |
| 286 | struct LocalClass {}; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 287 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 288 | /// Doc for local_var. |
| 289 | int local_var; |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 290 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 291 | ^ |
| 292 | } |
| 293 | )cpp", |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 294 | {cls("IndexClass"), var("index_var"), func("index_func")}, Opts); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 295 | |
| 296 | // Class members. Should never be present in global completions. |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 297 | EXPECT_THAT(Results.items, |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 298 | Not(AnyOf(Has("method"), Has("method()"), Has("field")))); |
| 299 | // Global items. |
Sam McCall | d8169a8 | 2018-01-18 15:31:30 +0000 | [diff] [blame] | 300 | EXPECT_THAT(Results.items, |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 301 | AllOf(Has("global_var"), Has("index_var"), |
Sam McCall | d8169a8 | 2018-01-18 15:31:30 +0000 | [diff] [blame] | 302 | Has(Opts.EnableSnippets ? "global_func()" : "global_func"), |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 303 | Has("index_func" /* our fake symbol doesn't include () */), |
| 304 | Has("GlobalClass"), Has("IndexClass"))); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 305 | // A macro. |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 306 | EXPECT_IFF(Opts.IncludeMacros, Results.items, Has("MACRO")); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 307 | // Local items. Must be present always. |
Ilya Biryukov | 9b5ffc2 | 2017-12-12 12:56:46 +0000 | [diff] [blame] | 308 | EXPECT_THAT(Results.items, |
| 309 | AllOf(Has("local_var"), Has("LocalClass"), |
| 310 | Contains(Kind(CompletionItemKind::Snippet)))); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 311 | // Check documentation. |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 312 | EXPECT_IFF(Opts.IncludeBriefComments, Results.items, |
| 313 | Contains(IsDocumented())); |
Sam McCall | f6ae323 | 2017-12-05 20:11:29 +0000 | [diff] [blame] | 314 | } |
| 315 | |
| 316 | TEST(CompletionTest, CompletionOptions) { |
Sam McCall | 2c3849a | 2018-01-16 12:21:24 +0000 | [diff] [blame] | 317 | auto Test = [&](const clangd::CodeCompleteOptions &Opts) { |
| 318 | TestAfterDotCompletion(Opts); |
| 319 | TestGlobalScopeCompletion(Opts); |
| 320 | }; |
| 321 | // We used to test every combination of options, but that got too slow (2^N). |
| 322 | auto Flags = { |
Ilya Biryukov | 71028b8 | 2018-03-12 15:28:22 +0000 | [diff] [blame] | 323 | &clangd::CodeCompleteOptions::IncludeMacros, |
| 324 | &clangd::CodeCompleteOptions::IncludeBriefComments, |
| 325 | &clangd::CodeCompleteOptions::EnableSnippets, |
| 326 | &clangd::CodeCompleteOptions::IncludeCodePatterns, |
| 327 | &clangd::CodeCompleteOptions::IncludeIneligibleResults, |
Sam McCall | 2c3849a | 2018-01-16 12:21:24 +0000 | [diff] [blame] | 328 | }; |
| 329 | // Test default options. |
| 330 | Test({}); |
| 331 | // Test with one flag flipped. |
| 332 | for (auto &F : Flags) { |
| 333 | clangd::CodeCompleteOptions O; |
| 334 | O.*F ^= true; |
| 335 | Test(O); |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 336 | } |
| 337 | } |
| 338 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 339 | TEST(CompletionTest, Priorities) { |
| 340 | auto Internal = completions(R"cpp( |
| 341 | class Foo { |
| 342 | public: void pub(); |
| 343 | protected: void prot(); |
| 344 | private: void priv(); |
| 345 | }; |
| 346 | void Foo::pub() { this->^ } |
| 347 | )cpp"); |
| 348 | EXPECT_THAT(Internal.items, |
| 349 | HasSubsequence(Named("priv"), Named("prot"), Named("pub"))); |
| 350 | |
| 351 | auto External = completions(R"cpp( |
| 352 | class Foo { |
| 353 | public: void pub(); |
| 354 | protected: void prot(); |
| 355 | private: void priv(); |
| 356 | }; |
| 357 | void test() { |
| 358 | Foo F; |
| 359 | F.^ |
| 360 | } |
| 361 | )cpp"); |
| 362 | EXPECT_THAT(External.items, |
| 363 | AllOf(Has("pub"), Not(Has("prot")), Not(Has("priv")))); |
| 364 | } |
| 365 | |
| 366 | TEST(CompletionTest, Qualifiers) { |
| 367 | auto Results = completions(R"cpp( |
| 368 | class Foo { |
| 369 | public: int foo() const; |
| 370 | int bar() const; |
| 371 | }; |
| 372 | class Bar : public Foo { |
| 373 | int foo() const; |
| 374 | }; |
| 375 | void test() { Bar().^ } |
| 376 | )cpp"); |
| 377 | EXPECT_THAT(Results.items, HasSubsequence(Labeled("bar() const"), |
| 378 | Labeled("Foo::foo() const"))); |
| 379 | EXPECT_THAT(Results.items, Not(Contains(Labeled("foo() const")))); // private |
| 380 | } |
| 381 | |
| 382 | TEST(CompletionTest, Snippets) { |
| 383 | clangd::CodeCompleteOptions Opts; |
| 384 | Opts.EnableSnippets = true; |
| 385 | auto Results = completions( |
| 386 | R"cpp( |
| 387 | struct fake { |
| 388 | int a; |
| 389 | int f(int i, const float f) const; |
| 390 | }; |
| 391 | int main() { |
| 392 | fake f; |
| 393 | f.^ |
| 394 | } |
| 395 | )cpp", |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 396 | /*IndexSymbols=*/{}, Opts); |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 397 | EXPECT_THAT(Results.items, |
Eric Liu | 63696e1 | 2017-12-20 17:24:31 +0000 | [diff] [blame] | 398 | HasSubsequence(Snippet("a"), |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 399 | Snippet("f(${1:int i}, ${2:const float f})"))); |
| 400 | } |
| 401 | |
| 402 | TEST(CompletionTest, Kinds) { |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 403 | auto Results = completions( |
| 404 | R"cpp( |
| 405 | #define MACRO X |
| 406 | int variable; |
| 407 | struct Struct {}; |
| 408 | int function(); |
| 409 | int X = ^ |
| 410 | )cpp", |
| 411 | {func("indexFunction"), var("indexVariable"), cls("indexClass")}); |
| 412 | EXPECT_THAT(Results.items, |
| 413 | AllOf(Has("function", CompletionItemKind::Function), |
| 414 | Has("variable", CompletionItemKind::Variable), |
| 415 | Has("int", CompletionItemKind::Keyword), |
| 416 | Has("Struct", CompletionItemKind::Class), |
| 417 | Has("MACRO", CompletionItemKind::Text), |
| 418 | Has("indexFunction", CompletionItemKind::Function), |
| 419 | Has("indexVariable", CompletionItemKind::Variable), |
| 420 | Has("indexClass", CompletionItemKind::Class))); |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 421 | |
Sam McCall | 44fdcec2 | 2017-12-08 15:00:59 +0000 | [diff] [blame] | 422 | Results = completions("nam^"); |
| 423 | EXPECT_THAT(Results.items, Has("namespace", CompletionItemKind::Snippet)); |
| 424 | } |
| 425 | |
Sam McCall | 84652cc | 2018-01-12 16:16:09 +0000 | [diff] [blame] | 426 | TEST(CompletionTest, NoDuplicates) { |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 427 | auto Results = completions( |
| 428 | R"cpp( |
| 429 | class Adapter { |
| 430 | void method(); |
| 431 | }; |
Sam McCall | 84652cc | 2018-01-12 16:16:09 +0000 | [diff] [blame] | 432 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 433 | void Adapter::method() { |
| 434 | Adapter^ |
| 435 | } |
| 436 | )cpp", |
| 437 | {cls("Adapter")}); |
Sam McCall | 84652cc | 2018-01-12 16:16:09 +0000 | [diff] [blame] | 438 | |
| 439 | // Make sure there are no duplicate entries of 'Adapter'. |
Sam McCall | d2a9592 | 2018-01-22 21:05:00 +0000 | [diff] [blame] | 440 | EXPECT_THAT(Results.items, ElementsAre(Named("Adapter"))); |
Sam McCall | 84652cc | 2018-01-12 16:16:09 +0000 | [diff] [blame] | 441 | } |
| 442 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 443 | TEST(CompletionTest, ScopedNoIndex) { |
| 444 | auto Results = completions( |
| 445 | R"cpp( |
| 446 | namespace fake { int BigBang, Babble, Ball; }; |
| 447 | int main() { fake::bb^ } |
| 448 | ")cpp"); |
Sam McCall | 84652cc | 2018-01-12 16:16:09 +0000 | [diff] [blame] | 449 | // BigBang is a better match than Babble. Ball doesn't match at all. |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 450 | EXPECT_THAT(Results.items, ElementsAre(Named("BigBang"), Named("Babble"))); |
Sam McCall | 84652cc | 2018-01-12 16:16:09 +0000 | [diff] [blame] | 451 | } |
| 452 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 453 | TEST(CompletionTest, Scoped) { |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 454 | auto Results = completions( |
| 455 | R"cpp( |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 456 | namespace fake { int Babble, Ball; }; |
| 457 | int main() { fake::bb^ } |
| 458 | ")cpp", |
| 459 | {var("fake::BigBang")}); |
| 460 | EXPECT_THAT(Results.items, ElementsAre(Named("BigBang"), Named("Babble"))); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 461 | } |
| 462 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 463 | TEST(CompletionTest, ScopedWithFilter) { |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 464 | auto Results = completions( |
| 465 | R"cpp( |
| 466 | void f() { ns::x^ } |
| 467 | )cpp", |
| 468 | {cls("ns::XYZ"), func("ns::foo")}); |
| 469 | EXPECT_THAT(Results.items, |
| 470 | UnorderedElementsAre(AllOf(Named("XYZ"), Filter("XYZ")))); |
| 471 | } |
| 472 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 473 | TEST(CompletionTest, GlobalQualified) { |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 474 | auto Results = completions( |
| 475 | R"cpp( |
| 476 | void f() { ::^ } |
| 477 | )cpp", |
| 478 | {cls("XYZ")}); |
| 479 | EXPECT_THAT(Results.items, AllOf(Has("XYZ", CompletionItemKind::Class), |
| 480 | Has("f", CompletionItemKind::Function))); |
| 481 | } |
| 482 | |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 483 | TEST(CompletionTest, FullyQualified) { |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 484 | auto Results = completions( |
| 485 | R"cpp( |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 486 | namespace ns { void bar(); } |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 487 | void f() { ::ns::^ } |
| 488 | )cpp", |
| 489 | {cls("ns::XYZ")}); |
Sam McCall | 545a20d | 2018-01-19 14:34:02 +0000 | [diff] [blame] | 490 | EXPECT_THAT(Results.items, AllOf(Has("XYZ", CompletionItemKind::Class), |
| 491 | Has("bar", CompletionItemKind::Function))); |
| 492 | } |
| 493 | |
| 494 | TEST(CompletionTest, SemaIndexMerge) { |
| 495 | auto Results = completions( |
| 496 | R"cpp( |
| 497 | namespace ns { int local; void both(); } |
| 498 | void f() { ::ns::^ } |
| 499 | )cpp", |
| 500 | {func("ns::both"), cls("ns::Index")}); |
| 501 | // We get results from both index and sema, with no duplicates. |
| 502 | EXPECT_THAT( |
| 503 | Results.items, |
| 504 | UnorderedElementsAre(Named("local"), Named("Index"), Named("both"))); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 505 | } |
| 506 | |
Haojian Wu | 48b4865 | 2018-01-25 09:20:09 +0000 | [diff] [blame] | 507 | TEST(CompletionTest, SemaIndexMergeWithLimit) { |
| 508 | clangd::CodeCompleteOptions Opts; |
| 509 | Opts.Limit = 1; |
| 510 | auto Results = completions( |
| 511 | R"cpp( |
| 512 | namespace ns { int local; void both(); } |
| 513 | void f() { ::ns::^ } |
| 514 | )cpp", |
| 515 | {func("ns::both"), cls("ns::Index")}, Opts); |
| 516 | EXPECT_EQ(Results.items.size(), Opts.Limit); |
| 517 | EXPECT_TRUE(Results.isIncomplete); |
| 518 | } |
| 519 | |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 520 | TEST(CompletionTest, IndexSuppressesPreambleCompletions) { |
| 521 | MockFSProvider FS; |
| 522 | MockCompilationDatabase CDB; |
| 523 | IgnoreDiagnostics DiagConsumer; |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 524 | ClangdServer Server(CDB, FS, DiagConsumer, ClangdServer::optsForTest()); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 525 | |
Sam McCall | c156806 | 2018-02-16 09:41:43 +0000 | [diff] [blame] | 526 | FS.Files[testPath("bar.h")] = |
Sam McCall | d5ea3e3 | 2018-01-24 17:53:32 +0000 | [diff] [blame] | 527 | R"cpp(namespace ns { struct preamble { int member; }; })cpp"; |
Sam McCall | c156806 | 2018-02-16 09:41:43 +0000 | [diff] [blame] | 528 | auto File = testPath("foo.cpp"); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 529 | Annotations Test(R"cpp( |
| 530 | #include "bar.h" |
| 531 | namespace ns { int local; } |
Sam McCall | d5ea3e3 | 2018-01-24 17:53:32 +0000 | [diff] [blame] | 532 | void f() { ns::^; } |
| 533 | void f() { ns::preamble().$2^; } |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 534 | )cpp"); |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 535 | runAddDocument(Server, File, Test.code()); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 536 | clangd::CodeCompleteOptions Opts = {}; |
| 537 | |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 538 | auto I = memIndex({var("ns::index")}); |
| 539 | Opts.Index = I.get(); |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 540 | auto WithIndex = cantFail(runCodeComplete(Server, File, Test.point(), Opts)); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 541 | EXPECT_THAT(WithIndex.items, |
| 542 | UnorderedElementsAre(Named("local"), Named("index"))); |
Sam McCall | d5ea3e3 | 2018-01-24 17:53:32 +0000 | [diff] [blame] | 543 | auto ClassFromPreamble = |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 544 | cantFail(runCodeComplete(Server, File, Test.point("2"), Opts)); |
Sam McCall | d5ea3e3 | 2018-01-24 17:53:32 +0000 | [diff] [blame] | 545 | EXPECT_THAT(ClassFromPreamble.items, Contains(Named("member"))); |
Sam McCall | 0bb24cd | 2018-02-13 08:59:23 +0000 | [diff] [blame] | 546 | |
| 547 | Opts.Index = nullptr; |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 548 | auto WithoutIndex = |
| 549 | cantFail(runCodeComplete(Server, File, Test.point(), Opts)); |
Sam McCall | 0bb24cd | 2018-02-13 08:59:23 +0000 | [diff] [blame] | 550 | EXPECT_THAT(WithoutIndex.items, |
| 551 | UnorderedElementsAre(Named("local"), Named("preamble"))); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 552 | } |
| 553 | |
| 554 | TEST(CompletionTest, DynamicIndexMultiFile) { |
| 555 | MockFSProvider FS; |
| 556 | MockCompilationDatabase CDB; |
| 557 | IgnoreDiagnostics DiagConsumer; |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 558 | auto Opts = ClangdServer::optsForTest(); |
| 559 | Opts.BuildDynamicSymbolIndex = true; |
| 560 | ClangdServer Server(CDB, FS, DiagConsumer, Opts); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 561 | |
Eric Liu | 709bde8 | 2018-02-19 18:48:44 +0000 | [diff] [blame] | 562 | FS.Files[testPath("foo.h")] = R"cpp( |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 563 | namespace ns { class XYZ {}; void foo(int x) {} } |
Eric Liu | 709bde8 | 2018-02-19 18:48:44 +0000 | [diff] [blame] | 564 | )cpp"; |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 565 | runAddDocument(Server, testPath("foo.cpp"), R"cpp( |
Eric Liu | 709bde8 | 2018-02-19 18:48:44 +0000 | [diff] [blame] | 566 | #include "foo.h" |
Sam McCall | 0bb24cd | 2018-02-13 08:59:23 +0000 | [diff] [blame] | 567 | )cpp"); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 568 | |
Sam McCall | c156806 | 2018-02-16 09:41:43 +0000 | [diff] [blame] | 569 | auto File = testPath("bar.cpp"); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 570 | Annotations Test(R"cpp( |
| 571 | namespace ns { |
| 572 | class XXX {}; |
| 573 | /// Doooc |
| 574 | void fooooo() {} |
| 575 | } |
| 576 | void f() { ns::^ } |
| 577 | )cpp"); |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 578 | runAddDocument(Server, File, Test.code()); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 579 | |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 580 | auto Results = cantFail(runCodeComplete(Server, File, Test.point(), {})); |
Sam McCall | a15c2d6 | 2018-01-18 09:27:56 +0000 | [diff] [blame] | 581 | // "XYZ" and "foo" are not included in the file being completed but are still |
| 582 | // visible through the index. |
| 583 | EXPECT_THAT(Results.items, Has("XYZ", CompletionItemKind::Class)); |
| 584 | EXPECT_THAT(Results.items, Has("foo", CompletionItemKind::Function)); |
| 585 | EXPECT_THAT(Results.items, Has("XXX", CompletionItemKind::Class)); |
| 586 | EXPECT_THAT(Results.items, Contains(AllOf(Named("fooooo"), Filter("fooooo"), |
| 587 | Kind(CompletionItemKind::Function), |
| 588 | Doc("Doooc"), Detail("void")))); |
| 589 | } |
| 590 | |
Haojian Wu | 58d208d | 2018-01-25 09:44:06 +0000 | [diff] [blame] | 591 | TEST(CodeCompleteTest, DisableTypoCorrection) { |
| 592 | auto Results = completions(R"cpp( |
| 593 | namespace clang { int v; } |
| 594 | void f() { clangd::^ |
| 595 | )cpp"); |
| 596 | EXPECT_TRUE(Results.items.empty()); |
| 597 | } |
| 598 | |
Ilya Biryukov | 53d6d93 | 2018-03-06 16:45:21 +0000 | [diff] [blame] | 599 | TEST(CodeCompleteTest, NoColonColonAtTheEnd) { |
| 600 | auto Results = completions(R"cpp( |
| 601 | namespace clang { } |
| 602 | void f() { |
| 603 | clan^ |
| 604 | } |
| 605 | )cpp"); |
| 606 | |
| 607 | EXPECT_THAT(Results.items, Contains(Labeled("clang"))); |
| 608 | EXPECT_THAT(Results.items, Not(Contains(Labeled("clang::")))); |
| 609 | } |
| 610 | |
Sam McCall | 800d437 | 2017-12-19 10:29:27 +0000 | [diff] [blame] | 611 | SignatureHelp signatures(StringRef Text) { |
| 612 | MockFSProvider FS; |
| 613 | MockCompilationDatabase CDB; |
| 614 | IgnoreDiagnostics DiagConsumer; |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 615 | ClangdServer Server(CDB, FS, DiagConsumer, ClangdServer::optsForTest()); |
Sam McCall | c156806 | 2018-02-16 09:41:43 +0000 | [diff] [blame] | 616 | auto File = testPath("foo.cpp"); |
Sam McCall | 328cbdb | 2017-12-20 16:06:05 +0000 | [diff] [blame] | 617 | Annotations Test(Text); |
Sam McCall | 7363a2f | 2018-03-05 17:28:54 +0000 | [diff] [blame] | 618 | runAddDocument(Server, File, Test.code()); |
Sam McCall | a7bb0cc | 2018-03-12 23:22:35 +0000 | [diff] [blame^] | 619 | return cantFail(runSignatureHelp(Server, File, Test.point())); |
Sam McCall | 800d437 | 2017-12-19 10:29:27 +0000 | [diff] [blame] | 620 | } |
| 621 | |
| 622 | MATCHER_P(ParamsAre, P, "") { |
| 623 | if (P.size() != arg.parameters.size()) |
| 624 | return false; |
| 625 | for (unsigned I = 0; I < P.size(); ++I) |
| 626 | if (P[I] != arg.parameters[I].label) |
| 627 | return false; |
| 628 | return true; |
| 629 | } |
| 630 | |
| 631 | Matcher<SignatureInformation> Sig(std::string Label, |
| 632 | std::vector<std::string> Params) { |
| 633 | return AllOf(Labeled(Label), ParamsAre(Params)); |
| 634 | } |
| 635 | |
| 636 | TEST(SignatureHelpTest, Overloads) { |
| 637 | auto Results = signatures(R"cpp( |
| 638 | void foo(int x, int y); |
| 639 | void foo(int x, float y); |
| 640 | void foo(float x, int y); |
| 641 | void foo(float x, float y); |
| 642 | void bar(int x, int y = 0); |
| 643 | int main() { foo(^); } |
| 644 | )cpp"); |
| 645 | EXPECT_THAT(Results.signatures, |
| 646 | UnorderedElementsAre( |
| 647 | Sig("foo(float x, float y) -> void", {"float x", "float y"}), |
| 648 | Sig("foo(float x, int y) -> void", {"float x", "int y"}), |
| 649 | Sig("foo(int x, float y) -> void", {"int x", "float y"}), |
| 650 | Sig("foo(int x, int y) -> void", {"int x", "int y"}))); |
| 651 | // We always prefer the first signature. |
| 652 | EXPECT_EQ(0, Results.activeSignature); |
| 653 | EXPECT_EQ(0, Results.activeParameter); |
| 654 | } |
| 655 | |
| 656 | TEST(SignatureHelpTest, DefaultArgs) { |
| 657 | auto Results = signatures(R"cpp( |
| 658 | void bar(int x, int y = 0); |
| 659 | void bar(float x = 0, int y = 42); |
| 660 | int main() { bar(^ |
| 661 | )cpp"); |
| 662 | EXPECT_THAT(Results.signatures, |
| 663 | UnorderedElementsAre( |
| 664 | Sig("bar(int x, int y = 0) -> void", {"int x", "int y = 0"}), |
| 665 | Sig("bar(float x = 0, int y = 42) -> void", |
| 666 | {"float x = 0", "int y = 42"}))); |
| 667 | EXPECT_EQ(0, Results.activeSignature); |
| 668 | EXPECT_EQ(0, Results.activeParameter); |
| 669 | } |
| 670 | |
| 671 | TEST(SignatureHelpTest, ActiveArg) { |
| 672 | auto Results = signatures(R"cpp( |
| 673 | int baz(int a, int b, int c); |
| 674 | int main() { baz(baz(1,2,3), ^); } |
| 675 | )cpp"); |
| 676 | EXPECT_THAT(Results.signatures, |
| 677 | ElementsAre(Sig("baz(int a, int b, int c) -> int", |
| 678 | {"int a", "int b", "int c"}))); |
| 679 | EXPECT_EQ(0, Results.activeSignature); |
| 680 | EXPECT_EQ(1, Results.activeParameter); |
| 681 | } |
| 682 | |
Haojian Wu | 061c73e | 2018-01-23 11:37:26 +0000 | [diff] [blame] | 683 | class IndexRequestCollector : public SymbolIndex { |
| 684 | public: |
| 685 | bool |
Sam McCall | d1a7a37 | 2018-01-31 13:40:48 +0000 | [diff] [blame] | 686 | fuzzyFind(const FuzzyFindRequest &Req, |
Haojian Wu | 061c73e | 2018-01-23 11:37:26 +0000 | [diff] [blame] | 687 | llvm::function_ref<void(const Symbol &)> Callback) const override { |
| 688 | Requests.push_back(Req); |
Sam McCall | ab8e393 | 2018-02-19 13:04:41 +0000 | [diff] [blame] | 689 | return true; |
Haojian Wu | 061c73e | 2018-01-23 11:37:26 +0000 | [diff] [blame] | 690 | } |
| 691 | |
| 692 | const std::vector<FuzzyFindRequest> allRequests() const { return Requests; } |
| 693 | |
| 694 | private: |
| 695 | mutable std::vector<FuzzyFindRequest> Requests; |
| 696 | }; |
| 697 | |
| 698 | std::vector<FuzzyFindRequest> captureIndexRequests(llvm::StringRef Code) { |
| 699 | clangd::CodeCompleteOptions Opts; |
| 700 | IndexRequestCollector Requests; |
| 701 | Opts.Index = &Requests; |
| 702 | completions(Code, {}, Opts); |
| 703 | return Requests.allRequests(); |
| 704 | } |
| 705 | |
| 706 | TEST(CompletionTest, UnqualifiedIdQuery) { |
| 707 | auto Requests = captureIndexRequests(R"cpp( |
| 708 | namespace std {} |
| 709 | using namespace std; |
| 710 | namespace ns { |
| 711 | void f() { |
| 712 | vec^ |
| 713 | } |
| 714 | } |
| 715 | )cpp"); |
| 716 | |
| 717 | EXPECT_THAT(Requests, |
| 718 | ElementsAre(Field(&FuzzyFindRequest::Scopes, |
| 719 | UnorderedElementsAre("", "ns::", "std::")))); |
| 720 | } |
| 721 | |
| 722 | TEST(CompletionTest, ResolvedQualifiedIdQuery) { |
| 723 | auto Requests = captureIndexRequests(R"cpp( |
| 724 | namespace ns1 {} |
| 725 | namespace ns2 {} // ignore |
| 726 | namespace ns3 { namespace nns3 {} } |
| 727 | namespace foo { |
| 728 | using namespace ns1; |
| 729 | using namespace ns3::nns3; |
| 730 | } |
| 731 | namespace ns { |
| 732 | void f() { |
| 733 | foo::^ |
| 734 | } |
| 735 | } |
| 736 | )cpp"); |
| 737 | |
| 738 | EXPECT_THAT(Requests, |
| 739 | ElementsAre(Field( |
| 740 | &FuzzyFindRequest::Scopes, |
| 741 | UnorderedElementsAre("foo::", "ns1::", "ns3::nns3::")))); |
| 742 | } |
| 743 | |
| 744 | TEST(CompletionTest, UnresolvedQualifierIdQuery) { |
| 745 | auto Requests = captureIndexRequests(R"cpp( |
| 746 | namespace a {} |
| 747 | using namespace a; |
| 748 | namespace ns { |
| 749 | void f() { |
| 750 | bar::^ |
| 751 | } |
| 752 | } // namespace ns |
| 753 | )cpp"); |
| 754 | |
| 755 | EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes, |
| 756 | UnorderedElementsAre("bar::")))); |
| 757 | } |
| 758 | |
| 759 | TEST(CompletionTest, UnresolvedNestedQualifierIdQuery) { |
| 760 | auto Requests = captureIndexRequests(R"cpp( |
| 761 | namespace a {} |
| 762 | using namespace a; |
| 763 | namespace ns { |
| 764 | void f() { |
| 765 | ::a::bar::^ |
| 766 | } |
| 767 | } // namespace ns |
| 768 | )cpp"); |
| 769 | |
| 770 | EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes, |
| 771 | UnorderedElementsAre("a::bar::")))); |
| 772 | } |
| 773 | |
| 774 | TEST(CompletionTest, EmptyQualifiedQuery) { |
| 775 | auto Requests = captureIndexRequests(R"cpp( |
| 776 | namespace ns { |
| 777 | void f() { |
| 778 | ^ |
| 779 | } |
| 780 | } // namespace ns |
| 781 | )cpp"); |
| 782 | |
| 783 | EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes, |
| 784 | UnorderedElementsAre("", "ns::")))); |
| 785 | } |
| 786 | |
| 787 | TEST(CompletionTest, GlobalQualifiedQuery) { |
| 788 | auto Requests = captureIndexRequests(R"cpp( |
| 789 | namespace ns { |
| 790 | void f() { |
| 791 | ::^ |
| 792 | } |
| 793 | } // namespace ns |
| 794 | )cpp"); |
| 795 | |
| 796 | EXPECT_THAT(Requests, ElementsAre(Field(&FuzzyFindRequest::Scopes, |
| 797 | UnorderedElementsAre("")))); |
| 798 | } |
| 799 | |
Sam McCall | 9aad25f | 2017-12-05 07:20:26 +0000 | [diff] [blame] | 800 | } // namespace |
| 801 | } // namespace clangd |
| 802 | } // namespace clang |