Index: clangd/ClangdLSPServer.h =================================================================== --- clangd/ClangdLSPServer.h +++ clangd/ClangdLSPServer.h @@ -74,8 +74,7 @@ void onDocumentSymbol(const DocumentSymbolParams &, Callback); void onCodeAction(const CodeActionParams &, Callback); - void onCompletion(const TextDocumentPositionParams &, - Callback); + void onCompletion(const CompletionParams &, Callback); void onSignatureHelp(const TextDocumentPositionParams &, Callback); void onGoToDefinition(const TextDocumentPositionParams &, @@ -98,6 +97,12 @@ std::vector getFixes(StringRef File, const clangd::Diagnostic &D); + /// Checks if completion request should be ignored. We need this due to the + /// limitation of the LSP. Per LSP, a client sends requests for all "trigger + /// character" we specify, but for '>' and ':' we need to check they actually + /// produce '->' and '::', respectively. + bool isSporadicCompletion(const CompletionParams &Params) const; + /// Forces a reparse of all currently opened files. As a result, this method /// may be very expensive. This method is normally called when the /// compilation database is changed. Index: clangd/ClangdLSPServer.cpp =================================================================== --- clangd/ClangdLSPServer.cpp +++ clangd/ClangdLSPServer.cpp @@ -22,6 +22,15 @@ namespace clang { namespace clangd { namespace { +class CompletionSporadicError : public llvm::ErrorInfo { +public: + void log(llvm::raw_ostream &OS) const override { + OS << "ignored triggered completion, preceding char did not match"; + } + std::error_code convertToErrorCode() const override { + return std::make_error_code(std::errc::operation_canceled); + } +}; void adjustSymbolKinds(llvm::MutableArrayRef Syms, SymbolKindBitset Kinds) { @@ -310,6 +319,8 @@ {"completionProvider", json::Object{ {"resolveProvider", false}, + // We do extra checks for '>' and ':' in completion to only + // trigger on '->' and '::'. {"triggerCharacters", {".", ">", ":"}}, }}, {"signatureHelpProvider", @@ -612,25 +623,27 @@ } } -void ClangdLSPServer::onCompletion(const TextDocumentPositionParams &Params, +void ClangdLSPServer::onCompletion(const CompletionParams &Params, Callback Reply) { - Server->codeComplete(Params.textDocument.uri.file(), Params.position, CCOpts, - Bind( - [this](decltype(Reply) Reply, - Expected List) { - if (!List) - return Reply(List.takeError()); - CompletionList LSPList; - LSPList.isIncomplete = List->HasMore; - for (const auto &R : List->Completions) { - CompletionItem C = R.render(CCOpts); - C.kind = adjustKindToCapability( - C.kind, SupportedCompletionItemKinds); - LSPList.items.push_back(std::move(C)); - } - return Reply(std::move(LSPList)); - }, - std::move(Reply))); + if (isSporadicCompletion(Params)) + return Reply(llvm::make_error()); + Server->codeComplete( + Params.textDocument.uri.file(), Params.position, CCOpts, + Bind( + [this](decltype(Reply) Reply, Expected List) { + if (!List) + return Reply(List.takeError()); + CompletionList LSPList; + LSPList.isIncomplete = List->HasMore; + for (const auto &R : List->Completions) { + CompletionItem C = R.render(CCOpts); + C.kind = + adjustKindToCapability(C.kind, SupportedCompletionItemKinds); + LSPList.items.push_back(std::move(C)); + } + return Reply(std::move(LSPList)); + }, + std::move(Reply))); } void ClangdLSPServer::onSignatureHelp(const TextDocumentPositionParams &Params, @@ -773,6 +786,35 @@ return FixItsIter->second; } +bool ClangdLSPServer::isSporadicCompletion( + const CompletionParams &Params) const { + StringRef Trigger = Params.context.triggerCharacter; + if (Params.context.triggerKind != CompletionTriggerKind::TriggerCharacter || + (Trigger != ">" && Trigger != ":")) + return false; + + auto Code = DraftMgr.getDraft(Params.textDocument.uri.file()); + if (!Code) + return false; // completion code will log the error for untracked doc. + + auto Offset = positionToOffset(*Code, Params.position, + /*AllowColumnsBeyondLineLength=*/false); + if (!Offset) { + vlog("could not convert position '{0}' to offset for file '{1}'", + Params.position, Params.textDocument.uri.file()); + return false; + } + if (*Offset < 2) + return true; + + if (Trigger == ">") + return (*Code)[*Offset - 2] != '-'; // trigger only on '->'. + if (Trigger == ":") + return (*Code)[*Offset - 2] != ':'; // trigger only on '::'. + assert(false && "unhandled trigger character"); + return false; +} + void ClangdLSPServer::onDiagnosticsReady(PathRef File, std::vector Diagnostics) { auto URI = URIForFile::canonicalize(File, /*TUPath=*/File); Index: clangd/Protocol.h =================================================================== --- clangd/Protocol.h +++ clangd/Protocol.h @@ -775,6 +775,31 @@ }; bool fromJSON(const llvm::json::Value &, TextDocumentPositionParams &); +enum class CompletionTriggerKind { + /// Completion was triggered by typing an identifier (24x7 code + /// complete), manual invocation (e.g Ctrl+Space) or via API. + Invoked = 1, + /// Completion was triggered by a trigger character specified by + /// the `triggerCharacters` properties of the `CompletionRegistrationOptions`. + TriggerCharacter = 2, + /// Completion was re-triggered as the current completion list is incomplete. + TriggerTriggerForIncompleteCompletions = 3 +}; + +struct CompletionContext { + /// How the completion was triggered. + CompletionTriggerKind triggerKind = CompletionTriggerKind::Invoked; + /// The trigger character (a single character) that has trigger code complete. + /// Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter` + std::string triggerCharacter; +}; +bool fromJSON(const llvm::json::Value &, CompletionContext &); + +struct CompletionParams : TextDocumentPositionParams { + CompletionContext context; +}; +bool fromJSON(const llvm::json::Value &, CompletionParams &); + enum class MarkupKind { PlainText, Markdown, Index: clangd/Protocol.cpp =================================================================== --- clangd/Protocol.cpp +++ clangd/Protocol.cpp @@ -550,6 +550,29 @@ O.map("position", R.position); } +bool fromJSON(const llvm::json::Value &Params, CompletionContext &R) { + json::ObjectMapper O(Params); + if (!O) + return false; + + int triggerKind; + if (!O.map("triggerKind", triggerKind)) + return false; + R.triggerKind = static_cast(triggerKind); + + if (auto *TC = Params.getAsObject()->get("triggerCharacter")) + return fromJSON(*TC, R.triggerCharacter); + return true; +} + +bool fromJSON(const llvm::json::Value &Params, CompletionParams &R) { + if (!fromJSON(Params, static_cast(R))) + return false; + if (auto *Context = Params.getAsObject()->get("context")) + return fromJSON(*Context, R.context); + return true; +} + static StringRef toTextKind(MarkupKind Kind) { switch (Kind) { case MarkupKind::PlainText: