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
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import Foundation
import LSPLogging
import LanguageServerProtocol
import SKSupport
/// Represents metadata that SourceKit-LSP injects at every command returned by code actions.
/// The ExecuteCommand is not a TextDocumentRequest, so metadata is injected to allow SourceKit-LSP
/// to determine where a command should be executed.
public struct SourceKitLSPCommandMetadata: Codable, Hashable {
public var sourcekitlsp_textDocument: TextDocumentIdentifier
public init?(fromLSPDictionary dictionary: [String: LSPAny]) {
let textDocumentKey = CodingKeys.sourcekitlsp_textDocument.stringValue
guard case .dictionary(let textDocumentDict)? = dictionary[textDocumentKey],
let textDocument = TextDocumentIdentifier(fromLSPDictionary: textDocumentDict)
else {
return nil
}
self.init(textDocument: textDocument)
}
public init(textDocument: TextDocumentIdentifier) {
self.sourcekitlsp_textDocument = textDocument
}
public func encodeToLSPAny() -> LSPAny {
return .dictionary([
CodingKeys.sourcekitlsp_textDocument.stringValue: sourcekitlsp_textDocument.encodeToLSPAny()
])
}
}
extension CodeActionRequest {
public func injectMetadata(toResponse response: CodeActionRequestResponse?) -> CodeActionRequestResponse? {
let metadata = SourceKitLSPCommandMetadata(textDocument: textDocument)
let metadataArgument = metadata.encodeToLSPAny()
switch response {
case .codeActions(var codeActions)?:
for i in 0..<codeActions.count {
codeActions[i].command?.arguments?.append(metadataArgument)
}
return .codeActions(codeActions)
case .commands(var commands)?:
for i in 0..<commands.count {
commands[i].arguments?.append(metadataArgument)
}
return .commands(commands)
case nil:
return nil
}
}
}
extension ExecuteCommandRequest {
/// The document in which the command was invoked.
public var textDocument: TextDocumentIdentifier? {
return metadata?.sourcekitlsp_textDocument
}
/// Optional metadata containing SourceKit-LSP information about this command.
public var metadata: SourceKitLSPCommandMetadata? {
guard case .dictionary(let dictionary)? = arguments?.last else {
return nil
}
guard let metadata = SourceKitLSPCommandMetadata(fromLSPDictionary: dictionary) else {
logger.error("failed to decode lsp metadata in executeCommand request")
return nil
}
return metadata
}
/// Returns this Command's arguments without SourceKit-LSP's injected metadata, if it exists.
public var argumentsWithoutSourceKitMetadata: [LSPAny]? {
guard metadata != nil else {
return arguments
}
return arguments?.dropLast()
}
}
|
