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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 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 for documentation information about the symbol at a given location.
///
/// This request looks up the symbol (if any) at a given text document location and returns the
/// documentation markup content for that location, suitable to show in an dialog when hovering over
/// that symbol in an editor.
///
/// Servers that provide document highlights should set the `hoverProvider` server capability.
///
/// - Parameters:
/// - textDocument: The document in which to lookup the symbol location.
/// - position: The document location at which to lookup symbol information.
///
/// - Returns: HoverResponse for the given location, which contains the `MarkupContent`.
public struct HoverRequest: TextDocumentRequest, Hashable {
public static let method: String = "textDocument/hover"
public typealias Response = HoverResponse?
/// The document in which to lookup the symbol location.
public var textDocument: TextDocumentIdentifier
/// The document location at which to lookup symbol information.
public var position: Position
public init(textDocument: TextDocumentIdentifier, position: Position) {
self.textDocument = textDocument
self.position = position
}
}
/// Documentation markup contents for a symbol found by the hover request.
public struct HoverResponse: ResponseType, Hashable {
/// The documentation markup content.
public var contents: HoverResponseContents
/// An optional range to visually distinguish during hover.
@CustomCodable<PositionRange?>
public var range: Range<Position>?
public init(contents: HoverResponseContents, range: Range<Position>?) {
self.contents = contents
self._range = CustomCodable(wrappedValue: range)
}
}
public enum HoverResponseContents: Hashable, Sendable {
case markedStrings([MarkedString])
case markupContent(MarkupContent)
}
public enum MarkedString: Hashable {
private struct MarkdownCodeBlock: Codable {
let language: String
let value: String
}
case markdown(value: String)
case codeBlock(language: String, value: String)
}
extension MarkedString: Codable, Sendable {
public init(from decoder: Decoder) throws {
if let value = try? decoder.singleValueContainer().decode(String.self) {
self = .markdown(value: value)
} else if let codeBlock = try? MarkdownCodeBlock(from: decoder) {
self = .codeBlock(language: codeBlock.language, value: codeBlock.value)
} else {
let context = DecodingError.Context(
codingPath: decoder.codingPath,
debugDescription: "Expected String or MarkdownCodeBlock"
)
throw DecodingError.dataCorrupted(context)
}
}
public func encode(to encoder: Encoder) throws {
switch self {
case .markdown(value: let value):
try value.encode(to: encoder)
case .codeBlock(language: let language, value: let value):
try MarkdownCodeBlock(language: language, value: value).encode(to: encoder)
}
}
}
extension HoverResponseContents: Codable {
public init(from decoder: Decoder) throws {
if let value = try? MarkupContent(from: decoder) {
self = .markupContent(value)
} else if let value = try? [MarkedString](from: decoder) {
self = .markedStrings(value)
} else if let value = try? MarkedString(from: decoder) {
self = .markedStrings([value])
} else {
let context = DecodingError.Context(
codingPath: decoder.codingPath,
debugDescription: "Expected MarkedString, [MarkedString], or MarkupContent"
)
throw DecodingError.dataCorrupted(context)
}
}
public func encode(to encoder: Encoder) throws {
switch self {
case .markedStrings(let value):
try value.encode(to: encoder)
case .markupContent(let value):
try value.encode(to: encoder)
}
}
}
|
