ilya-biryukov created this revision.
ilya-biryukov added a reviewer: hokein.
Herald added subscribers: kadircet, arphaman, jkorous, MaskRay.
Herald added a project: clang.
By producing the $0 marker in the snippets at the last placeholder.
This produces nicer results in most cases, e.g. for
namespace <#name#> {
<#decls#>
}
we now produce ${0:decls} instead of ${2:decls} and the final cursor
placement is more convenient.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D62389
Files:
clang-tools-extra/clangd/CodeComplete.cpp
clang-tools-extra/clangd/CodeCompletionStrings.cpp
clang-tools-extra/clangd/CodeCompletionStrings.h
clang-tools-extra/clangd/unittests/CodeCompletionStringsTests.cpp
Index: clang-tools-extra/clangd/unittests/CodeCompletionStringsTests.cpp
===================================================================
--- clang-tools-extra/clangd/unittests/CodeCompletionStringsTests.cpp
+++ clang-tools-extra/clangd/unittests/CodeCompletionStringsTests.cpp
@@ -22,10 +22,12 @@
CCTUInfo(Allocator), Builder(*Allocator, CCTUInfo) {}
protected:
- void computeSignature(const CodeCompletionString &CCS) {
+ void computeSignature(const CodeCompletionString &CCS,
+ bool CompletingPattern = false) {
Signature.clear();
Snippet.clear();
- getSignature(CCS, &Signature, &Snippet);
+ getSignature(CCS, &Signature, &Snippet, /*RequiredQualifier=*/nullptr,
+ CompletingPattern);
}
std::shared_ptr<clang::GlobalCodeCompletionAllocator> Allocator;
@@ -99,6 +101,25 @@
EXPECT_EQ(Snippet, "(${1:\\$p\\}1\\\\})");
}
+TEST_F(CompletionStringTest, SnippetsInPatterns) {
+ auto MakeCCS = [this]() -> const CodeCompletionString & {
+ CodeCompletionBuilder Builder(*Allocator, CCTUInfo);
+ Builder.AddTypedTextChunk("namespace");
+ Builder.AddChunk(CodeCompletionString::CK_HorizontalSpace);
+ Builder.AddPlaceholderChunk("name");
+ Builder.AddChunk(CodeCompletionString::CK_Equal);
+ Builder.AddPlaceholderChunk("target");
+ Builder.AddChunk(CodeCompletionString::CK_SemiColon);
+ return *Builder.TakeString();
+ };
+ computeSignature(MakeCCS(), /*CompletingPattern=*/false);
+ EXPECT_EQ(Snippet, " ${1:name} = ${2:target};");
+
+ // When completing a pattern, the last placeholder holds the cursor position.
+ computeSignature(MakeCCS(), /*CompletingPattern=*/true);
+ EXPECT_EQ(Snippet, " ${1:name} = ${0:target};");
+}
+
TEST_F(CompletionStringTest, IgnoreInformativeQualifier) {
Builder.AddTypedTextChunk("X");
Builder.AddInformativeChunk("info ok");
Index: clang-tools-extra/clangd/CodeCompletionStrings.h
===================================================================
--- clang-tools-extra/clangd/CodeCompletionStrings.h
+++ clang-tools-extra/clangd/CodeCompletionStrings.h
@@ -38,12 +38,15 @@
/// Formats the signature for an item, as a display string and snippet.
/// e.g. for const_reference std::vector<T>::at(size_type) const, this returns:
/// *Signature = "(size_type) const"
-/// *Snippet = "(${0:size_type})"
+/// *Snippet = "(${1:size_type})"
/// If set, RequiredQualifiers is the text that must be typed before the name.
/// e.g "Base::" when calling a base class member function that's hidden.
+/// When \p CompletingPattern is true, the last placeholder will be of the form
+/// ${0:…}, indicating the cursor should stay there.
void getSignature(const CodeCompletionString &CCS, std::string *Signature,
std::string *Snippet,
- std::string *RequiredQualifiers = nullptr);
+ std::string *RequiredQualifiers = nullptr,
+ bool CompletingPattern = false);
/// Assembles formatted documentation for a completion result. This includes
/// documentation comments and other relevant information like annotations.
Index: clang-tools-extra/clangd/CodeCompletionStrings.cpp
===================================================================
--- clang-tools-extra/clangd/CodeCompletionStrings.cpp
+++ clang-tools-extra/clangd/CodeCompletionStrings.cpp
@@ -11,6 +11,8 @@
#include "clang/AST/DeclObjC.h"
#include "clang/AST/RawCommentList.h"
#include "clang/Basic/SourceManager.h"
+#include "clang/Sema/CodeCompleteConsumer.h"
+#include <limits>
#include <utility>
namespace clang {
@@ -73,8 +75,23 @@
}
void getSignature(const CodeCompletionString &CCS, std::string *Signature,
- std::string *Snippet, std::string *RequiredQualifiers) {
- unsigned ArgCount = 0;
+ std::string *Snippet, std::string *RequiredQualifiers,
+ bool CompletingPattern) {
+ // Placeholder with this index will be ${0:…} to mark final cursor position.
+ // Usually we do not add $0, so the cursor is placed at end of completed text.
+ unsigned CursorSnippetArg = std::numeric_limits<unsigned>::max();
+ if (CompletingPattern) {
+ // In patterns, it's best to place the cursor at the last placeholder, to
+ // handle cases like
+ // namespace ${1:name} {
+ // ${0:decls}
+ // }
+ CursorSnippetArg =
+ llvm::count_if(CCS, [](const CodeCompletionString::Chunk &C) {
+ return C.Kind == CodeCompletionString::CK_Placeholder;
+ });
+ }
+ unsigned SnippetArg = 0;
bool HadObjCArguments = false;
for (const auto &Chunk : CCS) {
// Informative qualifier chunks only clutter completion results, skip
@@ -124,8 +141,10 @@
break;
case CodeCompletionString::CK_Placeholder:
*Signature += Chunk.Text;
- ++ArgCount;
- *Snippet += "${" + std::to_string(ArgCount) + ':';
+ ++SnippetArg;
+ *Snippet +=
+ "${" +
+ std::to_string(SnippetArg == CursorSnippetArg ? 0 : SnippetArg) + ':';
appendEscapeSnippet(Chunk.Text, Snippet);
*Snippet += '}';
break;
Index: clang-tools-extra/clangd/CodeComplete.cpp
===================================================================
--- clang-tools-extra/clangd/CodeComplete.cpp
+++ clang-tools-extra/clangd/CodeComplete.cpp
@@ -394,8 +394,9 @@
Bundled.emplace_back();
BundledEntry &S = Bundled.back();
if (C.SemaResult) {
+ bool IsPattern = C.SemaResult->Kind == CodeCompletionResult::RK_Pattern;
getSignature(*SemaCCS, &S.Signature, &S.SnippetSuffix,
- &Completion.RequiredQualifier);
+ &Completion.RequiredQualifier, IsPattern);
S.ReturnType = getReturnType(*SemaCCS);
} else if (C.IndexResult) {
S.Signature = C.IndexResult->Signature;
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
