forked from qt-creator/qt-creator
205fb14a43
1. Rename ClientRequestTaskAdapter into
WorkspaceSymbolRequestTaskAdapter as it's adapting
the WorkspaceSymbolRequestTask, not the general
ClientRequestTask.
2. Rename the registered name inside Tasking namespace
into SymbolRequest, as WorkspaceSymbolRequest
may collide with the class defined inside workspace.h
header. We also aim for rather short names inside
Tasking namespace in order to not to be too verbose.
3. Register the adapter with QTC_DECLARE_CUSTOM_TASK,
not the task itself.
4. Fix isRunning() assert inside start().
5. Drop check for Client::locatorsEnabled() inside
preStartCheck(), as that's being done beforehand
when needed.
Amends 8e9b893325
Change-Id: I7cef290e18d5d86b48aa17d548a058bf35fd31ec
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: David Schulz <david.schulz@qt.io>
79 lines
2.3 KiB
C++
79 lines
2.3 KiB
C++
// Copyright (C) 2023 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
|
|
|
|
#pragma once
|
|
|
|
#include "languageclient_global.h"
|
|
|
|
#include "client.h"
|
|
|
|
#include <languageserverprotocol/lsptypes.h>
|
|
#include <languageserverprotocol/lsputils.h>
|
|
#include <languageserverprotocol/workspace.h>
|
|
#include <utils/tasktree.h>
|
|
|
|
namespace LanguageClient {
|
|
|
|
|
|
template <typename Request>
|
|
class LANGUAGECLIENT_EXPORT ClientRequestTask
|
|
{
|
|
public:
|
|
virtual ~ClientRequestTask()
|
|
{
|
|
if (m_id)
|
|
m_client->cancelRequest(*m_id); // In order to not to invoke a response callback anymore
|
|
}
|
|
|
|
void setClient(Client *client) { m_client = client; }
|
|
Client *client() const { return m_client; }
|
|
void setParams(const typename Request::Parameters ¶ms) { m_params = params; }
|
|
|
|
void start()
|
|
{
|
|
QTC_ASSERT(!isRunning(), return);
|
|
QTC_ASSERT(preStartCheck(), m_callback({}); return);
|
|
|
|
Request request(m_params);
|
|
request.setResponseCallback([this](const typename Request::Response &response) {
|
|
m_response = response;
|
|
m_id = {};
|
|
m_callback(response);
|
|
});
|
|
m_id = request.id();
|
|
m_client->sendMessage(request);
|
|
}
|
|
|
|
bool isRunning() const { return m_id.has_value(); }
|
|
virtual bool preStartCheck() { return m_client && m_client->reachable() && m_params.isValid(); }
|
|
|
|
typename Request::Response response() const { return m_response; }
|
|
void setResponseCallback(typename Request::ResponseCallback callback) { m_callback = callback; }
|
|
|
|
private:
|
|
Client *m_client = nullptr;
|
|
typename Request::Parameters m_params;
|
|
typename Request::ResponseCallback m_callback;
|
|
std::optional<LanguageServerProtocol::MessageId> m_id;
|
|
typename Request::Response m_response;
|
|
};
|
|
|
|
class LANGUAGECLIENT_EXPORT WorkspaceSymbolRequestTask
|
|
: public ClientRequestTask<LanguageServerProtocol::WorkspaceSymbolRequest>
|
|
{
|
|
public:
|
|
bool preStartCheck() override;
|
|
};
|
|
|
|
class LANGUAGECLIENT_EXPORT WorkspaceSymbolRequestTaskAdapter
|
|
: public Utils::Tasking::TaskAdapter<WorkspaceSymbolRequestTask>
|
|
{
|
|
public:
|
|
WorkspaceSymbolRequestTaskAdapter();
|
|
void start() final;
|
|
};
|
|
|
|
} // namespace LanguageClient
|
|
|
|
QTC_DECLARE_CUSTOM_TASK(SymbolRequest, LanguageClient::WorkspaceSymbolRequestTaskAdapter);
|