Merge pull request #686 from compnerd/utility

SourceKit: sever dependency on `TSCUtility`

Author: compnerd

Sources/SKCore/CMakeLists.txt

@@ -24,5 +24,4 @@ target_link_libraries(SKCore PRIVATE
   LanguageServerProtocolJSONRPC
   PackageModel
   SKSupport
-  SourceKitD
-  TSCUtility)
+  SourceKitD)

Sources/SKCore/FallbackBuildSystem.swift

@@ -12,11 +12,12 @@
 
 import BuildServerProtocol
 import LanguageServerProtocol
+import SKSupport
+import Foundation
 import Dispatch
 
 import class TSCBasic.Process
 import struct TSCBasic.AbsolutePath
-import enum TSCUtility.Platform
 
 /// A simple BuildSystem suitable as a fallback when accurate settings are unknown.
 public final class FallbackBuildSystem: BuildSystem {
@@ -29,14 +30,8 @@ public final class FallbackBuildSystem: BuildSystem {
 
   /// The path to the SDK.
   public lazy var sdkpath: AbsolutePath? = {
-    if case .darwin? = Platform.currentPlatform,
-       let str = try? Process.checkNonZeroExit(
-         args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx"),
-       let path = try? AbsolutePath(validating: str.spm_chomp())
-    {
-      return path
-    }
-    return nil
+    guard Platform.current == .darwin else { return nil }
+    return try? AbsolutePath(validating: Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx").trimmingCharacters(in: .whitespacesAndNewlines))
   }()
 
   /// Delegate to handle any build system events.

Sources/SKCore/Toolchain.swift

@@ -17,7 +17,6 @@ import SKSupport
 import struct TSCBasic.AbsolutePath
 import protocol TSCBasic.FileSystem
 import var TSCBasic.localFileSystem
-import enum TSCUtility.Platform
 
 /// A Toolchain is a collection of related compilers and libraries meant to be used together to
 /// build and edit source code.
@@ -135,7 +134,7 @@ extension Toolchain {
 
     var foundAny = false
 
-    let execExt = Platform.currentPlatform?.executableExtension ?? ""
+    let execExt = Platform.current?.executableExtension ?? ""
 
     let clangPath = binPath.appending(component: "clang\(execExt)")
     if fs.isExecutableFile(clangPath) {
@@ -162,7 +161,7 @@ extension Toolchain {
 
     // If 'currentPlatform' is nil it's most likely an unknown linux flavor.
     let dylibExt: String
-    if let dynamicLibraryExtension = Platform.currentPlatform?.dynamicLibraryExtension {
+    if let dynamicLibraryExtension = Platform.current?.dynamicLibraryExtension {
       dylibExt = dynamicLibraryExtension
     } else {
       log("Could not determine host OS. Falling back to using '.so' as dynamic library extension", level: .error)

Sources/SKCore/ToolchainRegistry.swift

@@ -351,11 +351,7 @@ extension ToolchainRegistry {
 
   /// The path of the current Xcode.app/Contents/Developer.
   public static var currentXcodeDeveloperPath: AbsolutePath? {
-    if let str = try? Process.checkNonZeroExit(args: "/usr/bin/xcode-select", "-p"),
-       let path = try? AbsolutePath(validating: str.spm_chomp())
-    {
-      return path
-    }
-    return nil
+    guard let str = try? Process.checkNonZeroExit(args: "/usr/bin/xcode-select", "-p") else { return nil }
+    return try? AbsolutePath(validating: str.trimmingCharacters(in: .whitespacesAndNewlines))
   }
 }

Sources/SKSupport/CMakeLists.txt

@@ -10,5 +10,3 @@ add_library(SKSupport STATIC
   dlopen.swift)
 set_target_properties(SKSupport PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
-target_link_libraries(SKSupport PRIVATE
-  TSCUtility)

Sources/SKSupport/Platform.swift

@@ -10,10 +10,46 @@
 //
 //===----------------------------------------------------------------------===//
 
-import enum TSCUtility.Platform
+import Foundation
+
+import class TSCBasic.Process
+import struct TSCBasic.AbsolutePath
+import var TSCBasic.localFileSystem
+
+private func isAndroid() -> Bool {
+  return (try? localFileSystem.isFile(AbsolutePath(validating: "/system/bin/toolchain"))) ?? false ||
+      (try? localFileSystem.isFile(AbsolutePath(validating: "/system/bin/toybox"))) ?? false
+}
+
+public enum Platform: Equatable {
+  case android
+  case darwin
+  case linux
+  case windows
+}
 
 extension Platform {
+  // This is not just a computed property because the ToolchainRegistryTests
+  // change the value.
+  public static var current: Platform? = {
+    #if os(Windows)
+    return .windows
+    #else
+    switch try? Process.checkNonZeroExit(args: "uname")
+        .trimmingCharacters(in: .whitespacesAndNewlines)
+        .lowercased() {
+    case "darwin"?:
+      return .darwin
+    case "linux"?:
+      return isAndroid() ? .android : .linux
+    default:
+      return nil
+    }
+    #endif
+  }()
+}
 
+extension Platform {
   /// The file extension used for a dynamic library on this platform.
   public var dynamicLibraryExtension: String {
     switch self {

Sources/SKTestSupport/HostPlatform.swift

@@ -13,6 +13,7 @@
 import SourceKitLSP
 import LanguageServerProtocol
 import SKCore
+import SKSupport
 import IndexStoreDB
 import ISDBTibs
 import ISDBTestSupport
@@ -21,7 +22,6 @@ import Foundation
 import LSPTestSupport
 
 import struct TSCBasic.AbsolutePath
-import enum TSCUtility.Platform
 import struct PackageModel.BuildFlags
 
 public typealias URL = Foundation.URL
@@ -237,7 +237,7 @@ extension Location {
 
 extension TibsToolchain {
   public convenience init(_ sktc: Toolchain) {
-    let execExt: String = Platform.currentPlatform?.executableExtension ?? ""
+    let execExt: String = Platform.current?.executableExtension ?? ""
 
     let ninja: URL?
     if let ninjaPath = ProcessInfo.processInfo.environment["NINJA_BIN"] {

Sources/SKTestSupport/SKTibsTestWorkspace.swift

@@ -15,5 +15,4 @@ set_target_properties(SourceKitD PROPERTIES
 target_link_libraries(SourceKitD PRIVATE
   Csourcekitd
   LSPLogging
-  SKSupport
-  TSCUtility)
+  SKSupport)

Sources/SourceKitD/CMakeLists.txt

@@ -46,8 +46,7 @@ target_link_libraries(SourceKitLSP PUBLIC
   SwiftSyntax::SwiftParser
   SwiftSyntax::SwiftDiagnostics
   SwiftSyntax::SwiftSyntax
-  SwiftSyntax::IDEUtils
-  TSCUtility)
+  SwiftSyntax::IDEUtils)
 target_link_libraries(SourceKitLSP PRIVATE
   $<$<NOT:$<PLATFORM_ID:Darwin>>:FoundationXML>)
 

Sources/SourceKitLSP/CMakeLists.txt

@@ -5,8 +5,7 @@ target_link_libraries(sourcekit-lsp PRIVATE
   ArgumentParser
   LanguageServerProtocolJSONRPC
   SKCore
-  SourceKitLSP
-  TSCUtility)
+  SourceKitLSP)
 target_link_libraries(sourcekit-lsp PRIVATE
   $<$<NOT:$<PLATFORM_ID:Darwin>>:FoundationXML>)
 

Sources/sourcekit-lsp/CMakeLists.txt

@@ -11,11 +11,10 @@
 //===----------------------------------------------------------------------===//
 
 import SKCore
+import SKSupport
 import TSCBasic
 import XCTest
 
-import enum TSCUtility.Platform
-
 final class ToolchainRegistryTests: XCTestCase {
   func testDefaultBasic() {
     let tr = ToolchainRegistry()
@@ -33,9 +32,9 @@ final class ToolchainRegistryTests: XCTestCase {
   }
 
   func testDefaultDarwin() {
-    let prevPlatform = Platform.currentPlatform
-    defer { Platform.currentPlatform = prevPlatform }
-    Platform.currentPlatform = .darwin
+    let prevPlatform = Platform.current
+    defer { Platform.current = prevPlatform }
+    Platform.current = .darwin
 
     let tr = ToolchainRegistry()
     tr.darwinToolchainOverride = nil
@@ -51,9 +50,9 @@ final class ToolchainRegistryTests: XCTestCase {
   }
 
   func testUnknownPlatform() {
-    let prevPlatform = Platform.currentPlatform
-    defer { Platform.currentPlatform = prevPlatform }
-    Platform.currentPlatform = nil
+    let prevPlatform = Platform.current
+    defer { Platform.current = prevPlatform }
+    Platform.current = nil
 
     let fs = InMemoryFileSystem()
     let binPath = AbsolutePath("/foo/bar/my_toolchain/bin")
@@ -548,7 +547,7 @@ private func makeToolchain(
 #endif
   }
 
-  let execExt = Platform.currentPlatform?.executableExtension ?? ""
+  let execExt = Platform.current?.executableExtension ?? ""
 
   if clang {
     makeExec(binPath.appending(component: "clang\(execExt)"))
@@ -560,7 +559,7 @@ private func makeToolchain(
     makeExec(binPath.appending(component: "swiftc\(execExt)"))
   }
 
-  let dylibSuffix = Platform.currentPlatform?.dynamicLibraryExtension ?? ".so"
+  let dylibSuffix = Platform.current?.dynamicLibraryExtension ?? ".so"
 
   if sourcekitd {
     try! fs.createDirectory(libPath.appending(component: "sourcekitd.framework"))

Tests/SKCoreTests/ToolchainRegistryTests.swift

@@ -16,6 +16,7 @@ import LSPTestSupport
 import LSPLogging
 import SourceKitLSP
 import SourceKitD
+import SKSupport
 import SKTestSupport
 import XCTest
 
@@ -42,7 +43,7 @@ fileprivate extension HoverResponse {
 
 final class CrashRecoveryTests: XCTestCase {
   func testSourcekitdCrashRecovery() throws {
-    try XCTSkipUnless(isDarwinHost, "Linux and Windows use in-process sourcekitd")
+    try XCTSkipUnless(Platform.current == .darwin, "Linux and Windows use in-process sourcekitd")
     try XCTSkipUnless(longTestsEnabled)
 
     let ws = try! staticSourceKitTibsWorkspace(name: "sourcekitdCrashRecovery")!

Tests/SourceKitDTests/CrashRecoveryTests.swift

@@ -13,25 +13,23 @@
 import LSPTestSupport
 import SourceKitD
 import SKCore
+import SKSupport
 import TSCBasic
 import ISDBTibs
 import ISDBTestSupport
+import Foundation
 import XCTest
 
-import enum TSCUtility.Platform
+import class TSCBasic.Process
 
 final class SourceKitDTests: XCTestCase {
   static var sourcekitdPath: AbsolutePath! = nil
   static var sdkpath: String? = nil
 
   override class func setUp() {
     sourcekitdPath = ToolchainRegistry.shared.default!.sourcekitd!
-    if case .darwin? = Platform.currentPlatform,
-       let str = try? Process.checkNonZeroExit(
-        args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx")
-    {
-      sdkpath = str.spm_chomp()
-    }
+    guard case .darwin? = Platform.current else { return }
+    sdkpath = try? Process.checkNonZeroExit(args: "/usr/bin/xcrun", "--show-sdk-path", "--sdk", "macosx").trimmingCharacters(in: .whitespacesAndNewlines)
   }
 
   func testMultipleNotificationHandlers() {