Rename SourceKitServer -> SourceKitLSPServer

This avoid ambiguities whether `SourceKitServer` handles sourcekitd or `sourcekit-lsp`.

Author: ahoppen

Sources/SKTestSupport/IndexedSingleSwiftFileWorkspace.swift

@@ -95,7 +95,7 @@ public struct IndexedSingleSwiftFileWorkspace {
     }
 
     // Create the test client
-    var options = SourceKitServer.Options.testDefault
+    var options = SourceKitLSPServer.Options.testDefault
     options.indexOptions = IndexOptions(
       indexStorePath: try AbsolutePath(validating: indexURL.path),
       indexDatabasePath: try AbsolutePath(validating: indexDBURL.path)

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -20,8 +20,8 @@ import SourceKitLSP
 import SwiftSyntax
 import XCTest
 
-extension SourceKitServer.Options {
-  /// The default SourceKitServer options for testing.
+extension SourceKitLSPServer.Options {
+  /// The default SourceKitLSPServer options for testing.
   public static var testDefault = Self(swiftPublishDiagnosticsDebounceDuration: 0)
 }
 
@@ -44,7 +44,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
   private let moduleCache: URL?
 
   /// The server that handles the requests.
-  public let server: SourceKitServer
+  public let server: SourceKitLSPServer
 
   /// Whether pull or push-model diagnostics should be used.
   ///
@@ -87,7 +87,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
   ///     This allows e.g. a `IndexedSingleSwiftFileWorkspace` to delete its temporary files when they are no longer
   ///     needed.
   public init(
-    serverOptions: SourceKitServer.Options = .testDefault,
+    serverOptions: SourceKitLSPServer.Options = .testDefault,
     useGlobalModuleCache: Bool = true,
     initialize: Bool = true,
     initializationOptions: LSPAny? = nil,
@@ -114,7 +114,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
 
     let serverToClientConnection = LocalConnection()
     self.serverToClientConnection = serverToClientConnection
-    server = SourceKitServer(
+    server = SourceKitLSPServer(
       client: serverToClientConnection,
       toolchainRegistry: ToolchainRegistry.forTesting,
       options: serverOptions,
@@ -262,26 +262,25 @@ public final class TestSourceKitLSPClient: MessageHandler {
 
   /// Handle the next request that is sent to the client with the given handler.
   ///
-  /// By default, `TestSourceKitServer` emits an `XCTFail` if a request is sent
+  /// By default, `TestSourceKitLSPClient` emits an `XCTFail` if a request is sent
   /// to the client, since it doesn't know how to handle it. This allows the
   /// simulation of a single request's handling on the client.
   ///
   /// If the next request that is sent to the client is of a different kind than
-  /// the given handler, `TestSourceKitServer` will emit an `XCTFail`.
+  /// the given handler, `TestSourceKitLSPClient` will emit an `XCTFail`.
   public func handleNextRequest<R: RequestType>(_ requestHandler: @escaping RequestHandler<R>) {
     requestHandlers.append(requestHandler)
   }
 
   // MARK: - Conformance to MessageHandler
 
-  /// - Important: Implementation detail of `TestSourceKitServer`. Do not call
+  /// - Important: Implementation detail of `TestSourceKitLSPServer`. Do not call
   ///   from tests.
   public func handle(_ params: some NotificationType) {
     notificationYielder.yield(params)
   }
 
-  /// - Important: Implementation detail of `TestSourceKitServer`. Do not call
-  ///   from tests.
+  /// - Important: Implementation detail of `TestSourceKitLSPClient`. Do not call from tests.
   public func handle<Request: RequestType>(
     _ params: Request,
     id: LanguageServerProtocol.RequestID,
@@ -393,8 +392,8 @@ public struct DocumentPositions {
 
 /// Wrapper around a weak `MessageHandler`.
 ///
-/// This allows us to set the ``TestSourceKitServer`` as the message handler of
-/// `SourceKitServer` without retaining it.
+/// This allows us to set the ``TestSourceKitLSPClient`` as the message handler of
+/// `SourceKitLSPServer` without retaining it.
 private class WeakMessageHandler: MessageHandler {
   private weak var handler: (any MessageHandler)?
 

Sources/SourceKitLSP/CMakeLists.txt

@@ -8,8 +8,8 @@ add_library(SourceKitLSP STATIC
   Sequence+AsyncMap.swift
   SourceKitIndexDelegate.swift
   SourceKitLSPCommandMetadata.swift
-  SourceKitServer.swift
-  SourceKitServer+Options.swift
+  SourceKitLSPServer.swift
+  SourceKitLSPServer+Options.swift
   TestDiscovery.swift
   ToolchainLanguageServer.swift
   WorkDoneProgressManager.swift

Sources/SourceKitLSP/CapabilityRegistry.swift

@@ -135,7 +135,7 @@ public final actor CapabilityRegistry {
     options: Options,
     forMethod method: String,
     languages: [Language],
-    in server: SourceKitServer,
+    in server: SourceKitLSPServer,
     registrationDict: [CapabilityRegistration: Options],
     setRegistrationDict: (CapabilityRegistration, Options?) -> Void
   ) async {
@@ -176,7 +176,7 @@ public final actor CapabilityRegistry {
   public func registerCompletionIfNeeded(
     options: CompletionOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicCompletionRegistration else { return }
 
@@ -195,7 +195,7 @@ public final actor CapabilityRegistry {
 
   public func registerDidChangeWatchedFiles(
     watchers: [FileSystemWatcher],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicDidChangeWatchedFilesRegistration else { return }
     if let registration = didChangeWatchedFiles {
@@ -230,7 +230,7 @@ public final actor CapabilityRegistry {
   public func registerFoldingRangeIfNeeded(
     options: FoldingRangeOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicFoldingRangeRegistration else { return }
 
@@ -253,7 +253,7 @@ public final actor CapabilityRegistry {
   public func registerSemanticTokensIfNeeded(
     options: SemanticTokensOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicSemanticTokensRegistration else { return }
 
@@ -276,7 +276,7 @@ public final actor CapabilityRegistry {
   public func registerInlayHintIfNeeded(
     options: InlayHintOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicInlayHintRegistration else { return }
     await registerLanguageSpecificCapability(
@@ -297,7 +297,7 @@ public final actor CapabilityRegistry {
   public func registerDiagnosticIfNeeded(
     options: DiagnosticOptions,
     for languages: [Language],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) async {
     guard clientHasDynamicDocumentDiagnosticsRegistration else { return }
 
@@ -318,7 +318,7 @@ public final actor CapabilityRegistry {
   /// it and we haven't yet registered the given command IDs yet.
   public func registerExecuteCommandIfNeeded(
     commands: [String],
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) {
     guard clientHasDynamicExecuteCommandRegistration else { return }
 

Sources/SourceKitLSP/Clang/ClangLanguageServer.swift

@@ -71,10 +71,10 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
   /// requests and notifications sent from clangd to the client is quite small.
   public let clangdMessageHandlingQueue = AsyncQueue<Serial>()
 
-  /// The ``SourceKitServer`` instance that created this `ClangLanguageServerShim`.
+  /// The ``SourceKitLSPServer`` instance that created this `ClangLanguageServerShim`.
   ///
   /// Used to send requests and notifications to the editor.
-  private weak var sourceKitServer: SourceKitServer?
+  private weak var sourceKitServer: SourceKitLSPServer?
 
   /// The connection to the clangd LSP. `nil` until `startClangdProcesss` has been called.
   var clangd: Connection!
@@ -133,9 +133,9 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
   /// Creates a language server for the given client referencing the clang binary specified in `toolchain`.
   /// Returns `nil` if `clangd` can't be found.
   public init?(
-    sourceKitServer: SourceKitServer,
+    sourceKitServer: SourceKitLSPServer,
     toolchain: Toolchain,
-    options: SourceKitServer.Options,
+    options: SourceKitLSPServer.Options,
     workspace: Workspace
   ) async throws {
     guard let clangdPath = toolchain.clangd else {
@@ -282,14 +282,14 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
       do {
         try self.startClangdProcess()
         // FIXME: We assume that clangd will return the same capabilities after restarting.
-        // Theoretically they could have changed and we would need to inform SourceKitServer about them.
-        // But since SourceKitServer more or less ignores them right now anyway, this should be fine for now.
+        // Theoretically they could have changed and we would need to inform SourceKitLSPServer about them.
+        // But since SourceKitLSPServer more or less ignores them right now anyway, this should be fine for now.
         _ = try await self.initialize(initializeRequest)
         self.clientInitialized(InitializedNotification())
         if let sourceKitServer {
           await sourceKitServer.reopenDocuments(for: self)
         } else {
-          logger.fault("Cannot reopen documents because SourceKitServer is no longer alive")
+          logger.fault("Cannot reopen documents because SourceKitLSPServer is no longer alive")
         }
         self.state = .connected
       } catch {
@@ -338,7 +338,7 @@ actor ClangLanguageServerShim: ToolchainLanguageServer, MessageHandler {
     )
     clangdMessageHandlingQueue.async {
       guard let sourceKitServer = await self.sourceKitServer else {
-        // `SourceKitServer` has been destructed. We are tearing down the language
+        // `SourceKitLSPServer` has been destructed. We are tearing down the language
         // server. Nothing left to do.
         reply(.failure(.unknown("Connection to the editor closed")))
         return
@@ -405,7 +405,7 @@ extension ClangLanguageServerShim {
     // incorrect result, making it very temporary.
     let buildSettings = await self.buildSettings(for: notification.uri)
     guard let sourceKitServer else {
-      logger.fault("Cannot publish diagnostics because SourceKitServer has been destroyed")
+      logger.fault("Cannot publish diagnostics because SourceKitLSPServer has been destroyed")
       return
     }
     if buildSettings?.isFallback ?? true {

Sources/SourceKitLSP/Rename.swift

@@ -495,7 +495,7 @@ public struct CrossLanguageName {
   }
 }
 
-// MARK: - SourceKitServer
+// MARK: - SourceKitLSPServer
 
 /// The kinds of symbol occurrence roles that should be renamed.
 fileprivate let renameRoles: SymbolRole = [.declaration, .definition, .reference]
@@ -508,7 +508,7 @@ extension DocumentManager {
   }
 }
 
-extension SourceKitServer {
+extension SourceKitLSPServer {
   /// Returns a `DocumentSnapshot`, a position and the corresponding language service that references
   /// `usr` from a Swift file. If `usr` is not referenced from Swift, returns `nil`.
   private func getReferenceFromSwift(

Sources/SourceKitLSP/SourceKitServer+Options.swift renamed to Sources/SourceKitLSP/SourceKitLSPServer+Options.swift

@@ -18,7 +18,7 @@ import SKSupport
 import struct TSCBasic.AbsolutePath
 import struct TSCBasic.RelativePath
 
-extension SourceKitServer {
+extension SourceKitLSPServer {
 
   /// Configuration options for the SourceKitServer.
   public struct Options {

Sources/SourceKitLSP/SourceKitServer.swift renamed to Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -132,7 +132,7 @@ final actor WorkDoneProgressState {
   /// Start a new task, creating a new `WorkDoneProgress` if none is running right now.
   ///
   /// - Parameter server: The server that is used to create the `WorkDoneProgress` on the client
-  func startProgress(server: SourceKitServer) async {
+  func startProgress(server: SourceKitLSPServer) async {
     activeTasks += 1
     guard await server.capabilityRegistry?.clientCapabilities.window?.workDoneProgress ?? false else {
       // If the client doesn't support workDoneProgress, keep track of the active task count but don't update the state.
@@ -154,7 +154,7 @@ final actor WorkDoneProgressState {
 
   private func handleCreateWorkDoneProgressResponse(
     _ result: Result<VoidResponse, ResponseError>,
-    server: SourceKitServer
+    server: SourceKitLSPServer
   ) {
     if result.success != nil {
       if self.activeTasks == 0 {
@@ -177,7 +177,7 @@ final actor WorkDoneProgressState {
   /// If this drops the active task count to 0, the work done progress is ended on the client.
   ///
   /// - Parameter server: The server that is used to send and update of the `WorkDoneProgress` to the client
-  func endProgress(server: SourceKitServer) async {
+  func endProgress(server: SourceKitLSPServer) async {
     assert(activeTasks > 0, "Unbalanced startProgress/endProgress calls")
     activeTasks -= 1
     guard await server.capabilityRegistry?.clientCapabilities.window?.workDoneProgress ?? false else {
@@ -385,12 +385,12 @@ fileprivate enum TaskMetadata: DependencyTracker {
   }
 }
 
-/// The SourceKit language server.
+/// The SourceKit-LSP server.
 ///
 /// This is the client-facing language server implementation, providing indexing, multiple-toolchain
 /// and cross-language support. Requests may be dispatched to language-specific services or handled
 /// centrally, but this is transparent to the client.
-public actor SourceKitServer {
+public actor SourceKitLSPServer {
   /// The queue on which all messages (notifications, requests, responses) are
   /// handled.
   ///
@@ -422,7 +422,7 @@ public actor SourceKitServer {
   let documentManager = DocumentManager()
 
   private var packageLoadingWorkDoneProgress = WorkDoneProgressState(
-    "SourceKitLSP.SourceKitServer.reloadPackage",
+    "SourceKitLSP.SourceKitLSPServer.reloadPackage",
     title: "SourceKit-LSP: Reloading Package"
   )
 
@@ -813,7 +813,7 @@ private func getNextNotificationIDForLogging() -> Int {
   }
 }
 
-extension SourceKitServer: MessageHandler {
+extension SourceKitLSPServer: MessageHandler {
   public nonisolated func handle(_ params: some NotificationType) {
     if let params = params as? CancelRequestNotification {
       // Request cancellation needs to be able to overtake any other message we
@@ -1018,7 +1018,7 @@ extension SourceKitServer: MessageHandler {
 
 // MARK: - Build System Delegate
 
-extension SourceKitServer: BuildSystemDelegate {
+extension SourceKitLSPServer: BuildSystemDelegate {
   public func buildTargetsChanged(_ changes: [BuildTargetEvent]) {
     // TODO: do something with these changes once build target support is in place
   }
@@ -1104,7 +1104,7 @@ private extension LanguageServerProtocol.WorkspaceType {
 
 // MARK: - Request and notification handling
 
-extension SourceKitServer {
+extension SourceKitLSPServer {
 
   // MARK: - General
 
@@ -1328,7 +1328,7 @@ extension SourceKitServer {
     registry: CapabilityRegistry
   ) async {
     // IMPORTANT: When adding new capabilities here, also add the value of that capability in `SwiftLanguageServer`
-    // to SourceKitServer.serverCapabilities. That way the capabilities get registered for all languages in case the
+    // to SourceKitLSPServer.serverCapabilities. That way the capabilities get registered for all languages in case the
     // client does not support dynamic capability registration.
 
     if let completionOptions = server.completionProvider {
@@ -1544,7 +1544,7 @@ extension SourceKitServer {
     // In practice, it is fine: sourcekit-lsp will not handle any new messages
     // while we are executing this function and thus there's no risk of
     // documents or workspaces changing. To hit the race condition, you need
-    // to invoke the API of `SourceKitServer` directly and open documents
+    // to invoke the API of `SourceKitLSPServer` directly and open documents
     // while this function is executing. Even in such an API use case, hitting
     // that race condition seems very unlikely.
     var preChangeWorkspaces: [DocumentURI: Workspace] = [:]
@@ -2492,7 +2492,7 @@ fileprivate struct NotificationRequestOperation {
 /// Used to queue up notifications and requests for documents which are blocked
 /// on `BuildSystem` operations such as fetching build settings.
 ///
-/// Note: This is not thread safe. Must be called from the `SourceKitServer.queue`.
+/// Note: This is not thread safe. Must be called from the `SourceKitLSPServer.queue`.
 fileprivate struct DocumentNotificationRequestQueue {
   fileprivate var queue = [NotificationRequestOperation]()