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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
/// Request to initialize the language server.
///
/// This is the first request sent by the client, providing the server with the client's
/// capabilities, configuration options, and initial information about the current workspace. The
/// server replies with its own capabilities, which allows the two sides to agree about the set of
/// supported protocol methods and values.
///
/// - Parameters:
/// - processId: The process identifier (pid) of the client process.
/// - rootURI: The workspace URI, or nil if no workspace is open.
/// - initializationOptions: User-provided options.
/// - capabilities: The capabilities provided by the client editor.
/// - trace: Whether to enable tracing.
/// - workspaceFolders: The workspace folders configured, if the client supports multiple workspace
/// folders.
///
/// - Returns:
public struct InitializeRequest: RequestType, Hashable {
/// Information about the client
public struct ClientInfo: Codable, Hashable, Sendable {
// The name of the client as defined by the client.
public var name: String
/// The client's version as defined by the client.
public var version: String?
public init(name: String, version: String? = nil) {
self.name = name
self.version = version
}
}
public static let method: String = "initialize"
public typealias Response = InitializeResult
/// The process identifier (pid) of the process that started the LSP server, or nil if the server
/// was started by e.g. a user shell and should not be monitored.
///
/// If the client process dies, the server should exit.
public var processId: Int? = nil
/// Information about the client
public var clientInfo: ClientInfo? = nil
/// The locale the client is currently showing the user interface
/// in. This must not necessarily be the locale of the operating
/// system.
///
/// Uses IETF language tags as the value's syntax
/// (See https://en.wikipedia.org/wiki/IETF_language_tag)
public var locale: String? = nil
/// The workspace path, or nil if no workspace is open.
///
/// - Note: deprecated in favour of `rootURI`.
public var rootPath: String? = nil
/// The workspace URI, or nil if no workspace is open.
///
/// Takes precedence over the deprecated `rootPath`.
public var rootURI: DocumentURI?
/// User-provided options.
public var initializationOptions: LSPAny? = nil
/// The capabilities provided by the client editor.
public var capabilities: ClientCapabilities
/// Whether to enable tracing.
public var trace: Tracing? = .off
/// The workspace folders configured, if the client supports multiple workspace folders.
public var workspaceFolders: [WorkspaceFolder]?
public init(
processId: Int? = nil,
clientInfo: ClientInfo? = nil,
locale: String? = nil,
rootPath: String? = nil,
rootURI: DocumentURI?,
initializationOptions: LSPAny? = nil,
capabilities: ClientCapabilities,
trace: Tracing = .off,
workspaceFolders: [WorkspaceFolder]?
) {
self.processId = processId
self.clientInfo = clientInfo
self.locale = locale
self.rootPath = rootPath
self.rootURI = rootURI
self.initializationOptions = initializationOptions
self.capabilities = capabilities
self.trace = trace
self.workspaceFolders = workspaceFolders
}
}
extension InitializeRequest: Codable {
private enum CodingKeys: String, CodingKey {
case processId
case clientInfo
case locale
case rootPath
case rootURI = "rootUri"
case initializationOptions
case capabilities
case trace
case workspaceFolders
}
}
/// The server capabilities returned from the initialize request.
public struct InitializeResult: ResponseType, Hashable {
/// The capabilities of the language server.
public var capabilities: ServerCapabilities
public init(capabilities: ServerCapabilities) {
self.capabilities = capabilities
}
}
|
