Add Copy Objective-C Selector code action

Author: iMostfa

Sources/SourceKitD/sourcekitd_uids.swift

@@ -878,6 +878,8 @@ package struct sourcekitd_api_requests {
   package let findLocalRenameRanges: sourcekitd_api_uid_t
   /// `source.request.semantic.refactoring`
   package let semanticRefactoring: sourcekitd_api_uid_t
+  /// `source.request.objc.selector`
+  package let objcSelector: sourcekitd_api_uid_t
   /// `source.request.enable-compile-notifications`
   package let enableCompileNotifications: sourcekitd_api_uid_t
   /// `source.request.test_notification`
@@ -951,6 +953,7 @@ package struct sourcekitd_api_requests {
     findRenameRanges = api.uid_get_from_cstr("source.request.find-syntactic-rename-ranges")!
     findLocalRenameRanges = api.uid_get_from_cstr("source.request.find-local-rename-ranges")!
     semanticRefactoring = api.uid_get_from_cstr("source.request.semantic.refactoring")!
+    objcSelector = api.uid_get_from_cstr("source.request.objc.selector")!
     enableCompileNotifications = api.uid_get_from_cstr("source.request.enable-compile-notifications")!
     testNotification = api.uid_get_from_cstr("source.request.test_notification")!
     collectExpressionType = api.uid_get_from_cstr("source.request.expression.type")!

Sources/SwiftLanguageService/CopyObjCSelector.swift

@@ -0,0 +1,46 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 Foundation
+@_spi(SourceKitLSP) import LanguageServerProtocol
+@_spi(SourceKitLSP) import SKLogging
+import SourceKitD
+import SourceKitLSP
+
+extension SwiftLanguageService {
+  /// Executes the direct SourceKitD request to fetch the Objective-C selector at the cursor position.
+  func copyObjCSelector(
+    _ command: CopyObjCSelectorCommand
+  ) async throws -> LSPAny {
+    let snapshot = try documentManager.latestSnapshot(command.textDocument.uri)
+    let compileCommand = await self.compileCommand(for: snapshot.uri, fallbackAfterTimeout: true)
+    let offset = snapshot.utf8Offset(of: command.positionRange.lowerBound)
+
+    let keys = self.keys
+    let skreq = sourcekitd.dictionary([:])
+    skreq.set(keys.offset, to: offset)
+    skreq.set(keys.sourceFile, to: snapshot.uri.sourcekitdSourceFile)
+    if let primaryFile = snapshot.uri.primaryFile?.pseudoPath {
+      skreq.set(keys.primaryFile, to: primaryFile)
+    }
+    if let compilerArgs = compileCommand?.compilerArgs {
+      skreq.set(keys.compilerArgs, to: compilerArgs as [any SKDRequestValue])
+    }
+
+    let dict = try await send(sourcekitdRequest: \.objcSelector, skreq, snapshot: snapshot)
+    if let selectorText: String = dict[keys.text] {
+      return .string(selectorText)
+    }
+
+    throw ResponseError.unknown("No Objective-C selector found at cursor position")
+  }
+}

Sources/SwiftLanguageService/CopyObjCSelectorCommand.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
+//
+//===----------------------------------------------------------------------===//
+
+@_spi(SourceKitLSP) package import LanguageServerProtocol
+import SourceKitD
+
+package struct CopyObjCSelectorCommand: SwiftCommand {
+  package static let identifier: String = "copy.objc.selector.command"
+
+  package var title = "Copy Objective-C Selector"
+  package var actionString = "source.refactoring.kind.copy.objc.selector"
+
+  package var positionRange: Range<Position>
+  package var textDocument: LanguageServerProtocol.TextDocumentIdentifier
+
+  package init(positionRange: Range<Position>, textDocument: LanguageServerProtocol.TextDocumentIdentifier) {
+    self.positionRange = positionRange
+    self.textDocument = textDocument
+  }
+
+  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 = LanguageServerProtocol.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: LanguageServerProtocol.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(),
+    ])
+  }
+}

Sources/SwiftLanguageService/SwiftCommand.swift

@@ -51,6 +51,7 @@ extension SwiftLanguageService {
     [
       SemanticRefactorCommand.self,
       ExpandMacroCommand.self,
+      CopyObjCSelectorCommand.self,
     ].map { (command: any SwiftCommand.Type) in
       command.identifier
     }

Sources/SwiftLanguageService/SwiftLanguageService.swift

@@ -949,11 +949,15 @@ extension SwiftLanguageService {
     }.flatMap { $0 }
   }
 
+  // most likely we will go from here ? 
   func retrieveRefactorCodeActions(_ params: CodeActionRequest) async throws -> [CodeAction] {
     let additionalCursorInfoParameters: ((SKDRequestDictionary) -> Void) = { skreq in
       skreq.set(self.keys.retrieveRefactorActions, to: 1)
     }
 
+    let snapshot = try documentManager.latestSnapshot(params.textDocument.uri)
+
+    // here we are returning for the server the available options?
     let cursorInfoResponse = try await cursorInfo(
       params.textDocument.uri,
       params.range,
@@ -979,9 +983,52 @@ extension SwiftLanguageService {
       refactorActions.append(CodeAction(title: expandMacroCommand.title, kind: .refactor, command: expandMacroCommand))
     }
 
+    if let copySelectorAction = await makeCopyObjCSelectorAction(
+      range: params.range,
+      textDocument: params.textDocument,
+      snapshot: snapshot
+    ) {
+      refactorActions.append(copySelectorAction)
+    }
+
     return refactorActions
   }
 
+  private func makeCopyObjCSelectorAction(
+    range: Range<Position>,
+    textDocument: LanguageServerProtocol.TextDocumentIdentifier,
+    snapshot: DocumentSnapshot
+  ) async -> CodeAction? {
+    let compileCommand = await self.compileCommand(for: snapshot.uri, fallbackAfterTimeout: true)
+    let offset = snapshot.utf8Offset(of: range.lowerBound)
+
+    let keys = self.keys
+    let skreq = sourcekitd.dictionary([:])
+    skreq.set(keys.offset, to: offset)
+    skreq.set(keys.sourceFile, to: snapshot.uri.sourcekitdSourceFile)
+    if let primaryFile = snapshot.uri.primaryFile?.pseudoPath {
+      skreq.set(keys.primaryFile, to: primaryFile)
+    }
+    if let compilerArgs = compileCommand?.compilerArgs {
+      skreq.set(keys.compilerArgs, to: compilerArgs as [any SKDRequestValue])
+    }
+
+    do {
+      let dict = try await send(sourcekitdRequest: \.objcSelector, skreq, snapshot: snapshot)
+      if dict[keys.text] as String? != nil {
+        let copyCommand = CopyObjCSelectorCommand(
+          positionRange: range,
+          textDocument: textDocument
+        ).asCommand()
+        return CodeAction(title: "Copy Objective-C Selector", kind: .refactor, command: copyCommand)
+      }
+    } catch {
+      logger.debug("CopyObjCSelector: applicability check failed: \(error.localizedDescription)")
+    }
+
+    return nil
+  }
+
   func retrieveQuickFixCodeActions(_ params: CodeActionRequest) async throws -> [CodeAction] {
     let snapshot = try await self.latestSnapshot(for: params.textDocument.uri)
     let buildSettings = await self.compileCommand(for: params.textDocument.uri, fallbackAfterTimeout: true)
@@ -1096,6 +1143,8 @@ extension SwiftLanguageService {
       try await semanticRefactoring(command)
     } else if let command = req.swiftCommand(ofType: ExpandMacroCommand.self) {
       try await expandMacro(command)
+    } else if let command = req.swiftCommand(ofType: CopyObjCSelectorCommand.self) {
+      return try await copyObjCSelector(command)
     } else if let command = req.swiftCommand(ofType: RemoveUnusedImportsCommand.self) {
       try await removeUnusedImports(command)
     } else {