/**************************************************************************** ** ** 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 "languageclientmanager.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace LanguageServerProtocol; namespace LanguageClient { static LanguageClientManager *managerInstance = nullptr; class LanguageClientMark : public TextEditor::TextMark { public: LanguageClientMark(const Utils::FileName &fileName, const Diagnostic &diag) : TextEditor::TextMark(fileName, diag.range().start().line() + 1, "lspmark") { 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()); } void removedFromEditor() override { LanguageClientManager::removeMark(this); } }; LanguageClientManager::LanguageClientManager() { JsonRpcMessageHandler::registerMessageProvider("textDocument/publishDiagnostics", [](const QJsonObject &object){ return new PublishDiagnosticsNotification(object); }); JsonRpcMessageHandler::registerMessageProvider(LogMessageNotification::methodName, [](const QJsonObject &object){ return new LogMessageNotification(object); }); managerInstance = this; } LanguageClientManager::~LanguageClientManager() { for (auto interface : Utils::filtered(m_clients, &BaseClient::reachable)) interface->shutdown(); } void LanguageClientManager::init() { using namespace Core; using namespace ProjectExplorer; QTC_ASSERT(managerInstance, return); connect(EditorManager::instance(), &EditorManager::editorOpened, managerInstance, &LanguageClientManager::editorOpened); connect(EditorManager::instance(), &EditorManager::editorsClosed, managerInstance, &LanguageClientManager::editorsClosed); connect(EditorManager::instance(), &EditorManager::saved, managerInstance, &LanguageClientManager::documentContentsSaved); connect(EditorManager::instance(), &EditorManager::aboutToSave, managerInstance, &LanguageClientManager::documentWillSave); connect(SessionManager::instance(), &SessionManager::projectAdded, managerInstance, &LanguageClientManager::projectAdded); connect(SessionManager::instance(), &SessionManager::projectRemoved, managerInstance, &LanguageClientManager::projectRemoved); } void LanguageClientManager::publishDiagnostics(const Core::Id &id, const PublishDiagnosticsParams ¶ms) { const Utils::FileName filePath = params.uri().toFileName(); auto doc = qobject_cast( Core::DocumentModel::documentForFilePath(filePath.toString())); if (!doc) return; removeMarks(filePath, id); managerInstance->m_marks[filePath][id].reserve(params.diagnostics().size()); for (const Diagnostic& diagnostic : params.diagnostics()) { auto mark = new LanguageClientMark(filePath, diagnostic); managerInstance->m_marks[filePath][id].append(mark); doc->addMark(mark); } } void LanguageClientManager::removeMark(LanguageClientMark *mark) { for (auto &marks : managerInstance->m_marks[mark->fileName()]) marks.removeAll(mark); delete mark; } void LanguageClientManager::removeMarks(const Utils::FileName &fileName) { auto doc = qobject_cast( Core::DocumentModel::documentForFilePath(fileName.toString())); if (!doc) return; for (auto marks : managerInstance->m_marks[fileName]) { for (TextEditor::TextMark *mark : marks) { doc->removeMark(mark); delete mark; } } managerInstance->m_marks[fileName].clear(); } void LanguageClientManager::removeMarks(const Utils::FileName &fileName, const Core::Id &id) { auto doc = qobject_cast( Core::DocumentModel::documentForFilePath(fileName.toString())); if (!doc) return; for (TextEditor::TextMark *mark : managerInstance->m_marks[fileName][id]) { doc->removeMark(mark); delete mark; } managerInstance->m_marks[fileName][id].clear(); } void LanguageClientManager::removeMarks(const Core::Id &id) { for (const Utils::FileName &fileName : managerInstance->m_marks.keys()) removeMarks(fileName, id); } void LanguageClientManager::startClient(LanguageClientSettings setting) { auto client = new StdIOClient(setting.m_executable, setting.m_arguments); client->setName(setting.m_name); if (setting.m_mimeType != noLanguageFilter) client->setSupportedMimeType({setting.m_mimeType}); startClient(client); } void LanguageClientManager::startClient(BaseClient *client) { managerInstance->m_clients.append(client); connect(client, &BaseClient::finished, managerInstance, [client](){ managerInstance->clientFinished(client); }); if (client->start()) client->initialize(); else managerInstance->clientFinished(client); } QVector LanguageClientManager::clients() { return managerInstance->m_clients; } void LanguageClientManager::addExclusiveRequest(const MessageId &id, BaseClient *client) { managerInstance->m_exclusiveRequests[id] << client; } void LanguageClientManager::reportFinished(const MessageId &id, BaseClient *byClient) { for (BaseClient *client : managerInstance->m_exclusiveRequests[id]) { if (client != byClient) client->cancelRequest(id); } managerInstance->m_exclusiveRequests.remove(id); } QVector LanguageClientManager::reachableClients() { return Utils::filtered(m_clients, &BaseClient::reachable); } static void sendToInterfaces(const IContent &content, const QVector &interfaces) { for (BaseClient *interface : interfaces) interface->sendContent(content); } void LanguageClientManager::sendToAllReachableServers(const IContent &content) { sendToInterfaces(content, reachableClients()); } void LanguageClientManager::clientFinished(BaseClient *client) { constexpr int restartTimeoutS = 5; const bool unexpectedFinish = client->state() != BaseClient::Shutdown && client->state() != BaseClient::ShutdownRequested; managerInstance->removeMarks(client->id()); managerInstance->m_clients.removeAll(client); if (unexpectedFinish) { client->disconnect(managerInstance); client->log(tr("Unexpectedly finished. Restarting in %1 seconds.").arg(restartTimeoutS), Core::MessageManager::Flash); client->reset(); QTimer::singleShot(restartTimeoutS * 1000, this, [client](){ startClient(client); }); } else { delete client; } } void LanguageClientManager::editorOpened(Core::IEditor *iEditor) { using namespace TextEditor; Core::IDocument *document = iEditor->document(); for (BaseClient *interface : reachableClients()) interface->openDocument(document); if (auto textDocument = qobject_cast(document)) { if (BaseTextEditor *editor = BaseTextEditor::textEditorForDocument(textDocument)) { if (TextEditorWidget *widget = editor->editorWidget()) { connect(widget, &TextEditorWidget::requestLinkAt, this, [this, filePath = document->filePath()] (const QTextCursor &cursor, Utils::ProcessLinkCallback &callback){ findLinkAt(filePath, cursor, callback); }); } } } } void LanguageClientManager::editorsClosed(const QList editors) { for (auto iEditor : editors) { if (auto editor = qobject_cast(iEditor)) { removeMarks(editor->document()->filePath()); const DidCloseTextDocumentParams params(TextDocumentIdentifier( DocumentUri::fromFileName(editor->document()->filePath()))); for (BaseClient *interface : reachableClients()) interface->closeDocument(params); } } } void LanguageClientManager::documentContentsSaved(Core::IDocument *document) { for (BaseClient *interface : reachableClients()) interface->documentContentsSaved(document); } void LanguageClientManager::documentWillSave(Core::IDocument *document) { for (BaseClient *interface : reachableClients()) interface->documentContentsSaved(document); } void LanguageClientManager::findLinkAt(const Utils::FileName &filePath, const QTextCursor &cursor, Utils::ProcessLinkCallback callback) { const DocumentUri uri = DocumentUri::fromFileName(filePath); const TextDocumentIdentifier document(uri); const Position pos(cursor); TextDocumentPositionParams params(document, pos); GotoDefinitionRequest request(params); request.setResponseCallback([callback](const Response &response){ if (Utils::optional _result = response.result()) { const GotoResult result = _result.value(); if (Utils::holds_alternative(result)) return; if (auto ploc = Utils::get_if(&result)) { callback(ploc->toLink()); } else if (auto plloc = Utils::get_if>(&result)) { if (!plloc->isEmpty()) callback(plloc->value(0).toLink()); } } }); for (BaseClient *interface : reachableClients()) { if (interface->findLinkAt(request)) m_exclusiveRequests[request.id()] << interface; } } void LanguageClientManager::projectAdded(ProjectExplorer::Project *project) { for (BaseClient *interface : reachableClients()) interface->projectOpened(project); } void LanguageClientManager::projectRemoved(ProjectExplorer::Project *project) { for (BaseClient *interface : reachableClients()) interface->projectClosed(project); } } // namespace LanguageClient