mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
d0fc00ce98
Add `.swift-format` to the repo and format the repo with `swift-format`. This commit does not add any automation to enforce formatting of sourcekit-lsp in CI. The goal of this commit is to get the majority of source changes out of the way so that the diff of actually enforcing formatting will have fewer changes or conflicts.
93 lines
3.2 KiB
Swift
93 lines
3.2 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
|
|
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 {
|
|
log("failed to decode lsp metadata in executeCommand request", level: .error)
|
|
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()
|
|
}
|
|
}
|