maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[clangd] Move function argument snippet disable mechanism from LSP rendering to internal clangd reprensentation. 

Summary:
We were handling the EnableFunctionArgSnippets only when we are producing LSP
response. Move that code into CompletionItem generation so that internal clients
can benefit from that as well.

Reviewers: ilya-biryukov, ioeric, hokein

Reviewed By: ilya-biryukov

Subscribers: MaskRay, jkorous, arphaman, cfe-commits

Differential Revision: https://reviews.llvm.org/D51102

llvm-svn: 340527
This commit is contained in:
Kadir Cetinkaya 2018-08-23 12:19:39 +00:00
parent 17e7ace5e9
commit 516fcdac6d
2 changed files with 38 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
clang-tools-extra/clangd/CodeComplete.cpp
View File

@ -269,7 +269,8 @@ struct CodeCompletionBuilder {
CodeCompletionString *SemaCCS,
const IncludeInserter &Includes, StringRef FileName,
const CodeCompleteOptions &Opts)
: ASTCtx(ASTCtx), ExtractDocumentation(Opts.IncludeComments) {
: ASTCtx(ASTCtx), ExtractDocumentation(Opts.IncludeComments),
EnableFunctionArgSnippets(Opts.EnableFunctionArgSnippets) {
add(C, SemaCCS);
if (C.SemaResult) {
Completion.Origin |= SymbolOrigin::AST;
@ -385,10 +386,17 @@ private:
}
std::string summarizeSnippet() const {
if (auto *Snippet = onlyValue<&BundledEntry::SnippetSuffix>())
return *Snippet;
// All bundles are function calls.
return "(${0})";
auto *Snippet = onlyValue<&BundledEntry::SnippetSuffix>();
if (!Snippet)
// All bundles are function calls.
return "($0)";
if (!Snippet->empty() && !EnableFunctionArgSnippets &&
((Completion.Kind == CompletionItemKind::Function) ||
(Completion.Kind == CompletionItemKind::Method)) &&
(Snippet->front() == '(') && (Snippet->back() == ')'))
// Check whether function has any parameters or not.
return Snippet->size() > 2 ? "($0)" : "()";
return *Snippet;
}
std::string summarizeSignature() const {
@ -402,6 +410,7 @@ private:
CodeCompletion Completion;
SmallVector<BundledEntry, 1> Bundled;
bool ExtractDocumentation;
bool EnableFunctionArgSnippets;
};
// Determine the symbol ID for a Sema code completion result, if possible.
@ -1413,16 +1422,8 @@ CompletionItem CodeCompletion::render(const CodeCompleteOptions &Opts) const {
LSP.additionalTextEdits.push_back(FixIt);
}
}
if (Opts.EnableSnippets && !SnippetSuffix.empty()) {
if (!Opts.EnableFunctionArgSnippets &&
((Kind == CompletionItemKind::Function) ||
(Kind == CompletionItemKind::Method)) &&
(SnippetSuffix.front() == '(') && (SnippetSuffix.back() == ')'))
// Check whether function has any parameters or not.
LSP.textEdit->newText += SnippetSuffix.size() > 2 ? "(${0})" : "()";
else
LSP.textEdit->newText += SnippetSuffix;
}
if (Opts.EnableSnippets)
LSP.textEdit->newText += SnippetSuffix;
// FIXME(kadircet): Do not even fill insertText after making sure textEdit is
// compatible with most of the editors.

64
clang-tools-extra/unittests/clangd/CodeCompleteTests.cpp
View File

@ -1140,7 +1140,7 @@ TEST(CompletionTest, OverloadBundling) {
// For now we just return one of the doc strings arbitrarily.
EXPECT_THAT(A.Documentation, AnyOf(HasSubstr("Overload with int"),
HasSubstr("Overload with bool")));
EXPECT_EQ(A.SnippetSuffix, "(${0})");
EXPECT_EQ(A.SnippetSuffix, "($0)");
}
TEST(CompletionTest, DocumentationFromChangedFileCrash) {
@ -1648,55 +1648,35 @@ TEST(SignatureHelpTest, IndexDocumentation) {
SigDoc("Doc from sema"))));
}
TEST(CompletionTest, RenderWithSnippetsForFunctionArgsDisabled) {
TEST(CompletionTest, CompletionFunctionArgsDisabled) {
CodeCompleteOptions Opts;
Opts.EnableFunctionArgSnippets = true;
{
CodeCompletion C;
C.RequiredQualifier = "Foo::";
C.Name = "x";
C.SnippetSuffix = "()";
auto R = C.render(Opts);
EXPECT_EQ(R.textEdit->newText, "Foo::x");
EXPECT_EQ(R.insertTextFormat, InsertTextFormat::PlainText);
}
Opts.EnableSnippets = true;
Opts.EnableFunctionArgSnippets = false;
const std::string Header =
R"cpp(
void xfoo();
void xfoo(int x, int y);
void xbar();
void f() {
)cpp";
{
CodeCompletion C;
C.RequiredQualifier = "Foo::";
C.Name = "x";
C.SnippetSuffix = "";
auto R = C.render(Opts);
EXPECT_EQ(R.textEdit->newText, "Foo::x");
EXPECT_EQ(R.insertTextFormat, InsertTextFormat::Snippet);
auto Results = completions(Header + "\nxfo^", {}, Opts);
EXPECT_THAT(
Results.Completions,
UnorderedElementsAre(AllOf(Named("xfoo"), SnippetSuffix("()")),
AllOf(Named("xfoo"), SnippetSuffix("($0)"))));
}
{
CodeCompletion C;
C.RequiredQualifier = "Foo::";
C.Name = "x";
C.SnippetSuffix = "()";
C.Kind = CompletionItemKind::Method;
auto R = C.render(Opts);
EXPECT_EQ(R.textEdit->newText, "Foo::x()");
EXPECT_EQ(R.insertTextFormat, InsertTextFormat::Snippet);
auto Results = completions(Header + "\nxba^", {}, Opts);
EXPECT_THAT(Results.Completions, UnorderedElementsAre(AllOf(
Named("xbar"), SnippetSuffix("()"))));
}
{
CodeCompletion C;
C.RequiredQualifier = "Foo::";
C.Name = "x";
C.SnippetSuffix = "(${0:bool})";
C.Kind = CompletionItemKind::Function;
auto R = C.render(Opts);
EXPECT_EQ(R.textEdit->newText, "Foo::x(${0})");
EXPECT_EQ(R.insertTextFormat, InsertTextFormat::Snippet);
Opts.BundleOverloads = true;
auto Results = completions(Header + "\nxfo^", {}, Opts);
EXPECT_THAT(
Results.Completions,
UnorderedElementsAre(AllOf(Named("xfoo"), SnippetSuffix("($0)"))));
}
}