Skip to content

Remove the version parameter for C++ interop mode build setting #6583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions Sources/PackageDescription/BuildSettings.swift
Original file line number Diff line number Diff line change
Expand Up @@ -377,22 +377,15 @@ public struct SwiftSetting {
///
/// - Parameters:
/// - mode: The language mode, either C or CXX.
/// - version: When using the CXX language mode, pass either the version
/// of Swift and C++ interoperability or `nil`; otherwise, `nil`.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.9)
public static func interoperabilityMode(
_ mode: InteroperabilityMode,
version: String? = nil,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
var values: [String] = [mode.rawValue]
if let version {
values.append(version)
}
return SwiftSetting(
name: "interoperabilityMode", value: values, condition: condition)
name: "interoperabilityMode", value: [mode.rawValue], condition: condition)
}
}

Expand Down
10 changes: 2 additions & 8 deletions Sources/PackageLoading/ManifestJSONParser.swift
Original file line number Diff line number Diff line change
Expand Up @@ -685,16 +685,10 @@ extension TargetBuildSettingDescription.Kind {
guard let lang = TargetBuildSettingDescription.InteroperabilityMode(rawValue: rawLang) else {
throw InternalError("unknown interoperability mode: \(rawLang)")
}
if values.count > 2 {
if values.count > 1 {
throw InternalError("invalid build settings value")
}
let version: String?
if values.count == 2 {
version = values[1]
} else {
version = nil
}
return .interoperabilityMode(lang, version)
return .interoperabilityMode(lang)
case "enableUpcomingFeature":
guard let value = values.first else {
throw InternalError("invalid (empty) build settings value")
Expand Down
7 changes: 2 additions & 5 deletions Sources/PackageLoading/PackageBuilder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1079,7 +1079,7 @@ public final class PackageBuilder {
decl = .LINK_FRAMEWORKS
}

case .interoperabilityMode(let lang, let version):
case .interoperabilityMode(let lang):
switch setting.tool {
case .c, .cxx, .linker:
throw InternalError("only Swift supports interoperability")
Expand All @@ -1089,10 +1089,7 @@ public final class PackageBuilder {
}

if lang == .Cxx {
// `version` is the compatibility version of Swift/C++ interop,
// which is meant to preserve source compatibility for
// user projects while Swift/C++ interop is evolving.
values = ["-cxx-interoperability-mode=\(version ?? "default")"]
values = ["-cxx-interoperability-mode=default"]
} else {
values = []
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public enum TargetBuildSettingDescription {
case linkedLibrary(String)
case linkedFramework(String)

case interoperabilityMode(InteroperabilityMode, String?)
case interoperabilityMode(InteroperabilityMode)

case enableUpcomingFeature(String)
case enableExperimentalFeature(String)
Expand Down
5 changes: 1 addition & 4 deletions Sources/PackageModel/ManifestSourceGeneration.swift
Original file line number Diff line number Diff line change
Expand Up @@ -513,11 +513,8 @@ fileprivate extension SourceCodeFragment {
params.append(SourceCodeFragment(from: condition))
}
self.init(enum: setting.kind.name, subnodes: params)
case .interoperabilityMode(let lang, let version):
case .interoperabilityMode(let lang):
params.append(SourceCodeFragment(enum: lang.rawValue))
if let version {
params.append(SourceCodeFragment(key: "version", string: version))
}
self.init(enum: setting.kind.name, subnodes: params)
case .unsafeFlags(let values):
params.append(SourceCodeFragment(strings: values))
Expand Down
12 changes: 6 additions & 6 deletions Tests/BuildTests/BuildPlanTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3311,8 +3311,8 @@ final class BuildPlanTests: XCTestCase {
.init(tool: .swift, kind: .define("RLINUX"), condition: .init(platformNames: ["linux"], config: "release")),
.init(tool: .swift, kind: .define("DMACOS"), condition: .init(platformNames: ["macos"], config: "debug")),
.init(tool: .swift, kind: .unsafeFlags(["-Isfoo", "-L", "sbar"])),
.init(tool: .swift, kind: .interoperabilityMode(.Cxx, "swift-5.9"), condition: .init(platformNames: ["linux"])),
.init(tool: .swift, kind: .interoperabilityMode(.Cxx, "swift-6.0"), condition: .init(platformNames: ["macos"])),
.init(tool: .swift, kind: .interoperabilityMode(.Cxx), condition: .init(platformNames: ["linux"])),
.init(tool: .swift, kind: .interoperabilityMode(.Cxx), condition: .init(platformNames: ["macos"])),
.init(tool: .swift, kind: .enableUpcomingFeature("BestFeature")),
.init(tool: .swift, kind: .enableUpcomingFeature("WorstFeature"), condition: .init(platformNames: ["macos"], config: "debug"))
]
Expand All @@ -3321,8 +3321,8 @@ final class BuildPlanTests: XCTestCase {
name: "exe", dependencies: ["bar"],
settings: [
.init(tool: .swift, kind: .define("FOO")),
.init(tool: .swift, kind: .interoperabilityMode(.C, nil), condition: .init(platformNames: ["linux"])),
.init(tool: .swift, kind: .interoperabilityMode(.Cxx, nil), condition: .init(platformNames: ["macos"])),
.init(tool: .swift, kind: .interoperabilityMode(.C), condition: .init(platformNames: ["linux"])),
.init(tool: .swift, kind: .interoperabilityMode(.Cxx), condition: .init(platformNames: ["macos"])),
.init(tool: .linker, kind: .linkedLibrary("sqlite3")),
.init(tool: .linker, kind: .linkedFramework("CoreData"), condition: .init(platformNames: ["macos"])),
.init(tool: .linker, kind: .unsafeFlags(["-Ilfoo", "-L", "lbar"])),
Expand Down Expand Up @@ -3381,7 +3381,7 @@ final class BuildPlanTests: XCTestCase {
XCTAssertMatch(cbar, [.anySequence, "-DCCC=2", "-I\(A.appending(components: "Sources", "cbar", "Sources", "headers"))", "-I\(A.appending(components: "Sources", "cbar", "Sources", "cppheaders"))", "-Icfoo", "-L", "cbar", "-Icxxfoo", "-L", "cxxbar", .end])

let bar = try result.target(for: "bar").swiftTarget().compileArguments()
XCTAssertMatch(bar, [.anySequence, "-DLINUX", "-Isfoo", "-L", "sbar", "-cxx-interoperability-mode=swift-5.9", "-enable-upcoming-feature", "BestFeature", .end])
XCTAssertMatch(bar, [.anySequence, "-DLINUX", "-Isfoo", "-L", "sbar", "-cxx-interoperability-mode=default", "-enable-upcoming-feature", "BestFeature", .end])

let exe = try result.target(for: "exe").swiftTarget().compileArguments()
XCTAssertMatch(exe, [.anySequence, "-DFOO", .end])
Expand All @@ -3397,7 +3397,7 @@ final class BuildPlanTests: XCTestCase {
XCTAssertMatch(cbar, [.anySequence, "-DCCC=2", "-I\(A.appending(components: "Sources", "cbar", "Sources", "headers"))", "-I\(A.appending(components: "Sources", "cbar", "Sources", "cppheaders"))", "-Icfoo", "-L", "cbar", "-Icxxfoo", "-L", "cxxbar", .end])

let bar = try result.target(for: "bar").swiftTarget().compileArguments()
XCTAssertMatch(bar, [.anySequence, "-DDMACOS", "-Isfoo", "-L", "sbar", "-cxx-interoperability-mode=swift-6.0", "-enable-upcoming-feature", "BestFeature", "-enable-upcoming-feature", "WorstFeature", .end])
XCTAssertMatch(bar, [.anySequence, "-DDMACOS", "-Isfoo", "-L", "sbar", "-cxx-interoperability-mode=default", "-enable-upcoming-feature", "BestFeature", "-enable-upcoming-feature", "WorstFeature", .end])

let exe = try result.target(for: "exe").swiftTarget().compileArguments()
XCTAssertMatch(exe, [.anySequence, "-DFOO", "-cxx-interoperability-mode=default", .end])
Expand Down