1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2018 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 _Concurrency
/// The build configuration, such as debug or release.
public struct BuildConfiguration: Sendable {
/// The configuration of the build. Valid values are `debug` and `release`.
let config: String
private init(_ config: String) {
self.config = config
}
/// The debug build configuration.
public static let debug: BuildConfiguration = BuildConfiguration("debug")
/// The release build configuration.
public static let release: BuildConfiguration = BuildConfiguration("release")
}
/// A condition that limits the application of a build setting.
///
/// By default, build settings are applicable for all platforms and build
/// configurations. Use the `.when` modifier to define a build setting for a
/// specific condition. Invalid usage of `.when` emits an error during manifest
/// parsing. For example, it's invalid to specify a `.when` condition with both
/// parameters as `nil`.
///
/// The following example shows how to use build setting conditions with various
/// APIs:
///
/// ```swift
/// ...
/// .target(
/// name: "MyTool",
/// dependencies: ["Utility"],
/// cSettings: [
/// .headerSearchPath("path/relative/to/my/target"),
/// .define("DISABLE_SOMETHING", .when(platforms: [.iOS], configuration: .release)),
/// ],
/// swiftSettings: [
/// .define("ENABLE_SOMETHING", .when(configuration: .release)),
/// ],
/// linkerSettings: [
/// .linkLibrary("openssl", .when(platforms: [.linux])),
/// ]
/// ),
/// ```
public struct BuildSettingCondition: Sendable {
/// The applicable platforms for this build setting condition.
let platforms: [Platform]?
/// The applicable build configuration for this build setting condition.
let config: BuildConfiguration?
/// The applicable traits for this build setting condition.
let traits: Set<String>?
private init(platforms: [Platform]?, config: BuildConfiguration?, traits: Set<String>?) {
self.platforms = platforms
self.config = config
self.traits = traits
}
@available(_PackageDescription, deprecated: 5.7)
public static func when(
platforms: [Platform]? = nil,
configuration: BuildConfiguration? = nil
) -> BuildSettingCondition {
precondition(!(platforms == nil && configuration == nil))
return BuildSettingCondition(platforms: platforms, config: configuration, traits: nil)
}
/// Creates a build setting condition.
///
/// - Parameters:
/// - platforms: The applicable platforms for this build setting condition.
/// - configuration: The applicable build configuration for this build setting condition.
/// - traits: The applicable traits for this build setting condition.
@available(_PackageDescription, introduced: 6.1)
public static func when(
platforms: [Platform]? = nil,
configuration: BuildConfiguration? = nil,
traits: Set<String>? = nil
) -> BuildSettingCondition {
precondition(!(platforms == nil && configuration == nil && traits == nil))
return BuildSettingCondition(platforms: platforms, config: configuration, traits: traits)
}
/// Creates a build setting condition.
///
/// - Parameters:
/// - platforms: The applicable platforms for this build setting condition.
/// - configuration: The applicable build configuration for this build setting condition.
@available(_PackageDescription, introduced: 5.7)
public static func when(platforms: [Platform], configuration: BuildConfiguration) -> BuildSettingCondition {
BuildSettingCondition(platforms: platforms, config: configuration, traits: nil)
}
/// Creates a build setting condition.
///
/// - Parameter platforms: The applicable platforms for this build setting condition.
@available(_PackageDescription, introduced: 5.7)
public static func when(platforms: [Platform]) -> BuildSettingCondition {
BuildSettingCondition(platforms: platforms, config: .none, traits: nil)
}
/// Creates a build setting condition.
///
/// - Parameter configuration: The applicable build configuration for this build setting condition.
@available(_PackageDescription, introduced: 5.7)
public static func when(configuration: BuildConfiguration) -> BuildSettingCondition {
BuildSettingCondition(platforms: .none, config: configuration, traits: nil)
}
}
/// The underlying build setting data.
struct BuildSettingData {
/// The name of the build setting.
let name: String
/// The value of the build setting.
let value: [String]
/// A condition that restricts the application of the build setting.
let condition: BuildSettingCondition?
}
/// A C language build setting.
public struct CSetting: Sendable {
/// The abstract build setting data.
let data: BuildSettingData
private init(name: String, value: [String], condition: BuildSettingCondition?) {
self.data = BuildSettingData(name: name, value: value, condition: condition)
}
/// Provides a header search path relative to the target's directory.
///
/// Use this setting to add a search path for headers within your target.
/// You can't use absolute paths and you can't use this setting to provide
/// headers that are visible to other targets.
///
/// The path must be a directory inside the package.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - path: The path of the directory that contains the headers. The path is relative to the target's directory.
/// - condition: A condition that restricts the use of the build setting.
@available(_PackageDescription, introduced: 5.0)
public static func headerSearchPath(_ path: String, _ condition: BuildSettingCondition? = nil) -> CSetting {
return CSetting(name: "headerSearchPath", value: [path], condition: condition)
}
/// Defines a value for a macro.
///
/// If you don't specify a value, the macro's default value is 1.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - name: The name of the macro.
/// - value: The value of the macro.
/// - condition: A condition that restricts the use of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func define(_ name: String, to value: String? = nil, _ condition: BuildSettingCondition? = nil) -> CSetting {
var settingValue = name
if let value {
settingValue += "=" + value
}
return CSetting(name: "define", value: [settingValue], condition: condition)
}
/// Sets unsafe flags to pass arbitrary command-line flags to the
/// corresponding build tool.
///
/// As the usage of the word “unsafe” implies, Swift Package Manager can't safely determine
/// if the build flags have any negative side effect on the build since
/// certain flags can change the behavior of how it performs a build.
///
/// As some build flags can be exploited for unsupported or malicious
/// behavior, the use of unsafe flags makes the products containing this
/// target ineligible for use by other packages.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - flags: The unsafe flags to set.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func unsafeFlags(_ flags: [String], _ condition: BuildSettingCondition? = nil) -> CSetting {
return CSetting(name: "unsafeFlags", value: flags, condition: condition)
}
/// Controls how all C compiler warnings are treated during compilation.
///
/// Use this setting to specify whether all warnings should be treated as warnings (default behavior)
/// or as errors. This is equivalent to passing `-Werror` or `-Wno-error`
/// to the C compiler.
///
/// This setting applies to all warnings emitted by the C compiler. To control specific
/// warnings individually, use `treatWarning(name:as:_:)` instead.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - level: The treatment level for all warnings (`.warning` or `.error`).
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func treatAllWarnings(
as level: WarningLevel,
_ condition: BuildSettingCondition? = nil
) -> CSetting {
return CSetting(
name: "treatAllWarnings", value: [level.rawValue], condition: condition)
}
/// Controls how a specific C compiler warning is treated during compilation.
///
/// Use this setting to specify whether a particular warning should be treated as a warning
/// (default behavior) or as an error. This is equivalent to passing `-Werror=` or `-Wno-error=`
/// followed by the warning name to the C compiler.
///
/// This setting allows for fine-grained control over individual warnings. To control all
/// warnings at once, use `treatAllWarnings(as:_:)` instead.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the specific warning to control.
/// - level: The treatment level for the warning (`.warning` or `.error`).
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func treatWarning(
_ name: String,
as level: WarningLevel,
_ condition: BuildSettingCondition? = nil
) -> CSetting {
return CSetting(
name: "treatWarning", value: [name, level.rawValue], condition: condition)
}
/// Enable a specific C compiler warning group.
///
/// Use this setting to enable a specific warning group. This is equivalent to passing
/// `-W` followed by the group name to the C compiler.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the warning group to enable.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func enableWarning(
_ name: String,
_ condition: BuildSettingCondition? = nil
) -> CSetting {
return CSetting(
name: "enableWarning", value: [name], condition: condition)
}
/// Disable a specific C compiler warning group.
///
/// Use this setting to disable a specific warning group. This is equivalent to passing
/// `-Wno-` followed by the group name to the C compiler.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the warning group to disable.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func disableWarning(
_ name: String,
_ condition: BuildSettingCondition? = nil
) -> CSetting {
return CSetting(
name: "disableWarning", value: [name], condition: condition)
}
}
/// A CXX-language build setting.
public struct CXXSetting: Sendable {
/// The data store for the CXX build setting.
let data: BuildSettingData
private init(name: String, value: [String], condition: BuildSettingCondition?) {
self.data = BuildSettingData(name: name, value: value, condition: condition)
}
/// Provides a header search path relative to the target's directory.
///
/// Use this setting to add a search path for headers within your target.
/// You can't use absolute paths and you can't use this setting to provide
/// headers that are visible to other targets.
///
/// The path must be a directory inside the package.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - path: The path of the directory that contains the headers. The path is
/// relative to the target's directory.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 5.0)
public static func headerSearchPath(_ path: String, _ condition: BuildSettingCondition? = nil) -> CXXSetting {
return CXXSetting(name: "headerSearchPath", value: [path], condition: condition)
}
/// Defines a value for a macro.
///
/// If you don't specify a value, the macro's default value is 1.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - name: The name of the macro.
/// - value: The value of the macro.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func define(_ name: String, to value: String? = nil, _ condition: BuildSettingCondition? = nil) -> CXXSetting {
var settingValue = name
if let value {
settingValue += "=" + value
}
return CXXSetting(name: "define", value: [settingValue], condition: condition)
}
/// Sets unsafe flags to pass arbitrary command-line flags to the
/// corresponding build tool.
///
/// As the usage of the word “unsafe” implies, Swift Package Manager can't safely determine
/// if the build flags have any negative side effect on the build since
/// certain flags can change the behavior of how it performs a build.
///
/// As some build flags can be exploited for unsupported or malicious
/// behavior, you can't use products with unsafe build flags as dependencies in another package.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - flags: The unsafe flags to set.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func unsafeFlags(_ flags: [String], _ condition: BuildSettingCondition? = nil) -> CXXSetting {
return CXXSetting(name: "unsafeFlags", value: flags, condition: condition)
}
/// Controls how all C++ compiler warnings are treated during compilation.
///
/// Use this setting to specify whether all warnings should be treated as warnings (default behavior)
/// or as errors. This is equivalent to passing `-Werror` or `-Wno-error`
/// to the C++ compiler.
///
/// This setting applies to all warnings emitted by the C++ compiler. To control specific
/// warnings individually, use `treatWarning(name:as:_:)` instead.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - level: The treatment level for all warnings (`.warning` or `.error`).
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func treatAllWarnings(
as level: WarningLevel,
_ condition: BuildSettingCondition? = nil
) -> CXXSetting {
return CXXSetting(
name: "treatAllWarnings", value: [level.rawValue], condition: condition)
}
/// Controls how a specific C++ compiler warning is treated during compilation.
///
/// Use this setting to specify whether a particular warning should be treated as a warning
/// (default behavior) or as an error. This is equivalent to passing `-Werror=` or `-Wno-error=`
/// followed by the warning name to the C++ compiler.
///
/// This setting allows for fine-grained control over individual warnings. To control all
/// warnings at once, use `treatAllWarnings(as:_:)` instead.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the specific warning to control.
/// - level: The treatment level for the warning (`.warning` or `.error`).
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func treatWarning(
_ name: String,
as level: WarningLevel,
_ condition: BuildSettingCondition? = nil
) -> CXXSetting {
return CXXSetting(
name: "treatWarning", value: [name, level.rawValue], condition: condition)
}
/// Enable a specific C++ compiler warning group.
///
/// Use this setting to enable a specific warning group. This is equivalent to passing
/// `-W` followed by the group name to the C++ compiler.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the warning group to enable.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func enableWarning(
_ name: String,
_ condition: BuildSettingCondition? = nil
) -> CXXSetting {
return CXXSetting(
name: "enableWarning", value: [name], condition: condition)
}
/// Disable a specific C++ compiler warning group.
///
/// Use this setting to disable a specific warning group. This is equivalent to passing
/// `-Wno-` followed by the group name to the C++ compiler.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the warning group to disable.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func disableWarning(
_ name: String,
_ condition: BuildSettingCondition? = nil
) -> CXXSetting {
return CXXSetting(
name: "disableWarning", value: [name], condition: condition)
}
}
/// A Swift language build setting.
public struct SwiftSetting: Sendable {
/// The data store for the Swift build setting.
let data: BuildSettingData
private init(name: String, value: [String], condition: BuildSettingCondition?) {
self.data = BuildSettingData(name: name, value: value, condition: condition)
}
/// Defines a compilation condition.
///
/// Use compilation conditions to only compile statements if a certain
/// condition is true. For example, the Swift compiler will only compile the
/// statements inside the `#if` block when `ENABLE_SOMETHING` is defined:
///
/// ```swift
/// #if ENABLE_SOMETHING
/// ...
/// #endif
/// ```
///
/// Unlike macros in C/C++, compilation conditions don't have an associated
/// value.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - name: The name of the macro.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func define(_ name: String, _ condition: BuildSettingCondition? = nil) -> SwiftSetting {
return SwiftSetting(name: "define", value: [name], condition: condition)
}
/// Set unsafe flags to pass arbitrary command-line flags to the
/// corresponding build tool.
///
/// As the usage of the word “unsafe” implies, Swift Package Manager can't safely determine
/// if the build flags have any negative side effect on the build since
/// certain flags can change the behavior of how it performs a build.
///
/// As some build flags can be exploited for unsupported or malicious
/// behavior, the use of unsafe flags makes the products containing this
/// target ineligible for use by other packages.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - flags: The unsafe flags to set.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func unsafeFlags(_ flags: [String], _ condition: BuildSettingCondition? = nil) -> SwiftSetting {
return SwiftSetting(name: "unsafeFlags", value: flags, condition: condition)
}
/// Enable an upcoming feature with the given name.
///
/// An upcoming feature is one that is available in Swift as of a
/// certain language version, but isn't available by default in prior
/// language modes because it has some impact on source compatibility.
///
/// You can add and use multiple upcoming features in a given target
/// without affecting its dependencies. Targets will ignore any unknown
/// upcoming features.
///
/// - Since: First available in PackageDescription 5.8.
///
/// - Parameters:
/// - name: The name of the upcoming feature; for example, `ConciseMagicFile`.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.8)
public static func enableUpcomingFeature(
_ name: String,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "enableUpcomingFeature", value: [name], condition: condition)
}
/// Enable an experimental feature with the given name.
///
/// An experimental feature is one that's in development, but
/// is not yet available in Swift as a language feature.
///
/// You can add and use multiple experimental features in a given target
/// without affecting its dependencies. Targets will ignore any unknown
/// experimental features.
///
/// - Since: First available in PackageDescription 5.8.
///
/// - Parameters:
/// - name: The name of the experimental feature; for example, `VariadicGenerics`.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.8)
public static func enableExperimentalFeature(
_ name: String,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "enableExperimentalFeature", value: [name], condition: condition)
}
/// Enable strict memory safety checking.
///
/// Strict memory safety checking is an opt-in compiler feature that
/// identifies any uses of language constructs or APIs that break
/// memory safety. Issues are reported as warnings and can generally
/// be suppressed by adding annotations (such as `@unsafe` and `unsafe`)
/// that acknowledge the presence of unsafe code, making it easier to
/// review and audit at a later time.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 6.2)
public static func strictMemorySafety(
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "strictMemorySafety", value: ["ON"], condition: condition)
}
public enum InteroperabilityMode: String {
case C
case Cxx
}
/// Enable Swift interoperability with a given language.
///
/// This is useful for enabling interoperability between Swift and C++ for
/// a given target.
///
/// Enabling C++ interoperability mode might alter the way some existing
/// C and Objective-C APIs are imported.
///
/// - Since: First available in PackageDescription 5.9.
///
/// - Parameters:
/// - mode: The language mode, either C or Cxx.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.9)
public static func interoperabilityMode(
_ mode: InteroperabilityMode,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "interoperabilityMode", value: [mode.rawValue], condition: condition)
}
/// Defines a `-swift-version` to pass to the
/// corresponding build tool.
///
/// - Since: First available in PackageDescription 6.0.
///
/// - Parameters:
/// - version: The Swift language version to use.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.0, deprecated: 6.0, renamed: "swiftLanguageMode(_:_:)")
public static func swiftLanguageVersion(
_ version: SwiftVersion,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "swiftLanguageMode", value: [.init(describing: version)], condition: condition)
}
/// Defines a `-language-mode` to pass to the
/// corresponding build tool.
///
/// - Since: First available in PackageDescription 6.0.
///
/// - Parameters:
/// - mode: The Swift language mode to use.
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.0)
public static func swiftLanguageMode(
_ mode: SwiftLanguageMode,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "swiftLanguageMode", value: [.init(describing: mode)], condition: condition)
}
/// Controls how all Swift compiler warnings are treated during compilation.
///
/// Use this setting to specify whether all warnings should be treated as warnings (default behavior)
/// or as errors. This is equivalent to passing `-warnings-as-errors` or `-no-warnings-as-errors`
/// to the Swift compiler.
///
/// This setting applies to all warnings emitted by the Swift compiler. To control specific
/// warnings individually, use `treatWarning(name:as:_:)` instead.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - level: The treatment level for all warnings (`.warning` or `.error`).
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func treatAllWarnings(
as level: WarningLevel,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "treatAllWarnings", value: [level.rawValue], condition: condition)
}
/// Controls how a specific Swift compiler warning is treated during compilation.
///
/// Use this setting to specify whether a particular warning should be treated as a warning
/// (default behavior) or as an error. This is equivalent to passing `-Werror` or `-Wwarning`
/// followed by the warning name to the Swift compiler.
///
/// This setting allows for fine-grained control over individual warnings. To control all
/// warnings at once, use `treatAllWarnings(as:_:)` instead.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - name: The name of the specific warning to control.
/// - level: The treatment level for the warning (`.warning` or `.error`).
/// - condition: A condition that restricts the application of the build setting.
@available(_PackageDescription, introduced: 6.2)
public static func treatWarning(
_ name: String,
as level: WarningLevel,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
return SwiftSetting(
name: "treatWarning", value: [name, level.rawValue], condition: condition)
}
/// Set the default isolation to the given global actor type.
///
/// - Since: First available in PackageDescription 6.2.
///
/// - Parameters:
/// - isolation: The type of global actor to use for default actor isolation
/// inference. The only valid arguments are `MainActor.self` and `nil`.
/// - condition: A condition that restricts the application of the build
/// setting.
///
/// The compiler defaults to inferring unannotated code as `nonisolated` if unspecified,
/// or if the `isolation` parameter is set to `nil`.
@available(_PackageDescription, introduced: 6.2)
public static func defaultIsolation(
_ isolation: MainActor.Type?,
_ condition: BuildSettingCondition? = nil
) -> SwiftSetting {
let isolationString =
if isolation == nil {
"nonisolated"
} else {
"MainActor"
}
return SwiftSetting(
name: "defaultIsolation", value: [isolationString], condition: condition)
}
}
/// A linker build setting.
public struct LinkerSetting: Sendable {
/// The data store for the Linker setting.
let data: BuildSettingData
private init(name: String, value: [String], condition: BuildSettingCondition?) {
self.data = BuildSettingData(name: name, value: value, condition: condition)
}
/// Declares linkage to a system library.
///
/// This setting is most useful when the library can't be linked
/// automatically, such as C++ based libraries and non-modular libraries.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - library: The library name.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func linkedLibrary(_ library: String, _ condition: BuildSettingCondition? = nil) -> LinkerSetting {
return LinkerSetting(name: "linkedLibrary", value: [library], condition: condition)
}
/// Declares linkage to a system framework.
///
/// This setting is most useful when the framework can't be linked
/// automatically, such as C++ based frameworks and non-modular frameworks.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - framework: The framework name.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func linkedFramework(_ framework: String, _ condition: BuildSettingCondition? = nil) -> LinkerSetting {
return LinkerSetting(name: "linkedFramework", value: [framework], condition: condition)
}
/// Sets unsafe flags to pass arbitrary command-line flags to the
/// corresponding build tool.
///
/// As the usage of the word “unsafe” implies, Swift Package Manager can't safely determine
/// if the build flags have any negative side effect on the build since
/// certain flags can change the behavior of how it performs a build.
///
/// As some build flags can be exploited for unsupported or malicious
/// behavior, the use of unsafe flags makes the products containing this
/// target ineligible for use by other packages.
///
/// - Since: First available in PackageDescription 5.0.
///
/// - Parameters:
/// - flags: The unsafe flags to set.
/// - condition: A condition that restricts the application of the build
/// setting.
@available(_PackageDescription, introduced: 5.0)
public static func unsafeFlags(_ flags: [String], _ condition: BuildSettingCondition? = nil) -> LinkerSetting {
return LinkerSetting(name: "unsafeFlags", value: flags, condition: condition)
}
}
|