|
| 1 | +// |
| 2 | +// This source file is part of the Swift.org open source project |
| 3 | +// |
| 4 | +// Copyright (c) 2025 Apple Inc. and the Swift project authors |
| 5 | +// Licensed under Apache License v2.0 with Runtime Library Exception |
| 6 | +// |
| 7 | +// See https://swift.org/LICENSE.txt for license information |
| 8 | +// See https://swift.org/CONTRIBUTORS.txt for Swift project authors |
| 9 | +// |
| 10 | + |
| 11 | +#if !SWT_NO_INTEROP |
| 12 | +#if SWT_TARGET_OS_APPLE && !SWT_NO_OS_UNFAIR_LOCK |
| 13 | +private import _TestingInternals |
| 14 | +#else |
| 15 | +private import Synchronization |
| 16 | +#endif |
| 17 | + |
| 18 | +#if SWT_TARGET_OS_APPLE && !SWT_NO_OS_UNFAIR_LOCK |
| 19 | +/// The installed event handler. |
| 20 | +private nonisolated(unsafe) let _fallbackEventHandler = { |
| 21 | + let result = ManagedBuffer<FallbackEventHandler?, os_unfair_lock>.create( |
| 22 | + minimumCapacity: 1, |
| 23 | + makingHeaderWith: { _ in nil } |
| 24 | + ) |
| 25 | + result.withUnsafeMutablePointerToHeader { $0.initialize(to: nil) } |
| 26 | + return result |
| 27 | +}() |
| 28 | +#else |
| 29 | +/// The installed event handler. |
| 30 | +private nonisolated(unsafe) let _fallbackEventHandler = Atomic<UnsafeRawPointer?>(nil) |
| 31 | +#endif |
| 32 | + |
| 33 | +/// A type describing a fallback event handler that testing API can invoke as an |
| 34 | +/// alternate method of reporting test events to the current test runner. |
| 35 | +/// |
| 36 | +/// For example, an `XCTAssert` failure in the body of a Swift Testing test |
| 37 | +/// cannot record issues directly with the Swift Testing runner. Instead, the |
| 38 | +/// framework packages the assertion failure as a JSON `Event` and invokes this |
| 39 | +/// handler to report the failure. |
| 40 | +/// |
| 41 | +/// - Parameters: |
| 42 | +/// - recordJSONSchemaVersionNumber: The JSON schema version used to encode |
| 43 | +/// the event record. |
| 44 | +/// - recordJSONBaseAddress: A pointer to the first byte of the encoded event. |
| 45 | +/// - recordJSONByteCount: The size of the encoded event in bytes. |
| 46 | +/// - reserved: Reserved for future use. |
| 47 | +@usableFromInline |
| 48 | +package typealias FallbackEventHandler = @Sendable @convention(c) ( |
| 49 | + _ recordJSONSchemaVersionNumber: UnsafePointer<CChar>, |
| 50 | + _ recordJSONBaseAddress: UnsafeRawPointer, |
| 51 | + _ recordJSONByteCount: Int, |
| 52 | + _ reserved: UnsafeRawPointer? |
| 53 | +) -> Void |
| 54 | + |
| 55 | +/// Get the current fallback event handler. |
| 56 | +/// |
| 57 | +/// - Returns: The currently-set handler function, if any. |
| 58 | +@_cdecl("_swift_testing_getFallbackEventHandler") |
| 59 | +@usableFromInline |
| 60 | +package func _swift_testing_getFallbackEventHandler() -> FallbackEventHandler? { |
| 61 | +#if SWT_TARGET_OS_APPLE && !SWT_NO_OS_UNFAIR_LOCK |
| 62 | + return _fallbackEventHandler.withUnsafeMutablePointers { fallbackEventHandler, lock in |
| 63 | + os_unfair_lock_lock(lock) |
| 64 | + defer { |
| 65 | + os_unfair_lock_unlock(lock) |
| 66 | + } |
| 67 | + return fallbackEventHandler.pointee |
| 68 | + } |
| 69 | +#else |
| 70 | + return _fallbackEventHandler.load(ordering: .sequentiallyConsistent).flatMap { fallbackEventHandler in |
| 71 | + unsafeBitCast(fallbackEventHandler, to: FallbackEventHandler?.self) |
| 72 | + } |
| 73 | +#endif |
| 74 | +} |
| 75 | + |
| 76 | +/// Set the current fallback event handler if one has not already been set. |
| 77 | +/// |
| 78 | +/// - Parameters: |
| 79 | +/// - handler: The handler function to set. |
| 80 | +/// |
| 81 | +/// - Returns: Whether or not `handler` was installed. |
| 82 | +/// |
| 83 | +/// The fallback event handler can only be installed once per process, typically |
| 84 | +/// by the first testing library to run. If this function has already been |
| 85 | +/// called and the handler set, it does not replace the previous handler. |
| 86 | +@_cdecl("_swift_testing_installFallbackEventHandler") |
| 87 | +@usableFromInline |
| 88 | +package func _swift_testing_installFallbackEventHandler(_ handler: FallbackEventHandler) -> CBool { |
| 89 | +#if SWT_TARGET_OS_APPLE && !SWT_NO_OS_UNFAIR_LOCK |
| 90 | + return _fallbackEventHandler.withUnsafeMutablePointers { fallbackEventHandler, lock in |
| 91 | + os_unfair_lock_lock(lock) |
| 92 | + defer { |
| 93 | + os_unfair_lock_unlock(lock) |
| 94 | + } |
| 95 | + guard fallbackEventHandler.pointee == nil else { |
| 96 | + return false |
| 97 | + } |
| 98 | + fallbackEventHandler.pointee = handler |
| 99 | + return true |
| 100 | + } |
| 101 | +#else |
| 102 | + let handler = unsafeBitCast(handler, to: UnsafeRawPointer.self) |
| 103 | + return _fallbackEventHandler.compareExchange(expected: nil, desired: handler, ordering: .sequentiallyConsistent).exchanged |
| 104 | +#endif |
| 105 | +} |
| 106 | +#endif |
0 commit comments