further cleanup of OpenGeneratedInterfaceRequest

removed from `LSP Extensions.md`
deleted OpenInterfaceRequest.swift and moved GeneratedInterfaceDetails to LanguageService.swift
refactored usages of TextDocumentIdentifier to DocumentURI
reformatted all code changes

Author: AppAppWorks

Documentation/LSP Extensions.md

@@ -169,42 +169,6 @@ interface SKCompletionOptions {
 }
 ```
 
-## `textDocument/interface`
-
-New request that request a textual interface of a module to display in the IDE. Used internally within SourceKit-LSP
-
-- params: `OpenInterfaceParams`
-- result: `InterfaceDetails?`
-
-```ts
-export interface OpenInterfaceRequest: TextDocumentRequest, Hashable {
-  /**
-   * The document whose compiler arguments should be used to generate the interface.
-   */
-  textDocument: TextDocumentIdentifier
-
-  /**
-   * The module to generate an index for.
-   */
-  moduleName: string
-
-  /**
-   * The module group name.
-   */
-  groupName?: string
-
-  /**
-   * The symbol USR to search for in the generated module interface.
-   */
-  symbolUSR?: string
-}
-
-interface InterfaceDetails {
-  uri: DocumentURI
-  position?: Position
-}
-```
-
 ## `textDocument/symbolInfo`
 
 New request for semantic information about the symbol at a given location.

Sources/LanguageServerProtocol/Requests/OpenInterfaceRequest.swift

@@ -621,8 +621,10 @@ extension ClangLanguageService {
     }
     return try await forwardRequestToClangd(req)
   }
-    
-  func openGeneratedInterface(textDocument: TextDocumentIdentifier, moduleName: String, groupName: String?, symbolUSR symbol: String?) async throws -> GeneratedInterfaceDetails? {
+
+  func openGeneratedInterface(document: DocumentURI, moduleName: String, groupName: String?, symbolUSR symbol: String?)
+    async throws -> GeneratedInterfaceDetails?
+  {
     throw ResponseError.unknown("unsupported method")
   }
 

Sources/SourceKitLSP/Clang/ClangLanguageService.swift

@@ -76,6 +76,18 @@ public struct RenameLocation: Sendable {
   let usage: Usage
 }
 
+/// The textual output of a module interface.
+public struct GeneratedInterfaceDetails: ResponseType, Hashable {
+
+  public var uri: DocumentURI
+  public var position: Position?
+
+  public init(uri: DocumentURI, position: Position?) {
+    self.uri = uri
+    self.position = position
+  }
+}
+
 /// Provides language specific functionality to sourcekit-lsp from a specific toolchain.
 ///
 /// For example, we may have a language service that provides semantic functionality for c-family using a clangd server,
@@ -147,7 +159,7 @@ public protocol LanguageService: AnyObject, Sendable {
   func hover(_ req: HoverRequest) async throws -> HoverResponse?
   func symbolInfo(_ request: SymbolInfoRequest) async throws -> [SymbolDetails]
   func openGeneratedInterface(
-    textDocument: TextDocumentIdentifier,
+    document: DocumentURI,
     moduleName: String,
     groupName: String?,
     symbolUSR symbol: String?

Sources/SourceKitLSP/LanguageService.swift

@@ -1475,15 +1475,15 @@ extension SourceKitLSPServer {
   }
 
   func openGeneratedInterface(
-    textDocument: TextDocumentIdentifier,
+    document: DocumentURI,
     moduleName: String,
     groupName: String?,
     symbolUSR symbol: String?,
     workspace: Workspace,
     languageService: LanguageService
   ) async throws -> GeneratedInterfaceDetails? {
     return try await languageService.openGeneratedInterface(
-      textDocument: textDocument,
+      document: document,
       moduleName: moduleName,
       groupName: groupName,
       symbolUSR: symbol
@@ -1891,12 +1891,14 @@ extension SourceKitLSPServer {
     originatorUri: DocumentURI,
     languageService: LanguageService
   ) async throws -> Location {
-    guard let interfaceDetails = try await languageService.openGeneratedInterface(
-      textDocument: TextDocumentIdentifier(originatorUri),
-      moduleName: moduleName,
-      groupName: groupName,
-      symbolUSR: symbolUSR
-    ) else {
+    guard
+      let interfaceDetails = try await languageService.openGeneratedInterface(
+        document: originatorUri,
+        moduleName: moduleName,
+        groupName: groupName,
+        symbolUSR: symbolUSR
+      )
+    else {
       throw ResponseError.unknown("Could not generate Swift Interface for \(moduleName)")
     }
     let position = interfaceDetails.position ?? Position(line: 0, utf16index: 0)

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -22,17 +22,18 @@ struct GeneratedInterfaceInfo {
 
 extension SwiftLanguageService {
   public func openGeneratedInterface(
-    textDocument: TextDocumentIdentifier,
+    document: DocumentURI,
     moduleName: String,
     groupName: String?,
     symbolUSR symbol: String?
   ) async throws -> GeneratedInterfaceDetails? {
-      // Name of interface module name with group names appended
-    let name = if let groupName {
+    // Name of interface module name with group names appended
+    let name =
+      if let groupName {
         "\(moduleName).\(groupName.replacing("/", with: "."))"
-    } else {
+      } else {
         moduleName
-    }
+      }
     let interfaceFilePath = self.generatedInterfacesPath.appendingPathComponent("\(name).swiftinterface")
     let interfaceDocURI = DocumentURI(interfaceFilePath)
     // has interface already been generated
@@ -43,12 +44,12 @@ extension SwiftLanguageService {
         symbol: symbol
       )
     } else {
-        let interfaceInfo = try await self.generatedInterfaceInfo(
-            textDocument: textDocument,
-            moduleName: moduleName,
-            groupName: groupName,
-            interfaceURI: interfaceDocURI
-        )
+      let interfaceInfo = try await self.generatedInterfaceInfo(
+        document: document,
+        moduleName: moduleName,
+        groupName: groupName,
+        interfaceURI: interfaceDocURI
+      )
       try interfaceInfo.contents.write(to: interfaceFilePath, atomically: true, encoding: String.Encoding.utf8)
       let snapshot = DocumentSnapshot(
         uri: interfaceDocURI,
@@ -77,7 +78,7 @@ extension SwiftLanguageService {
   /// - Important: This opens a document with name `interfaceURI.pseudoPath` in sourcekitd. The caller is responsible
   ///   for ensuring that the document will eventually get closed in sourcekitd again.
   private func generatedInterfaceInfo(
-    textDocument: TextDocumentIdentifier,
+    document: DocumentURI,
     moduleName: String,
     groupName: String?,
     interfaceURI: DocumentURI
@@ -89,7 +90,7 @@ extension SwiftLanguageService {
       keys.groupName: groupName,
       keys.name: interfaceURI.pseudoPath,
       keys.synthesizedExtension: 1,
-      keys.compilerArgs: await self.buildSettings(for: textDocument.uri)?.compilerArgs as [SKDRequestValue]?,
+      keys.compilerArgs: await self.buildSettings(for: document)?.compilerArgs as [SKDRequestValue]?,
     ])
 
     let dict = try await self.sourcekitd.send(skreq, fileContents: nil)