Files
qt-creator/src/plugins/languageclient/languageclientmanager.h
David Schulz 1c05237820 LanguageClient: prevent accessing freed data on shutdown
Change-Id: I0d6e7abd653acb2ab7409a9cd5e58a2df3b1f259
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-09-22 10:07:53 +00:00

124 lines
4.4 KiB
C++

// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#pragma once
#include "client.h"
#include "languageclient_global.h"
#include "languageclientsettings.h"
#include "locatorfilter.h"
#include "lspinspector.h"
#include <utils/algorithm.h>
#include <utils/id.h>
#include <languageserverprotocol/diagnostics.h>
#include <languageserverprotocol/languagefeatures.h>
#include <languageserverprotocol/textsynchronization.h>
namespace Core {
class IEditor;
class IDocument;
}
namespace ProjectExplorer { class Project; }
namespace LanguageClient {
class LanguageClientMark;
class LANGUAGECLIENT_EXPORT LanguageClientManager : public QObject
{
Q_OBJECT
public:
LanguageClientManager(const LanguageClientManager &other) = delete;
LanguageClientManager(LanguageClientManager &&other) = delete;
~LanguageClientManager() override;
static void init();
static void clientStarted(Client *client);
static void clientFinished(Client *client);
static Client *startClient(const BaseSettings *setting, ProjectExplorer::Project *project = nullptr);
static const QList<Client *> clients();
static void addClient(Client *client);
static void addExclusiveRequest(const LanguageServerProtocol::MessageId &id, Client *client);
static void reportFinished(const LanguageServerProtocol::MessageId &id, Client *byClient);
static void shutdownClient(Client *client);
static void deleteClient(Client *client);
static void shutdown();
static bool isShuttingDown();
static LanguageClientManager *instance();
static QList<Client *> clientsSupportingDocument(const TextEditor::TextDocument *doc);
static void applySettings();
static QList<BaseSettings *> currentSettings();
static void registerClientSettings(BaseSettings *settings);
static void enableClientSettings(const QString &settingsId, bool enable = true);
static QList<Client *> clientsForSetting(const BaseSettings *setting);
static const BaseSettings *settingForClient(Client *setting);
static Client *clientForDocument(TextEditor::TextDocument *document);
static Client *clientForFilePath(const Utils::FilePath &filePath);
static Client *clientForUri(const LanguageServerProtocol::DocumentUri &uri);
static const QList<Client *> clientsForProject(const ProjectExplorer::Project *project);
template<typename T> static bool hasClients();
///
/// \brief openDocumentWithClient
/// makes sure the document is opened and activated with the client and
/// deactivates the document for a potential previous active client
///
static void openDocumentWithClient(TextEditor::TextDocument *document, Client *client);
static void logJsonRpcMessage(const LspLogMessage::MessageSender sender,
const QString &clientName,
const LanguageServerProtocol::JsonRpcMessage &message);
static void showInspector();
signals:
void clientAdded(Client *client);
void clientRemoved(Client *client);
void shutdownFinished();
private:
LanguageClientManager(QObject *parent);
void editorOpened(Core::IEditor *editor);
void documentOpened(Core::IDocument *document);
void documentClosed(Core::IDocument *document);
void documentContentsSaved(Core::IDocument *document);
void documentWillSave(Core::IDocument *document);
void updateProject(ProjectExplorer::Project *project);
void projectAdded(ProjectExplorer::Project *project);
QList<Client *> reachableClients();
bool m_shuttingDown = false;
QList<Client *> m_clients;
QList<BaseSettings *> m_currentSettings; // owned
QMap<QString, QList<Client *>> m_clientsForSetting;
QHash<TextEditor::TextDocument *, QPointer<Client>> m_clientForDocument;
QHash<LanguageServerProtocol::MessageId, QList<Client *>> m_exclusiveRequests;
DocumentLocatorFilter m_currentDocumentLocatorFilter;
WorkspaceLocatorFilter m_workspaceLocatorFilter;
WorkspaceClassLocatorFilter m_workspaceClassLocatorFilter;
WorkspaceMethodLocatorFilter m_workspaceMethodLocatorFilter;
LspInspector m_inspector;
};
template<typename T> bool LanguageClientManager::hasClients()
{
return Utils::contains(instance()->m_clients, [](const Client *c) {
return qobject_cast<const T* >(c);
});
}
} // namespace LanguageClient