Files
sourcekit-lsp/Sources/SourceKitLSP/Swift/SemanticRefactorCommand.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

112 lines
3.5 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
import SourceKitD
package struct SemanticRefactorCommand: RefactorCommand {
typealias Response = SemanticRefactoring
package static let identifier: String = "semantic.refactor.command"
/// The name of this refactoring action.
package var title: String
/// The sourcekitd identifier of the refactoring action.
package var actionString: String
/// The range to refactor.
package var positionRange: Range<Position>
/// The text document related to the refactoring action.
package var textDocument: TextDocumentIdentifier
package init?(fromLSPDictionary dictionary: [String: LSPAny]) {
guard case .dictionary(let documentDict)? = dictionary[CodingKeys.textDocument.stringValue],
case .string(let title)? = dictionary[CodingKeys.title.stringValue],
case .string(let actionString)? = dictionary[CodingKeys.actionString.stringValue],
case .dictionary(let rangeDict)? = dictionary[CodingKeys.positionRange.stringValue]
else {
return nil
}
guard let positionRange = Range<Position>(fromLSPDictionary: rangeDict),
let textDocument = TextDocumentIdentifier(fromLSPDictionary: documentDict)
else {
return nil
}
self.init(
title: title,
actionString: actionString,
positionRange: positionRange,
textDocument: textDocument
)
}
package init(
title: String,
actionString: String,
positionRange: Range<Position>,
textDocument: TextDocumentIdentifier
) {
self.title = title
self.actionString = actionString
self.positionRange = positionRange
self.textDocument = textDocument
}
package func encodeToLSPAny() -> LSPAny {
return .dictionary([
CodingKeys.title.stringValue: .string(title),
CodingKeys.actionString.stringValue: .string(actionString),
CodingKeys.positionRange.stringValue: positionRange.encodeToLSPAny(),
CodingKeys.textDocument.stringValue: textDocument.encodeToLSPAny(),
])
}
}
extension Array where Element == SemanticRefactorCommand {
init?(
array: SKDResponseArray?,
range: Range<Position>,
textDocument: TextDocumentIdentifier,
_ keys: sourcekitd_api_keys,
_ api: sourcekitd_api_functions_t
) {
guard let results = array else {
return nil
}
var commands: [SemanticRefactorCommand] = []
results.forEach { _, value in
if let name: String = value[keys.actionName],
let actionuid: sourcekitd_api_uid_t = value[keys.actionUID],
let ptr = api.uid_get_string_ptr(actionuid)
{
let actionName = String(cString: ptr)
guard !actionName.hasPrefix("source.refactoring.kind.rename.") else {
// TODO: Rename.
return true
}
commands.append(
SemanticRefactorCommand(
title: name,
actionString: actionName,
positionRange: range,
textDocument: textDocument
)
)
}
return true
}
self = commands
}
}