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
|
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 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
//
import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros
/// An enumeration representing the different kinds of test content known to the
/// testing library.
///
/// When adding cases to this enumeration, be sure to also update the
/// corresponding enumeration in TestContent.md.
///
/// - Bug: This type should be imported directly from `_TestDiscovery` instead
/// of being redefined (differently) here.
enum TestContentKind: UInt32 {
/// A test or suite declaration.
case testDeclaration = 0x74657374
/// An exit test.
case exitTest = 0x65786974
/// This kind value as a comment (`/* 'abcd' */`) if it looks like it might be
/// a [FourCC](https://en.wikipedia.org/wiki/FourCC) value, or `nil` if not.
var commentRepresentation: Trivia {
let stringValue = withUnsafeBytes(of: self.rawValue.bigEndian) { bytes in
String(decoding: bytes, as: Unicode.ASCII.self)
}
return .blockComment("/* '\(stringValue)' */")
}
}
/// Make a test content record that can be discovered at runtime by the testing
/// library.
///
/// - Parameters:
/// - name: The name of the record declaration to use in Swift source. The
/// value of this argument should be unique in the context in which the
/// declaration will be emitted.
/// - typeName: The name of the type enclosing the resulting declaration, or
/// `nil` if it will not be emitted into a type's scope.
/// - kind: The kind of test content record being emitted.
/// - accessorName: The Swift name of an `@convention(c)` function to emit
/// into the resulting record.
/// - context: A value to emit as the `context` field of the test content
/// record.
///
/// - Returns: A variable declaration that, when emitted into Swift source, will
/// cause the linker to emit data in a location that is discoverable at
/// runtime.
func makeTestContentRecordDecl(named name: TokenSyntax, in typeName: TypeSyntax? = nil, ofKind kind: TestContentKind, accessingWith accessorName: TokenSyntax, context: UInt32 = 0) -> DeclSyntax {
let kindExpr = IntegerLiteralExprSyntax(kind.rawValue, radix: .hex)
let contextExpr = if context == 0 {
IntegerLiteralExprSyntax(0)
} else {
IntegerLiteralExprSyntax(context, radix: .binary)
}
let unsafeKeyword: TokenSyntax? = isUnsafeKeywordSupported ? .keyword(.unsafe, trailingTrivia: .space) : nil
var result: DeclSyntax = """
@available(*, deprecated, message: "This property is an implementation detail of the testing library. Do not use it directly.")
private nonisolated \(staticKeyword(for: typeName)) let \(name): Testing.__TestContentRecord = (
\(kindExpr), \(kind.commentRepresentation)
0,
\(unsafeKeyword)\(accessorName),
\(contextExpr),
0
)
"""
#if hasFeature(SymbolLinkageMarkers)
result = """
#if hasFeature(SymbolLinkageMarkers)
#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS) || os(visionOS)
@_section("__DATA_CONST,__swift5_tests")
#elseif os(Linux) || os(FreeBSD) || os(OpenBSD) || os(Android) || os(WASI)
@_section("swift5_tests")
#elseif os(Windows)
@_section(".sw5test$B")
#else
@Testing.__testing(warning: "Platform-specific implementation missing: test content section name unavailable")
#endif
@_used
#endif
\(result)
"""
#endif
return result
}
|
