Files
sourcekit-lsp/Sources/SourceKitLSP/Swift/SwiftCommand.swift
Alex Hoppen 2877675bd5 Adopt package access level
Change a l public declarations to the `package` access level, accept for:
- The `LanguageServerProtocol` module
- The `BuildServerProtocol` module
- `InProcessClient.InProcessSourceKitLSPClient`
- `LanguageServerProtocolJSONRPC` (I would like to create a more ergonomic API for this like `InProcessSourceKitLSPClient` in the future, but for now, we’ll leave it public)

Unfortunately, our pattern of marking functions as `@_spi(Testing) public` no longer works with the `package` access level because declarations at the `package` access level cannot be marked as SPI. I have decided to just mark these functions as `package`. Alternatives would be:
- Add an underscore to these functions, like we did for functions exposed for testing before the introduction of `SPI`
- Use `@testable` import in the test targets and mark the methods as `internal`

Resolves #1315
rdar://128295618
2024-07-19 09:54:30 -07:00

57 lines
1.9 KiB
Swift

//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import LanguageServerProtocol
/// The set of known Swift commands.
///
/// All commands from the Swift LSP should be listed here.
package let builtinSwiftCommands: [String] = [
SemanticRefactorCommand.self,
ExpandMacroCommand.self,
].map { (command: any SwiftCommand.Type) in
command.identifier
}
/// A `Command` that should be executed by Swift's language server.
package protocol SwiftCommand: Codable, Hashable, LSPAnyCodable {
static var identifier: String { get }
var title: String { get set }
}
extension SwiftCommand {
/// Converts this `SwiftCommand` to a generic LSP `Command` object.
package func asCommand() -> Command {
let argument = encodeToLSPAny()
return Command(title: title, command: Self.identifier, arguments: [argument])
}
}
extension ExecuteCommandRequest {
/// Attempts to convert the underlying `Command` metadata from this request
/// to a specific Swift language server `SwiftCommand`.
///
/// - Parameters:
/// - type: The `SwiftCommand` metatype to convert to.
package func swiftCommand<T: SwiftCommand>(ofType type: T.Type) -> T? {
guard type.identifier == command else {
return nil
}
guard let argument = arguments?.first else {
return nil
}
guard case let .dictionary(dictionary) = argument else {
return nil
}
return type.init(fromLSPDictionary: dictionary)
}
}