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

  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_keys, _ api: sourcekitd_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_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
  }
}