1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
#pragma once
#include "clientcapabilities.h"
#include "jsonrpcmessages.h"
#include "lsptypes.h"
#include "servercapabilities.h"
namespace LanguageServerProtocol {
class LANGUAGESERVERPROTOCOL_EXPORT Trace
{
public:
enum Values
{
off,
messages,
verbose
};
Trace() = default;
Trace(Values val) : m_value(val) {}
Trace(QString val) : Trace(fromString(val)) {}
static Trace fromString(const QString& val);
QString toString() const;
private:
Values m_value = off;
};
class LANGUAGESERVERPROTOCOL_EXPORT InitializeParams : public JsonObject
{
public:
InitializeParams();
using JsonObject::JsonObject;
/*
* The process Id of the parent process that started
* the server. Is null if the process has not been started by another process.
* If the parent process is not alive then the server should exit (see exit notification)
* its process.
*/
LanguageClientValue<int> processId() const { return clientValue<int>(processIdKey); }
void setProcessId(const LanguageClientValue<int> &id) { insert(processIdKey, id.toJson()); }
/*
* The rootPath of the workspace. Is null
* if no folder is open.
*
* @deprecated in favor of rootUri.
*/
Utils::optional<LanguageClientValue<QString>> rootPath() const
{ return optionalClientValue<QString>(rootPathKey); }
void setRootPath(const LanguageClientValue<QString> &path)
{ insert(rootPathKey, path.toJson()); }
void clearRootPath() { remove(rootPathKey); }
/*
* The rootUri of the workspace. Is null if no
* folder is open. If both `rootPath` and `rootUri` are set
* `rootUri` wins.
*/
LanguageClientValue<DocumentUri> rootUri() const
{ return clientValue<QString>(rootUriKey).transform<DocumentUri>(); }
void setRootUri(const LanguageClientValue<DocumentUri> &uri)
{ insert(rootUriKey, uri.toJson()); }
// User provided initialization options.
Utils::optional<QJsonObject> initializationOptions() const
{ return optionalValue<QJsonObject>(initializationOptionsKey); }
void setInitializationOptions(const QJsonObject &options)
{ insert(initializationOptionsKey, options); }
void clearInitializationOptions() { remove(initializationOptionsKey); }
// The capabilities provided by the client (editor or tool)
ClientCapabilities capabilities() const { return typedValue<ClientCapabilities>(capabilitiesKey); }
void setCapabilities(const ClientCapabilities &capabilities)
{ insert(capabilitiesKey, capabilities); }
// The initial trace setting. If omitted trace is disabled ('off').
Utils::optional<Trace> trace() const;
void setTrace(Trace trace) { insert(traceKey, trace.toString()); }
void clearTrace() { remove(traceKey); }
/*
* The workspace folders configured in the client when the server starts.
* This property is only available if the client supports workspace folders.
* It can be `null` if the client supports workspace folders but none are
* configured.
*
* Since 3.6.0
*/
Utils::optional<LanguageClientArray<WorkSpaceFolder>> workSpaceFolders() const
{ return optionalClientArray<WorkSpaceFolder>(workSpaceFoldersKey); }
void setWorkSpaceFolders(const LanguageClientArray<WorkSpaceFolder> &folders)
{ insert(workSpaceFoldersKey, folders.toJson()); }
void clearWorkSpaceFolders() { remove(workSpaceFoldersKey); }
bool isValid(QStringList *error) const override;
};
class LANGUAGESERVERPROTOCOL_EXPORT InitializeNotification : public Notification<LanguageClientNull>
{
public:
InitializeNotification();
using Notification::Notification;
constexpr static const char methodName[] = "initialized";
bool parametersAreValid(QString * /*errorMessage*/) const final { return true; }
};
class LANGUAGESERVERPROTOCOL_EXPORT InitializeResult : public JsonObject
{
public:
using JsonObject::JsonObject;
Utils::optional<ServerCapabilities> capabilities() const
{ return optionalValue<ServerCapabilities>(capabilitiesKey); }
void setCapabilities(const ServerCapabilities &capabilities)
{ insert(capabilitiesKey, capabilities); }
void clearCapabilities() { remove(capabilitiesKey); }
bool isValid(QStringList *error) const override
{ return checkOptional<ServerCapabilities>(error, capabilitiesKey); }
};
class LANGUAGESERVERPROTOCOL_EXPORT InitializeError : public JsonObject
{
public:
using JsonObject::JsonObject;
/*
* Indicates whether the client execute the following retry logic:
* (1) show the message provided by the ResponseError to the user
* (2) user selects retry or cancel
* (3) if user selected retry the initialize method is sent again.
*/
Utils::optional<bool> retry() const { return optionalValue<bool>(retryKey); }
void setRetry(bool retry) { insert(retryKey, retry); }
void clearRetry() { remove(retryKey); }
bool isValid(QStringList *error) const override { return checkOptional<bool>(error, retryKey); }
};
class LANGUAGESERVERPROTOCOL_EXPORT InitializeRequest : public Request<
InitializeResult, InitializeError, InitializeParams>
{
public:
InitializeRequest(const InitializeParams ¶ms = InitializeParams());
using Request::Request;
constexpr static const char methodName[] = "initialize";
};
using InitializeResponse = Response<InitializeResult, InitializeError>;
} // namespace LanguageClient
|
