/**************************************************************************** ** ** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of Qt Creator. ** ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 3 as published by the Free Software ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-3.0.html. ** ****************************************************************************/ #include "client.h" #include "languageclientinterface.h" #include "languageclientmanager.h" #include "languageclientutils.h" #include "semantichighlightsupport.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace LanguageServerProtocol; using namespace Utils; namespace LanguageClient { static Q_LOGGING_CATEGORY(LOGLSPCLIENT, "qtc.languageclient.client", QtWarningMsg); class TextMark : public TextEditor::TextMark { public: TextMark(const Utils::FilePath &fileName, const Diagnostic &diag, const Utils::Id &clientId) : TextEditor::TextMark(fileName, diag.range().start().line() + 1, clientId) , m_diagnostic(diag) { using namespace Utils; setLineAnnotation(diag.message()); setToolTip(diag.message()); const bool isError = diag.severity().value_or(DiagnosticSeverity::Hint) == DiagnosticSeverity::Error; setColor(isError ? Theme::CodeModel_Error_TextMarkColor : Theme::CodeModel_Warning_TextMarkColor); setIcon(isError ? Icons::CODEMODEL_ERROR.icon() : Icons::CODEMODEL_WARNING.icon()); } const Diagnostic &diagnostic() const { return m_diagnostic; } private: const Diagnostic m_diagnostic; }; Client::Client(BaseClientInterface *clientInterface) : m_id(Utils::Id::fromString(QUuid::createUuid().toString())) , m_clientInterface(clientInterface) , m_documentSymbolCache(this) , m_hoverHandler(this) , m_symbolSupport(this) { m_clientProviders.completionAssistProvider = new LanguageClientCompletionAssistProvider(this); m_clientProviders.functionHintProvider = new FunctionHintAssistProvider(this); m_clientProviders.quickFixAssistProvider = new LanguageClientQuickFixProvider(this); m_documentUpdateTimer.setSingleShot(true); m_documentUpdateTimer.setInterval(500); connect(&m_documentUpdateTimer, &QTimer::timeout, this, &Client::sendPostponedDocumentUpdates); m_contentHandler.insert(JsonRpcMessageHandler::jsonRpcMimeType(), &JsonRpcMessageHandler::parseContent); QTC_ASSERT(clientInterface, return); connect(clientInterface, &BaseClientInterface::messageReceived, this, &Client::handleMessage); connect(clientInterface, &BaseClientInterface::error, this, &Client::setError); connect(clientInterface, &BaseClientInterface::finished, this, &Client::finished); connect(TextEditor::TextEditorSettings::instance(), &TextEditor::TextEditorSettings::fontSettingsChanged, this, &Client::rehighlight); } static void updateEditorToolBar(QList documents) { for (TextEditor::TextDocument *document : documents) { for (Core::IEditor *editor : Core::DocumentModel::editorsForDocument(document)) updateEditorToolBar(editor); } } Client::~Client() { using namespace TextEditor; // FIXME: instead of replacing the completion provider in the text document store the // completion provider as a prioritised list in the text document for (TextDocument *document : m_resetAssistProvider.keys()) resetAssistProviders(document); for (Core::IEditor * editor : Core::DocumentModel::editorsForOpenedDocuments()) { if (auto textEditor = qobject_cast(editor)) { TextEditorWidget *widget = textEditor->editorWidget(); widget->setRefactorMarkers(RefactorMarker::filterOutType(widget->refactorMarkers(), id())); widget->removeHoverHandler(&m_hoverHandler); } } for (const DocumentUri &uri : m_diagnostics.keys()) removeDiagnostics(uri); for (const DocumentUri &uri : m_highlights.keys()) { if (TextDocument *doc = TextDocument::textDocumentForFilePath(uri.toFilePath())) { if (TextEditor::SyntaxHighlighter *highlighter = doc->syntaxHighlighter()) highlighter->clearAllExtraFormats(); } } for (IAssistProcessor *processor : m_runningAssistProcessors) processor->setAsyncProposalAvailable(nullptr); updateEditorToolBar(m_openedDocument.keys()); } static ClientCapabilities generateClientCapabilities() { ClientCapabilities capabilities; WorkspaceClientCapabilities workspaceCapabilities; workspaceCapabilities.setWorkspaceFolders(true); workspaceCapabilities.setApplyEdit(true); DynamicRegistrationCapabilities allowDynamicRegistration; allowDynamicRegistration.setDynamicRegistration(true); workspaceCapabilities.setDidChangeConfiguration(allowDynamicRegistration); workspaceCapabilities.setExecuteCommand(allowDynamicRegistration); capabilities.setWorkspace(workspaceCapabilities); TextDocumentClientCapabilities documentCapabilities; TextDocumentClientCapabilities::SynchronizationCapabilities syncCapabilities; syncCapabilities.setDynamicRegistration(true); syncCapabilities.setWillSave(true); syncCapabilities.setWillSaveWaitUntil(false); syncCapabilities.setDidSave(true); documentCapabilities.setSynchronization(syncCapabilities); SymbolCapabilities symbolCapabilities; SymbolCapabilities::SymbolKindCapabilities symbolKindCapabilities; symbolKindCapabilities.setValueSet( {SymbolKind::File, SymbolKind::Module, SymbolKind::Namespace, SymbolKind::Package, SymbolKind::Class, SymbolKind::Method, SymbolKind::Property, SymbolKind::Field, SymbolKind::Constructor, SymbolKind::Enum, SymbolKind::Interface, SymbolKind::Function, SymbolKind::Variable, SymbolKind::Constant, SymbolKind::String, SymbolKind::Number, SymbolKind::Boolean, SymbolKind::Array, SymbolKind::Object, SymbolKind::Key, SymbolKind::Null, SymbolKind::EnumMember, SymbolKind::Struct, SymbolKind::Event, SymbolKind::Operator, SymbolKind::TypeParameter}); symbolCapabilities.setSymbolKind(symbolKindCapabilities); documentCapabilities.setDocumentSymbol(symbolCapabilities); TextDocumentClientCapabilities::SemanticHighlightingCapabilities semanticHighlight; semanticHighlight.setSemanticHighlighting(true); documentCapabilities.setSemanticHighlightingCapabilities(semanticHighlight); TextDocumentClientCapabilities::CompletionCapabilities completionCapabilities; completionCapabilities.setDynamicRegistration(true); TextDocumentClientCapabilities::CompletionCapabilities::CompletionItemKindCapabilities completionItemKindCapabilities; completionItemKindCapabilities.setValueSet( {CompletionItemKind::Text, CompletionItemKind::Method, CompletionItemKind::Function, CompletionItemKind::Constructor, CompletionItemKind::Field, CompletionItemKind::Variable, CompletionItemKind::Class, CompletionItemKind::Interface, CompletionItemKind::Module, CompletionItemKind::Property, CompletionItemKind::Unit, CompletionItemKind::Value, CompletionItemKind::Enum, CompletionItemKind::Keyword, CompletionItemKind::Snippet, CompletionItemKind::Color, CompletionItemKind::File, CompletionItemKind::Reference, CompletionItemKind::Folder, CompletionItemKind::EnumMember, CompletionItemKind::Constant, CompletionItemKind::Struct, CompletionItemKind::Event, CompletionItemKind::Operator, CompletionItemKind::TypeParameter}); completionCapabilities.setCompletionItemKind(completionItemKindCapabilities); TextDocumentClientCapabilities::CompletionCapabilities::CompletionItemCapbilities completionItemCapbilities; completionItemCapbilities.setSnippetSupport(false); completionItemCapbilities.setCommitCharacterSupport(true); completionCapabilities.setCompletionItem(completionItemCapbilities); documentCapabilities.setCompletion(completionCapabilities); TextDocumentClientCapabilities::CodeActionCapabilities codeActionCapabilities; TextDocumentClientCapabilities::CodeActionCapabilities::CodeActionLiteralSupport literalSupport; literalSupport.setCodeActionKind( TextDocumentClientCapabilities::CodeActionCapabilities::CodeActionLiteralSupport:: CodeActionKind(QList{"*"})); codeActionCapabilities.setCodeActionLiteralSupport(literalSupport); documentCapabilities.setCodeAction(codeActionCapabilities); TextDocumentClientCapabilities::HoverCapabilities hover; #if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0) hover.setContentFormat({MarkupKind::markdown, MarkupKind::plaintext}); #else hover.setContentFormat({MarkupKind::plaintext}); #endif hover.setDynamicRegistration(true); documentCapabilities.setHover(hover); TextDocumentClientCapabilities::RenameClientCapabilities rename; rename.setPrepareSupport(true); rename.setDynamicRegistration(true); documentCapabilities.setRename(rename); documentCapabilities.setReferences(allowDynamicRegistration); documentCapabilities.setDocumentHighlight(allowDynamicRegistration); documentCapabilities.setDefinition(allowDynamicRegistration); documentCapabilities.setTypeDefinition(allowDynamicRegistration); documentCapabilities.setImplementation(allowDynamicRegistration); capabilities.setTextDocument(documentCapabilities); return capabilities; } void Client::initialize() { using namespace ProjectExplorer; QTC_ASSERT(m_clientInterface, return); QTC_ASSERT(m_state == Uninitialized, return); qCDebug(LOGLSPCLIENT) << "initializing language server " << m_displayName; InitializeRequest initRequest; auto params = initRequest.params().value_or(InitializeParams()); params.setCapabilities(generateClientCapabilities()); params.setInitializationOptions(m_initializationOptions); if (m_project) { params.setRootUri(DocumentUri::fromFilePath(m_project->projectDirectory())); params.setWorkSpaceFolders(Utils::transform(SessionManager::projects(), [](Project *pro) { return WorkSpaceFolder(DocumentUri::fromFilePath(pro->projectDirectory()), pro->displayName()); })); } initRequest.setParams(params); initRequest.setResponseCallback([this](const InitializeRequest::Response &initResponse){ initializeCallback(initResponse); }); // directly send data otherwise the state check would fail; initRequest.registerResponseHandler(&m_responseHandlers); LanguageClientManager::logBaseMessage(LspLogMessage::ClientMessage, name(), initRequest.toBaseMessage()); m_clientInterface->sendMessage(initRequest.toBaseMessage()); m_state = InitializeRequested; } void Client::shutdown() { QTC_ASSERT(m_state == Initialized, emit finished(); return); qCDebug(LOGLSPCLIENT) << "shutdown language server " << m_displayName; ShutdownRequest shutdown; shutdown.setResponseCallback([this](const ShutdownRequest::Response &shutdownResponse){ shutDownCallback(shutdownResponse); }); sendContent(shutdown); m_state = ShutdownRequested; } Client::State Client::state() const { return m_state; } void Client::openDocument(TextEditor::TextDocument *document) { using namespace TextEditor; if (!isSupportedDocument(document)) return; m_openedDocument[document] = document->plainText(); if (m_state != Initialized) return; const FilePath &filePath = document->filePath(); const QString method(DidOpenTextDocumentNotification::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { if (!registered.value()) return; const TextDocumentRegistrationOptions option( m_dynamicCapabilities.option(method).toObject()); if (option.isValid(nullptr) && !option.filterApplies(filePath, Utils::mimeTypeForName(document->mimeType()))) { return; } } else if (Utils::optional _sync = m_serverCapabilities.textDocumentSync()) { if (auto options = Utils::get_if(&_sync.value())) { if (!options->openClose().value_or(true)) return; } } connect(document, &TextDocument::contentsChangedWithPosition, this, [this, document](int position, int charsRemoved, int charsAdded) { documentContentsChanged(document, position, charsRemoved, charsAdded); }); TextDocumentItem item; item.setLanguageId(TextDocumentItem::mimeTypeToLanguageId(document->mimeType())); item.setUri(DocumentUri::fromFilePath(filePath)); item.setText(document->plainText()); item.setVersion(document->document()->revision()); sendContent(DidOpenTextDocumentNotification(DidOpenTextDocumentParams(item))); const Client *currentClient = LanguageClientManager::clientForDocument(document); if (currentClient == this) // this is the active client for the document so directly activate it activateDocument(document); else if (currentClient == nullptr) // there is no client for this document so assign it to this server LanguageClientManager::openDocumentWithClient(document, this); } void Client::sendContent(const IContent &content) { QTC_ASSERT(m_clientInterface, return); QTC_ASSERT(m_state == Initialized, return); sendPostponedDocumentUpdates(); content.registerResponseHandler(&m_responseHandlers); QString error; if (!QTC_GUARD(content.isValid(&error))) Core::MessageManager::write(error); LanguageClientManager::logBaseMessage(LspLogMessage::ClientMessage, name(), content.toBaseMessage()); m_clientInterface->sendMessage(content.toBaseMessage()); } void Client::sendContent(const DocumentUri &uri, const IContent &content) { if (!Utils::anyOf(m_openedDocument.keys(), [uri](TextEditor::TextDocument *documnent) { return uri.toFilePath() == documnent->filePath(); })) { sendContent(content); } } void Client::cancelRequest(const MessageId &id) { m_responseHandlers.remove(id); sendContent(CancelRequest(CancelParameter(id))); } void Client::closeDocument(TextEditor::TextDocument *document) { deactivateDocument(document); const DocumentUri &uri = DocumentUri::fromFilePath(document->filePath()); m_highlights[uri].clear(); if (m_openedDocument.remove(document) != 0 && m_state == Initialized) { DidCloseTextDocumentParams params(TextDocumentIdentifier{uri}); sendContent(DidCloseTextDocumentNotification(params)); } } void Client::activateDocument(TextEditor::TextDocument *document) { auto uri = DocumentUri::fromFilePath(document->filePath()); showDiagnostics(uri); SemanticHighligtingSupport::applyHighlight(document, m_highlights.value(uri), capabilities()); // only replace the assist provider if the language server support it if (m_serverCapabilities.completionProvider()) { m_resetAssistProvider[document].completionAssistProvider = document->completionAssistProvider(); document->setCompletionAssistProvider(m_clientProviders.completionAssistProvider); } if (m_serverCapabilities.signatureHelpProvider()) { m_resetAssistProvider[document].functionHintProvider = document->functionHintAssistProvider(); document->setFunctionHintAssistProvider(m_clientProviders.functionHintProvider); } if (m_serverCapabilities.codeActionProvider()) { m_resetAssistProvider[document].quickFixAssistProvider = document->quickFixAssistProvider(); document->setQuickFixAssistProvider(m_clientProviders.quickFixAssistProvider); } document->setFormatter(new LanguageClientFormatter(document, this)); for (Core::IEditor *editor : Core::DocumentModel::editorsForDocument(document)) { updateEditorToolBar(editor); if (auto textEditor = qobject_cast(editor)) { textEditor->editorWidget()->addHoverHandler(&m_hoverHandler); if (symbolSupport().supportsRename(document)) { textEditor->editorWidget()->addOptionalActions( TextEditor::TextEditorActionHandler::RenameSymbol); } } } } void Client::deactivateDocument(TextEditor::TextDocument *document) { hideDiagnostics(document); resetAssistProviders(document); document->setFormatter(nullptr); if (m_serverCapabilities.semanticHighlighting().has_value()) { if (TextEditor::SyntaxHighlighter *highlighter = document->syntaxHighlighter()) highlighter->clearAllExtraFormats(); } for (Core::IEditor *editor : Core::DocumentModel::editorsForDocument(document)) { if (auto textEditor = qobject_cast(editor)) textEditor->editorWidget()->removeHoverHandler(&m_hoverHandler); } } bool Client::documentOpen(const TextEditor::TextDocument *document) const { return m_openedDocument.contains(const_cast(document)); } void Client::documentContentsSaved(TextEditor::TextDocument *document) { if (!m_openedDocument.contains(document)) return; bool sendMessage = true; bool includeText = false; const QString method(DidSaveTextDocumentNotification::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { sendMessage = registered.value(); if (sendMessage) { const TextDocumentSaveRegistrationOptions option( m_dynamicCapabilities.option(method).toObject()); if (option.isValid(nullptr)) { sendMessage = option.filterApplies(document->filePath(), Utils::mimeTypeForName(document->mimeType())); includeText = option.includeText().value_or(includeText); } } } else if (Utils::optional _sync = m_serverCapabilities.textDocumentSync()) { if (auto options = Utils::get_if(&_sync.value())) { if (Utils::optional saveOptions = options->save()) includeText = saveOptions.value().includeText().value_or(includeText); } } if (!sendMessage) return; DidSaveTextDocumentParams params( TextDocumentIdentifier(DocumentUri::fromFilePath(document->filePath()))); if (includeText) params.setText(document->plainText()); sendContent(DidSaveTextDocumentNotification(params)); } void Client::documentWillSave(Core::IDocument *document) { const FilePath &filePath = document->filePath(); auto textDocument = qobject_cast(document); if (!m_openedDocument.contains(textDocument)) return; bool sendMessage = true; const QString method(WillSaveTextDocumentNotification::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { sendMessage = registered.value(); if (sendMessage) { const TextDocumentRegistrationOptions option(m_dynamicCapabilities.option(method)); if (option.isValid(nullptr)) { sendMessage = option.filterApplies(filePath, Utils::mimeTypeForName(document->mimeType())); } } } else if (Utils::optional _sync = m_serverCapabilities.textDocumentSync()) { if (auto options = Utils::get_if(&_sync.value())) sendMessage = options->willSave().value_or(sendMessage); } if (!sendMessage) return; const WillSaveTextDocumentParams params( TextDocumentIdentifier(DocumentUri::fromFilePath(filePath))); sendContent(WillSaveTextDocumentNotification(params)); } void Client::documentContentsChanged(TextEditor::TextDocument *document, int position, int charsRemoved, int charsAdded) { if (!m_openedDocument.contains(document) || !reachable()) return; const QString method(DidChangeTextDocumentNotification::methodName); TextDocumentSyncKind syncKind = m_serverCapabilities.textDocumentSyncKindHelper(); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { syncKind = registered.value() ? TextDocumentSyncKind::None : TextDocumentSyncKind::Full; if (syncKind != TextDocumentSyncKind::None) { const TextDocumentChangeRegistrationOptions option( m_dynamicCapabilities.option(method).toObject()); syncKind = option.isValid(nullptr) ? option.syncKind() : syncKind; } } if (syncKind != TextDocumentSyncKind::None) { if (syncKind == TextDocumentSyncKind::Incremental) { DidChangeTextDocumentParams::TextDocumentContentChangeEvent change; QTextDocument oldDoc(m_openedDocument[document]); QTextCursor cursor(&oldDoc); // Workaround https://bugreports.qt.io/browse/QTBUG-80662 // The contentsChanged gives a character count that can be wrong for QTextCursor // when there are special characters removed/added (like formating characters). // Also, characterCount return the number of characters + 1 because of the hidden // paragraph separator character. // This implementation is based on QWidgetTextControlPrivate::_q_contentsChanged. // For charsAdded, textAt handles the case itself. cursor.setPosition(qMin(oldDoc.characterCount() - 1, position + charsRemoved)); cursor.setPosition(position, QTextCursor::KeepAnchor); change.setRange(Range(cursor)); change.setRangeLength(cursor.selectionEnd() - cursor.selectionStart()); change.setText(document->textAt(position, charsAdded)); m_documentsToUpdate[document] << change; } else { m_documentsToUpdate[document] = {document->plainText()}; } m_openedDocument[document] = document->plainText(); } using namespace TextEditor; for (BaseTextEditor *editor : BaseTextEditor::textEditorsForDocument(document)) { if (TextEditorWidget *widget = editor->editorWidget()) { widget->setRefactorMarkers( RefactorMarker::filterOutType(widget->refactorMarkers(), id())); } } m_documentUpdateTimer.start(); } void Client::registerCapabilities(const QList ®istrations) { m_dynamicCapabilities.registerCapability(registrations); } void Client::unregisterCapabilities(const QList &unregistrations) { m_dynamicCapabilities.unregisterCapability(unregistrations); } TextEditor::HighlightingResult createHighlightingResult(const SymbolInformation &info) { if (!info.isValid(nullptr)) return {}; const Position &start = info.location().range().start(); return TextEditor::HighlightingResult(start.line() + 1, start.character() + 1, info.name().length(), info.kind()); } void Client::cursorPositionChanged(TextEditor::TextEditorWidget *widget) { if (m_documentsToUpdate.contains(widget->textDocument())) return; // we are currently changing this document so postpone the DocumentHighlightsRequest const auto uri = DocumentUri::fromFilePath(widget->textDocument()->filePath()); if (m_dynamicCapabilities.isRegistered(DocumentHighlightsRequest::methodName).value_or(false)) { TextDocumentRegistrationOptions option( m_dynamicCapabilities.option(DocumentHighlightsRequest::methodName)); if (!option.filterApplies(widget->textDocument()->filePath())) return; } else if (!m_serverCapabilities.documentHighlightProvider().value_or(false)) { return; } auto runningRequest = m_highlightRequests.find(uri); if (runningRequest != m_highlightRequests.end()) cancelRequest(runningRequest.value()); DocumentHighlightsRequest request(TextDocumentPositionParams(uri, widget->textCursor())); request.setResponseCallback( [widget = QPointer(widget), this, uri] (DocumentHighlightsRequest::Response response) { m_highlightRequests.remove(uri); if (!widget) return; QList selections; const DocumentHighlightsResult result = response.result().value_or(DocumentHighlightsResult()); if (!holds_alternative>(result)) { widget->setExtraSelections(TextEditor::TextEditorWidget::CodeSemanticsSelection, selections); return; } const QTextCharFormat &format = widget->textDocument()->fontSettings().toTextCharFormat(TextEditor::C_OCCURRENCES); QTextDocument *document = widget->document(); for (const auto &highlight : get>(result)) { QTextEdit::ExtraSelection selection{widget->textCursor(), format}; const int &start = highlight.range().start().toPositionInDocument(document); const int &end = highlight.range().end().toPositionInDocument(document); if (start < 0 || end < 0) continue; selection.cursor.setPosition(start); selection.cursor.setPosition(end, QTextCursor::KeepAnchor); selections << selection; } widget->setExtraSelections(TextEditor::TextEditorWidget::CodeSemanticsSelection, selections); }); m_highlightRequests[uri] = request.id(); sendContent(request); } SymbolSupport &Client::symbolSupport() { return m_symbolSupport; } void Client::requestCodeActions(const DocumentUri &uri, const QList &diagnostics) { const Utils::FilePath fileName = uri.toFilePath(); TextEditor::TextDocument *doc = TextEditor::TextDocument::textDocumentForFilePath(fileName); if (!doc) return; CodeActionParams codeActionParams; CodeActionParams::CodeActionContext context; context.setDiagnostics(diagnostics); codeActionParams.setContext(context); codeActionParams.setTextDocument(uri); Position start(0, 0); const QTextBlock &lastBlock = doc->document()->lastBlock(); Position end(lastBlock.blockNumber(), lastBlock.length() - 1); codeActionParams.setRange(Range(start, end)); CodeActionRequest request(codeActionParams); request.setResponseCallback( [uri, self = QPointer(this)](const CodeActionRequest::Response &response) { if (self) self->handleCodeActionResponse(response, uri); }); requestCodeActions(request); } void Client::requestCodeActions(const CodeActionRequest &request) { if (!request.isValid(nullptr)) return; const Utils::FilePath fileName = request.params().value_or(CodeActionParams()).textDocument().uri().toFilePath(); const QString method(CodeActionRequest::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { if (!registered.value()) return; const TextDocumentRegistrationOptions option( m_dynamicCapabilities.option(method).toObject()); if (option.isValid(nullptr) && !option.filterApplies(fileName)) return; } else { Utils::variant provider = m_serverCapabilities.codeActionProvider().value_or(false); if (!(Utils::holds_alternative(provider) || Utils::get(provider))) return; } sendContent(request); } void Client::handleCodeActionResponse(const CodeActionRequest::Response &response, const DocumentUri &uri) { if (const Utils::optional &error = response.error()) log(*error); if (const Utils::optional &_result = response.result()) { const CodeActionResult &result = _result.value(); if (auto list = Utils::get_if>>(&result)) { for (const Utils::variant &item : *list) { if (auto action = Utils::get_if(&item)) updateCodeActionRefactoringMarker(this, *action, uri); else if (auto command = Utils::get_if(&item)) { Q_UNUSED(command) // todo } } } } } void Client::executeCommand(const Command &command) { using CommandOptions = LanguageServerProtocol::ServerCapabilities::ExecuteCommandOptions; const QString method(ExecuteCommandRequest::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { if (!registered.value()) return; const CommandOptions option(m_dynamicCapabilities.option(method).toObject()); if (option.isValid(nullptr) && !option.commands().isEmpty() && !option.commands().contains(command.command())) return; } else if (Utils::optional option = m_serverCapabilities.executeCommandProvider()) { if (option->isValid(nullptr) && !option->commands().isEmpty() && !option->commands().contains(command.command())) return; } else { return; } const ExecuteCommandRequest request((ExecuteCommandParams(command))); sendContent(request); } static const FormattingOptions formattingOptions(const TextEditor::TabSettings &settings) { FormattingOptions options; options.setTabSize(settings.m_tabSize); options.setInsertSpace(settings.m_tabPolicy == TextEditor::TabSettings::SpacesOnlyTabPolicy); return options; } template static void handleFormattingResponse(const DocumentUri &uri, const QPointer client, const FormattingResponse &response) { if (client) { if (const Utils::optional &error = response.error()) client->log(*error); } if (Utils::optional> result = response.result()) { if (!result->isNull()) { applyTextEdits(uri, result->toList()); } } } void Client::formatFile(const TextEditor::TextDocument *document) { if (!isSupportedDocument(document)) return; const FilePath &filePath = document->filePath(); const QString method(DocumentFormattingRequest::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { if (!registered.value()) return; const TextDocumentRegistrationOptions option( m_dynamicCapabilities.option(method).toObject()); if (option.isValid(nullptr) && !option.filterApplies(filePath, Utils::mimeTypeForName(document->mimeType()))) { return; } } else if (!m_serverCapabilities.documentFormattingProvider().value_or(false)) { return; } DocumentFormattingParams params; const DocumentUri uri = DocumentUri::fromFilePath(filePath); params.setTextDocument(uri); params.setOptions(formattingOptions(document->tabSettings())); DocumentFormattingRequest request(params); request.setResponseCallback( [uri, self = QPointer(this)](const DocumentFormattingRequest::Response &response) { handleFormattingResponse(uri, self, response); }); sendContent(request); } void Client::formatRange(const TextEditor::TextDocument *document, const QTextCursor &cursor) { if (!isSupportedDocument(document)) return; const FilePath &filePath = document->filePath(); const QString method(DocumentRangeFormattingRequest::methodName); if (Utils::optional registered = m_dynamicCapabilities.isRegistered(method)) { if (!registered.value()) return; const TextDocumentRegistrationOptions option( m_dynamicCapabilities.option(method).toObject()); if (option.isValid(nullptr) && !option.filterApplies(filePath, Utils::mimeTypeForName(document->mimeType()))) { return; } } else if (!m_serverCapabilities.documentRangeFormattingProvider().value_or(false)) { return; } DocumentRangeFormattingParams params; const DocumentUri uri = DocumentUri::fromFilePath(filePath); params.setTextDocument(uri); params.setOptions(formattingOptions(document->tabSettings())); if (!cursor.hasSelection()) { QTextCursor c = cursor; c.select(QTextCursor::LineUnderCursor); params.setRange(Range(c)); } else { params.setRange(Range(cursor)); } DocumentRangeFormattingRequest request(params); request.setResponseCallback([uri, self = QPointer(this)]( const DocumentRangeFormattingRequest::Response &response) { handleFormattingResponse(uri, self, response); }); sendContent(request); } const ProjectExplorer::Project *Client::project() const { return m_project; } void Client::setCurrentProject(ProjectExplorer::Project *project) { using namespace ProjectExplorer; if (m_project) disconnect(m_project, &Project::fileListChanged, this, &Client::projectFileListChanged); m_project = project; if (m_project) connect(m_project, &Project::fileListChanged, this, &Client::projectFileListChanged); } void Client::projectOpened(ProjectExplorer::Project *project) { if (!sendWorkspceFolderChanges()) return; WorkspaceFoldersChangeEvent event; event.setAdded({WorkSpaceFolder(DocumentUri::fromFilePath(project->projectDirectory()), project->displayName())}); DidChangeWorkspaceFoldersParams params; params.setEvent(event); DidChangeWorkspaceFoldersNotification change(params); sendContent(change); } void Client::projectClosed(ProjectExplorer::Project *project) { if (project == m_project) { if (m_state == Initialized) { shutdown(); } else { m_state = Shutdown; // otherwise the manager would try to restart this server emit finished(); } } if (!sendWorkspceFolderChanges()) return; WorkspaceFoldersChangeEvent event; event.setRemoved({WorkSpaceFolder(DocumentUri::fromFilePath(project->projectDirectory()), project->displayName())}); DidChangeWorkspaceFoldersParams params; params.setEvent(event); DidChangeWorkspaceFoldersNotification change(params); sendContent(change); } void Client::projectFileListChanged() { for (Core::IDocument *doc : Core::DocumentModel::openedDocuments()) { if (m_project->isKnownFile(doc->filePath())) { if (auto textDocument = qobject_cast(doc)) openDocument(textDocument); } } } void Client::setSupportedLanguage(const LanguageFilter &filter) { m_languagFilter = filter; } void Client::setInitializationOptions(const QJsonObject &initializationOptions) { m_initializationOptions = initializationOptions; } bool Client::isSupportedDocument(const TextEditor::TextDocument *document) const { QTC_ASSERT(document, return false); return m_languagFilter.isSupported(document); } bool Client::isSupportedFile(const Utils::FilePath &filePath, const QString &mimeType) const { return m_languagFilter.isSupported(filePath, mimeType); } bool Client::isSupportedUri(const DocumentUri &uri) const { return m_languagFilter.isSupported(uri.toFilePath(), Utils::mimeTypeForFile(uri.toFilePath().fileName()).name()); } void Client::addAssistProcessor(TextEditor::IAssistProcessor *processor) { m_runningAssistProcessors.insert(processor); } void Client::removeAssistProcessor(TextEditor::IAssistProcessor *processor) { m_runningAssistProcessors.remove(processor); } bool Client::needsRestart(const BaseSettings *settings) const { QTC_ASSERT(settings, return false); return m_languagFilter.mimeTypes != settings->m_languageFilter.mimeTypes || m_languagFilter.filePattern != settings->m_languageFilter.filePattern || m_initializationOptions != settings->initializationOptions(); } QList Client::diagnosticsAt(const DocumentUri &uri, const Range &range) const { QList diagnostics; for (const Diagnostic &diagnostic : m_diagnostics[uri]) { if (diagnostic.range().overlaps(range)) diagnostics << diagnostic; } return diagnostics; } bool Client::start() { return m_clientInterface->start(); } bool Client::reset() { if (!m_restartsLeft) return false; --m_restartsLeft; m_state = Uninitialized; m_responseHandlers.clear(); m_clientInterface->resetBuffer(); updateEditorToolBar(m_openedDocument.keys()); m_serverCapabilities = ServerCapabilities(); m_dynamicCapabilities.reset(); for (const DocumentUri &uri : m_diagnostics.keys()) removeDiagnostics(uri); for (TextEditor::TextDocument *document : m_openedDocument.keys()) document->disconnect(this); for (TextEditor::TextDocument *document : m_resetAssistProvider.keys()) resetAssistProviders(document); for (TextEditor::IAssistProcessor *processor : m_runningAssistProcessors) processor->setAsyncProposalAvailable(nullptr); m_runningAssistProcessors.clear(); return true; } void Client::setError(const QString &message) { log(message); m_state = Error; } void Client::handleMessage(const BaseMessage &message) { LanguageClientManager::logBaseMessage(LspLogMessage::ServerMessage, name(), message); if (auto handler = m_contentHandler[message.mimeType]) { QString parseError; handler(message.content, message.codec, parseError, [this](MessageId id, const QByteArray &content, QTextCodec *codec){ this->handleResponse(id, content, codec); }, [this](const QString &method, MessageId id, const IContent *content){ this->handleMethod(method, id, content); }); if (!parseError.isEmpty()) log(parseError); } else { log(tr("Cannot handle content of type: %1").arg(QLatin1String(message.mimeType))); } } void Client::log(const QString &message, Core::MessageManager::PrintToOutputPaneFlag flag) { Core::MessageManager::write(QString("LanguageClient %1: %2").arg(name(), message), flag); } void Client::showDiagnostics(Core::IDocument *doc) { showDiagnostics(DocumentUri::fromFilePath(doc->filePath())); } void Client::hideDiagnostics(TextEditor::TextDocument *doc) { if (!doc) return; qDeleteAll(Utils::filtered(doc->marks(), Utils::equal(&TextEditor::TextMark::category, id()))); } const ServerCapabilities &Client::capabilities() const { return m_serverCapabilities; } const DynamicCapabilities &Client::dynamicCapabilities() const { return m_dynamicCapabilities; } const BaseClientInterface *Client::clientInterface() const { return m_clientInterface.data(); } DocumentSymbolCache *Client::documentSymbolCache() { return &m_documentSymbolCache; } HoverHandler *Client::hoverHandler() { return &m_hoverHandler; } void Client::log(const ShowMessageParams &message, Core::MessageManager::PrintToOutputPaneFlag flag) { log(message.toString(), flag); } void Client::showMessageBox(const ShowMessageRequestParams &message, const MessageId &id) { auto box = new QMessageBox(); box->setText(message.toString()); box->setAttribute(Qt::WA_DeleteOnClose); switch (message.type()) { case Error: box->setIcon(QMessageBox::Critical); break; case Warning: box->setIcon(QMessageBox::Warning); break; case Info: box->setIcon(QMessageBox::Information); break; case Log: box->setIcon(QMessageBox::NoIcon); break; } QHash itemForButton; if (const Utils::optional> actions = message.actions()) { for (const MessageActionItem &action : actions.value()) itemForButton.insert(box->addButton(action.title(), QMessageBox::InvalidRole), action); } box->setModal(true); connect(box, &QMessageBox::finished, this, [=]{ ShowMessageRequest::Response response(id); const MessageActionItem &item = itemForButton.value(box->clickedButton()); response.setResult(item.isValid(nullptr) ? LanguageClientValue(item) : LanguageClientValue()); sendContent(response); }); box->show(); } static void addDiagnosticsSelections(const Diagnostic &diagnostic, QTextDocument *textDocument, QList &extraSelections) { QTextCursor cursor(textDocument); cursor.setPosition(::Utils::Text::positionInText(textDocument, diagnostic.range().start().line() + 1, diagnostic.range().start().character() + 1)); cursor.setPosition(::Utils::Text::positionInText(textDocument, diagnostic.range().end().line() + 1, diagnostic.range().end().character() + 1), QTextCursor::KeepAnchor); QTextCharFormat format; const TextEditor::FontSettings& fontSettings = TextEditor::TextEditorSettings::instance()->fontSettings(); DiagnosticSeverity severity = diagnostic.severity().value_or(DiagnosticSeverity::Warning); if (severity == DiagnosticSeverity::Error) { format = fontSettings.toTextCharFormat(TextEditor::C_ERROR); } else { format = fontSettings.toTextCharFormat(TextEditor::C_WARNING); } extraSelections.push_back(std::move(QTextEdit::ExtraSelection{cursor, format})); } void Client::showDiagnostics(const DocumentUri &uri) { const FilePath &filePath = uri.toFilePath(); if (TextEditor::TextDocument *doc = TextEditor::TextDocument::textDocumentForFilePath( filePath)) { QList extraSelections; for (const Diagnostic &diagnostic : m_diagnostics.value(uri)) { doc->addMark(new TextMark(filePath, diagnostic, id())); addDiagnosticsSelections(diagnostic, doc->document(), extraSelections); } for (Core::IEditor *editor : Core::DocumentModel::editorsForDocument(doc)) { if (auto textEditor = qobject_cast(editor)) { TextEditor::TextEditorWidget *widget = textEditor->editorWidget(); widget->setExtraSelections(TextEditor::TextEditorWidget::CodeWarningsSelection, extraSelections); } } } } void Client::removeDiagnostics(const DocumentUri &uri) { hideDiagnostics(TextEditor::TextDocument::textDocumentForFilePath(uri.toFilePath())); m_diagnostics.remove(uri); } void Client::resetAssistProviders(TextEditor::TextDocument *document) { const AssistProviders providers = m_resetAssistProvider.take(document); if (document->completionAssistProvider() == m_clientProviders.completionAssistProvider) document->setCompletionAssistProvider(providers.completionAssistProvider); if (document->functionHintAssistProvider() == m_clientProviders.functionHintProvider) document->setFunctionHintAssistProvider(providers.functionHintProvider); if (document->quickFixAssistProvider() == m_clientProviders.quickFixAssistProvider) document->setQuickFixAssistProvider(providers.quickFixAssistProvider); } void Client::sendPostponedDocumentUpdates() { m_documentUpdateTimer.stop(); if (m_documentsToUpdate.isEmpty()) return; TextEditor::TextEditorWidget *currentWidget = TextEditor::TextEditorWidget::currentTextEditorWidget(); const QList documents = m_documentsToUpdate.keys(); for (auto document : documents) { const auto uri = DocumentUri::fromFilePath(document->filePath()); m_highlights[uri].clear(); VersionedTextDocumentIdentifier docId(uri); docId.setVersion(document->document()->revision()); DidChangeTextDocumentParams params; params.setTextDocument(docId); params.setContentChanges(m_documentsToUpdate.take(document)); sendContent(DidChangeTextDocumentNotification(params)); emit documentUpdated(document); if (currentWidget && currentWidget->textDocument() == document) cursorPositionChanged(currentWidget); } } void Client::handleResponse(const MessageId &id, const QByteArray &content, QTextCodec *codec) { if (auto handler = m_responseHandlers[id]) handler(content, codec); } void Client::handleMethod(const QString &method, MessageId id, const IContent *content) { ErrorHierarchy error; auto logError = [&](const JsonObject &content) { log(QJsonDocument(content).toJson(QJsonDocument::Indented) + '\n' + tr("Invalid parameter in \"%1\": %2").arg(method, error.toString()), Core::MessageManager::Flash); }; if (method == PublishDiagnosticsNotification::methodName) { auto params = dynamic_cast(content)->params().value_or(PublishDiagnosticsParams()); if (params.isValid(&error)) handleDiagnostics(params); else logError(params); } else if (method == LogMessageNotification::methodName) { auto params = dynamic_cast(content)->params().value_or(LogMessageParams()); if (params.isValid(&error)) log(params, Core::MessageManager::Flash); else logError(params); } else if (method == SemanticHighlightNotification::methodName) { auto params = dynamic_cast(content)->params().value_or(SemanticHighlightingParams()); if (params.isValid(&error)) handleSemanticHighlight(params); else logError(params); } else if (method == ShowMessageNotification::methodName) { auto params = dynamic_cast(content)->params().value_or(ShowMessageParams()); if (params.isValid(&error)) log(params); else logError(params); } else if (method == ShowMessageRequest::methodName) { auto request = dynamic_cast(content); auto params = request->params().value_or(ShowMessageRequestParams()); if (params.isValid(&error)) { showMessageBox(params, request->id()); } else { ShowMessageRequest::Response response(request->id()); ResponseError error; const QString errorMessage = QString("Could not parse ShowMessageRequest parameter of '%1': \"%2\"") .arg(request->id().toString(), QString::fromUtf8(QJsonDocument(params).toJson())); error.setMessage(errorMessage); response.setError(error); sendContent(response); } } else if (method == RegisterCapabilityRequest::methodName) { auto params = dynamic_cast(content)->params().value_or(RegistrationParams()); if (params.isValid(&error)) m_dynamicCapabilities.registerCapability(params.registrations()); else logError(params); } else if (method == UnregisterCapabilityRequest::methodName) { auto params = dynamic_cast(content)->params().value_or(UnregistrationParams()); if (params.isValid(&error)) m_dynamicCapabilities.unregisterCapability(params.unregistrations()); else logError(params); } else if (method == ApplyWorkspaceEditRequest::methodName) { auto params = dynamic_cast(content)->params().value_or(ApplyWorkspaceEditParams()); if (params.isValid(&error)) applyWorkspaceEdit(params.edit()); else logError(params); } else if (method == WorkSpaceFolderRequest::methodName) { WorkSpaceFolderRequest::Response response(dynamic_cast(content)->id()); const QList projects = ProjectExplorer::SessionManager::projects(); WorkSpaceFolderResult result; if (projects.isEmpty()) { result = nullptr; } else { result = Utils::transform(projects, [](ProjectExplorer::Project *project) { return WorkSpaceFolder(DocumentUri::fromFilePath(project->projectDirectory()), project->displayName()); }); } response.setResult(result); sendContent(response); } else if (id.isValid(&error)) { Response response(id); ResponseError error; error.setCode(ResponseError::MethodNotFound); response.setError(error); sendContent(response); } delete content; } void Client::handleDiagnostics(const PublishDiagnosticsParams ¶ms) { const DocumentUri &uri = params.uri(); removeDiagnostics(uri); const QList &diagnostics = params.diagnostics(); m_diagnostics[uri] = diagnostics; if (LanguageClientManager::clientForUri(uri) == this) { showDiagnostics(uri); requestCodeActions(uri, diagnostics); } } void Client::handleSemanticHighlight(const SemanticHighlightingParams ¶ms) { DocumentUri uri; LanguageClientValue version; auto textDocument = params.textDocument(); if (Utils::holds_alternative(textDocument)) { uri = Utils::get(textDocument).uri(); version = Utils::get(textDocument).version(); } else { uri = Utils::get(textDocument).uri(); } m_highlights[uri].clear(); TextEditor::TextDocument *doc = TextEditor::TextDocument::textDocumentForFilePath( uri.toFilePath()); if (!doc || LanguageClientManager::clientForDocument(doc) != this || (!version.isNull() && doc->document()->revision() != version.value())) { return; } const TextEditor::HighlightingResults results = SemanticHighligtingSupport::generateResults( params.lines()); m_highlights[uri] = results; SemanticHighligtingSupport::applyHighlight(doc, results, capabilities()); } void Client::rehighlight() { using namespace TextEditor; for (auto it = m_highlights.begin(), end = m_highlights.end(); it != end; ++it) { if (TextDocument *doc = TextDocument::textDocumentForFilePath(it.key().toFilePath())) { if (LanguageClientManager::clientForDocument(doc) == this) SemanticHighligtingSupport::applyHighlight(doc, it.value(), capabilities()); } } } bool Client::documentUpdatePostponed(const QString &fileName) const { return Utils::contains(m_documentsToUpdate.keys(), [fileName](const TextEditor::TextDocument *doc) { return doc->filePath() == Utils::FilePath::fromString(fileName); }); } void Client::initializeCallback(const InitializeRequest::Response &initResponse) { QTC_ASSERT(m_state == InitializeRequested, return); if (optional> error = initResponse.error()) { if (error.value().data().has_value() && error.value().data().value().retry().value_or(false)) { const QString title(tr("Language Server \"%1\" Initialize Error").arg(m_displayName)); auto result = QMessageBox::warning(Core::ICore::dialogParent(), title, error.value().message(), QMessageBox::Retry | QMessageBox::Cancel, QMessageBox::Retry); if (result == QMessageBox::Retry) { m_state = Uninitialized; initialize(); return; } } setError(tr("Initialize error: ") + error.value().message()); emit finished(); return; } const optional &_result = initResponse.result(); if (!_result.has_value()) {// continue on ill formed result log(tr("No initialize result.")); } else { const InitializeResult &result = _result.value(); ErrorHierarchy error; if (!result.isValid(&error)) { // continue on ill formed result log(QJsonDocument(result).toJson(QJsonDocument::Indented) + '\n' + tr("Initialize result is not valid: ") + error.toString()); } m_serverCapabilities = result.capabilities().value_or(ServerCapabilities()); } if (auto completionProvider = qobject_cast( m_clientProviders.completionAssistProvider)) { completionProvider->setTriggerCharacters( m_serverCapabilities.completionProvider() .value_or(ServerCapabilities::CompletionOptions()) .triggerCharacters() .value_or(QList())); } if (auto functionHintAssistProvider = qobject_cast( m_clientProviders.functionHintProvider)) { functionHintAssistProvider->setTriggerCharacters( m_serverCapabilities.signatureHelpProvider() .value_or(ServerCapabilities::SignatureHelpOptions()) .triggerCharacters() .value_or(QList())); } qCDebug(LOGLSPCLIENT) << "language server " << m_displayName << " initialized"; m_state = Initialized; sendContent(InitializeNotification()); if (m_dynamicCapabilities.isRegistered(DocumentSymbolsRequest::methodName) .value_or(capabilities().documentSymbolProvider().value_or(false))) { TextEditor::IOutlineWidgetFactory::updateOutline(); } for (TextEditor::TextDocument *document : m_openedDocument.keys()) openDocument(document); emit initialized(m_serverCapabilities); } void Client::shutDownCallback(const ShutdownRequest::Response &shutdownResponse) { QTC_ASSERT(m_state == ShutdownRequested, return); QTC_ASSERT(m_clientInterface, return); optional errorValue = shutdownResponse.error(); if (errorValue.has_value()) { ShutdownRequest::Response::Error error = errorValue.value(); qDebug() << error; return; } // directly send data otherwise the state check would fail; m_clientInterface->sendMessage(ExitNotification().toBaseMessage()); qCDebug(LOGLSPCLIENT) << "language server " << m_displayName << " shutdown"; m_state = Shutdown; } bool Client::sendWorkspceFolderChanges() const { if (m_dynamicCapabilities.isRegistered( DidChangeWorkspaceFoldersNotification::methodName).value_or(false)) { return true; } if (auto workspace = m_serverCapabilities.workspace()) { if (auto folder = workspace.value().workspaceFolders()) { if (folder.value().supported().value_or(false)) { // holds either the Id for deregistration or whether it is registered auto notification = folder.value().changeNotifications().value_or(false); return holds_alternative(notification) || (holds_alternative(notification) && get(notification)); } } } return false; } } // namespace LanguageClient