clang-tools  9.0.0
CodeCompletionStringsTests.cpp
Go to the documentation of this file.
1 //===-- CodeCompletionStringsTests.cpp --------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
10 #include "clang/Sema/CodeCompleteConsumer.h"
11 #include "gmock/gmock.h"
12 #include "gtest/gtest.h"
13 
14 namespace clang {
15 namespace clangd {
16 namespace {
17 
18 class CompletionStringTest : public ::testing::Test {
19 public:
20  CompletionStringTest()
21  : Allocator(std::make_shared<clang::GlobalCodeCompletionAllocator>()),
23 
24 protected:
25  void computeSignature(const CodeCompletionString &CCS,
26  bool CompletingPattern = false) {
27  Signature.clear();
28  Snippet.clear();
29  getSignature(CCS, &Signature, &Snippet, /*RequiredQualifier=*/nullptr,
30  CompletingPattern);
31  }
32 
33  std::shared_ptr<clang::GlobalCodeCompletionAllocator> Allocator;
34  CodeCompletionTUInfo CCTUInfo;
35  CodeCompletionBuilder Builder;
36  std::string Signature;
37  std::string Snippet;
38 };
39 
40 TEST_F(CompletionStringTest, ReturnType) {
41  Builder.AddResultTypeChunk("result");
42  Builder.AddResultTypeChunk("redundant result no no");
43  EXPECT_EQ(getReturnType(*Builder.TakeString()), "result");
44 }
45 
46 TEST_F(CompletionStringTest, Documentation) {
47  Builder.addBriefComment("This is ignored");
48  EXPECT_EQ(formatDocumentation(*Builder.TakeString(), "Is this brief?"),
49  "Is this brief?");
50 }
51 
52 TEST_F(CompletionStringTest, DocumentationWithAnnotation) {
53  Builder.addBriefComment("This is ignored");
54  Builder.AddAnnotation("Ano");
55  EXPECT_EQ(formatDocumentation(*Builder.TakeString(), "Is this brief?"),
56  "Annotation: Ano\n\nIs this brief?");
57 }
58 
59 TEST_F(CompletionStringTest, MultipleAnnotations) {
60  Builder.AddAnnotation("Ano1");
61  Builder.AddAnnotation("Ano2");
62  Builder.AddAnnotation("Ano3");
63 
64  EXPECT_EQ(formatDocumentation(*Builder.TakeString(), ""),
65  "Annotations: Ano1 Ano2 Ano3\n");
66 }
67 
68 TEST_F(CompletionStringTest, EmptySignature) {
69  Builder.AddTypedTextChunk("X");
70  Builder.AddResultTypeChunk("result no no");
71  computeSignature(*Builder.TakeString());
72  EXPECT_EQ(Signature, "");
73  EXPECT_EQ(Snippet, "");
74 }
75 
76 TEST_F(CompletionStringTest, Function) {
77  Builder.AddResultTypeChunk("result no no");
78  Builder.addBriefComment("This comment is ignored");
79  Builder.AddTypedTextChunk("Foo");
80  Builder.AddChunk(CodeCompletionString::CK_LeftParen);
81  Builder.AddPlaceholderChunk("p1");
82  Builder.AddChunk(CodeCompletionString::CK_Comma);
83  Builder.AddPlaceholderChunk("p2");
84  Builder.AddChunk(CodeCompletionString::CK_RightParen);
85 
86  auto *CCS = Builder.TakeString();
87  computeSignature(*CCS);
88  EXPECT_EQ(Signature, "(p1, p2)");
89  EXPECT_EQ(Snippet, "(${1:p1}, ${2:p2})");
90  EXPECT_EQ(formatDocumentation(*CCS, "Foo's comment"), "Foo's comment");
91 }
92 
93 TEST_F(CompletionStringTest, EscapeSnippet) {
94  Builder.AddTypedTextChunk("Foo");
95  Builder.AddChunk(CodeCompletionString::CK_LeftParen);
96  Builder.AddPlaceholderChunk("$p}1\\");
97  Builder.AddChunk(CodeCompletionString::CK_RightParen);
98 
99  computeSignature(*Builder.TakeString());
100  EXPECT_EQ(Signature, "($p}1\\)");
101  EXPECT_EQ(Snippet, "(${1:\\$p\\}1\\\\})");
102 }
103 
104 TEST_F(CompletionStringTest, SnippetsInPatterns) {
105  auto MakeCCS = [this]() -> const CodeCompletionString & {
106  CodeCompletionBuilder Builder(*Allocator, CCTUInfo);
107  Builder.AddTypedTextChunk("namespace");
108  Builder.AddChunk(CodeCompletionString::CK_HorizontalSpace);
109  Builder.AddPlaceholderChunk("name");
110  Builder.AddChunk(CodeCompletionString::CK_Equal);
111  Builder.AddPlaceholderChunk("target");
112  Builder.AddChunk(CodeCompletionString::CK_SemiColon);
113  return *Builder.TakeString();
114  };
115  computeSignature(MakeCCS(), /*CompletingPattern=*/false);
116  EXPECT_EQ(Snippet, " ${1:name} = ${2:target};");
117 
118  // When completing a pattern, the last placeholder holds the cursor position.
119  computeSignature(MakeCCS(), /*CompletingPattern=*/true);
120  EXPECT_EQ(Snippet, " ${1:name} = ${0:target};");
121 }
122 
123 TEST_F(CompletionStringTest, IgnoreInformativeQualifier) {
124  Builder.AddTypedTextChunk("X");
125  Builder.AddInformativeChunk("info ok");
126  Builder.AddInformativeChunk("info no no::");
127  computeSignature(*Builder.TakeString());
128  EXPECT_EQ(Signature, "info ok");
129  EXPECT_EQ(Snippet, "");
130 }
131 
132 TEST_F(CompletionStringTest, ObjectiveCMethodNoArguments) {
133  Builder.AddResultTypeChunk("void");
134  Builder.AddTypedTextChunk("methodName");
135 
136  auto *CCS = Builder.TakeString();
137  computeSignature(*CCS);
138  EXPECT_EQ(Signature, "");
139  EXPECT_EQ(Snippet, "");
140 }
141 
142 TEST_F(CompletionStringTest, ObjectiveCMethodOneArgument) {
143  Builder.AddResultTypeChunk("void");
144  Builder.AddTypedTextChunk("methodWithArg:");
145  Builder.AddPlaceholderChunk("(type)");
146 
147  auto *CCS = Builder.TakeString();
148  computeSignature(*CCS);
149  EXPECT_EQ(Signature, "(type)");
150  EXPECT_EQ(Snippet, "${1:(type)}");
151 }
152 
153 TEST_F(CompletionStringTest, ObjectiveCMethodTwoArgumentsFromBeginning) {
154  Builder.AddResultTypeChunk("int");
155  Builder.AddTypedTextChunk("withFoo:");
156  Builder.AddPlaceholderChunk("(type)");
157  Builder.AddChunk(CodeCompletionString::CK_HorizontalSpace);
158  Builder.AddTypedTextChunk("bar:");
159  Builder.AddPlaceholderChunk("(type2)");
160 
161  auto *CCS = Builder.TakeString();
162  computeSignature(*CCS);
163  EXPECT_EQ(Signature, "(type) bar:(type2)");
164  EXPECT_EQ(Snippet, "${1:(type)} bar:${2:(type2)}");
165 }
166 
167 TEST_F(CompletionStringTest, ObjectiveCMethodTwoArgumentsFromMiddle) {
168  Builder.AddResultTypeChunk("int");
169  Builder.AddInformativeChunk("withFoo:");
170  Builder.AddTypedTextChunk("bar:");
171  Builder.AddPlaceholderChunk("(type2)");
172 
173  auto *CCS = Builder.TakeString();
174  computeSignature(*CCS);
175  EXPECT_EQ(Signature, "(type2)");
176  EXPECT_EQ(Snippet, "${1:(type2)}");
177 }
178 
179 } // namespace
180 } // namespace clangd
181 } // namespace clang
std::shared_ptr< clang::GlobalCodeCompletionAllocator > Allocator
std::string getReturnType(const CodeCompletionString &CCS)
Gets detail to be used as the detail field in an LSP completion item.
TEST_F(BackgroundIndexTest, NoCrashOnErrorFile)
std::string formatDocumentation(const CodeCompletionString &CCS, llvm::StringRef DocComment)
Assembles formatted documentation for a completion result.
std::string ReturnType
std::string Signature
CodeCompletionBuilder Builder
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
CodeCompletionTUInfo CCTUInfo
void getSignature(const CodeCompletionString &CCS, std::string *Signature, std::string *Snippet, std::string *RequiredQualifiers, bool CompletingPattern)
Formats the signature for an item, as a display string and snippet.