Rename language specific language services

The naming was quite inconsistent here. Let’s rename these to `LanguageService` to highlight that they belong together.

- ToolchainLanguageServer -> LanguageService
- SwiftLanguageServer -> SwiftLanguageService
- ClangLanguageServerShim -> ClangLanguageService

Author: ahoppen

Sources/SourceKitLSP/CMakeLists.txt

@@ -3,20 +3,20 @@ add_library(SourceKitLSP STATIC
   CapabilityRegistry.swift
   DocumentManager.swift
   IndexStoreDB+MainFilesProvider.swift
-  ResponseError+Init.swift
+  LanguageService.swift
   Rename.swift
+  ResponseError+Init.swift
   Sequence+AsyncMap.swift
   SourceKitIndexDelegate.swift
   SourceKitLSPCommandMetadata.swift
   SourceKitLSPServer.swift
   SourceKitLSPServer+Options.swift
   TestDiscovery.swift
-  ToolchainLanguageServer.swift
   WorkDoneProgressManager.swift
   Workspace.swift
 )
 target_sources(SourceKitLSP PRIVATE
-  Clang/ClangLanguageServer.swift)
+  Clang/ClangLanguageService.swift)
 target_sources(SourceKitLSP PRIVATE
   Swift/AdjustPositionToStartOfIdentifier.swift
   Swift/CodeCompletion.swift
@@ -36,7 +36,7 @@ target_sources(SourceKitLSP PRIVATE
   Swift/SemanticTokens.swift
   Swift/SourceKitD+ResponseError.swift
   Swift/SwiftCommand.swift
-  Swift/SwiftLanguageServer.swift
+  Swift/SwiftLanguageService.swift
   Swift/SymbolInfo.swift
   Swift/SyntaxHighlightingToken.swift
   Swift/SyntaxHighlightingTokenParser.swift

Sources/SourceKitLSP/Clang/ClangLanguageServer.swift renamed to Sources/SourceKitLSP/Clang/ClangLanguageService.swift

@@ -60,7 +60,7 @@ fileprivate class ClangdStderrLogForwarder {
 /// ``ClangLanguageServerShim`` conforms to ``MessageHandler`` to receive
 /// requests and notifications **from** clangd, not from the editor, and it will
 /// forward these requests and notifications to the editor.
-actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
+actor ClangLanguageService: LanguageService, MessageHandler {
   /// The queue on which all messages that originate from clangd are handled.
   ///
   /// These are requests and notifications sent *from* clangd, not replies from
@@ -71,7 +71,7 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
   /// requests and notifications sent from clangd to the client is quite small.
   public let clangdMessageHandlingQueue = AsyncQueue<Serial>()
 
-  /// The ``SourceKitLSPServer`` instance that created this `ClangLanguageServerShim`.
+  /// The ``SourceKitLSPServer`` instance that created this `ClangLanguageService`.
   ///
   /// Used to send requests and notifications to the editor.
   private weak var sourceKitServer: SourceKitLSPServer?
@@ -191,7 +191,7 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
     }
   }
 
-  /// Start the `clangd` process, either on creation of the `ClangLanguageServerShim` or after `clangd` has crashed.
+  /// Start the `clangd` process, either on creation of the `ClangLanguageService` or after `clangd` has crashed.
   private func startClangdProcess() throws {
     // Since we are starting a new clangd process, reset the list of open document
     openDocuments = [:]
@@ -387,7 +387,7 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
 
 // MARK: - LanguageServer
 
-extension ClangLanguageServerShim {
+extension ClangLanguageService {
 
   /// Intercept clangd's `PublishDiagnosticsNotification` to withold it if we're using fallback
   /// build settings.
@@ -424,9 +424,9 @@ extension ClangLanguageServerShim {
 
 }
 
-// MARK: - ToolchainLanguageServer
+// MARK: - LanguageService
 
-extension ClangLanguageServerShim {
+extension ClangLanguageService {
 
   func initialize(_ initialize: InitializeRequest) async throws -> InitializeResult {
     // Store the initialize request so we can replay it in case clangd crashes
@@ -521,7 +521,6 @@ extension ClangLanguageServerShim {
 
   // MARK: - Text Document
 
-  /// Returns true if the `ToolchainLanguageServer` will take ownership of the request.
   public func definition(_ req: DefinitionRequest) async throws -> LocationsOrLocationLinksResponse? {
     // We handle it to provide jump-to-header support for #import/#include.
     return try await self.forwardRequestToClangd(req)

Sources/SourceKitLSP/ToolchainLanguageServer.swift renamed to Sources/SourceKitLSP/LanguageService.swift

@@ -60,8 +60,11 @@ public struct RenameLocation {
   let usage: Usage
 }
 
-/// A `LanguageServer` that exists within the context of the current process.
-public protocol ToolchainLanguageServer: AnyObject {
+/// 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,
+/// launched from a specific toolchain or from sourcekitd.
+public protocol LanguageService: AnyObject {
 
   // MARK: - Creation
 

Sources/SourceKitLSP/Rename.swift

@@ -310,7 +310,7 @@ private extension IndexSymbolKind {
 
 // MARK: - Name translation
 
-extension SwiftLanguageServer {
+extension SwiftLanguageService {
   enum NameTranslationError: Error, CustomStringConvertible {
     case cannotComputeOffset(SymbolLocation)
     case malformedSwiftToClangTranslateNameResponse(SKDResponseDictionary)
@@ -515,7 +515,7 @@ extension SourceKitLSPServer {
     usr: String,
     index: IndexStoreDB,
     workspace: Workspace
-  ) async -> (languageServer: SwiftLanguageServer, snapshot: DocumentSnapshot, location: SymbolLocation)? {
+  ) async -> (swiftLanguageService: SwiftLanguageService, snapshot: DocumentSnapshot, location: SymbolLocation)? {
     var reference: SymbolOccurrence? = nil
     index.forEachSymbolOccurrence(byUSR: usr, roles: renameRoles) {
       if index.symbolProvider(for: $0.location.path) == .swift {
@@ -533,11 +533,11 @@ extension SourceKitLSPServer {
     guard let snapshot = self.documentManager.latestSnapshotOrDisk(uri, language: .swift) else {
       return nil
     }
-    let swiftLanguageServer = await self.languageService(for: uri, .swift, in: workspace) as? SwiftLanguageServer
-    guard let swiftLanguageServer else {
+    let swiftLanguageService = await self.languageService(for: uri, .swift, in: workspace) as? SwiftLanguageService
+    guard let swiftLanguageService else {
       return nil
     }
-    return (swiftLanguageServer, snapshot, reference.location)
+    return (swiftLanguageService, snapshot, reference.location)
   }
 
   /// Returns a `CrossLanguageName` for the symbol with the given USR.
@@ -612,11 +612,11 @@ extension SourceKitLSPServer {
     let definitionName = overrideName ?? definitionSymbol.name
 
     switch definitionLanguageService {
-    case is ClangLanguageServerShim:
+    case is ClangLanguageService:
       let swiftName: String?
       if let swiftReference = await getReferenceFromSwift(usr: usr, index: index, workspace: workspace) {
         let isObjectiveCSelector = definitionLanguage == .objective_c && definitionSymbol.kind.isMethod
-        swiftName = try await swiftReference.languageServer.translateClangNameToSwift(
+        swiftName = try await swiftReference.swiftLanguageService.translateClangNameToSwift(
           at: swiftReference.location,
           in: swiftReference.snapshot,
           isObjectiveCSelector: isObjectiveCSelector,
@@ -627,7 +627,7 @@ extension SourceKitLSPServer {
         swiftName = nil
       }
       return CrossLanguageName(clangName: definitionName, swiftName: swiftName, definitionLanguage: definitionLanguage)
-    case let swiftLanguageServer as SwiftLanguageServer:
+    case let swiftLanguageService as SwiftLanguageService:
       // Continue iteration if the symbol provider is not clang.
       // If we terminate early by returning `false` from the closure, `forEachSymbolOccurrence` returns `true`,
       // indicating that we have found a reference from clang.
@@ -636,7 +636,7 @@ extension SourceKitLSPServer {
       }
       let clangName: String?
       if hasReferenceFromClang {
-        clangName = try await swiftLanguageServer.translateSwiftNameToClang(
+        clangName = try await swiftLanguageService.translateSwiftNameToClang(
           at: definitionOccurrence.location,
           in: definitionDocumentUri,
           name: CompoundDeclName(definitionName)
@@ -845,7 +845,7 @@ extension SourceKitLSPServer {
   func prepareRename(
     _ request: PrepareRenameRequest,
     workspace: Workspace,
-    languageService: ToolchainLanguageServer
+    languageService: LanguageService
   ) async throws -> PrepareRenameResponse? {
     guard let languageServicePrepareRename = try await languageService.prepareRename(request) else {
       return nil
@@ -874,15 +874,15 @@ extension SourceKitLSPServer {
   func indexedRename(
     _ request: IndexedRenameRequest,
     workspace: Workspace,
-    languageService: ToolchainLanguageServer
+    languageService: LanguageService
   ) async throws -> WorkspaceEdit? {
     return try await languageService.indexedRename(request)
   }
 }
 
 // MARK: - Swift
 
-extension SwiftLanguageServer {
+extension SwiftLanguageService {
   /// From a list of rename locations compute the list of `SyntacticRenameName`s that define which ranges need to be
   /// edited to rename a compound decl name.
   ///
@@ -1368,7 +1368,7 @@ extension SwiftLanguageServer {
 
 // MARK: - Clang
 
-extension ClangLanguageServerShim {
+extension ClangLanguageService {
   func rename(_ renameRequest: RenameRequest) async throws -> (edits: WorkspaceEdit, usr: String?) {
     async let edits = forwardRequestToClangd(renameRequest)
     let symbolInfoRequest = SymbolInfoRequest(

Sources/SourceKitLSP/SourceKitLSPServer+Options.swift

@@ -42,8 +42,8 @@ extension SourceKitLSPServer {
     /// Override the default directory where generated interfaces will be stored
     public var generatedInterfacesPath: AbsolutePath
 
-    /// The time that `SwiftLanguageServer` should wait after an edit before starting to compute diagnostics and sending
-    /// a `PublishDiagnosticsNotification`.
+    /// The time that `SwiftLanguageService` should wait after an edit before starting to compute diagnostics and
+    /// sending a `PublishDiagnosticsNotification`.
     ///
     /// This is mostly intended for testing purposes so we don't need to wait the debouncing time to get a diagnostics
     /// notification when running unit tests.