Use withUnsafeFileSystemRepresentation to get the path of a URL on disk

`URL.path` returns forward slashes in the path on Windows (swiftlang/swift-foundation#973) where we expect backslashes. Work around that by defining our own `filePath` property that is backed by `withUnsafeFileSystemRepresentation`, which produces backslashes.

rdar://137963660

Author: ahoppen

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -587,7 +587,7 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
         logger.error("Toolchain is not a file URL")
         return nil
       }
-      return try AbsolutePath(validating: toolchainUrl.path)
+      return try AbsolutePath(validating: toolchainUrl.filePath)
     }
     if let toolchainPath {
       if let toolchain = await self.toolchainRegistry.toolchain(withPath: toolchainPath) {
@@ -645,10 +645,10 @@ package actor BuildSystemManager: QueueBasedMessageHandler {
         result.formUnion(targets)
       }
       if !filesAndDirectories.directories.isEmpty,
-        let documentPath = AbsolutePath(validatingOrNil: document.fileURL?.path)
+        let documentPath = AbsolutePath(validatingOrNil: try? document.fileURL?.filePath)
       {
         for (directory, info) in filesAndDirectories.directories {
-          guard let directoryPath = AbsolutePath(validatingOrNil: directory.fileURL?.path) else {
+          guard let directoryPath = AbsolutePath(validatingOrNil: try? directory.fileURL?.filePath) else {
             continue
           }
           if documentPath.isDescendant(of: directoryPath) {

Sources/BuildSystemIntegration/CompilationDatabase.swift

@@ -264,7 +264,7 @@ package struct JSONCompilationDatabase: CompilationDatabase, Equatable, Codable
     if let indices = pathToCommands[uri] {
       return indices.map { commands[$0] }
     }
-    if let fileURL = uri.fileURL, let indices = pathToCommands[DocumentURI(fileURL.realpath)] {
+    if let fileURL = try? uri.fileURL?.realpath, let indices = pathToCommands[DocumentURI(fileURL)] {
       return indices.map { commands[$0] }
     }
     return []

Sources/BuildSystemIntegration/DetermineBuildSystem.swift

@@ -14,13 +14,15 @@
 package import LanguageServerProtocol
 import SKLogging
 package import SKOptions
+import SwiftExtensions
 import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
 #else
 import LanguageServerProtocol
 import SKLogging
 import SKOptions
+import SwiftExtensions
 import ToolchainRegistry
 
 import struct TSCBasic.AbsolutePath
@@ -42,7 +44,7 @@ package func determineBuildSystem(
     buildSystemPreference.insert(defaultBuildSystem, at: 0)
   }
   guard let workspaceFolderUrl = workspaceFolder.fileURL,
-    let workspaceFolderPath = try? AbsolutePath(validating: workspaceFolderUrl.path)
+    let workspaceFolderPath = try? AbsolutePath(validating: workspaceFolderUrl.filePath)
   else {
     return nil
   }
@@ -58,7 +60,7 @@ package func determineBuildSystem(
       }
     case .swiftPM:
       if let projectRootURL = SwiftPMBuildSystem.projectRoot(for: workspaceFolderUrl, options: options),
-        let projectRoot = try? AbsolutePath(validating: projectRootURL.path)
+        let projectRoot = try? AbsolutePath(validating: projectRootURL.filePath)
       {
         return .swiftPM(projectRoot: projectRoot)
       }

Sources/BuildSystemIntegration/ExternalBuildSystemAdapter.swift

@@ -16,6 +16,7 @@ import LanguageServerProtocol
 import LanguageServerProtocolJSONRPC
 import SKLogging
 import SKOptions
+import SwiftExtensions
 
 import struct TSCBasic.AbsolutePath
 import func TSCBasic.getEnvSearchPaths
@@ -224,7 +225,7 @@ actor ExternalBuildSystemAdapter {
         .filter { $0.pathExtension == "json" }
 
       if let configFileURL = jsonFiles?.sorted(by: { $0.lastPathComponent < $1.lastPathComponent }).first,
-        let configFilePath = AbsolutePath(validatingOrNil: configFileURL.path)
+        let configFilePath = AbsolutePath(validatingOrNil: try? configFileURL.filePath)
       {
         return configFilePath
       }

Sources/BuildSystemIntegration/SwiftPMBuildSystem.swift

@@ -238,14 +238,16 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
   private var targetDependencies: [BuildTargetIdentifier: Set<BuildTargetIdentifier>] = [:]
 
   static package func projectRoot(for path: URL, options: SourceKitLSPOptions) -> URL? {
-    var path = path.realpath
+    guard var path = orLog("Getting realpath for project root", { try path.realpath }) else {
+      return nil
+    }
     while true {
       let packagePath = path.appending(component: "Package.swift")
       if (try? String(contentsOf: packagePath, encoding: .utf8))?.contains("PackageDescription") ?? false {
         return path
       }
 
-      if (try? AbsolutePath(validating: path.path))?.isRoot ?? true {
+      if (try? AbsolutePath(validating: path.filePath))?.isRoot ?? true {
         break
       }
       path.deleteLastPathComponent()
@@ -572,7 +574,7 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
   package func sourceKitOptions(
     request: TextDocumentSourceKitOptionsRequest
   ) async throws -> TextDocumentSourceKitOptionsResponse? {
-    guard let url = request.textDocument.uri.fileURL, let path = try? AbsolutePath(validating: url.path) else {
+    guard let url = request.textDocument.uri.fileURL, let path = try? AbsolutePath(validating: url.filePath) else {
       // We can't determine build settings for non-file URIs.
       return nil
     }
@@ -587,7 +589,7 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
     }
 
     if !swiftPMTarget.sources.lazy.map(DocumentURI.init).contains(request.textDocument.uri),
-      let substituteFile = swiftPMTarget.sources.sorted(by: { $0.path < $1.path }).first
+      let substituteFile = swiftPMTarget.sources.sorted(by: { $0.description < $1.description }).first
     {
       logger.info("Getting compiler arguments for \(url) using substitute file \(substituteFile)")
       // If `url` is not part of the target's source, it's most likely a header file. Fake compiler arguments for it
@@ -600,7 +602,7 @@ package actor SwiftPMBuildSystem: BuiltInBuildSystem {
       let buildSettings = FileBuildSettings(
         compilerArguments: try await compilerArguments(for: DocumentURI(substituteFile), in: swiftPMTarget),
         workingDirectory: projectRoot.pathString
-      ).patching(newFile: DocumentURI(path.asURL.realpath), originalFile: DocumentURI(substituteFile))
+      ).patching(newFile: DocumentURI(try path.asURL.realpath), originalFile: DocumentURI(substituteFile))
       return TextDocumentSourceKitOptionsResponse(
         compilerArguments: buildSettings.compilerArguments,
         workingDirectory: buildSettings.workingDirectory

Sources/Diagnose/DiagnoseCommand.swift

@@ -14,6 +14,7 @@
 package import ArgumentParser
 import Foundation
 import ToolchainRegistry
+import SwiftExtensions
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process
@@ -22,6 +23,7 @@ import class TSCUtility.PercentProgressAnimation
 import ArgumentParser
 import Foundation
 import ToolchainRegistry
+import SwiftExtensions
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process
@@ -172,7 +174,7 @@ package struct DiagnoseCommand: AsyncParsableCommand {
         .deletingLastPathComponent()
         .deletingLastPathComponent()
 
-      guard let toolchain = try Toolchain(AbsolutePath(validating: toolchainPath.path)),
+      guard let toolchain = try Toolchain(AbsolutePath(validating: toolchainPath.filePath)),
         let sourcekitd = toolchain.sourcekitd
       else {
         continue
@@ -223,7 +225,7 @@ package struct DiagnoseCommand: AsyncParsableCommand {
     #if os(macOS)
     reportProgress(.collectingLogMessages(progress: 0), message: "Collecting log messages")
     let outputFileUrl = bundlePath.appendingPathComponent("log.txt")
-    guard FileManager.default.createFile(atPath: outputFileUrl.path, contents: nil) else {
+    guard FileManager.default.createFile(atPath: try outputFileUrl.filePath, contents: nil) else {
       throw GenericError("Failed to create log.txt")
     }
     let fileHandle = try FileHandle(forWritingTo: outputFileUrl)
@@ -316,7 +318,7 @@ package struct DiagnoseCommand: AsyncParsableCommand {
   @MainActor
   private func addSwiftVersion(toBundle bundlePath: URL) async throws {
     let outputFileUrl = bundlePath.appendingPathComponent("swift-versions.txt")
-    guard FileManager.default.createFile(atPath: outputFileUrl.path, contents: nil) else {
+    guard FileManager.default.createFile(atPath: try outputFileUrl.filePath, contents: nil) else {
       throw GenericError("Failed to create file at \(outputFileUrl)")
     }
     let fileHandle = try FileHandle(forWritingTo: outputFileUrl)
@@ -333,9 +335,9 @@ package struct DiagnoseCommand: AsyncParsableCommand {
         continue
       }
 
-      try fileHandle.write(contentsOf: "\(swiftUrl.path) --version\n".data(using: .utf8)!)
+      try fileHandle.write(contentsOf: "\(swiftUrl.filePath) --version\n".data(using: .utf8)!)
       let process = Process(
-        arguments: [swiftUrl.path, "--version"],
+        arguments: [try swiftUrl.filePath, "--version"],
         outputRedirection: .stream(
           stdout: { try? fileHandle.write(contentsOf: $0) },
           stderr: { _ in }
@@ -417,7 +419,7 @@ package struct DiagnoseCommand: AsyncParsableCommand {
       Bundle created.
       When filing an issue at https://github.com/swiftlang/sourcekit-lsp/issues/new,
       please attach the bundle located at
-      \(bundlePath.path)
+      \(try bundlePath.filePath)
       """
     )
 
@@ -428,7 +430,7 @@ package struct DiagnoseCommand: AsyncParsableCommand {
     // is responsible for showing the diagnose bundle location to the user
     if self.bundleOutputPath == nil {
       do {
-        _ = try await Process.run(arguments: ["open", "-R", bundlePath.path], workingDirectory: nil)
+        _ = try await Process.run(arguments: ["open", "-R", bundlePath.filePath], workingDirectory: nil)
       } catch {
         // If revealing the bundle in Finder should fail, we don't care. We still printed the bundle path to stdout.
       }

Sources/Diagnose/ReproducerBundle.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
+import SwiftExtensions
 import ToolchainRegistry
 
 /// Create a folder that contains all files that should be necessary to reproduce a sourcekitd crash.
@@ -26,7 +27,7 @@ func makeReproducerBundle(for requestInfo: RequestInfo, toolchain: Toolchain, bu
     encoding: .utf8
   )
   if let toolchainPath = toolchain.path {
-    try toolchainPath.asURL.realpath.path
+    try toolchainPath.asURL.realpath.filePath
       .write(
         to: bundlePath.appendingPathComponent("toolchain.txt"),
         atomically: true,
@@ -59,7 +60,7 @@ func makeReproducerBundle(for requestInfo: RequestInfo, toolchain: Toolchain, bu
       // aren't user specific and would bloat the reproducer bundle.
       continue
     }
-    let dest = URL(fileURLWithPath: bundlePath.path + path)
+    let dest = URL(fileURLWithPath: try bundlePath.filePath + path)
     try? FileManager.default.createDirectory(at: dest.deletingLastPathComponent(), withIntermediateDirectories: true)
     try? FileManager.default.copyItem(at: URL(fileURLWithPath: String(path)), to: dest)
   }

Sources/Diagnose/RequestInfo.swift

@@ -13,9 +13,11 @@
 #if compiler(>=6)
 package import Foundation
 import RegexBuilder
+import SwiftExtensions
 #else
 import Foundation
 import RegexBuilder
+import SwiftExtensions
 #endif
 
 /// All the information necessary to replay a sourcektid request.
@@ -48,7 +50,7 @@ package struct RequestInfo: Sendable {
       requestTemplate
       .replacingOccurrences(of: "$OFFSET", with: String(offset))
       .replacingOccurrences(of: "$COMPILER_ARGS", with: compilerArgs)
-      .replacingOccurrences(of: "$FILE", with: file.path)
+      .replacingOccurrences(of: "$FILE", with: try file.filePath.replacing(#"\"#, with: #"\\"#))
   }
 
   /// A fake value that is used to indicate that we are reducing a `swift-frontend` issue instead of a sourcekitd issue.

Sources/Diagnose/SourceKitDRequestExecutor.swift

@@ -13,13 +13,15 @@
 #if compiler(>=6)
 package import Foundation
 import SourceKitD
+import SwiftExtensions
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process
 import struct TSCBasic.ProcessResult
 #else
 import Foundation
 import SourceKitD
+import SwiftExtensions
 
 import struct TSCBasic.AbsolutePath
 import class TSCBasic.Process
@@ -147,9 +149,9 @@ package class OutOfProcessSourceKitRequestExecutor: SourceKitRequestExecutor {
   package func runSwiftFrontend(request: RequestInfo) async throws -> SourceKitDRequestResult {
     try request.fileContents.write(to: temporarySourceFile, atomically: true, encoding: .utf8)
 
-    let arguments = request.compilerArgs.replacing(["$FILE"], with: [temporarySourceFile.path])
+    let arguments = request.compilerArgs.replacing(["$FILE"], with: [try temporarySourceFile.filePath])
 
-    let process = Process(arguments: [swiftFrontend.path] + arguments)
+    let process = Process(arguments: [try swiftFrontend.filePath] + arguments)
     try process.launch()
     let result = try await process.waitUntilExit()
 
@@ -167,9 +169,9 @@ package class OutOfProcessSourceKitRequestExecutor: SourceKitRequestExecutor {
         "debug",
         "run-sourcekitd-request",
         "--sourcekitd",
-        sourcekitd.path,
+        try sourcekitd.filePath,
         "--request-file",
-        temporaryRequestFile.path,
+        try temporaryRequestFile.filePath,
       ]
     )
     try process.launch()

Sources/InProcessClient/InProcessSourceKitLSPClient.swift

@@ -68,7 +68,7 @@ public final class InProcessSourceKitLSPClient: Sendable {
     let serverToClientConnection = LocalConnection(receiverName: "client")
     self.server = SourceKitLSPServer(
       client: serverToClientConnection,
-      toolchainRegistry: ToolchainRegistry(installPath: AbsolutePath(validatingOrNil: toolchainPath?.path)),
+      toolchainRegistry: ToolchainRegistry(installPath: AbsolutePath(validatingOrNil: try? toolchainPath?.filePath)),
       options: options,
       testHooks: TestHooks(),
       onExit: {