/**************************************************************************** ** ** 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 "languageclientutils.h" #include "languageclientplugin.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace LanguageServerProtocol; namespace LanguageClient { static LanguageClientManager *managerInstance = nullptr; LanguageClientManager::LanguageClientManager(QObject *parent) : QObject (parent) { using namespace Core; using namespace ProjectExplorer; JsonRpcMessageHandler::registerMessageProvider(); JsonRpcMessageHandler::registerMessageProvider(); JsonRpcMessageHandler::registerMessageProvider(); JsonRpcMessageHandler::registerMessageProvider(); JsonRpcMessageHandler::registerMessageProvider(); JsonRpcMessageHandler::registerMessageProvider(); connect(EditorManager::instance(), &EditorManager::editorOpened, this, &LanguageClientManager::editorOpened); connect(EditorManager::instance(), &EditorManager::documentOpened, this, &LanguageClientManager::documentOpened); connect(EditorManager::instance(), &EditorManager::documentClosed, this, &LanguageClientManager::documentClosed); connect(EditorManager::instance(), &EditorManager::saved, this, &LanguageClientManager::documentContentsSaved); connect(EditorManager::instance(), &EditorManager::aboutToSave, this, &LanguageClientManager::documentWillSave); connect(SessionManager::instance(), &SessionManager::projectAdded, this, &LanguageClientManager::projectAdded); connect(SessionManager::instance(), &SessionManager::projectRemoved, this, &LanguageClientManager::projectRemoved); } LanguageClientManager::~LanguageClientManager() { QTC_ASSERT(m_clients.isEmpty(), qDeleteAll(m_clients)); qDeleteAll(m_currentSettings); managerInstance = nullptr; } void LanguageClientManager::init() { if (managerInstance) return; QTC_ASSERT(LanguageClientPlugin::instance(), return); managerInstance = new LanguageClientManager(LanguageClientPlugin::instance()); } void LanguageClientManager::startClient(Client *client) { QTC_ASSERT(managerInstance, return); QTC_ASSERT(client, return); if (managerInstance->m_shuttingDown) { managerInstance->clientFinished(client); return; } if (!managerInstance->m_clients.contains(client)) managerInstance->m_clients.append(client); connect(client, &Client::finished, managerInstance, [client](){ managerInstance->clientFinished(client); }); if (client->start()) client->initialize(); else managerInstance->clientFinished(client); } QVector LanguageClientManager::clients() { QTC_ASSERT(managerInstance, return {}); return managerInstance->m_clients; } void LanguageClientManager::addExclusiveRequest(const MessageId &id, Client *client) { QTC_ASSERT(managerInstance, return); managerInstance->m_exclusiveRequests[id] << client; } void LanguageClientManager::reportFinished(const MessageId &id, Client *byClient) { QTC_ASSERT(managerInstance, return); for (Client *client : managerInstance->m_exclusiveRequests[id]) { if (client != byClient) client->cancelRequest(id); } managerInstance->m_exclusiveRequests.remove(id); } void LanguageClientManager::deleteClient(Client *client) { QTC_ASSERT(managerInstance, return); QTC_ASSERT(client, return); client->disconnect(); managerInstance->m_clients.removeAll(client); if (managerInstance->m_shuttingDown) delete client; else client->deleteLater(); } void LanguageClientManager::shutdown() { QTC_ASSERT(managerInstance, return); if (managerInstance->m_shuttingDown) return; managerInstance->m_shuttingDown = true; for (auto interface : managerInstance->m_clients) { if (interface->reachable()) interface->shutdown(); else deleteClient(interface); } QTimer::singleShot(3000, managerInstance, [](){ for (auto interface : managerInstance->m_clients) deleteClient(interface); emit managerInstance->shutdownFinished(); }); } LanguageClientManager *LanguageClientManager::instance() { return managerInstance; } QList LanguageClientManager::clientsSupportingDocument( const TextEditor::TextDocument *doc) { QTC_ASSERT(managerInstance, return {}); QTC_ASSERT(doc, return {};); return Utils::filtered(managerInstance->reachableClients(), [doc](Client *client) { return client->isSupportedDocument(doc); }).toList(); } void LanguageClientManager::applySettings() { QTC_ASSERT(instance(), return); qDeleteAll(instance()->m_currentSettings); instance()->m_currentSettings = Utils::transform(LanguageClientSettings::currentPageSettings(), [](BaseSettings *settings) { return settings->copy(); }); LanguageClientSettings::toSettings(Core::ICore::settings(), instance()->m_currentSettings); const QList restarts = Utils::filtered(LanguageClientManager::currentSettings(), &BaseSettings::needsRestart); for (BaseSettings *setting : restarts) { if (auto client = setting->m_client) { if (client->reachable()) client->shutdown(); else deleteClient(client); } if (setting->isValid() && setting->m_enabled) { const bool start = setting->m_alwaysOn || Utils::anyOf(Core::DocumentModel::openedDocuments(), [filter = setting->m_languageFilter]( Core::IDocument *doc) { return filter.isSupported(doc); }); if (start) setting->startClient(); } } } QList LanguageClientManager::currentSettings() { QTC_ASSERT(instance(), return {}); return instance()->m_currentSettings; } QVector LanguageClientManager::reachableClients() { return Utils::filtered(m_clients, &Client::reachable); } static void sendToInterfaces(const IContent &content, const QVector &interfaces) { for (Client *interface : interfaces) interface->sendContent(content); } void LanguageClientManager::sendToAllReachableServers(const IContent &content) { sendToInterfaces(content, reachableClients()); } void LanguageClientManager::clientFinished(Client *client) { constexpr int restartTimeoutS = 5; const bool unexpectedFinish = client->state() != Client::Shutdown && client->state() != Client::ShutdownRequested; if (unexpectedFinish && !m_shuttingDown && client->reset()) { client->disconnect(this); client->log(tr("Unexpectedly finished. Restarting in %1 seconds.").arg(restartTimeoutS), Core::MessageManager::Flash); QTimer::singleShot(restartTimeoutS * 1000, client, [client](){ startClient(client); }); } else { if (unexpectedFinish && !m_shuttingDown) client->log(tr("Unexpectedly finished."), Core::MessageManager::Flash); deleteClient(client); if (m_shuttingDown && m_clients.isEmpty()) emit shutdownFinished(); } } void LanguageClientManager::editorOpened(Core::IEditor *editor) { using namespace TextEditor; if (auto *textEditor = qobject_cast(editor)) { if (TextEditorWidget *widget = textEditor->editorWidget()) { connect(widget, &TextEditorWidget::requestLinkAt, this, [this, filePath = editor->document()->filePath()] (const QTextCursor &cursor, Utils::ProcessLinkCallback &callback) { findLinkAt(filePath, cursor, callback); }); connect(widget, &TextEditorWidget::requestUsages, this, [this, filePath = editor->document()->filePath()] (const QTextCursor &cursor){ findUsages(filePath, cursor); }); connect(widget, &TextEditorWidget::cursorPositionChanged, this, [this, widget](){ // TODO This would better be a compressing timer QTimer::singleShot(50, this, [this, widget = QPointer(widget)]() { if (widget) { for (Client *client : this->reachableClients()) { if (client->isSupportedDocument(widget->textDocument())) client->cursorPositionChanged(widget); } } }); }); updateEditorToolBar(editor); } } } void LanguageClientManager::documentOpened(Core::IDocument *document) { for (BaseSettings *setting : LanguageClientSettings::currentPageSettings()) { if (setting->m_client.isNull() && setting->m_languageFilter.isSupported(document)) setting->startClient(); } for (Client *interface : reachableClients()) interface->openDocument(document); } void LanguageClientManager::documentClosed(Core::IDocument *document) { const DidCloseTextDocumentParams params( TextDocumentIdentifier(DocumentUri::fromFileName(document->filePath()))); for (Client *interface : reachableClients()) interface->closeDocument(params); } void LanguageClientManager::documentContentsSaved(Core::IDocument *document) { for (Client *interface : reachableClients()) interface->documentContentsSaved(document); } void LanguageClientManager::documentWillSave(Core::IDocument *document) { for (Client *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 GotoDefinitionRequest::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 (Client *interface : reachableClients()) { if (interface->findLinkAt(request)) m_exclusiveRequests[request.id()] << interface; } } QList generateSearchResultItems(const LanguageClientArray &locations) { auto convertPosition = [](const Position &pos){ return Core::Search::TextPosition(pos.line() + 1, pos.character()); }; auto convertRange = [convertPosition](const Range &range){ return Core::Search::TextRange(convertPosition(range.start()), convertPosition(range.end())); }; QList result; if (locations.isNull()) return result; QMap> rangesInDocument; for (const Location &location : locations.toList()) rangesInDocument[location.uri().toFileName().toString()] << convertRange(location.range()); for (auto it = rangesInDocument.begin(); it != rangesInDocument.end(); ++it) { const QString &fileName = it.key(); QFile file(fileName); file.open(QFile::ReadOnly); Core::SearchResultItem item; item.path = QStringList() << fileName; item.useTextEditorFont = true; QStringList lines = QString::fromLocal8Bit(file.readAll()).split(QChar::LineFeed); for (const Core::Search::TextRange &range : it.value()) { item.mainRange = range; if (file.isOpen() && range.begin.line > 0 && range.begin.line <= lines.size()) item.text = lines[range.begin.line - 1]; else item.text.clear(); result << item; } } return result; } void LanguageClientManager::findUsages(const Utils::FileName &filePath, const QTextCursor &cursor) { const DocumentUri uri = DocumentUri::fromFileName(filePath); const TextDocumentIdentifier document(uri); const Position pos(cursor); QTextCursor termCursor(cursor); termCursor.select(QTextCursor::WordUnderCursor); ReferenceParams params(TextDocumentPositionParams(document, pos)); params.setContext(ReferenceParams::ReferenceContext(true)); FindReferencesRequest request(params); auto callback = [wordUnderCursor = termCursor.selectedText()] (const QString &clientName, const FindReferencesRequest::Response &response){ if (auto result = response.result()) { Core::SearchResult *search = Core::SearchResultWindow::instance()->startNewSearch( tr("Find References with %1 for:").arg(clientName), "", wordUnderCursor); search->addResults(generateSearchResultItems(result.value()), Core::SearchResult::AddOrdered); QObject::connect(search, &Core::SearchResult::activated, [](const Core::SearchResultItem& item) { Core::EditorManager::openEditorAtSearchResult(item); }); search->finishSearch(false); search->popup(); } }; for (Client *client : reachableClients()) { request.setResponseCallback([callback, clientName = client->name()] (const FindReferencesRequest::Response &response){ callback(clientName, response); }); if (client->findUsages(request)) m_exclusiveRequests[request.id()] << client; } } void LanguageClientManager::projectAdded(ProjectExplorer::Project *project) { for (Client *interface : reachableClients()) interface->projectOpened(project); } void LanguageClientManager::projectRemoved(ProjectExplorer::Project *project) { for (Client *interface : reachableClients()) interface->projectClosed(project); } } // namespace LanguageClient