Revision control
Copy as Markdown
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant
#ifndef QLANGUAGESERVERBASE_P_H
#define QLANGUAGESERVERBASE_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtLanguageServer/qtlanguageserverglobal.h>
#include <QtLanguageServer/private/qlanguageserverspec_p.h>
#include <QtJsonRpc/private/qjsonrpcprotocol_p.h>
#include <QtJsonRpc/private/qjsonrpctransport_p.h>
#include <QtCore/QByteArray>
#include <functional>
#include <memory>
QT_BEGIN_NAMESPACE
Q_DECLARE_LOGGING_CATEGORY(lspLog);
namespace QLspSpecification {
class Q_LANGUAGESERVER_EXPORT ResponseError
{
public:
int code = { };
QByteArray message = { };
std::optional<QJsonValue> data = { };
template <typename W>
void walk(W &w)
{
field(w, "code", code);
field(w, "message", message);
field(w, "data", data);
}
};
class ProtocolBasePrivate;
class Q_LANGUAGESERVER_EXPORT ProtocolBase
{
Q_DISABLE_COPY_MOVE(ProtocolBase)
public:
~ProtocolBase();
using ResponseErrorHandler = std::function<void(const QLspSpecification::ResponseError &)>;
// generated, defined in qlanguageservergen.cpp
static QByteArray requestMethodToBaseCppName(const QByteArray &);
// generated, defined in qlanguageservergen.cpp
static QByteArray notificationMethodToBaseCppName(const QByteArray &);
static void defaultUndispatchedRequestHandler(const QJsonRpc::IdType &id,
const QByteArray &method,
QJsonRpc::TypedResponse &&response);
static void defaultUndispatchedNotificationHandler(const QByteArray &method);
static void defaultResponseErrorHandler(const QLspSpecification::ResponseError &err);
void registerResponseErrorHandler(const ResponseErrorHandler &h);
void handleResponseError(const ResponseError &err);
void handleUndispatchedRequest(const QJsonRpc::IdType &id, const QByteArray &method,
QJsonRpc::TypedResponse &&response);
void handleUndispatchedNotification(const QByteArray &method);
QJsonRpc::TypedRpc *typedRpc();
protected:
std::unique_ptr<ProtocolBasePrivate> d_ptr;
ProtocolBase(std::unique_ptr<ProtocolBasePrivate> &&priv);
QJsonRpcTransport *transport();
private:
void registerMethods(QJsonRpc::TypedRpc *);
Q_DECLARE_PRIVATE(ProtocolBase)
};
template<typename T, typename F>
void decodeAndCall(QJsonValue value, F funct,
ProtocolBase::ResponseErrorHandler errorHandler =
&ProtocolBase::defaultResponseErrorHandler)
{
using namespace Qt::StringLiterals;
T result;
QTypedJson::Reader r(value);
doWalk(r, result);
if (!r.errorMessages().isEmpty()) {
errorHandler(QLspSpecification::ResponseError {
int(QLspSpecification::ErrorCodes::ParseError),
u"Errors decoding data:\n %1"_s.arg(r.errorMessages().join(u"\n ")).toUtf8(),
value });
r.clearErrorMessages();
} else {
if constexpr (std::is_same_v<T, std::nullptr_t> && std::is_invocable_v<F>) {
funct();
} else {
funct(result);
}
}
}
} // namespace QLspSpecification
QT_END_NAMESPACE
#endif // QLANGUAGESERVERBASE_P_H