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
|
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
//
extension Trait where Self == ConditionTrait {
/// Get a string describing a platform and optional version tuple.
///
/// - Parameters:
/// - platformName: The name of the platform provided during `@Test` macro
/// expansion.
/// - version: A platform version tuple as provided during `@Test` macro
/// expansion, if any.
///
/// - Returns: A string describing `platformName` and `version` such as
/// `"toasterOS 1.0.2"`.
private static func _description(
ofPlatformName platformName: String,
version: (major: UInt64, minor: UInt64?, patch: UInt64?)?
) -> String {
guard let version else {
return platformName
}
guard let minorVersion = version.minor else {
return "\(platformName) \(version.major)"
}
guard let patchVersion = version.patch else {
return "\(platformName) \(version.major).\(minorVersion)"
}
return "\(platformName) \(version.major).\(minorVersion).\(patchVersion)"
}
/// Create a trait controlling availability of a test based on an
/// `@available()` attribute applied to it.
///
/// - Parameters:
/// - platformName: The name of the platform specified in the `@available()`
/// attribute.
/// - version: A platform version tuple specified in the `@available()`
/// attribute, if any.
/// - message: The `message` parameter of the availability attribute.
/// - sourceLocation: The source location of the test.
/// - condition: A closure containing the actual `if #available()`
/// expression.
///
/// - Returns: A trait.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __available(
_ platformName: String,
introduced version: (major: UInt64, minor: UInt64?, patch: UInt64?)?,
message: Comment?,
sourceLocation: SourceLocation,
_ condition: @escaping @Sendable () -> Bool
) -> Self {
// TODO: Semantic capture of platform name/version (rather than just a comment)
Self(
kind: .conditional(condition),
comments: [message ?? "Requires \(_description(ofPlatformName: platformName, version: version))"],
sourceLocation: sourceLocation
)
}
/// Create a trait controlling availability of a test based on an
/// `@available()` attribute applied to it.
///
/// - Parameters:
/// - platformName: The name of the platform specified in the `@available()`
/// attribute.
/// - version: A platform version tuple specified in the `@available()`
/// attribute, if any.
/// - message: The `message` parameter of the availability attribute.
/// - sourceLocation: The source location of the test.
/// - condition: A closure containing the actual `if #available()`
/// expression.
///
/// - Returns: A trait.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __available(
_ platformName: String,
obsoleted version: (major: UInt64, minor: UInt64?, patch: UInt64?)?,
message: Comment?,
sourceLocation: SourceLocation,
_ condition: @escaping @Sendable () -> Bool
) -> Self {
// TODO: Semantic capture of platform name/version (rather than just a comment)
Self(
kind: .conditional(condition),
comments: [message ?? "Obsolete as of \(_description(ofPlatformName: platformName, version: version))"],
sourceLocation: sourceLocation
)
}
/// Create a trait controlling availability of a test based on an
/// `@available(*, unavailable)` attribute applied to it.
///
/// - Parameters:
/// - message: The `message` parameter of the availability attribute.
/// - sourceLocation: The source location of the test.
///
/// - Returns: A trait.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __unavailable(message: Comment?, sourceLocation: SourceLocation) -> Self {
Self(
kind: .unconditional(false),
comments: [message ?? "Marked @available(*, unavailable)"],
sourceLocation: sourceLocation
)
}
}
|