Fix package access modifier in XCBuild support

CMakeLists.txt

@@ -51,5 +51,8 @@ find_package(dispatch QUIET)
 find_package(Foundation QUIET)
 find_package(SQLite3 REQUIRED)
 
+# Enable `package` modifier for the whole package.
+add_compile_options("$<$<COMPILE_LANGUAGE:Swift>:-package-name;SwiftPM>")
+
 add_subdirectory(Sources)
 add_subdirectory(cmake/modules)

Package.swift

@@ -4,7 +4,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors
+// Copyright (c) 2014-2024 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
@@ -461,6 +461,7 @@ let package = Package(
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 "Basics",
                 "Build",
+                "DriverSupport",
                 "PackageGraph",
                 "PackageLoading",
                 "PackageModel",

Sources/Build/BuildDescription/SwiftTargetBuildDescription.swift

@@ -422,7 +422,7 @@ public final class SwiftTargetBuildDescription {
     private func packageNameArgumentIfSupported(with pkg: ResolvedPackage, packageAccess: Bool) -> [String] {
         let flag = "-package-name"
         if pkg.manifest.usePackageNameFlag,
-           DriverSupport.checkToolchainDriverFlags(flags: [flag], toolchain:  self.buildParameters.toolchain, fileSystem: self.fileSystem) {
+           DriverSupport.isPackageNameSupported(toolchain: self.buildParameters.toolchain, fileSystem: self.fileSystem) {
             if packageAccess {
                 let pkgID = pkg.identity.description.spm_mangledToC99ExtendedIdentifier()
                 return [flag, pkgID]

Sources/CoreCommands/SwiftTool.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors
+// Copyright (c) 2014-2024 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
@@ -721,7 +721,11 @@ public final class SwiftTool {
                 enableParseableModuleInterfaces: options.build.shouldEnableParseableModuleInterfaces,
                 explicitTargetDependencyImportCheckingMode: options.build.explicitTargetDependencyImportCheck.modeParameter,
                 useIntegratedSwiftDriver: options.build.useIntegratedSwiftDriver,
-                useExplicitModuleBuild: options.build.useExplicitModuleBuild
+                useExplicitModuleBuild: options.build.useExplicitModuleBuild,
+                isPackageAccessModifierSupported: DriverSupport.isPackageNameSupported(
+                    toolchain: toolchain,
+                    fileSystem: self.fileSystem
+                )
             ),
             linkingParameters: .init(
                 linkerDeadStrip: options.linker.linkerDeadStrip,

Sources/DriverSupport/DriverSupportUtils.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Copyright (c) 2022-2024 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
@@ -17,11 +17,11 @@ import class TSCBasic.Process
 import enum TSCBasic.ProcessEnv
 import struct TSCBasic.ProcessResult
 
-public enum DriverSupport {
+package enum DriverSupport {
     private static var flagsMap = ThreadSafeBox<[String: Set<String>]>()
 
     // This checks _frontend_ supported flags, which are not necessarily supported in the driver.
-    public static func checkSupportedFrontendFlags(
+    package static func checkSupportedFrontendFlags(
         flags: Set<String>,
         toolchain: PackageModel.Toolchain,
         fileSystem: FileSystem
@@ -54,7 +54,7 @@ public enum DriverSupport {
     // This checks if given flags are supported in the built-in toolchain driver. Currently
     // there's no good way to get the supported flags from it, so run `swiftc -h` directly
     // to get the flags and cache the result.
-    public static func checkToolchainDriverFlags(
+    static func checkToolchainDriverFlags(
         flags: Set<String>,
         toolchain: PackageModel.Toolchain,
         fileSystem: FileSystem
@@ -83,4 +83,8 @@ public enum DriverSupport {
             return false
         }
     }
+
+    package static func isPackageNameSupported(toolchain: PackageModel.Toolchain, fileSystem: FileSystem) -> Bool {
+        DriverSupport.checkToolchainDriverFlags(flags: ["-package-name"], toolchain: toolchain, fileSystem: fileSystem)
+    }
 }

Sources/PackageGraph/Resolution/ResolvedTarget.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors
+// Copyright (c) 2014-2024 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

Sources/PackageModel/Target/SwiftTarget.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors
+// Copyright (c) 2014-2024 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

Sources/SPMBuildCore/BuildParameters/BuildParameters+Driver.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors
+// Copyright (c) 2020-2024 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
@@ -25,13 +25,15 @@ extension BuildParameters {
             enableParseableModuleInterfaces: Bool = false,
             explicitTargetDependencyImportCheckingMode: TargetDependencyImportCheckingMode = .none,
             useIntegratedSwiftDriver: Bool = false,
-            useExplicitModuleBuild: Bool = false
+            useExplicitModuleBuild: Bool = false,
+            isPackageAccessModifierSupported: Bool = false
         ) {
             self.canRenameEntrypointFunctionName = canRenameEntrypointFunctionName
             self.enableParseableModuleInterfaces = enableParseableModuleInterfaces
             self.explicitTargetDependencyImportCheckingMode = explicitTargetDependencyImportCheckingMode
             self.useIntegratedSwiftDriver = useIntegratedSwiftDriver
             self.useExplicitModuleBuild = useExplicitModuleBuild
+            self.isPackageAccessModifierSupported = isPackageAccessModifierSupported
         }
 
         /// Whether to enable the entry-point-function-name feature.
@@ -45,11 +47,15 @@ extension BuildParameters {
         /// `.swiftmodule`s.
         public var enableParseableModuleInterfaces: Bool
 
-        /// Whether to use the integrated Swift driver rather than shelling out
+        /// Whether to use the integrated Swift Driver rather than shelling out
         /// to a separate process.
         public var useIntegratedSwiftDriver: Bool
 
         /// Whether to use the explicit module build flow (with the integrated driver).
         public var useExplicitModuleBuild: Bool
+
+        /// Whether the version of Swift Driver used in the currently selected toolchain
+        /// supports `-package-name` options.
+        package var isPackageAccessModifierSupported: Bool
     }
 }

Sources/SPMBuildCore/BuildParameters/BuildParameters.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors
+// Copyright (c) 2020-2024 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
@@ -132,7 +132,7 @@ public struct BuildParameters: Encodable {
         isXcodeBuildSystemEnabled: Bool = false,
         shouldSkipBuilding: Bool = false,
         debuggingParameters: Debugging? = nil,
-        driverParameters: Driver = .init(),
+        driverParameters: Driver,
         linkingParameters: Linking = .init(),
         outputParameters: Output = .init(),
         testingParameters: Testing? = nil

Sources/SPMBuildCore/CMakeLists.txt

@@ -23,6 +23,7 @@ add_library(SPMBuildCore
   Plugins/PluginMessages.swift
   Plugins/PluginScriptRunner.swift
   PrebuildCommandResult.swift
+  ResolvedPackage+Extensions.swift
   Triple+Extensions.swift
   XCFrameworkMetadata.swift)
 # NOTE(compnerd) workaround for CMake not setting up include flags yet

Sources/SPMBuildCore/ResolvedPackage+Extensions.swift

@@ -0,0 +1,24 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2014-2024 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 struct PackageGraph.ResolvedPackage
+import struct PackageGraph.ResolvedTarget
+
+extension ResolvedPackage {
+    package func packageNameArgument(target: ResolvedTarget, isPackageNameSupported: Bool) -> [String] {
+        if self.manifest.usePackageNameFlag, target.packageAccess {
+            ["-package-name", self.identity.description.spm_mangledToC99ExtendedIdentifier()]
+        } else {
+            []
+        }
+    }
+}

Sources/SPMTestSupport/PIFTester.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2014-2020 Apple Inc. and the Swift project authors
+// Copyright (c) 2014-2024 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
@@ -32,7 +32,12 @@ public final class PIFWorkspaceTester {
         targetMap = Dictionary(uniqueKeysWithValues: targetsByGUID)
     }
 
-    public func checkProject(_ guid: PIF.GUID, file: StaticString = #file, line: UInt = #line, body: (PIFProjectTester) -> Void) throws {
+    public func checkProject(
+        _ guid: PIF.GUID,
+        file: StaticString = #file,
+        line: UInt = #line,
+        body: (PIFProjectTester) -> Void
+    ) throws {
         guard let project = projectMap[guid] else {
             return XCTFail("project \(guid) not found", file: file, line: line)
         }
@@ -55,10 +60,20 @@ public final class PIFProjectTester {
     fileprivate init(project: PIF.Project, targetMap: [PIF.GUID: PIF.BaseTarget]) throws {
         self.project = project
         self.targetMap = targetMap
-        self.fileMap = try collectFiles(from: project.groupTree, parentPath: project.path, projectPath: project.path, builtProductsPath: project.path)
+        self.fileMap = try collectFiles(
+            from: project.groupTree,
+            parentPath: project.path,
+            projectPath: project.path,
+            builtProductsPath: project.path
+        )
     }
 
-    public func checkTarget(_ guid: PIF.GUID, file: StaticString = #file, line: UInt = #line, body: ((PIFTargetTester) -> Void)? = nil) {
+    public func checkTarget(
+        _ guid: PIF.GUID,
+        file: StaticString = #file,
+        line: UInt = #line,
+        body: ((PIFTargetTester) -> Void)? = nil
+    ) {
         guard let baseTarget = baseTarget(withGUID: guid) else {
             let guids = project.targets.map { $0.guid }.joined(separator: ", ")
             return XCTFail("target \(guid) not found among \(guids)", file: file, line: line)
@@ -71,13 +86,23 @@ public final class PIFProjectTester {
         body?(PIFTargetTester(target: target, targetMap: targetMap, fileMap: fileMap))
     }
 
-    public func checkNoTarget(_ guid: PIF.GUID, file: StaticString = #file, line: UInt = #line, body: ((PIFTargetTester) -> Void)? = nil) {
+    public func checkNoTarget(
+        _ guid: PIF.GUID,
+        file: StaticString = #file,
+        line: UInt = #line,
+        body: ((PIFTargetTester) -> Void)? = nil
+    ) {
         if baseTarget(withGUID: guid) != nil {
             XCTFail("target \(guid) found", file: file, line: line)
         }
     }
 
-    public func checkAggregateTarget(_ guid: PIF.GUID, file: StaticString = #file, line: UInt = #line, body: ((PIFAggregateTargetTester) -> Void)? = nil) {
+    public func checkAggregateTarget(
+        _ guid: PIF.GUID,
+        file: StaticString = #file,
+        line: UInt = #line,
+        body: ((PIFAggregateTargetTester) -> Void)? = nil
+    ) {
         guard let baseTarget = baseTarget(withGUID: guid) else {
             let guids = project.targets.map { $0.guid }.joined(separator: ", ")
             return XCTFail("target \(guid) not found among \(guids)", file: file, line: line)
@@ -90,7 +115,12 @@ public final class PIFProjectTester {
         body?(PIFAggregateTargetTester(target: target, targetMap: targetMap, fileMap: fileMap))
     }
 
-    public func checkBuildConfiguration(_ name: String, file: StaticString = #file, line: UInt = #line, body: (PIFBuildConfigurationTester) -> Void) {
+    public func checkBuildConfiguration(
+        _ name: String,
+        file: StaticString = #file,
+        line: UInt = #line,
+        body: (PIFBuildConfigurationTester) -> Void
+    ) {
         guard let configuration = buildConfiguration(withName: name) else {
             let names = project.buildConfigurations.map { $0.name }.joined(separator: ", ")
             return XCTFail("build configuration \(name) not found among \(names)", file: file, line: line)
@@ -151,7 +181,12 @@ public class PIFBaseTargetTester {
         })
     }
 
-    public func checkBuildConfiguration(_ name: String, file: StaticString = #file, line: UInt = #line, body: (PIFBuildConfigurationTester) -> Void) {
+    public func checkBuildConfiguration(
+        _ name: String,
+        file: StaticString = #file,
+        line: UInt = #line,
+        body: (PIFBuildConfigurationTester) -> Void
+    ) {
         guard let configuration = buildConfiguration(withName: name) else {
             return XCTFail("build configuration \(name) not found", file: file, line: line)
         }
@@ -163,19 +198,33 @@ public class PIFBaseTargetTester {
         return baseTarget.buildConfigurations.first { $0.name == name }
     }
 
-    public func checkImpartedBuildSettings(file: StaticString = #file, line: UInt = #line, _ body: (PIFBuildSettingsTester) -> Void) {
-        let buildSettingsTester = PIFBuildSettingsTester(buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings)
+    public func checkImpartedBuildSettings(
+        file: StaticString = #file,
+        line: UInt = #line,
+        _ body: (PIFBuildSettingsTester) -> Void
+    ) {
+        let buildSettingsTester = PIFBuildSettingsTester(
+            buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings
+        )
         body(buildSettingsTester)
     }
 
-    public func checkAllImpartedBuildSettings(file: StaticString = #file, line: UInt = #line, _ body: (PIFBuildSettingsTester) -> Void) {
-        let buildSettingsTester = PIFBuildSettingsTester(buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings)
+    public func checkAllImpartedBuildSettings(
+        file: StaticString = #file,
+        line: UInt = #line,
+        _ body: (PIFBuildSettingsTester) -> Void
+    ) {
+        let buildSettingsTester = PIFBuildSettingsTester(
+            buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings
+        )
         body(buildSettingsTester)
         buildSettingsTester.checkUncheckedSettings(file: file, line: line)
     }
 
     public func checkNoImpartedBuildSettings(file: StaticString = #file, line: UInt = #line) {
-        let buildSettingsTester = PIFBuildSettingsTester(buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings)
+        let buildSettingsTester = PIFBuildSettingsTester(
+            buildSettings: baseTarget.buildConfigurations.first!.impartedBuildProperties.buildSettings
+        )
         buildSettingsTester.checkUncheckedSettings(file: file, line: line)
     }
 }
@@ -313,7 +362,12 @@ private func collectFiles(
         files[reference.guid] = referencePath.pathString
     } else if let group = reference as? PIF.Group {
         for child in group.children {
-            let childFiles = try collectFiles(from: child, parentPath: referencePath, projectPath: projectPath, builtProductsPath: builtProductsPath)
+            let childFiles = try collectFiles(
+                from: child,
+                parentPath: referencePath,
+                projectPath: projectPath,
+                builtProductsPath: builtProductsPath
+            )
             files.merge(childFiles, uniquingKeysWith: { _, _ in fatalError("non-unique GUID") })
         }
     }

Sources/SPMTestSupport/SwiftPMProduct.swift

@@ -128,7 +128,7 @@ extension SwiftPM {
             completeArgs += ["--package-path", packagePath.pathString]
         }
         completeArgs += args
-        
+
         return try Process.popen(arguments: completeArgs, environment: environment)
     }
 }