Add local refactoring code actions based on swift-syntax

Sources/LanguageServerProtocol/Requests/CodeActionRequest.swift

@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public typealias CodeActionProvider = (CodeActionRequest) async throws -> [CodeAction]
+public typealias CodeActionRequestProvider = (CodeActionRequest) async throws -> [CodeAction]
 
 /// Request for returning all possible code actions for a given text document and range.
 ///

Sources/SourceKitLSP/CMakeLists.txt

@@ -20,6 +20,13 @@ target_sources(SourceKitLSP PRIVATE
   Clang/ClangLanguageService.swift)
 target_sources(SourceKitLSP PRIVATE
   Swift/AdjustPositionToStartOfIdentifier.swift
+  Swift/CodeActions/CodeActionProvider.swift
+  Swift/CodeActions/CodeActions.swift
+  Swift/CodeActions/ConvertIntegerLiteral.swift
+  Swift/CodeActions/ConvertJSONToCodableStruct.swift
+  Swift/CodeActions/Demorgan.swift
+  Swift/CodeActions/EditBuilder.swift
+  Swift/CodeActions/SyntaxRefactoringCodeActionProvider.swift
   Swift/CodeCompletion.swift
   Swift/CodeCompletionSession.swift
   Swift/CommentXML.swift

Sources/SourceKitLSP/Swift/CodeActions/CodeActionProvider.swift

@@ -0,0 +1,73 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 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 SwiftSyntax
+import LSPLogging
+import SwiftRefactor
+
+public protocol CodeActionProvider {
+  static var kind: CodeActionKind { get }
+  static func provideAssistance(in scope: CodeActionScope) -> [ProvidedAction]
+}
+
+public struct CodeActionScope {
+  public var snapshot: DocumentSnapshot
+  public var parameters: CodeActionRequest
+  public var file: SourceFileSyntax
+  public var range: ByteSourceRange
+
+  init(snapshot: DocumentSnapshot, syntaxTree tree: SourceFileSyntax, parameters: CodeActionRequest) throws {
+    self.snapshot = snapshot
+    self.parameters = parameters
+    self.file = tree
+
+    let start = self.snapshot.utf8Offset(of: self.parameters.range.lowerBound) ?? 0
+    let end = self.snapshot.utf8Offset(of: self.parameters.range.upperBound) ?? start
+    let left = self.file.token(at: start)
+    let right = self.file.token(at: end)
+
+    let leftOff = left?.positionAfterSkippingLeadingTrivia.utf8Offset ?? 0
+    let rightOff = right?.endPositionBeforeTrailingTrivia.utf8Offset ?? leftOff
+    assert(leftOff <= rightOff)
+    self.range = ByteSourceRange(offset: leftOff, length: rightOff - leftOff)
+  }
+
+  public func starts(with tokenKind: TokenKind) -> TokenSyntax? {
+    guard
+      let token = self.file.token(at: self.range.offset),
+      token.tokenKind == tokenKind
+    else {
+      return nil
+    }
+    return token
+  }
+}
+
+extension SyntaxProtocol {
+  func token(at utf8Offset: Int) -> TokenSyntax? {
+    return token(at: AbsolutePosition(utf8Offset: utf8Offset))
+  }
+}
+
+extension ByteSourceRange {
+  fileprivate func contains(_ other: Int) -> Bool {
+    return self.offset <= other && other <= self.endOffset
+  }
+}
+
+extension SyntaxProtocol {
+  var textRange: ByteSourceRange {
+    return ByteSourceRange(offset: self.positionAfterSkippingLeadingTrivia.utf8Offset,
+                           length: self.trimmedLength.utf8Length)
+  }
+}

Sources/SourceKitLSP/Swift/CodeActions/CodeActions.swift

@@ -0,0 +1,25 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 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 SwiftRefactor
+
+/// List of all of the syntax-local code actions.
+public let allLocalCodeActions: [CodeActionProvider.Type] = [
+  AddSeparatorsToIntegerLiteral.self,
+  ConvertIntegerLiteral.self,
+  ConvertJSONToCodableStruct.self,
+  Demorgan.self,
+  FormatRawStringLiteral.self,
+  MigrateToNewIfLetSyntax.self,
+  OpaqueParameterToGeneric.self,
+  RemoveSeparatorsFromIntegerLiteral.self,
+]

Sources/SourceKitLSP/Swift/CodeActions/ConvertIntegerLiteral.swift

@@ -0,0 +1,65 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 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 SwiftSyntax
+import LanguageServerProtocol
+import SwiftRefactor
+
+// TODO: Make the type IntegerLiteralExprSyntax.Radix conform to CaseEnumerable
+// in swift-syntax.
+
+extension IntegerLiteralExprSyntax.Radix {
+  static var allCases: [Self] = [.binary, .octal, .decimal, .hex]
+}
+
+public struct ConvertIntegerLiteral: CodeActionProvider {
+  public static var kind: CodeActionKind { .refactorInline }
+
+  public static func provideAssistance(in scope: CodeActionScope) -> [ProvidedAction] {
+    guard
+      let token = scope.file.token(at: scope.range.offset),
+      let lit = token.parent?.as(IntegerLiteralExprSyntax.self),
+      let integerValue = Int(lit.split().value, radix: lit.radix.size)
+    else {
+      return []
+    }
+
+    var actions = [ProvidedAction]()
+    let currentRadix = lit.radix
+    for radix in IntegerLiteralExprSyntax.Radix.allCases {
+      guard radix != currentRadix else {
+        continue
+      }
+
+      //TODO: Add this to swift-syntax?
+      let prefix: String
+      switch radix {
+      case .binary:
+        prefix = "0b"
+      case .octal:
+        prefix = "0o"
+      case .hex:
+        prefix = "0x"
+      case .decimal:
+        prefix = ""
+      }
+
+      let convertedValue: ExprSyntax =
+        "\(raw: prefix)\(raw: String(integerValue, radix: radix.size))"
+      actions.append(ProvidedAction(title: "Convert \(lit) to \(convertedValue)") {
+        Replace(lit, with: convertedValue)
+      })
+    }
+
+    return actions
+  }
+}