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
|
//
// 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
//
#if !defined(SWT_WILLTHROW_H)
#define SWT_WILLTHROW_H
#include "Defines.h"
SWT_ASSUME_NONNULL_BEGIN
/// The type of handler that is called by `swift_willThrow()`.
///
/// - Parameters:
/// - error: The error that is about to be thrown. This pointer refers to an
/// instance of `SwiftError` or (on platforms with Objective-C interop) an
/// instance of `NSError`.
typedef void (* SWT_SENDABLE SWTWillThrowHandler)(void *error);
/// Set the callback function that fires when an instance of `Swift.Error` is
/// thrown.
///
/// - Parameters:
/// - handler: The handler function to set, or `nil` to clear the handler
/// function.
///
/// - Returns: The previously-set handler function, if any.
///
/// This function sets the global `_swift_willThrow()` variable in the Swift
/// runtime, which is reserved for use by the testing framework. If another
/// testing framework such as XCTest has already set a handler, it is returned.
///
/// ## See Also
///
/// ``SWTWillThrowHandler``
SWT_EXTERN SWTWillThrowHandler SWT_SENDABLE _Nullable swt_setWillThrowHandler(SWTWillThrowHandler SWT_SENDABLE _Nullable handler);
/// The type of handler that is called by `swift_willThrowTyped()`.
///
/// - Parameters:
/// - error: The error that is about to be thrown. This pointer points
/// directly to the unboxed error in memory. For errors of reference type,
/// the pointer points to the object and is not the object's address itself.
/// - errorType: The metatype of `error`.
/// - errorConformance: The witness table for `error`'s conformance to the
/// `Error` protocol.
typedef void (* SWT_SENDABLE SWTWillThrowTypedHandler)(void *error, const void *errorType, const void *errorConformance);
/// Set the callback function that fires when an instance of `Swift.Error` is
/// thrown using the typed throws mechanism.
///
/// - Parameters:
/// - handler: The handler function to set, or `nil` to clear the handler
/// function.
///
/// - Returns: The previously-set handler function, if any.
///
/// This function sets the global `_swift_willThrowTypedImpl()` variable in the
/// Swift runtime, which is reserved for use by the testing framework. If
/// another testing framework such as XCTest has already set a handler, it is
/// returned.
///
/// ## See Also
///
/// ``SWTWillThrowTypedHandler``
SWT_EXTERN SWTWillThrowTypedHandler SWT_SENDABLE _Nullable swt_setWillThrowTypedHandler(SWTWillThrowTypedHandler SWT_SENDABLE _Nullable handler);
#if !defined(__APPLE__)
/// The result of `swift__getErrorValue()`.
///
/// For more information, see this type's declaration
/// [in the Swift repository](https://github.com/swiftlang/swift/blob/main/include/swift/Runtime/Error.h).
typedef struct SWTErrorValueResult {
void *value;
const void *type;
const void *errorConformance;
} SWTErrorValueResult;
/// Unbox an error existential and get its type and protocol conformance.
///
/// This function is provided by the Swift runtime. For more information, see
/// this function's declaration [in the Swift repository](https://github.com/swiftlang/swift/blob/main/include/swift/Runtime/Error.h).
SWT_IMPORT_FROM_STDLIB void swift_getErrorValue(void *error, void *_Nullable *_Nonnull scratch, SWTErrorValueResult *out);
#endif
SWT_ASSUME_NONNULL_END
#endif
|
