Merge pull request #2234 from ahoppen/move-swiftlanguageservice

Move `SwiftLanguageService` into its own module

Author: ahoppen

Package.swift

@@ -267,6 +267,7 @@ var targets: [Target] = [
       "SKLogging",
       "SKOptions",
       "SourceKitLSP",
+      "SwiftLanguageService",
       "ToolchainRegistry",
       "TSCExtensions",
     ],
@@ -464,6 +465,7 @@ var targets: [Target] = [
       "SourceKitD",
       "SourceKitLSP",
       "SwiftExtensions",
+      "SwiftLanguageService",
       "ToolchainRegistry",
       "TSCExtensions",
       .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
@@ -533,17 +535,8 @@ var targets: [Target] = [
       "ToolchainRegistry",
       "TSCExtensions",
       .product(name: "IndexStoreDB", package: "indexstore-db"),
-      .product(name: "Crypto", package: "swift-crypto"),
       .product(name: "Markdown", package: "swift-markdown"),
-      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
-    ]
-      + swiftPMDependency([
-        .product(name: "SwiftPM-auto", package: "swift-package-manager")
-      ])
-      + swiftSyntaxDependencies([
-        "SwiftBasicFormat", "SwiftDiagnostics", "SwiftIDEUtils", "SwiftParser", "SwiftParserDiagnostics",
-        "SwiftRefactor", "SwiftSyntax",
-      ]),
+    ] + swiftSyntaxDependencies(["SwiftSyntax"]),
     exclude: ["CMakeLists.txt"],
     swiftSettings: globalSwiftSettings
   ),
@@ -597,6 +590,48 @@ var targets: [Target] = [
     swiftSettings: globalSwiftSettings
   ),
 
+  // MARK: SwiftLanguageService
+
+  .target(
+    name: "SwiftLanguageService",
+    dependencies: [
+      "BuildServerProtocol",
+      "BuildServerIntegration",
+      "Csourcekitd",
+      "DocCDocumentation",
+      "LanguageServerProtocol",
+      "LanguageServerProtocolExtensions",
+      "LanguageServerProtocolJSONRPC",
+      "SemanticIndex",
+      "SKLogging",
+      "SKOptions",
+      "SKUtilities",
+      "SourceKitD",
+      "SourceKitLSP",
+      "SwiftExtensions",
+      "ToolchainRegistry",
+      "TSCExtensions",
+      .product(name: "IndexStoreDB", package: "indexstore-db"),
+      .product(name: "Crypto", package: "swift-crypto"),
+      .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+    ]
+      + swiftPMDependency([
+        .product(name: "SwiftPM-auto", package: "swift-package-manager")
+      ])
+      + swiftSyntaxDependencies([
+        "SwiftBasicFormat",
+        "SwiftDiagnostics",
+        "SwiftIDEUtils",
+        "SwiftParser",
+        "SwiftParserDiagnostics",
+        "SwiftRefactor",
+        "SwiftSyntax",
+        "SwiftSyntaxBuilder",
+      ]),
+    exclude: ["CMakeLists.txt"],
+    swiftSettings: globalSwiftSettings
+  ),
+
   // MARK: SwiftSourceKitClientPlugin
 
   .target(

Sources/CMakeLists.txt

@@ -1,8 +1,8 @@
 add_compile_options("$<$<COMPILE_LANGUAGE:Swift>:SHELL:-package-name sourcekit_lsp>")
 add_compile_options("$<$<COMPILE_LANGUAGE:Swift>:SHELL:-DRESILIENT_LIBRARIES>")
 add_compile_options("$<$<COMPILE_LANGUAGE:Swift>:SHELL:-swift-version 6>")
-add_subdirectory(BuildServerProtocol)
 add_subdirectory(BuildServerIntegration)
+add_subdirectory(BuildServerProtocol)
 add_subdirectory(CAtomics)
 add_subdirectory(CCompletionScoring)
 add_subdirectory(ClangLanguageService)
@@ -17,10 +17,11 @@ add_subdirectory(SemanticIndex)
 add_subdirectory(SKLogging)
 add_subdirectory(SKOptions)
 add_subdirectory(SKUtilities)
-add_subdirectory(SourceKitLSP)
-add_subdirectory(SourceKitD)
 add_subdirectory(sourcekit-lsp)
+add_subdirectory(SourceKitD)
+add_subdirectory(SourceKitLSP)
 add_subdirectory(SwiftExtensions)
+add_subdirectory(SwiftLanguageService)
 add_subdirectory(SwiftSourceKitClientPlugin)
 add_subdirectory(SwiftSourceKitPlugin)
 add_subdirectory(SwiftSourceKitPluginCommon)

Sources/ClangLanguageService/ClangLanguageService.swift

@@ -12,6 +12,7 @@
 
 import BuildServerIntegration
 import Foundation
+package import IndexStoreDB
 package import LanguageServerProtocol
 import LanguageServerProtocolExtensions
 import LanguageServerProtocolJSONRPC
@@ -100,14 +101,16 @@ package actor ClangLanguageService: LanguageService, MessageHandler {
 
   /// The documents that have been opened and which language they have been
   /// opened with.
-  private var openDocuments: [DocumentURI: Language] = [:]
+  private var openDocuments: [DocumentURI: LanguageServerProtocol.Language] = [:]
 
   /// Type to map `clangd`'s semantic token legend to SourceKit-LSP's.
   private var semanticTokensTranslator: SemanticTokensLegendTranslator? = nil
 
   /// While `clangd` is running, its `Process` object.
   private var clangdProcess: Process?
 
+  package static var builtInCommands: [String] { [] }
+
   /// Creates a language server for the given client referencing the clang binary specified in `toolchain`.
   /// Returns `nil` if `clangd` can't be found.
   package init?(
@@ -500,7 +503,7 @@ extension ClangLanguageService {
       throw ResponseError.unknown("Connection to the editor closed")
     }
 
-    let snapshot = try await sourceKitLSPServer.documentManager.latestSnapshot(req.textDocument.uri)
+    let snapshot = try sourceKitLSPServer.documentManager.latestSnapshot(req.textDocument.uri)
     throw ResponseError.requestFailed(doccDocumentationError: .unsupportedLanguage(snapshot.language))
   }
   #endif
@@ -509,6 +512,13 @@ extension ClangLanguageService {
     return try await forwardRequestToClangd(req)
   }
 
+  package func symbolGraph(
+    forOnDiskContentsOf symbolDocumentUri: DocumentURI,
+    at location: SymbolLocation
+  ) async throws -> String? {
+    return nil
+  }
+
   package func documentSymbolHighlight(_ req: DocumentHighlightRequest) async throws -> [DocumentHighlight]? {
     return try await forwardRequestToClangd(req)
   }
@@ -652,6 +662,10 @@ extension ClangLanguageService {
     return nil
   }
 
+  package static func syntacticTestItems(in uri: DocumentURI) async -> [AnnotatedTestItem] {
+    return []
+  }
+
   package func editsToRename(
     locations renameLocations: [RenameLocation],
     in snapshot: DocumentSnapshot,

Sources/InProcessClient/CMakeLists.txt

@@ -12,6 +12,7 @@ target_link_libraries(InProcessClient PUBLIC
   SKLogging
   SKOptions
   SourceKitLSP
+  SwiftLanguageService
   ToolchainRegistry
 )
 

Sources/InProcessClient/LanguageServiceRegistry+staticallyKnownServices.swift

@@ -13,6 +13,7 @@
 import ClangLanguageService
 import LanguageServerProtocol
 package import SourceKitLSP
+import SwiftLanguageService
 
 extension LanguageServiceRegistry {
   /// All types conforming to `LanguageService` that are known at compile time.

Sources/SKTestSupport/SkipUnless.swift

@@ -18,6 +18,7 @@ import SKLogging
 import SourceKitD
 import SourceKitLSP
 import SwiftExtensions
+import SwiftLanguageService
 import TSCExtensions
 import ToolchainRegistry
 import XCTest
@@ -378,7 +379,7 @@ package actor SkipUnless {
 
       let tokens = SyntaxHighlightingTokens(lspEncodedTokens: response.data)
       return tokens.tokens.last
-        == SourceKitLSP.SyntaxHighlightingToken(
+        == SyntaxHighlightingToken(
           range: Position(line: 1, utf16index: 4)..<Position(line: 1, utf16index: 11),
           kind: .variable,
           modifiers: []

Sources/SourceKitLSP/CMakeLists.txt

@@ -4,20 +4,24 @@ add_library(SourceKitLSP STATIC
   DocumentManager.swift
   DocumentSnapshot+FromFileContents.swift
   DocumentSnapshot+PositionConversions.swift
+  GeneratedInterfaceDocumentURLData.swift
   Hooks.swift
   IndexProgressManager.swift
   IndexStoreDB+MainFilesProvider.swift
-  LanguageServiceRegistry.swift
   LanguageService.swift
+  LanguageServiceRegistry.swift
   LogMessageNotification+representingStructureUsingEmojiPrefixIfNecessary.swift
+  MacroExpansionReferenceDocumentURLData.swift
   MessageHandlingDependencyTracker.swift
+  ReferenceDocumentURL.swift
   Rename.swift
   SemanticTokensLegend+SourceKitLSPLegend.swift
   SharedWorkDoneProgressManager.swift
   SourceKitIndexDelegate.swift
   SourceKitLSPCommandMetadata.swift
   SourceKitLSPServer.swift
   SymbolLocation+DocumentURI.swift
+  SyntacticTestIndex.swift
   TestDiscovery.swift
   TextEdit+IsNoop.swift
   Workspace.swift
@@ -26,80 +30,27 @@ target_sources(SourceKitLSP PRIVATE
   Documentation/DocCDocumentationHandler.swift
   Documentation/DocumentationLanguageService.swift
 )
-target_sources(SourceKitLSP PRIVATE
-  Swift/AdjustPositionToStartOfIdentifier.swift
-  Swift/ClosureCompletionFormat.swift
-  Swift/CodeActions/AddDocumentation.swift
-  Swift/CodeActions/ConvertIntegerLiteral.swift
-  Swift/CodeActions/ConvertJSONToCodableStruct.swift
-  Swift/CodeActions/ConvertStringConcatenationToStringInterpolation.swift
-  Swift/CodeActions/PackageManifestEdits.swift
-  Swift/CodeActions/SyntaxCodeActionProvider.swift
-  Swift/CodeActions/SyntaxCodeActions.swift
-  Swift/CodeActions/SyntaxRefactoringCodeActionProvider.swift
-  Swift/CodeCompletion.swift
-  Swift/CodeCompletionSession.swift
-  Swift/CommentXML.swift
-  Swift/CursorInfo.swift
-  Swift/Diagnostic.swift
-  Swift/DiagnosticReportManager.swift
-  Swift/DocumentFormatting.swift
-  Swift/DocumentSymbols.swift
-  Swift/ExpandMacroCommand.swift
-  Swift/FoldingRange.swift
-  Swift/GeneratedInterfaceDocumentURLData.swift
-  Swift/GeneratedInterfaceManager.swift
-  Swift/GeneratedInterfaceManager.swift
-  Swift/MacroExpansion.swift
-  Swift/MacroExpansionReferenceDocumentURLData.swift
-  Swift/OpenInterface.swift
-  Swift/RefactoringEdit.swift
-  Swift/RefactoringResponse.swift
-  Swift/ReferenceDocumentURL.swift
-  Swift/RelatedIdentifiers.swift
-  Swift/RewriteSourceKitPlaceholders.swift
-  Swift/SemanticRefactorCommand.swift
-  Swift/SemanticRefactoring.swift
-  Swift/SemanticTokens.swift
-  Swift/SwiftCodeLensScanner.swift
-  Swift/SwiftCommand.swift
-  Swift/SwiftLanguageService.swift
-  Swift/SwiftTestingScanner.swift
-  Swift/SymbolInfo.swift
-  Swift/SyntacticSwiftXCTestScanner.swift
-  Swift/SyntacticTestIndex.swift
-  Swift/SyntaxHighlightingToken.swift
-  Swift/SyntaxHighlightingTokenParser.swift
-  Swift/SyntaxHighlightingTokens.swift
-  Swift/SyntaxTreeManager.swift
-  Swift/VariableTypeInfo.swift
-  Swift/WithSnapshotFromDiskOpenedInSourcekitd.swift
-)
 set_target_properties(SourceKitLSP PROPERTIES
-  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY}
+)
 target_link_libraries(SourceKitLSP PUBLIC
   BuildServerProtocol
   BuildServerIntegration
   LanguageServerProtocol
   LanguageServerProtocolExtensions
-  LanguageServerProtocolJSONRPC
   SemanticIndex
-  SKLogging
   SKOptions
   SKUtilities
-  SourceKitD
   SwiftExtensions
   ToolchainRegistry
   IndexStoreDB
-  SwiftSyntax::SwiftBasicFormat
-  SwiftSyntax::SwiftDiagnostics
-  SwiftSyntax::SwiftIDEUtils
-  SwiftSyntax::SwiftParser
-  SwiftSyntax::SwiftParserDiagnostics
-  SwiftSyntax::SwiftRefactor
-  SwiftSyntax::SwiftSyntax)
+  SwiftSyntax::SwiftSyntax
+)
 target_link_libraries(SourceKitLSP PRIVATE
-  PackageModelSyntax
+  LanguageServerProtocolJSONRPC
+  SKLogging
+  SourceKitD
   TSCExtensions
-  $<$<NOT:$<PLATFORM_ID:Darwin>>:FoundationXML>)
+  $<$<NOT:$<PLATFORM_ID:Darwin>>:FoundationXML>
+)
 

Sources/SourceKitLSP/CapabilityRegistry.swift

@@ -20,7 +20,7 @@ import SwiftExtensions
 /// capabilities.
 package final actor CapabilityRegistry {
   /// The client's capabilities as they were reported when sourcekit-lsp was launched.
-  package let clientCapabilities: ClientCapabilities
+  package nonisolated let clientCapabilities: ClientCapabilities
 
   // MARK: Tracking capabilities dynamically registered in the client
 

Sources/SourceKitLSP/DocumentSnapshot+PositionConversions.swift

@@ -237,23 +237,6 @@ extension DocumentSnapshot {
     )
   }
 
-  // MARK: Position <-> SourceKitDPosition
-
-  func sourcekitdPosition(
-    of position: Position,
-    callerFile: StaticString = #fileID,
-    callerLine: UInt = #line
-  ) -> SourceKitDPosition {
-    let utf8Column = lineTable.utf8ColumnAt(
-      line: position.line,
-      utf16Column: position.utf16index,
-      callerFile: callerFile,
-      callerLine: callerLine
-    )
-    // FIXME: Introduce new type for UTF-8 based positions
-    return SourceKitDPosition(line: position.line + 1, utf8Column: utf8Column + 1)
-  }
-
   // MAR: Position <-> SymbolLocation
 
   /// Converts the given UTF-8-offset-based `SymbolLocation` to a UTF-16-based line:column `Position`.

Sources/SourceKitLSP/Documentation/DoccDocumentationHandler.swift

@@ -64,22 +64,10 @@ extension DocumentationLanguageService {
             fetchSymbolGraph: { location in
               guard let symbolWorkspace = try await workspaceForDocument(uri: location.documentUri),
                 let languageService = try await languageService(for: location.documentUri, .swift, in: symbolWorkspace)
-                  as? SwiftLanguageService
               else {
                 throw ResponseError.internalError("Unable to find Swift language service for \(location.documentUri)")
               }
-              return try await languageService.withSnapshotFromDiskOpenedInSourcekitd(
-                uri: location.documentUri,
-                fallbackSettingsAfterTimeout: false
-              ) { (snapshot, compileCommand) in
-                let (_, _, symbolGraph) = try await languageService.cursorInfo(
-                  snapshot,
-                  compileCommand: compileCommand,
-                  Range(snapshot.position(of: location)),
-                  includeSymbolGraph: true
-                )
-                return symbolGraph
-              }
+              return try await languageService.symbolGraph(forOnDiskContentsOf: location.documentUri, at: location)
             }
           )
         else {
@@ -89,21 +77,13 @@ extension DocumentationLanguageService {
         guard
           let symbolWorkspace = try await workspaceForDocument(uri: symbolDocumentUri),
           let languageService = try await languageService(for: symbolDocumentUri, .swift, in: symbolWorkspace)
-            as? SwiftLanguageService
         else {
           throw ResponseError.internalError("Unable to find Swift language service for \(symbolDocumentUri)")
         }
-        let symbolGraph = try await languageService.withSnapshotFromDiskOpenedInSourcekitd(
-          uri: symbolDocumentUri,
-          fallbackSettingsAfterTimeout: false
-        ) { snapshot, compileCommand in
-          try await languageService.cursorInfo(
-            snapshot,
-            compileCommand: compileCommand,
-            Range(snapshot.position(of: symbolOccurrence.location)),
-            includeSymbolGraph: true
-          ).symbolGraph
-        }
+        let symbolGraph = try await languageService.symbolGraph(
+          forOnDiskContentsOf: symbolDocumentUri,
+          at: symbolOccurrence.location
+        )
         guard let symbolGraph else {
           throw ResponseError.internalError("Unable to retrieve symbol graph for \(symbolOccurrence.symbol.name)")
         }