Merge pull request #143 from rmaz/separatetoolchain

Separate toolchain discovery from build settings

Author: benlangmuir

Sources/SKCore/BuildSystem.swift

@@ -32,5 +32,8 @@ public protocol BuildSystem {
   /// Returns the settings for the given url and language mode, if known.
   func settings(for: URL, _ language: Language) -> FileBuildSettings?
 
+  /// Returns the toolchain to use to compile this file
+  func toolchain(for: URL, _ language: Language) -> Toolchain?
+
   // TODO: notifications when settings change.
 }

Sources/SKCore/BuildSystemList.swift

@@ -38,4 +38,8 @@ extension BuildSystemList: BuildSystem {
     }
     return nil
   }
+
+  public func toolchain(for url: URL, _ language: Language) -> Toolchain? {
+    return providers.first?.toolchain(for: url, language)
+  }
 }

Sources/SKCore/CompilationDatabaseBuildSystem.swift

@@ -43,12 +43,13 @@ extension CompilationDatabaseBuildSystem: BuildSystem {
     guard let db = database(for: url),
           let cmd = db[url].first else { return nil }
     return FileBuildSettings(
-      preferredToolchain: nil, // FIXME: infer from path
       compilerArguments: Array(cmd.commandLine.dropFirst()),
       workingDirectory: cmd.directory
     )
   }
 
+  public func toolchain(for: URL, _ language: Language) -> Toolchain? { return nil }
+
   func database(for url: URL) -> CompilationDatabase? {
     if let path = try? AbsolutePath(validating: url.path) {
       return database(for: path)

Sources/SKCore/FallbackBuildSystem.swift

@@ -50,6 +50,8 @@ public final class FallbackBuildSystem: BuildSystem {
     }
   }
 
+  public func toolchain(for: URL, _ language: Language) -> Toolchain? { return nil }
+
   func settingsSwift(_ path: AbsolutePath) -> FileBuildSettings {
     var args: [String] = []
     if let sdkpath = sdkpath {
@@ -59,7 +61,7 @@ public final class FallbackBuildSystem: BuildSystem {
       ]
     }
     args.append(path.pathString)
-    return FileBuildSettings(preferredToolchain: nil, compilerArguments: args)
+    return FileBuildSettings(compilerArguments: args)
   }
 
   func settingsClang(_ path: AbsolutePath, _ language: Language) -> FileBuildSettings {
@@ -71,6 +73,6 @@ public final class FallbackBuildSystem: BuildSystem {
       ]
     }
     args.append(path.pathString)
-    return FileBuildSettings(preferredToolchain: nil, compilerArguments: args)
+    return FileBuildSettings(compilerArguments: args)
   }
 }

Sources/SKCore/FileBuildSettings.swift

@@ -12,26 +12,20 @@
 
 /// Build settings for a single file.
 ///
-/// Encapsulates all the settings needed to compile a single file, including the compiler arguments,
-/// working directory, and preferred toolchain if any. FileBuildSettings are typically the result
-/// of a BuildSystem query.
+/// Encapsulates all the settings needed to compile a single file, including the compiler arguments
+/// and working directory. FileBuildSettings are typically the result of a BuildSystem query.
 public struct FileBuildSettings {
 
-  /// The Toolchain that is preferred for compiling this file, if any.
-  public var preferredToolchain: Toolchain? = nil
-
   /// The compiler arguments to use for this file.
   public var compilerArguments: [String]
 
   /// The working directory to resolve any relative paths in `compilerArguments`.
   public var workingDirectory: String? = nil
 
   public init(
-    preferredToolchain: Toolchain? = nil,
     compilerArguments: [String],
     workingDirectory: String? = nil)
   {
-    self.preferredToolchain = preferredToolchain
     self.compilerArguments = compilerArguments
     self.workingDirectory = workingDirectory
   }

Sources/SKSwiftPMWorkspace/SwiftPMWorkspace.swift

@@ -214,6 +214,10 @@ extension SwiftPMWorkspace: BuildSystem {
     return nil
   }
 
+  public func toolchain(for: LanguageServerProtocol.URL, _ language: Language) -> SKCore.Toolchain? {
+    return nil
+  }
+
   /// Returns the resolved target description for the given file, if one is known.
   func targetDescription(for file: AbsolutePath) -> TargetBuildDescription? {
     if let td = fileToTarget[file] {
@@ -257,10 +261,7 @@ extension SwiftPMWorkspace {
     func impl(_ path: AbsolutePath) -> FileBuildSettings? {
       for package in packageGraph.packages where path == package.manifest.path {
         let compilerArgs = workspace.interpreterFlags(for: package.path) + [path.pathString]
-        return FileBuildSettings(
-          preferredToolchain: nil,
-          compilerArguments: compilerArgs
-        )
+        return FileBuildSettings(compilerArguments: compilerArgs)
       }
       return nil
     }
@@ -319,7 +320,6 @@ extension SwiftPMWorkspace {
     args += td.compileArguments()
 
     return FileBuildSettings(
-      preferredToolchain: nil,
       compilerArguments: args,
       workingDirectory: workspacePath.pathString)
   }
@@ -382,7 +382,6 @@ extension SwiftPMWorkspace {
     }
 
     return FileBuildSettings(
-      preferredToolchain: nil,
       compilerArguments: args,
       workingDirectory: workspacePath.pathString)
   }

Sources/SourceKit/SourceKitServer.swift

@@ -134,7 +134,7 @@ public final class SourceKitServer: LanguageServer {
   }
 
   func toolchain(for url: URL, _ language: Language) -> Toolchain? {
-    if let toolchain = workspace?.buildSettings.settings(for: url, language)?.preferredToolchain {
+    if let toolchain = workspace?.buildSettings.toolchain(for: url, language) {
       return toolchain
     }
 

Tests/SKCoreTests/FallbackBuildSystemTests.swift

@@ -28,7 +28,6 @@ final class FallbackBuildSystemTests: XCTestCase {
     XCTAssertNil(bs.indexDatabasePath)
 
     let settings = bs.settings(for: source.asURL, .swift)!
-    XCTAssertNil(settings.preferredToolchain)
     XCTAssertNil(settings.workingDirectory)
 
     let args = settings.compilerArguments
@@ -53,7 +52,6 @@ final class FallbackBuildSystemTests: XCTestCase {
     bs.sdkpath = sdk
 
     let settings = bs.settings(for: source.asURL, .cpp)!
-    XCTAssertNil(settings.preferredToolchain)
     XCTAssertNil(settings.workingDirectory)
 
     let args = settings.compilerArguments