Files
sourcekit-lsp/Sources/SourceKitLSP/Swift/SemanticRefactorCommand.swift
Lokesh T R fd50560998 Add LSP support for @freestanding Macro Expansions.
------
Simplify `SemanticRefactoring` with new `Refactoring` protocol to handle sourcekitd requests

Create and implement `ExpandMacroCommand` while temporarily storing generated expansions.

Create test case `testFreestandingMacroExpansion`

Manually inject `ExpandMacroCommand` into `retrieveRefactorCodeActions` upon an "Inline Macro" from sourcekitd

Address Review Comments

Mark `@_spi(Testing) public` for `MacroExpansionEdit`

Address Review Comments

Create separate directory for each buffer with its name, containing a generated file named as the source file along with position range

Fixed generated macro expansion file extension not recognised, by switching to file names which don't contain fragments

Address Review Comments

Wrap the entire feature under `ExperimentalFeatures`

Address Review Comments

Make Swift Lint Pass

Fix Windows Build not passing
2024-06-20 18:14:45 +00:00

108 lines
3.4 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
public struct SemanticRefactorCommand: RefactorCommand {
typealias Response = SemanticRefactoring
public static let identifier: String = "semantic.refactor.command"
/// The name of this refactoring action.
public var title: String
/// The sourcekitd identifier of the refactoring action.
public var actionString: String
/// The range to refactor.
public var positionRange: Range<Position>
/// The text document related to the refactoring action.
public var textDocument: TextDocumentIdentifier
public 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
)
}
public init(title: String, actionString: String, positionRange: Range<Position>, textDocument: TextDocumentIdentifier)
{
self.title = title
self.actionString = actionString
self.positionRange = positionRange
self.textDocument = textDocument
}
public 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
}
}