SwiftUsd:

Made MethodsReturningReferences be borrowing by default

Build system:
Add support for iOS/visionOS simulator builds of SwiftUsd/OpenUSD
Cherry pick PixarAnimationStudios/OpenUSD#3707 to add support for compiling for iOS/visionOS simulator
Add support for Intel and macOS Universal binaries

Scripts:
Add a `--force` flag to make-swift-package. Now, it will abort if you try to run it and the `generatedPackageDir` already exists unless you use `--force`.
Change how ShellUtil.runCommandAndGetOutput works to avoid swiftlang/swift#57827

Author: maddyadams

Examples/HelloSwiftUsd_CLI_SPM/Package.swift

@@ -25,7 +25,7 @@ let package = Package(
     name: "HelloSwiftUsd_SPM",
     platforms: [.macOS(.v15)],
     dependencies: [
-        .package(url: "https://github.com/apple/SwiftUsd", from: "5.0.2"),
+        .package(url: "https://github.com/apple/SwiftUsd", from: "5.2.0"),
     ],
     targets: [
         .executableTarget(

SwiftUsd.docc/AboutThisRepo/ReleaseChecklist.md

@@ -49,6 +49,7 @@ Checklist for releasing new versions of SwiftUsd
         1. [Getting Started, "Swift Package"](<doc:GettingStarted#Swift-Package>)
         1. make-spm-tests.py in SwiftUsdTests
         1. project.pbxproj in SwiftUsdTests
+        1. project.pbxproj for each Xcode project in Examples
 1. If files have been added or removed, update [Miscellaneous, "Repo structure"](<doc:Miscellaneous#Repo-structure>)
 1. Update [Ongoing Work](<doc:OngoingWork>)
 1. Update the [Change Log](<doc:ChangeLog>)

SwiftUsd.docc/TechnicalDetails/ChangesToOpenUSD.md

@@ -14,6 +14,10 @@ These changes fix bugs or add features to Usd that aren't part of vanilla OpenUS
 - Cherry pick 4cf5fee816332f98af626f44a5cd852e06093e08 to avoid increasing memory footprint when using UsdImagingGLEngine on macOS:
   - Modified: `pxr/imaging/hdx/taskControllerSceneIndex.cpp`
 
+- Cherry pick https://github.com/PixarAnimationStudios/OpenUSD/pull/3707 to add support for compiling for iOS simulator:
+  - Modified: `build_scripts/apple_utils.py`
+  - Modified: `build_scripts/build_usd.py`
+
 #### Swift-specific changes to OpenUSD before building
 These changes work around Swift-specific issues in vanilla OpenUSD, add Swift-specific features, and work around issues in the Swift compiler.  
 - Header modularization fixes:

openusd-patch.patch

@@ -88,7 +88,11 @@ struct CLIArgs: AsyncParsableCommand {
     """)
     var artifactsHostingURL: String?
 
-    
+    @Flag(help: """
+                If `generatedPackageDir` already exists, make-swift-package will exit to avoid overwriting it
+                unless --force is passed
+                """)
+    var force: Bool = false
 
 
 

scripts/make-swift-package/Sources/CLIArgs.swift

@@ -138,14 +138,19 @@ struct FileSystemInfo {
             switch $0.lastPathComponent {
             case "ios-arm64": return ".iOS"
             case "macos-arm64": return ".macOS"
+            case "macos-x86_64": return ".macOS"
+            case "macos-arm64_x86_64": return ".macOS"
+            case "ios-arm64-simulator": return ".iOS"
+            case "xros-arm64": return ".visionOS"
+            case "xros-arm64-simulator": return ".visionOS"
             case "Info.plist": return nil
             default:
                 print("Warning: Unknown xcframework platform subdirectory: \($0.lastPathComponent)")
                 return $0.lastPathComponent
             }
         }
 
-        return ".when(platforms: [\(subdirNames.joined(separator: ", "))])"
+        return ".when(platforms: [\(Set(subdirNames).sorted().joined(separator: ", "))])"
     }
 
 }
@@ -414,7 +419,6 @@ fileprivate func _getSwiftUsdRepoURL() -> URL {
 fileprivate func getPlatformNameForDylib(_ dylib: URL) async throws -> String {
     #if canImport(Darwin)
     let vtoolOutput = try await ShellUtil.runCommandAndGetOutput(arguments: ["vtool", "-show-build", dylib])
-        .reduce([]) { $0 + [$1] }
     guard let platformLine = vtoolOutput.first(where: { $0.trimmingCharacters(in: .whitespaces).starts(with: "platform")} ) else {
         throw ValidationError("vtool -show-build parsing failure")
     }
@@ -424,6 +428,9 @@ fileprivate func getPlatformNameForDylib(_ dylib: URL) async throws -> String {
     switch platform {
     case "MACOS": return "macOS"
     case "IOS": return "iOS"
+    case "IOSSIMULATOR": return "iOSSimulator"
+    case "VISIONOS": return "visionOS"
+    case "VISIONOSSIMULATOR": return "visionOSSimulator"
     default:
         print("Warning! Unknown vtool platform \(platform)")
         return platform

scripts/make-swift-package/Sources/FileSystemInfo.swift

@@ -240,7 +240,7 @@ struct Framework: Sendable {
     /// Greps for `cmd` in the load commands of the dylib,
     /// returning the path associated with the command
     private func grepOtool(_ cmd: String) async -> [String] {
-        let otoolOutput = try! await ShellUtil.runCommandAndGetOutput(arguments: ["otool", "-l", fsInfo.dylib]).reduce([]) { $0 + [$1] }
+        let otoolOutput = try! await ShellUtil.runCommandAndGetOutput(arguments: ["otool", "-l", fsInfo.dylib])
 
         var result = [String]()
 
@@ -402,15 +402,15 @@ struct Framework: Sendable {
         var result = [URL]()
         do {
             // Just use `otool` and extract the `@rpath` dylibs, relative to the `lib_dir`
-            for try await line in try! ShellUtil.runCommandAndGetOutput(arguments: ["otool", "-L", dylib]) {
+            for line in try! await ShellUtil.runCommandAndGetOutput(arguments: ["otool", "-L", dylib]) {
                 let pattern = #/\s*@rpath/(.*\.dylib) \(compatibility version .*, current version .*\)/#
                 if let match = line.wholeMatch(of: pattern)?.output.1 {
                     let toAppend = usdInstall.libDir.appending(path: match)
                     if !FileManager.default.fileExists(at: toAppend) {
                         // otool -L told us about an rpath dependency we can't find.
                         // if this happens because the dependency is itself, that's okay.
                         // (otool -L outputs the shared library ID when ran on a shared library)
-                        let sharedLibraryId = (try! await ShellUtil.runCommandAndGetOutput(arguments: ["otool", "-D", dylib]).reduce([]) { $0 + [$1] })[1]
+                        let sharedLibraryId = (try! await ShellUtil.runCommandAndGetOutput(arguments: ["otool", "-D", dylib]))[1]
                         if sharedLibraryId.wholeMatch(of: #/@rpath/(.*\.dylib)/#)?.output.1 == match {
                             continue
                         } else {
@@ -435,8 +435,6 @@ struct Framework: Sendable {
                     print("Did you mean to use `--ignore-paths` or `--ignore-homebrew` when building OpenUSD?")
                 }
             }
-        } catch {
-            fatalError(String(describing: error))
         }
 
         return result

scripts/make-swift-package/Sources/Framework.swift

@@ -65,6 +65,15 @@ struct SwiftPackage {
     }
 
     private func setupDirectoryStructure() async throws {
+        if fm.fileExists(atPath: fsInfo.swiftUsdPackage.generatedSwiftPackageDir.path(percentEncoded: false)) {
+            if cliArgs.force {
+                try! fm.removeItem(at: fsInfo.swiftUsdPackage.generatedSwiftPackageDir)
+            } else {
+                print("Error: \(fsInfo.swiftUsdPackage.generatedSwiftPackageDir.relativePath) already exists.")
+                print("Choose another destination, or pass `--force` to overwrite it.")
+                throw ValidationError("\(fsInfo.swiftUsdPackage.generatedSwiftPackageDir.relativePath) already exists but `--force` wasn't passed")
+            }
+        }
         try! fm.createDirectory(at: fsInfo.swiftUsdPackage.generatedSwiftPackageDir, withIntermediateDirectories: true)
         try! fsInfo.packageConfigInfo.write(to: fsInfo.packageConfigInfoUrl, atomically: true, encoding: .utf8)
         try! fm.createDirectory(at: fsInfo.swiftUsdPackage.tmpDir, withIntermediateDirectories: true)
@@ -132,7 +141,7 @@ struct SwiftPackage {
             let dest = cliArgs.checksummedArtifactsDir!.appending(path: "\(src.lastPathComponent).zip")
             try await ShellUtil.runCommandAndWait(arguments: ["ditto", "-c", "-k", "--sequesterRsrc", src, dest])
 
-            let opensslOutput = try await ShellUtil.runCommandAndGetOutput(arguments: ["openssl", "dgst", "-sha256", dest]).reduce([]) { $0 + [$1] }
+            let opensslOutput = try await ShellUtil.runCommandAndGetOutput(arguments: ["openssl", "dgst", "-sha256", dest])
             guard let checksum = opensslOutput[0].wholeMatch(of: #/SHA256\(.*\.xcframework\.zip\)= ([0-9a-f]*)/#)?.output.1 else {
                 throw ValidationError("openssl checksumming error! Got \(opensslOutput)")
             }
@@ -311,6 +320,7 @@ struct SwiftPackage {
                     "module \(moduleName) {",
                     "    // \(shortName) is not available on embedded platforms",
                     "    requires !ios",
+                    "    requires !xros",
                     "}"
                 ]
             } else {

scripts/make-swift-package/Sources/SwiftPackage.swift

@@ -196,8 +196,8 @@ extension ShellUtil {
         }
     }
     #endif
-
-    public static func runCommandAndGetOutput(arguments: [any Argument], exitOnSigint: Bool = true) throws -> ShellUtilCommandOutput {
+    
+    public static func runCommandAndGetOutput(arguments: [any Argument], exitOnSigint: Bool = true) async throws -> [String] {
         let output = Pipe()
 
         let process = Process()
@@ -210,12 +210,13 @@ extension ShellUtil {
         process.executableURL = URL(filePath: "/bin/bash")
         process.arguments = ["-c", arguments.map { $0.asSpaceEscapedString() }.joined(separator: " ")]
         try process.run()
-
-        #if os(macOS)
-        return output.fileHandleForReading.bytes.lines
-        #else
-        return .init(output.fileHandleForReading)
-        #endif
+        
+        let result = try await output.fileHandleForReading.bytes.lines.map { $0 }.reduce([]) { $0 + [$1] }
+        
+        try output.fileHandleForReading.close()
+        try output.fileHandleForWriting.close()
+        
+        return result
     }
 
     public static func runCommandAndWait(arguments: [any Argument], currentDirectoryURL: URL? = nil, exitOnSigint: Bool = true, quiet: Bool = false) async throws {