rwols updated this revision to Diff 113650.
rwols marked 3 inline comments as done.
rwols added a comment.
- Split up the CompletionItemsCollector into two classes called
PlainTextCompletionItemsCollector and SnippetCompletionItemsCollector to allow
collecting both types of items.
- Add a command-line setting to clangd called "--enable-snippets" that, when
set, will make clangd use the SnippetCompletionItemsCollector. The default is
to use the PlainTextCompletionItemsCollector.
- Enable "code pattern" completions when "--enable-snippets" is true.
- Do not add a space in the completion label when we encounter a
CK_VerticalSpace in the SnippetCompletionItemsCollector. A space looks weird.
I will add tests now.
https://reviews.llvm.org/D37101
Files:
clangd/ClangdLSPServer.cpp
clangd/ClangdLSPServer.h
clangd/ClangdServer.cpp
clangd/ClangdServer.h
clangd/ClangdUnit.cpp
clangd/ClangdUnit.h
clangd/Protocol.cpp
clangd/Protocol.h
clangd/tool/ClangdMain.cpp
Index: clangd/tool/ClangdMain.cpp
===================================================================
--- clangd/tool/ClangdMain.cpp
+++ clangd/tool/ClangdMain.cpp
@@ -26,6 +26,13 @@
llvm::cl::desc("Number of async workers used by clangd"),
llvm::cl::init(getDefaultAsyncThreadsCount()));
+// FIXME: Make snippets the default once the client landscape has adjusted.
+static llvm::cl::opt<bool> EnableSnippets(
+ "enable-snippets",
+ llvm::cl::desc("Present completions with embedded snippets instead of "
+ "plaintext completions"),
+ llvm::cl::init(false));
+
static llvm::cl::opt<bool> RunSynchronously(
"run-synchronously",
llvm::cl::desc("Parse on main thread. If set, -j is ignored"),
@@ -61,6 +68,7 @@
if (!ResourceDir.empty())
ResourceDirRef = ResourceDir;
- ClangdLSPServer LSPServer(Out, WorkerThreadsCount, ResourceDirRef);
+ ClangdLSPServer LSPServer(Out, WorkerThreadsCount, EnableSnippets,
+ ResourceDirRef);
LSPServer.run(std::cin);
}
Index: clangd/Protocol.h
===================================================================
--- clangd/Protocol.h
+++ clangd/Protocol.h
@@ -389,6 +389,9 @@
/// themselves.
std::vector<TextEdit> additionalTextEdits;
+ CompletionItem() = default;
+ CompletionItem(const InsertTextFormat Format);
+
// TODO(krasimir): The following optional fields defined by the language
// server protocol are unsupported:
//
Index: clangd/Protocol.cpp
===================================================================
--- clangd/Protocol.cpp
+++ clangd/Protocol.cpp
@@ -705,6 +705,9 @@
return Result;
}
+CompletionItem::CompletionItem(const InsertTextFormat Format)
+ : insertTextFormat(Format) {}
+
std::string CompletionItem::unparse(const CompletionItem &CI) {
std::string Result = "{";
llvm::raw_string_ostream Os(Result);
@@ -724,8 +727,8 @@
if (!CI.insertText.empty())
Os << R"("insertText":")" << llvm::yaml::escape(CI.insertText) << R"(",)";
if (CI.insertTextFormat != InsertTextFormat::Missing) {
- Os << R"("insertTextFormat":")" << static_cast<int>(CI.insertTextFormat)
- << R"(",)";
+ Os << R"("insertTextFormat":)" << static_cast<int>(CI.insertTextFormat)
+ << R"(,)";
}
if (CI.textEdit)
Os << R"("textEdit":)" << TextEdit::unparse(*CI.textEdit) << ',';
Index: clangd/ClangdUnit.h
===================================================================
--- clangd/ClangdUnit.h
+++ clangd/ClangdUnit.h
@@ -253,7 +253,8 @@
codeComplete(PathRef FileName, tooling::CompileCommand Command,
PrecompiledPreamble const *Preamble, StringRef Contents,
Position Pos, IntrusiveRefCntPtr<vfs::FileSystem> VFS,
- std::shared_ptr<PCHContainerOperations> PCHs);
+ std::shared_ptr<PCHContainerOperations> PCHs,
+ const bool SnippetCompletions);
/// Get definition of symbol at a specified \p Pos.
std::vector<Location> findDefinitions(ParsedAST &AST, Position Pos);
Index: clangd/ClangdUnit.cpp
===================================================================
--- clangd/ClangdUnit.cpp
+++ clangd/ClangdUnit.cpp
@@ -272,68 +272,277 @@
}
}
+std::string SnippetEscape(const llvm::StringRef Text) {
+ std::string Result;
+ Result.reserve(Text.size()); // Assume '$', '}' and '\\' are rare.
+ for (const auto Character : Text) {
+ if (Character == '$' || Character == '}' || Character == '\\')
+ Result.push_back('\\');
+ Result.push_back(Character);
+ }
+ return Result;
+}
+
class CompletionItemsCollector : public CodeCompleteConsumer {
- std::vector<CompletionItem> *Items;
- std::shared_ptr<clang::GlobalCodeCompletionAllocator> Allocator;
- CodeCompletionTUInfo CCTUInfo;
public:
- CompletionItemsCollector(std::vector<CompletionItem> *Items,
- const CodeCompleteOptions &CodeCompleteOpts)
+ CompletionItemsCollector(const CodeCompleteOptions &CodeCompleteOpts,
+ std::vector<CompletionItem> &Items)
: CodeCompleteConsumer(CodeCompleteOpts, /*OutputIsBinary=*/false),
Items(Items),
Allocator(std::make_shared<clang::GlobalCodeCompletionAllocator>()),
CCTUInfo(Allocator) {}
void ProcessCodeCompleteResults(Sema &S, CodeCompletionContext Context,
CodeCompletionResult *Results,
- unsigned NumResults) override {
- for (unsigned I = 0; I != NumResults; ++I) {
- CodeCompletionResult &Result = Results[I];
- CodeCompletionString *CCS = Result.CreateCodeCompletionString(
+ unsigned NumResults) override final {
+ Items.reserve(NumResults);
+ for (unsigned I = 0; I < NumResults; ++I) {
+ auto &Result = Results[I];
+ const auto *CCS = Result.CreateCodeCompletionString(
S, Context, *Allocator, CCTUInfo,
CodeCompleteOpts.IncludeBriefComments);
- if (CCS) {
- CompletionItem Item;
- for (CodeCompletionString::Chunk C : *CCS) {
- switch (C.Kind) {
- case CodeCompletionString::CK_ResultType:
- Item.detail = C.Text;
- break;
- case CodeCompletionString::CK_Optional:
- break;
- default:
- Item.label += C.Text;
- break;
- }
- }
- assert(CCS->getTypedText());
- Item.kind = getKind(Result.CursorKind);
- // Priority is a 16-bit integer, hence at most 5 digits.
- assert(CCS->getPriority() < 99999 && "Expecting code completion result "
- "priority to have at most "
- "5-digits");
- llvm::raw_string_ostream(Item.sortText)
- << llvm::format("%05d%s", CCS->getPriority(), CCS->getTypedText());
- Item.insertText = Item.filterText = CCS->getTypedText();
- if (CCS->getBriefComment())
- Item.documentation = CCS->getBriefComment();
- Items->push_back(std::move(Item));
- }
+ assert(CCS && "Expected the CodeCompletionString to be non-null");
+ Items.push_back(ProcessCodeCompleteResult(Result, *CCS));
}
}
GlobalCodeCompletionAllocator &getAllocator() override { return *Allocator; }
CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo; }
-};
+
+protected:
+ std::vector<CompletionItem> &Items;
+ std::shared_ptr<clang::GlobalCodeCompletionAllocator> Allocator;
+ CodeCompletionTUInfo CCTUInfo;
+
+ void FillSortText(const CodeCompletionString &CCS,
+ CompletionItem &Item) const {
+ // Fill in the sortText of the CompletionItem.
+ assert(CCS.getPriority() < 99999 && "Expecting code completion result "
+ "priority to have at most 5-digits");
+ llvm::raw_string_ostream(Item.sortText)
+ << llvm::format("%05d%s", CCS.getPriority(), CCS.getTypedText());
+ }
+
+ void FillDocumentation(const CodeCompletionString &CCS,
+ CompletionItem &Item) const {
+ // Things like __attribute__((nonnull(1,3))) and [[noreturn]]. Present this
+ // information in the documentation field.
+ const unsigned AnnotationCount = CCS.getAnnotationCount();
+ if (AnnotationCount > 0) {
+ Item.documentation += "Annotation";
+ if (AnnotationCount == 1) {
+ Item.documentation += ": ";
+ } else /* AnnotationCount > 1 */ {
+ Item.documentation += "s: ";
+ }
+ for (unsigned I = 0; I < AnnotationCount; ++I) {
+ Item.documentation += CCS.getAnnotation(I);
+ Item.documentation.push_back(I == AnnotationCount - 1 ? '\n' : ' ');
+ }
+ }
+
+ // Add brief documentation (if there is any).
+ if (CCS.getBriefComment() != nullptr) {
+ if (!Item.documentation.empty()) {
+ // This means we previously added annotations. Add an extra newline
+ // character to make the annotations stand out.
+ Item.documentation.push_back('\n');
+ }
+ Item.documentation += CCS.getBriefComment();
+ }
+ }
+
+private:
+ virtual CompletionItem
+ ProcessCodeCompleteResult(const CodeCompletionResult &Result,
+ const CodeCompletionString &CCS) const = 0;
+}; // CompletionItemsCollector
+
+class PlainTextCompletionItemsCollector final
+ : public CompletionItemsCollector {
+
+public:
+ PlainTextCompletionItemsCollector(const CodeCompleteOptions &CodeCompleteOpts,
+ std::vector<CompletionItem> &Items)
+ : CompletionItemsCollector(CodeCompleteOpts, Items) {}
+
+private:
+ CompletionItem
+ ProcessCodeCompleteResult(const CodeCompletionResult &Result,
+ const CodeCompletionString &CCS) const override {
+
+ CompletionItem Item{InsertTextFormat::PlainText};
+
+ FillDocumentation(CCS, Item);
+
+ // Fill in the label, detail and filterText fields of the CompletionItem.
+ ProcessChunks(CCS, Item);
+
+ // Fill in the kind field of the CompletionItem.
+ Item.kind = getKind(Result.CursorKind);
+
+ FillSortText(CCS, Item);
+
+ return Item;
+ }
+
+ void ProcessChunks(const CodeCompletionString &CCS,
+ CompletionItem &Item) const {
+ for (const auto &Chunk : CCS) {
+ switch (Chunk.Kind) {
+ case CodeCompletionString::CK_TypedText:
+ Item.filterText += Chunk.Text;
+ case CodeCompletionString::CK_Text:
+ Item.label += Chunk.Text;
+ break;
+ case CodeCompletionString::CK_ResultType:
+ assert(Item.detail.empty() && "Unexpected extraneous CK_ResultType");
+ Item.detail = Chunk.Text;
+ break;
+ case CodeCompletionString::CK_Optional:
+ break;
+ default:
+ Item.label += Chunk.Text;
+ break;
+ }
+ }
+ }
+}; // PlainTextCompletionItemsCollector
+
+class SnippetCompletionItemsCollector final : public CompletionItemsCollector {
+
+public:
+ SnippetCompletionItemsCollector(const CodeCompleteOptions &CodeCompleteOpts,
+ std::vector<CompletionItem> &Items)
+ : CompletionItemsCollector(CodeCompleteOpts, Items) {}
+
+private:
+ CompletionItem
+ ProcessCodeCompleteResult(const CodeCompletionResult &Result,
+ const CodeCompletionString &CCS) const override {
+
+ // Always a snippet. This is because CK_Informative chunks should not be
+ // inserted into the text buffer, but they are part of the label. For
+ // example, "foo::bar() const" is the label, but "bar()" is the
+ // insertText.
+ CompletionItem Item{InsertTextFormat::Snippet};
+
+ FillDocumentation(CCS, Item);
+
+ // Fill in the label, detail, insertText and filterText fields of the
+ // CompletionItem.
+ ProcessChunks(CCS, Item);
+
+ // Fill in the kind field of the CompletionItem.
+ Item.kind = getKind(Result.CursorKind);
+
+ FillSortText(CCS, Item);
+
+ return Item;
+ }
+
+ void ProcessChunks(const CodeCompletionString &CCS,
+ CompletionItem &Item) const {
+ unsigned ArgCount = 0;
+ for (const auto &Chunk : CCS) {
+ switch (Chunk.Kind) {
+ case CodeCompletionString::CK_TypedText:
+ // The piece of text that the user is expected to type to match
+ // the code-completion string, typically a keyword or the name of
+ // a declarator or macro.
+ Item.filterText += Chunk.Text;
+ case CodeCompletionString::CK_Text:
+ // A piece of text that should be placed in the buffer,
+ // e.g., parentheses or a comma in a function call.
+ Item.label += Chunk.Text;
+ Item.insertText += Chunk.Text;
+ break;
+ case CodeCompletionString::CK_Optional:
+ // A code completion string that is entirely optional.
+ // For example, an optional code completion string that
+ // describes the default arguments in a function call.
+
+ // FIXME: Maybe add an option to allow presenting the optional chunks?
+ break;
+ case CodeCompletionString::CK_Placeholder:
+ // A string that acts as a placeholder for, e.g., a function call
+ // argument.
+ ++ArgCount;
+ Item.insertText += "${" + std::to_string(ArgCount) + ':' +
+ SnippetEscape(Chunk.Text) + '}';
+ Item.label += Chunk.Text;
+ break;
+ case CodeCompletionString::CK_Informative:
+ // A piece of text that describes something about the result
+ // but should not be inserted into the buffer.
+ // For example, the word "const" for a const method, or the name of
+ // the base class for methods that are part of the base class.
+ Item.label += Chunk.Text;
+ // Don't put the informative chunks in the insertText.
+ break;
+ case CodeCompletionString::CK_ResultType:
+ // A piece of text that describes the type of an entity or,
+ // for functions and methods, the return type.
+ assert(Item.detail.empty() && "Unexpected extraneous CK_ResultType");
+ Item.detail = Chunk.Text;
+ break;
+ case CodeCompletionString::CK_CurrentParameter:
+ // A piece of text that describes the parameter that corresponds to
+ // the code-completion location within a function call, message send,
+ // macro invocation, etc.
+ //
+ // This should never be present while collecting completion items,
+ // only while collecting overload candidates.
+ llvm_unreachable("Unexpected CK_CurrentParameter while collecting "
+ "CompletionItems");
+ case CodeCompletionString::CK_LeftParen:
+ // A left parenthesis ('(').
+ case CodeCompletionString::CK_RightParen:
+ // A right parenthesis (')').
+ case CodeCompletionString::CK_LeftBracket:
+ // A left bracket ('[').
+ case CodeCompletionString::CK_RightBracket:
+ // A right bracket (']').
+ case CodeCompletionString::CK_LeftBrace:
+ // A left brace ('{').
+ case CodeCompletionString::CK_RightBrace:
+ // A right brace ('}').
+ case CodeCompletionString::CK_LeftAngle:
+ // A left angle bracket ('<').
+ case CodeCompletionString::CK_RightAngle:
+ // A right angle bracket ('>').
+ case CodeCompletionString::CK_Comma:
+ // A comma separator (',').
+ case CodeCompletionString::CK_Colon:
+ // A colon (':').
+ case CodeCompletionString::CK_SemiColon:
+ // A semicolon (';').
+ case CodeCompletionString::CK_Equal:
+ // An '=' sign.
+ case CodeCompletionString::CK_HorizontalSpace:
+ // Horizontal whitespace (' ').
+ Item.insertText += Chunk.Text;
+ Item.label += Chunk.Text;
+ break;
+ case CodeCompletionString::CK_VerticalSpace:
+ // Vertical whitespace ('\n' or '\r\n', depending on the
+ // platform).
+ Item.insertText += Chunk.Text;
+ // Don't even add a space to the label.
+ }
+ }
+ }
+}; // SnippetCompletionItemsCollector
} // namespace
std::vector<CompletionItem>
clangd::codeComplete(PathRef FileName, tooling::CompileCommand Command,
PrecompiledPreamble const *Preamble, StringRef Contents,
Position Pos, IntrusiveRefCntPtr<vfs::FileSystem> VFS,
- std::shared_ptr<PCHContainerOperations> PCHs) {
+ std::shared_ptr<PCHContainerOperations> PCHs,
+ const bool SnippetCompletions) {
std::vector<const char *> ArgStrs;
for (const auto &S : Command.CommandLine)
ArgStrs.push_back(S.c_str());
@@ -371,18 +580,23 @@
FrontendOpts.SkipFunctionBodies = true;
FrontendOpts.CodeCompleteOpts.IncludeGlobals = true;
- // we don't handle code patterns properly yet, disable them.
- FrontendOpts.CodeCompleteOpts.IncludeCodePatterns = false;
FrontendOpts.CodeCompleteOpts.IncludeMacros = true;
FrontendOpts.CodeCompleteOpts.IncludeBriefComments = true;
FrontendOpts.CodeCompletionAt.FileName = FileName;
FrontendOpts.CodeCompletionAt.Line = Pos.line + 1;
FrontendOpts.CodeCompletionAt.Column = Pos.character + 1;
std::vector<CompletionItem> Items;
- Clang->setCodeCompletionConsumer(
- new CompletionItemsCollector(&Items, FrontendOpts.CodeCompleteOpts));
+ if (SnippetCompletions) {
+ FrontendOpts.CodeCompleteOpts.IncludeCodePatterns = true;
+ Clang->setCodeCompletionConsumer(new SnippetCompletionItemsCollector(
+ FrontendOpts.CodeCompleteOpts, Items));
+ } else {
+ FrontendOpts.CodeCompleteOpts.IncludeCodePatterns = false;
+ Clang->setCodeCompletionConsumer(new PlainTextCompletionItemsCollector(
+ FrontendOpts.CodeCompleteOpts, Items));
+ }
SyntaxOnlyAction Action;
if (!Action.BeginSourceFile(*Clang, Clang->getFrontendOpts().Inputs[0])) {
Index: clangd/ClangdServer.h
===================================================================
--- clangd/ClangdServer.h
+++ clangd/ClangdServer.h
@@ -179,6 +179,9 @@
/// AsyncThreadsCount worker threads. However, if \p AsyncThreadsCount is 0,
/// all requests will be processed on the calling thread.
///
+ /// When \p SnippetCompletions is true, completion items will be presented
+ /// with embedded snippets. Otherwise, plaintext items will be presented.
+ ///
/// ClangdServer uses \p FSProvider to get an instance of vfs::FileSystem for
/// each parsing request. Results of code completion and diagnostics also
/// include a tag, that \p FSProvider returns along with the vfs::FileSystem.
@@ -201,6 +204,7 @@
ClangdServer(GlobalCompilationDatabase &CDB,
DiagnosticsConsumer &DiagConsumer,
FileSystemProvider &FSProvider, unsigned AsyncThreadsCount,
+ const bool SnippetCompletions,
llvm::Optional<StringRef> ResourceDir = llvm::None);
/// Add a \p File to the list of tracked C++ files or update the contents if
@@ -274,6 +278,7 @@
// called before all other members to stop the worker thread that references
// ClangdServer
ClangdScheduler WorkScheduler;
+ bool SnippetCompletions;
};
} // namespace clangd
Index: clangd/ClangdServer.cpp
===================================================================
--- clangd/ClangdServer.cpp
+++ clangd/ClangdServer.cpp
@@ -145,11 +145,13 @@
DiagnosticsConsumer &DiagConsumer,
FileSystemProvider &FSProvider,
unsigned AsyncThreadsCount,
+ const bool SnippetCompletions,
llvm::Optional<StringRef> ResourceDir)
: CDB(CDB), DiagConsumer(DiagConsumer), FSProvider(FSProvider),
ResourceDir(ResourceDir ? ResourceDir->str() : getStandardResourceDir()),
PCHs(std::make_shared<PCHContainerOperations>()),
- WorkScheduler(AsyncThreadsCount) {}
+ WorkScheduler(AsyncThreadsCount), SnippetCompletions(SnippetCompletions) {
+}
std::future<void> ClangdServer::addDocument(PathRef File, StringRef Contents) {
DocVersion Version = DraftMgr.updateDraft(File, Contents);
@@ -206,10 +208,10 @@
assert(Resources && "Calling completion on non-added file");
auto Preamble = Resources->getPossiblyStalePreamble();
- std::vector<CompletionItem> Result =
- clangd::codeComplete(File, Resources->getCompileCommand(),
- Preamble ? &Preamble->Preamble : nullptr,
- *OverridenContents, Pos, TaggedFS.Value, PCHs);
+ std::vector<CompletionItem> Result = clangd::codeComplete(
+ File, Resources->getCompileCommand(),
+ Preamble ? &Preamble->Preamble : nullptr, *OverridenContents, Pos,
+ TaggedFS.Value, PCHs, SnippetCompletions);
return make_tagged(std::move(Result), TaggedFS.Tag);
}
Index: clangd/ClangdLSPServer.h
===================================================================
--- clangd/ClangdLSPServer.h
+++ clangd/ClangdLSPServer.h
@@ -27,6 +27,7 @@
class ClangdLSPServer {
public:
ClangdLSPServer(JSONOutput &Out, unsigned AsyncThreadsCount,
+ const bool SnippetCompletions,
llvm::Optional<StringRef> ResourceDir);
/// Run LSP server loop, receiving input for it from \p In. \p In must be
Index: clangd/ClangdLSPServer.cpp
===================================================================
--- clangd/ClangdLSPServer.cpp
+++ clangd/ClangdLSPServer.cpp
@@ -221,9 +221,11 @@
}
ClangdLSPServer::ClangdLSPServer(JSONOutput &Out, unsigned AsyncThreadsCount,
+ const bool SnippetCompletions,
llvm::Optional<StringRef> ResourceDir)
: Out(Out), DiagConsumer(*this),
- Server(CDB, DiagConsumer, FSProvider, AsyncThreadsCount, ResourceDir) {}
+ Server(CDB, DiagConsumer, FSProvider, AsyncThreadsCount,
+ SnippetCompletions, ResourceDir) {}
void ClangdLSPServer::run(std::istream &In) {
assert(!IsDone && "Run was called before");
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
