Basics: introduce some native path representation helpers

We end up needing these in a few places, and while we could make it
`internal` and use `@testable` imports in the tests, this ends up being
needed in `Build` and `PackageLoading`.  Ideally, we would give it
package visibility, but that functionality would not be backwards
compatible.  This is a reluctant approach at solving that problem by
using `public` visibility.

Author: compnerd

Sources/Basics/CMakeLists.txt

@@ -42,6 +42,7 @@ add_library(Basics
   ImportScanning.swift
   JSON+Extensions.swift
   JSONDecoder+Extensions.swift
+  NativePathExtensions.swift
   Netrc.swift
   Observability.swift
   SQLite.swift

Sources/Basics/NativePathExtensions.swift

@@ -0,0 +1,32 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+import struct TSCBasic.AbsolutePath
+
+extension String {
+    public func _nativePathString(escaped: Bool) -> Self {
+        return URL(fileURLWithPath: self).withUnsafeFileSystemRepresentation {
+            let repr = String(cString: $0!)
+            if escaped {
+                return repr.replacingOccurrences(of: "\\", with: "\\\\")
+            }
+            return repr
+        }
+    }
+}
+
+extension AbsolutePath {
+    public func _nativePathString(escaped: Bool) -> String {
+        return self.pathString._nativePathString(escaped: escaped)
+    }
+}

Sources/Build/BuildDescription/SwiftTargetBuildDescription.swift

@@ -681,7 +681,7 @@ public final class SwiftTargetBuildDescription {
             content +=
                 #"""
                     "dependencies": "\#(
-                    self.tempsPath.appending(component: moduleName + ".d").nativePathString(escaped: true)
+                    self.tempsPath.appending(component: moduleName + ".d")._nativePathString(escaped: true)
                 )",
 
                 """#
@@ -690,15 +690,15 @@ public final class SwiftTargetBuildDescription {
             content +=
                 #"""
                     "object": "\#(
-                    self.tempsPath.appending(component: moduleName + ".o").nativePathString(escaped: true)
+                    self.tempsPath.appending(component: moduleName + ".o")._nativePathString(escaped: true)
                 )",
 
                 """#
 
         }
         content +=
             #"""
-                "swift-dependencies": "\#(masterDepsPath.nativePathString(escaped: true))"
+                "swift-dependencies": "\#(masterDepsPath._nativePathString(escaped: true))"
               },
 
             """#
@@ -716,15 +716,15 @@ public final class SwiftTargetBuildDescription {
 
             content +=
                 #"""
-                  "\#(source.nativePathString(escaped: true))": {
+                  "\#(source._nativePathString(escaped: true))": {
 
                 """#
 
             if !self.buildParameters.useWholeModuleOptimization {
                 let depsPath = objectDir.appending(component: sourceFileName + ".d")
                 content +=
                     #"""
-                        "dependencies": "\#(depsPath.nativePathString(escaped: true))",
+                        "dependencies": "\#(depsPath._nativePathString(escaped: true))",
 
                     """#
                 // FIXME: Need to record this deps file for processing it later.
@@ -735,9 +735,9 @@ public final class SwiftTargetBuildDescription {
 
             content +=
                 #"""
-                    "object": "\#(object.nativePathString(escaped: true))",
-                    "swiftmodule": "\#(partialModulePath.nativePathString(escaped: true))",
-                    "swift-dependencies": "\#(swiftDepsPath.nativePathString(escaped: true))"
+                    "object": "\#(object._nativePathString(escaped: true))",
+                    "swiftmodule": "\#(partialModulePath._nativePathString(escaped: true))",
+                    "swift-dependencies": "\#(swiftDepsPath._nativePathString(escaped: true))"
                   }\#((idx + 1) < sources.count ? "," : "")
 
                 """#

Sources/Build/BuildPlan.swift

@@ -30,18 +30,6 @@ extension String {
     }
 }
 
-extension AbsolutePath {
-    internal func nativePathString(escaped: Bool) -> String {
-        return URL(fileURLWithPath: self.pathString).withUnsafeFileSystemRepresentation {
-            let repr = String(cString: $0!)
-            if escaped {
-                return repr.replacingOccurrences(of: "\\", with: "\\\\")
-            }
-            return repr
-        }
-    }
-}
-
 extension BuildParameters {
     /// Returns the directory to be used for module cache.
     public var moduleCache: AbsolutePath {

Tests/WorkspaceTests/ManifestSourceGenerationTests.swift

@@ -19,21 +19,6 @@ import TSCBasic
 import Workspace
 import XCTest
 
-extension String {
-    fileprivate func nativePathString(escaped: Bool) -> String {
-#if _runtime(_ObjC)
-        return self
-#else
-        let fsr = self.fileSystemRepresentation
-        defer { fsr.deallocate() }
-        if escaped {
-            return String(cString: fsr).replacingOccurrences(of: "\\", with: "\\\\")
-        }
-        return String(cString: fsr)
-#endif
-    }
-}
-
 class ManifestSourceGenerationTests: XCTestCase {
 
     /// Private function that writes the contents of a package manifest to a temporary package directory and then loads it, then serializes the loaded manifest back out again and loads it once again, after which it compares that no information was lost. Return the source of the newly generated manifest.
@@ -282,9 +267,9 @@ class ManifestSourceGenerationTests: XCTestCase {
         let newContents = try testManifestWritingRoundTrip(manifestContents: manifestContents, toolsVersion: .v5_3)
 
         // Check some things about the contents of the manifest.
-        XCTAssertTrue(newContents.contains("url: \"\("../MyPkg10".nativePathString(escaped: true))\""), newContents)
-        XCTAssertTrue(newContents.contains("path: \"\("../MyPkg11".nativePathString(escaped: true))\""), newContents)
-        XCTAssertTrue(newContents.contains("path: \"\("packages/path/to/MyPkg12".nativePathString(escaped: true))"), newContents)
+        XCTAssertTrue(newContents.contains("url: \"\("../MyPkg10"._nativePathString(escaped: true))\""), newContents)
+        XCTAssertTrue(newContents.contains("path: \"\("../MyPkg11"._nativePathString(escaped: true))\""), newContents)
+        XCTAssertTrue(newContents.contains("path: \"\("packages/path/to/MyPkg12"._nativePathString(escaped: true))"), newContents)
     }
 
     func testResources() throws {