mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-06-24 12:21:58 +02:00
Rintaro Ishizaki
a9566ac183
Remove hand-written `init?(fromLSPDictionary:)` / `encodeToLSPAny()` from LSPAnyCodable types, relying instead on the default implementations backed by `LSPAnyEncoder`/`LSPAnyDecoder`
95 lines
3.4 KiB
Swift
95 lines
3.4 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// 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
|
|
@_spi(SourceKitLSP) package import LanguageServerProtocol
|
|
@_spi(SourceKitLSP) import LanguageServerProtocolExtensions
|
|
@_spi(SourceKitLSP) import SKLogging
|
|
|
|
/// 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.
|
|
package struct SourceKitLSPCommandMetadata: Codable, Hashable, LSPAnyCodable {
|
|
|
|
package var sourcekitlsp_textDocument: TextDocumentIdentifier
|
|
|
|
package init(textDocument: TextDocumentIdentifier) {
|
|
self.sourcekitlsp_textDocument = textDocument
|
|
}
|
|
}
|
|
|
|
/// Metadata injected into CodeAction.data to support routing codeAction/resolve requests.
|
|
package struct CodeActionResolveMetadata: Codable, Hashable, LSPAnyCodable {
|
|
package var textDocument: TextDocumentIdentifier
|
|
package var underlyingData: LSPAny?
|
|
|
|
package init(textDocument: TextDocumentIdentifier, underlyingData: LSPAny? = nil) {
|
|
self.textDocument = textDocument
|
|
self.underlyingData = underlyingData
|
|
}
|
|
}
|
|
|
|
extension CodeActionRequest {
|
|
package func injectMetadata(toResponse response: CodeActionRequestResponse?) -> CodeActionRequestResponse? {
|
|
let commandMetadata = SourceKitLSPCommandMetadata(textDocument: textDocument)
|
|
let commandMetadataArgument = commandMetadata.encodeToLSPAny()
|
|
switch response {
|
|
case .codeActions(var codeActions)?:
|
|
for i in 0..<codeActions.count {
|
|
codeActions[i].command?.arguments?.append(commandMetadataArgument)
|
|
|
|
if codeActions[i].edit == nil && codeActions[i].command == nil {
|
|
codeActions[i].data = CodeActionResolveMetadata(
|
|
textDocument: textDocument,
|
|
underlyingData: codeActions[i].data
|
|
).encodeToLSPAny()
|
|
}
|
|
}
|
|
return .codeActions(codeActions)
|
|
case .commands(var commands)?:
|
|
for i in 0..<commands.count {
|
|
commands[i].arguments?.append(commandMetadataArgument)
|
|
}
|
|
return .commands(commands)
|
|
case nil:
|
|
return nil
|
|
}
|
|
}
|
|
}
|
|
|
|
extension ExecuteCommandRequest {
|
|
/// The document in which the command was invoked.
|
|
package var textDocument: TextDocumentIdentifier? {
|
|
return metadata?.sourcekitlsp_textDocument
|
|
}
|
|
|
|
/// Optional metadata containing SourceKit-LSP information about this command.
|
|
package 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.
|
|
package var argumentsWithoutSourceKitMetadata: [LSPAny]? {
|
|
guard metadata != nil else {
|
|
return arguments
|
|
}
|
|
return arguments?.dropLast()
|
|
}
|
|
}
|