Split toolchain-related functionality out of SKCore

Author: ahoppen

Documentation/Modules.md

@@ -67,14 +67,6 @@ This includes:
 - SplitShellCommand.swift
 - WorkspaceType.swift
 
-#### ToolchainRegistry
-
-Discovers Swift toolchains on the system.
-
-- Toolchain.swift
-- ToolchainRegistry.swift
-- XCToolchainPlist.swift
-
 ### SKLogging
 
 Types that are API-compatible with OSLog to allow logging to OSLog when building for Darwin platforms and logging to stderr or files on non-Darwin platforms. This should not be dependent on any LSP specific types and be portable to other packages.
@@ -112,3 +104,6 @@ This is the core module that implements the SourceKit-LSP server.
 
 Extensions to the Swift standard library and Foundation. Should not have any other dependencies. Any types in here should theoretically make senses to put in the Swift standard library or Foundation and they shouldn't be specific to SourceKit-LSP
 
+#### ToolchainRegistry
+
+Discovers Swift toolchains on the system.

Package.swift

@@ -30,6 +30,7 @@ let package = Package(
         "SKCore",
         "SKSupport",
         "SourceKitLSP",
+        "ToolchainRegistry",
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -81,6 +82,7 @@ let package = Package(
         "SourceKitD",
         "SourceKitLSP",
         "SwiftExtensions",
+        "ToolchainRegistry",
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "SwiftIDEUtils", package: "swift-syntax"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
@@ -98,6 +100,7 @@ let package = Package(
         "SKLogging",
         "SKTestSupport",
         "SourceKitD",
+        "ToolchainRegistry",
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ]
     ),
@@ -111,6 +114,7 @@ let package = Package(
         "SKCore",
         "SKLogging",
         "SourceKitLSP",
+        "ToolchainRegistry",
       ],
       exclude: ["CMakeLists.txt"]
     ),
@@ -159,6 +163,7 @@ let package = Package(
         "SKCore",
         "SKLogging",
         "SwiftExtensions",
+        "ToolchainRegistry",
         .product(name: "IndexStoreDB", package: "indexstore-db"),
       ],
       exclude: ["CMakeLists.txt"]
@@ -185,6 +190,7 @@ let package = Package(
         "SKSupport",
         "SourceKitD",
         "SwiftExtensions",
+        "ToolchainRegistry",
         .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -196,6 +202,7 @@ let package = Package(
       dependencies: [
         "SKCore",
         "SKTestSupport",
+        "ToolchainRegistry",
       ]
     ),
 
@@ -252,6 +259,7 @@ let package = Package(
         "SKCore",
         "SKLogging",
         "SwiftExtensions",
+        "ToolchainRegistry",
         .product(name: "SwiftPM-auto", package: "swift-package-manager"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -266,6 +274,7 @@ let package = Package(
         "SKSwiftPMWorkspace",
         "SKTestSupport",
         "SourceKitLSP",
+        "ToolchainRegistry",
         .product(name: "SwiftPM-auto", package: "swift-package-manager"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ]
@@ -285,6 +294,7 @@ let package = Package(
         "SKSupport",
         "SourceKitLSP",
         "SwiftExtensions",
+        "ToolchainRegistry",
         .product(name: "ISDBTestSupport", package: "indexstore-db"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
@@ -311,6 +321,7 @@ let package = Package(
         "SKCore",
         "SKTestSupport",
         "SwiftExtensions",
+        "ToolchainRegistry",
       ]
     ),
 
@@ -329,6 +340,7 @@ let package = Package(
         "SKSwiftPMWorkspace",
         "SourceKitD",
         "SwiftExtensions",
+        "ToolchainRegistry",
         .product(name: "IndexStoreDB", package: "indexstore-db"),
         .product(name: "SwiftBasicFormat", package: "swift-syntax"),
         .product(name: "Crypto", package: "swift-crypto"),
@@ -356,6 +368,7 @@ let package = Package(
         "SKTestSupport",
         "SourceKitD",
         "SourceKitLSP",
+        "ToolchainRegistry",
         .product(name: "IndexStoreDB", package: "indexstore-db"),
         .product(name: "ISDBTestSupport", package: "indexstore-db"),
         .product(name: "SwiftParser", package: "swift-syntax"),
@@ -374,6 +387,30 @@ let package = Package(
       name: "SwiftExtensions",
       exclude: ["CMakeLists.txt"]
     ),
+
+    // MARK: ToolchainRegistry
+
+    .target(
+      name: "ToolchainRegistry",
+      dependencies: [
+        "SKLogging",
+        "SKSupport",
+        "SwiftExtensions",
+        .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
+        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+      ],
+      exclude: ["CMakeLists.txt"]
+    ),
+
+    .testTarget(
+      name: "ToolchainRegistryTests",
+      dependencies: [
+        "SKTestSupport",
+        "ToolchainRegistry",
+        .product(name: "SwiftPMDataModel-auto", package: "swift-package-manager"),
+        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+      ]
+    ),
   ],
   swiftLanguageVersions: [.v5, .version("6")]
 )

Sources/CMakeLists.txt

@@ -15,3 +15,4 @@ add_subdirectory(SourceKitLSP)
 add_subdirectory(SourceKitD)
 add_subdirectory(sourcekit-lsp)
 add_subdirectory(SwiftExtensions)
+add_subdirectory(ToolchainRegistry)

Sources/Diagnose/CMakeLists.txt

@@ -30,6 +30,7 @@ target_link_libraries(Diagnose PUBLIC
   SKLogging
   SourceKitD
   SwiftExtensions
+  ToolchainRegistry
   ArgumentParser
   SwiftSyntax::SwiftIDEUtils
   SwiftSyntax::SwiftSyntax

Sources/Diagnose/DiagnoseCommand.swift

@@ -12,7 +12,7 @@
 
 import ArgumentParser
 import Foundation
-import SKCore
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process

Sources/Diagnose/IndexCommand.swift

@@ -18,6 +18,7 @@ import SKCore
 import SKSupport
 import SourceKitLSP
 import SwiftExtensions
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process

Sources/Diagnose/ReduceCommand.swift

@@ -12,7 +12,7 @@
 
 import ArgumentParser
 import Foundation
-import SKCore
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process

Sources/Diagnose/ReduceFrontendCommand.swift

@@ -12,7 +12,7 @@
 
 import ArgumentParser
 import Foundation
-import SKCore
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process

Sources/Diagnose/ReproducerBundle.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SKCore
+import ToolchainRegistry
 
 /// Create a folder that contains all files that should be necessary to reproduce a sourcekitd crash.
 /// - Parameters:

Sources/Diagnose/RunSourcekitdRequestCommand.swift

@@ -12,9 +12,9 @@
 
 import ArgumentParser
 import Foundation
-import SKCore
 import SKSupport
 import SourceKitD
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 

Sources/Diagnose/Toolchain+SwiftFrontend.swift

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SKCore
+import ToolchainRegistry
 
 extension Toolchain {
   /// The path to `swift-frontend` in the toolchain, found relative to `swift`.

Sources/InProcessClient/CMakeLists.txt

@@ -10,4 +10,5 @@ target_link_libraries(InProcessClient PUBLIC
   SKCore
   SKLogging
   SourceKitLSP
+  ToolchainRegistry
 )

Sources/InProcessClient/InProcessSourceKitLSPClient.swift

@@ -14,6 +14,7 @@ import LanguageServerProtocol
 import SKCore
 import SKSupport
 import SourceKitLSP
+import ToolchainRegistry
 
 /// Launches a `SourceKitLSPServer` in-process and allows sending messages to it.
 public final class InProcessSourceKitLSPClient: Sendable {

Sources/SKCore/BuildServerBuildSystem.swift

@@ -16,6 +16,7 @@ import LanguageServerProtocolJSONRPC
 import SKLogging
 import SKSupport
 import SwiftExtensions
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 import protocol TSCBasic.FileSystem
@@ -281,7 +282,7 @@ extension BuildServerBuildSystem: BuildSystem {
     return nil
   }
 
-  package func toolchain(for uri: DocumentURI, _ language: Language) async -> SKCore.Toolchain? {
+  package func toolchain(for uri: DocumentURI, _ language: Language) async -> Toolchain? {
     return nil
   }
 

Sources/SKCore/BuildSystem.swift

@@ -13,6 +13,7 @@
 import BuildServerProtocol
 import LanguageServerProtocol
 import SKLogging
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 

Sources/SKCore/BuildSystemManager.swift

@@ -15,6 +15,7 @@ import Dispatch
 import LanguageServerProtocol
 import SKLogging
 import SwiftExtensions
+import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 

Sources/SKCore/CMakeLists.txt

@@ -14,10 +14,7 @@ add_library(SKCore STATIC
   PathPrefixMapping.swift
   SourceKitLSPOptions.swift
   SplitShellCommand.swift
-  Toolchain.swift
-  ToolchainRegistry.swift
-  WorkspaceType.swift
-  XCToolchainPlist.swift)
+  WorkspaceType.swift)
 set_target_properties(SKCore PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
 target_link_libraries(SKCore PUBLIC
@@ -28,5 +25,6 @@ target_link_libraries(SKCore PUBLIC
   SKSupport
   SourceKitD
   SwiftExtensions
+  ToolchainRegistry
   PackageModel
   TSCBasic)

Sources/SKCore/CompilationDatabaseBuildSystem.swift

@@ -15,6 +15,7 @@ import Dispatch
 import LanguageServerProtocol
 import SKLogging
 import SKSupport
+import ToolchainRegistry
 
 import struct Foundation.URL
 import struct TSCBasic.AbsolutePath
@@ -119,7 +120,7 @@ extension CompilationDatabaseBuildSystem: BuildSystem {
     return nil
   }
 
-  package func toolchain(for uri: DocumentURI, _ language: Language) async -> SKCore.Toolchain? {
+  package func toolchain(for uri: DocumentURI, _ language: Language) async -> Toolchain? {
     return nil
   }
 

Sources/SKSwiftPMWorkspace/CMakeLists.txt

@@ -9,6 +9,7 @@ target_link_libraries(SKSwiftPMWorkspace PRIVATE
   SKCore
   SKLogging
   SwiftExtensions
+  ToolchainRegistry
   TSCBasic)
 target_link_libraries(SKSwiftPMWorkspace PUBLIC
   Build

Sources/SKSwiftPMWorkspace/SwiftPMBuildSystem.swift

@@ -25,6 +25,7 @@ import SKSupport
 import SourceControl
 import SourceKitLSPAPI
 import SwiftExtensions
+import ToolchainRegistry
 import Workspace
 
 import struct Basics.AbsolutePath
@@ -36,6 +37,7 @@ import protocol TSCBasic.FileSystem
 import class TSCBasic.Process
 import var TSCBasic.localFileSystem
 import func TSCBasic.resolveSymlinks
+import class ToolchainRegistry.Toolchain
 
 typealias AbsolutePath = Basics.AbsolutePath
 
@@ -61,7 +63,7 @@ package typealias BuildServerTarget = BuildServerProtocol.BuildTarget
 ///
 /// Needed to work around a compiler crash that prevents us from accessing `toolchainRegistry.preferredToolchain` in
 /// `SwiftPMWorkspace.init`.
-private func preferredToolchain(_ toolchainRegistry: ToolchainRegistry) async -> SKCore.Toolchain? {
+private func preferredToolchain(_ toolchainRegistry: ToolchainRegistry) async -> Toolchain? {
   return await toolchainRegistry.preferredToolchain(containing: [
     \.clang, \.clangd, \.sourcekitd, \.swift, \.swiftc,
   ])
@@ -142,7 +144,7 @@ package actor SwiftPMBuildSystem {
   package let toolsBuildParameters: BuildParameters
   package let destinationBuildParameters: BuildParameters
   private let fileSystem: FileSystem
-  private let toolchain: SKCore.Toolchain
+  private let toolchain: Toolchain
 
   private var fileToTargets: [DocumentURI: [SwiftBuildTarget]] = [:]
   private var sourceDirToTargets: [DocumentURI: [SwiftBuildTarget]] = [:]
@@ -528,7 +530,7 @@ extension SwiftPMBuildSystem: SKCore.BuildSystem {
     return nil
   }
 
-  package func toolchain(for uri: DocumentURI, _ language: Language) async -> SKCore.Toolchain? {
+  package func toolchain(for uri: DocumentURI, _ language: Language) async -> Toolchain? {
     return toolchain
   }
 

Sources/SKTestSupport/IndexedSingleSwiftFileTestProject.swift

@@ -15,6 +15,7 @@ import LanguageServerProtocol
 @_spi(Testing) import SKCore
 import SourceKitLSP
 import TSCBasic
+import ToolchainRegistry
 
 package struct IndexedSingleSwiftFileTestProject {
   enum Error: Swift.Error {

Sources/SKTestSupport/SkipUnless.swift

@@ -17,6 +17,7 @@ import RegexBuilder
 import SKLogging
 import SKTestSupport
 import SourceKitLSP
+import ToolchainRegistry
 import XCTest
 
 import enum PackageLoading.Platform

Sources/SKTestSupport/SwiftPMTestProject.swift

@@ -15,6 +15,7 @@ import LanguageServerProtocol
 @_spi(Testing) import SKCore
 import SourceKitLSP
 import TSCBasic
+import ToolchainRegistry
 
 private struct SwiftSyntaxCShimsModulemapNotFoundError: Error {}
 

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -20,6 +20,7 @@ import SKTestSupport
 import SourceKitLSP
 import SwiftExtensions
 import SwiftSyntax
+import ToolchainRegistry
 import XCTest
 
 extension SourceKitLSPOptions {