Merge remote-tracking branch 'origin/main' into 6.2-merge-main

Author: dschaefer2

.swift-version

@@ -0,0 +1 @@
+6.1.0

CMakeLists.txt

@@ -45,6 +45,7 @@ if(FIND_PM_DEPS)
   find_package(SwiftASN1 CONFIG REQUIRED)
   find_package(SwiftCertificates CONFIG REQUIRED)
   find_package(SwiftCrypto CONFIG REQUIRED)
+  find_package(SwiftBuild CONFIG REQUIRED)
 endif()
 
 find_package(dispatch QUIET)

CODEOWNERS

@@ -26,4 +26,4 @@
 
 Sources/XCBuildSupport/* @jakepetroules
 
-* @bnbarham @MaxDesiatov @jakepetroules @xedin @dschaefer2 @shawnhyam @bripeticca @plemarquand @owenv @bkhouri @cmcgee1024 @daveyc123
+* @jakepetroules @dschaefer2 @shawnhyam @bripeticca @plemarquand @owenv @bkhouri @cmcgee1024 @daveyc123

CONTRIBUTING.md

@@ -88,7 +88,13 @@ $> swift --version
 Apple Swift version 5.3
 ```
 
-Note: Alternatively use tools like [swiftly](https://www.swift.org/swiftly/documentation/swiftlydocs/) that help manage toolchains versions.
+Alternatively, there are tools like [swiftly](https://github.com/swiftlang/swiftly) that can install and manage toolchains automatically. This repository has a file called `.swift-version` that will keep swiftly at the current recommended version of the toolchain for best results. The `swiftly install` command ensures that SwiftPM's in-use toolchain is installed on your system and ready for you to do your development work with the usual swift commands.
+
+```bash
+swiftly install
+swift build
+swift test
+```
 
 ## Local Development
 
@@ -322,14 +328,15 @@ Note there are several Linux and Swift versions options to choose from, e.g.:
 2. Clone a working copy of your fork
 3. Create a new branch
 4. Make your code changes
-5. Try to keep your changes (when possible) below 200 lines of code.
-6. We use [SwiftFormat](https://www.github.com/nicklockwood/SwiftFormat) to enforce code style. Please install and run SwiftFormat before submitting your PR, ideally isolating formatting changes only to code changed for the original goal of the PR. This will keep the PR diff smaller.
-7. Commit (include the Radar link or GitHub issue id in the commit message if possible and a description your changes). Try to have only 1 commit in your PR (but, of course, if you add changes that can be helpful to be kept aside from the previous commit, make a new commit for them).
-8. Push the commit / branch to your fork
-9. Make a PR from your fork / branch to `apple: main`
-10. While creating your PR, make sure to follow the PR Template providing information about the motivation and highlighting the changes.
-11. Reviewers are going to be automatically added to your PR
-12. Pull requests will be merged by the maintainers after it passes CI testing and receives approval from one or more reviewers. Merge timing may be impacted by release schedule considerations.
+5. If a particular version of the Swift toolchain is needed then update the `.swift-version` file to that version (or use `swiftly use` to update it).
+6. Try to keep your changes (when possible) below 200 lines of code.
+7. We use [SwiftFormat](https://www.github.com/nicklockwood/SwiftFormat) to enforce code style. Please install and run SwiftFormat before submitting your PR, ideally isolating formatting changes only to code changed for the original goal of the PR. This will keep the PR diff smaller.
+8. Commit (include the Radar link or GitHub issue id in the commit message if possible and a description your changes). Try to have only 1 commit in your PR (but, of course, if you add changes that can be helpful to be kept aside from the previous commit, make a new commit for them).
+9. Push the commit / branch to your fork
+10. Make a PR from your fork / branch to `apple: main`
+11. While creating your PR, make sure to follow the PR Template providing information about the motivation and highlighting the changes.
+12. Reviewers are going to be automatically added to your PR
+13. Pull requests will be merged by the maintainers after it passes CI testing and receives approval from one or more reviewers. Merge timing may be impacted by release schedule considerations.
 
 By submitting a pull request, you represent that you have the right to license
 your contribution to Apple and the community, and agree by submitting the patch

Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Binaries/MyVendedSourceGenBuildTool.artifactbundle/info.json

@@ -12,6 +12,10 @@
                 {
                     "path": "mytool-linux/mytool",
                     "supportedTriples": ["x86_64-unknown-linux-gnu"]
+                },
+                {
+                    "path": "mytool-windows/mytool.bat",
+                    "supportedTriples": ["x86_64-unknown-windows-msvc", "aarch64-unknown-windows-msvc"]
                 }
             ]
         }

Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Binaries/MyVendedSourceGenBuildTool.artifactbundle/mytool-windows/mytool.bat

@@ -0,0 +1,21 @@
+@echo off
+
+set verbose=false
+IF NOT "%1"=="" (
+    IF "%1"=="--verbose" (
+        SET verbose=true
+        SHIFT
+    )
+)
+
+set input=%1
+set output=%2
+shift
+shift
+
+
+if "%verbose%" == "true" (
+    echo "[mytool-windows] '%input%' '%output%'"
+)
+@echo on
+echo f | xcopy.exe /f "%input%" "%output%"

Fixtures/SwiftMigrate/ExistentialAnyMigration/Package.swift

@@ -0,0 +1,10 @@
+// swift-tools-version:5.8
+
+import PackageDescription
+
+let package = Package(
+    name: "ExistentialAnyMigration",
+    targets: [
+        .target(name: "Diagnostics", path: "Sources", exclude: ["Fixed"]),
+    ]
+)

Fixtures/SwiftMigrate/ExistentialAnyMigration/Sources/Fixed/Test.swift

@@ -0,0 +1,16 @@
+protocol P {
+}
+
+func test1(_: any P) {
+}
+
+func test2(_: (any P).Protocol) {
+}
+
+func test3() {
+    let _: [(any P)?] = []
+}
+
+func test4() {
+    var x = 42
+}

Fixtures/SwiftMigrate/ExistentialAnyMigration/Sources/Test.swift

@@ -0,0 +1,16 @@
+protocol P {
+}
+
+func test1(_: P) {
+}
+
+func test2(_: P.Protocol) {
+}
+
+func test3() {
+    let _: [P?] = []
+}
+
+func test4() {
+    var x = 42
+}

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:6.0
+// swift-tools-version:6.1
 
 //===----------------------------------------------------------------------===//
 //
@@ -104,7 +104,7 @@ let package = Package(
     name: "SwiftPM",
     platforms: [
         .macOS(.v13),
-        .iOS(.v16),
+        .iOS(.v17),
         .macCatalyst(.v17),
     ],
     products:
@@ -138,7 +138,7 @@ let package = Package(
             type: .dynamic,
             targets: ["AppleProductTypes"]
         ),
-        
+
         .library(
             name: "PackagePlugin",
             type: .dynamic,
@@ -304,6 +304,21 @@ let package = Package(
             ]
         ),
 
+        .target(
+            /** API for deserializing diagnostics and applying fix-its */
+            name: "SwiftFixIt",
+            dependencies: [
+                "Basics",
+                .product(name: "TSCBasic", package: "swift-tools-support-core"),
+            ] + swiftSyntaxDependencies(
+                ["SwiftDiagnostics", "SwiftIDEUtils", "SwiftParser", "SwiftSyntax"]
+            ),
+            exclude: ["CMakeLists.txt"],
+            swiftSettings: commonExperimentalFeatures + [
+                .unsafeFlags(["-static"]),
+            ]
+        ),
+
         // MARK: Project Model
 
         .target(
@@ -573,6 +588,7 @@ let package = Package(
                 "Workspace",
                 "XCBuildSupport",
                 "SwiftBuildSupport",
+                "SwiftFixIt",
             ] + swiftSyntaxDependencies(["SwiftIDEUtils"]),
             exclude: ["CMakeLists.txt", "README.md"],
             swiftSettings: swift6CompatibleExperimentalFeatures + [
@@ -808,7 +824,11 @@ let package = Package(
 
         .testTarget(
             name: "BasicsTests",
-            dependencies: ["Basics", "_InternalTestSupport", "tsan_utils"],
+            dependencies: [
+                "Basics",
+                "_InternalTestSupport",
+                "tsan_utils",
+            ],
             exclude: [
                 "Archiver/Inputs/archive.tar.gz",
                 "Archiver/Inputs/archive.zip",
@@ -916,6 +936,10 @@ let package = Package(
             dependencies: ["SourceControl", "_InternalTestSupport"],
             exclude: ["Inputs/TestRepo.tgz"]
         ),
+        .testTarget(
+            name: "SwiftFixItTests",
+            dependencies: ["SwiftFixIt", "_InternalTestSupport"]
+        ),
         .testTarget(
             name: "XCBuildSupportTests",
             dependencies: ["XCBuildSupport", "_InternalTestSupport", "_InternalBuildTestSupport"],
@@ -928,7 +952,7 @@ let package = Package(
             path: "Examples/package-info/Sources/package-info"
         )
     ],
-    swiftLanguageVersions: [.v5]
+    swiftLanguageModes: [.v5]
 )
 
 #if canImport(Darwin)
@@ -1079,8 +1103,7 @@ if ProcessInfo.processInfo.environment["ENABLE_APPLE_PRODUCT_TYPES"] == "1" {
     }
 }
 
-if ProcessInfo.processInfo.environment["SWIFTPM_SWBUILD_FRAMEWORK"] == nil &&
-    ProcessInfo.processInfo.environment["SWIFTPM_NO_SWBUILD_DEPENDENCY"] == nil {
+if ProcessInfo.processInfo.environment["SWIFTPM_SWBUILD_FRAMEWORK"] == nil {
 
     let swiftbuildsupport: Target = package.targets.first(where: { $0.name == "SwiftBuildSupport" } )!
     swiftbuildsupport.dependencies += [

Sources/Basics/Archiver/TarArchiver.swift

@@ -25,7 +25,7 @@ public struct TarArchiver: Archiver {
     private let cancellator: Cancellator
 
     /// The underlying command
-    private let tarCommand: String
+    internal let tarCommand: String
 
     /// Creates a `TarArchiver`.
     ///

Sources/Basics/Archiver/ZipArchiver.swift

@@ -29,7 +29,14 @@ public struct ZipArchiver: Archiver, Cancellable {
 
     /// Absolute path to the Windows tar in the system folder
     #if os(Windows)
-    private let windowsTar: String
+        internal let windowsTar: String
+    #else
+        internal let unzip = "unzip"
+        internal let zip = "zip"
+    #endif
+
+    #if os(FreeBSD)
+        internal let tar = "tar"
     #endif
 
     /// Creates a `ZipArchiver`.
@@ -74,7 +81,9 @@ public struct ZipArchiver: Archiver, Cancellable {
             // It's part of system32 anyway so use the absolute path.
             let process = AsyncProcess(arguments: [windowsTar, "xf", archivePath.pathString, "-C", destinationPath.pathString])
             #else
-            let process = AsyncProcess(arguments: ["unzip", archivePath.pathString, "-d", destinationPath.pathString])
+                let process = AsyncProcess(arguments: [
+                    self.unzip, archivePath.pathString, "-d", destinationPath.pathString,
+                ])
             #endif
             guard let registrationKey = self.cancellator.register(process) else {
                 throw CancellationError.failedToRegisterProcess(process)
@@ -113,7 +122,10 @@ public struct ZipArchiver: Archiver, Cancellable {
         // On FreeBSD, the unzip command is available in base but not the zip command.
         // Therefore; we use libarchive(bsdtar) to produce the ZIP archive instead.
         let process = AsyncProcess(
-          arguments: ["tar", "-c", "--format", "zip", "-f", destinationPath.pathString, directory.basename],
+                arguments: [
+                    self.tar, "-c", "--format", "zip", "-f", destinationPath.pathString,
+                    directory.basename,
+                ],
           workingDirectory: directory.parentDirectory
         )
         #else
@@ -127,7 +139,7 @@ public struct ZipArchiver: Archiver, Cancellable {
             arguments: [
                 "/bin/sh",
                 "-c",
-                "cd \(directory.parentDirectory.underlying.pathString) && zip -ry \(destinationPath.pathString) \(directory.basename)",
+                    "cd \(directory.parentDirectory.underlying.pathString) && \(self.zip) -ry \(destinationPath.pathString) \(directory.basename)"
             ]
         )
         #endif
@@ -154,7 +166,7 @@ public struct ZipArchiver: Archiver, Cancellable {
             #if os(Windows)
             let process = AsyncProcess(arguments: [windowsTar, "tf", path.pathString])
             #else
-            let process = AsyncProcess(arguments: ["unzip", "-t", path.pathString])
+                let process = AsyncProcess(arguments: [self.unzip, "-t", path.pathString])
             #endif
             guard let registrationKey = self.cancellator.register(process) else {
                 throw CancellationError.failedToRegisterProcess(process)

Sources/Basics/Concurrency/ConcurrencyHelpers.swift

@@ -59,4 +59,20 @@ extension DispatchQueue {
             }
         }
     }
+
+    package func asyncResult<T: Sendable>(_ callback: @escaping @Sendable (Result<T, Error>) -> Void, _ closure: @escaping @Sendable () async throws -> T) {
+        let completion: @Sendable (Result<T, Error>) -> Void = {
+            result in self.async {
+                callback(result)
+            }
+        }
+
+        Task {
+            do {
+                completion(.success(try await closure()))
+            } catch {
+                completion(.failure(error))
+            }
+        }
+    }
 }

Sources/Basics/Concurrency/SendableBox.swift

@@ -16,24 +16,24 @@ import struct Foundation.Date
 /// an `async` closure. This type serves as a replacement for `ThreadSafeBox`
 /// implemented with Swift Concurrency primitives.
 public actor SendableBox<Value: Sendable> {
-    init(_ value: Value? = nil) {
+    public init(_ value: Value) {
         self.value = value
     }
 
-    var value: Value?
+    public var value: Value
+
+    public func set(_ value: Value) {
+        self.value = value
+    }
 }
 
 extension SendableBox where Value == Int {
     func increment() {
-        if let value {
-            self.value = value + 1
-        }
+        self.value = value + 1
     }
 
     func decrement() {
-        if let value {
-            self.value = value - 1
-        }
+        self.value = value - 1
     }
 }
 

Sources/Basics/FileSystem/FileSystem+Extensions.swift

@@ -681,3 +681,17 @@ extension FileSystem {
         }
     }
 }
+
+extension FileSystem {
+    /// Do a deep enumeration, passing each file to block
+    public func enumerate(directory: AbsolutePath, block: (AbsolutePath) throws -> ()) throws {
+        for file in try getDirectoryContents(directory) {
+            let path = directory.appending(file)
+            if isDirectory(path) {
+                try enumerate(directory: path, block: block)
+            } else {
+                try block(path)
+            }
+        }
+    }
+}

Sources/Build/BuildDescription/ModuleBuildDescription.swift

@@ -140,6 +140,14 @@ public enum ModuleBuildDescription: SPMBuildCore.ModuleBuildDescription {
         }
     }
 
+    public var diagnosticFiles: [AbsolutePath] {
+        switch self {
+        case .swift(let buildDescription):
+            buildDescription.diagnosticFiles
+        case .clang(_):
+            []
+        }
+    }
     /// Determines the arguments needed to run `swift-symbolgraph-extract` for
     /// this module.
     public func symbolGraphExtractArguments() throws -> [String] {
@@ -214,4 +222,14 @@ extension ModuleBuildDescription {
         }
         return dependencies
     }
+
+    package func recursiveLinkDependencies(using plan: BuildPlan) -> [Dependency] {
+        var dependencies: [Dependency] = []
+        plan.traverseLinkDependencies(of: self) { product, _, description in
+            dependencies.append(.product(product, description))
+        } onModule: { module, _, description in
+            dependencies.append(.module(module, description))
+        }
+        return dependencies
+    }
 }