@@ -17,12 +17,42 @@ private import _TestingInternals
1717/// test is expected to pass or fail by passing them to
1818/// ``expect(exitsWith:observing:_:sourceLocation:performing:)`` or
1919/// ``require(exitsWith:observing:_:sourceLocation:performing:)``.
20- @_spi ( Experimental)
20+ ///
21+ /// ## Topics
22+ ///
23+ /// ### Successful exit conditions
24+ ///
25+ /// - ``success``
26+ ///
27+ /// ### Failing exit conditions
28+ ///
29+ /// - ``failure``
30+ /// - ``exitCode(_:)``
31+ /// - ``signal(_:)``
32+ ///
33+ /// ### Comparing exit conditions
34+ ///
35+ /// - ``/Swift/Optional/==(_:_:)``
36+ /// - ``/Swift/Optional/!=(_:_:)``
37+ /// - ``/Swift/Optional/===(_:_:)``
38+ /// - ``/Swift/Optional/!==(_:_:)``
39+ ///
40+ /// @Metadata {
41+ /// @Available(Swift, introduced: 6.2)
42+ /// }
2143#if SWT_NO_PROCESS_SPAWNING
2244@available ( * , unavailable, message: " Exit tests are not available on this platform. " )
2345#endif
2446public enum ExitCondition : Sendable {
2547 /// The process terminated successfully with status `EXIT_SUCCESS`.
48+ ///
49+ /// The C programming language defines two [standard exit codes](https://en.cppreference.com/w/c/program/EXIT_status),
50+ /// `EXIT_SUCCESS` and `EXIT_FAILURE` as well as `0` (as a synonym for
51+ /// `EXIT_SUCCESS`.)
52+ ///
53+ /// @Metadata {
54+ /// @Available(Swift, introduced: 6.2)
55+ /// }
2656 public static var success : Self {
2757 // Strictly speaking, the C standard treats 0 as a successful exit code and
2858 // potentially distinct from EXIT_SUCCESS. To my knowledge, no modern
@@ -33,6 +63,10 @@ public enum ExitCondition: Sendable {
3363
3464 /// The process terminated abnormally with any status other than
3565 /// `EXIT_SUCCESS` or with any signal.
66+ ///
67+ /// @Metadata {
68+ /// @Available(Swift, introduced: 6.2)
69+ /// }
3670 case failure
3771
3872 /// The process terminated with the given exit code.
@@ -56,6 +90,10 @@ public enum ExitCondition: Sendable {
5690 /// the process is yielded to the parent process. Linux and other POSIX-like
5791 /// systems may only reliably report the low unsigned 8 bits (0–255) of
5892 /// the exit code.
93+ ///
94+ /// @Metadata {
95+ /// @Available(Swift, introduced: 6.2)
96+ /// }
5997 case exitCode( _ exitCode: CInt )
6098
6199 /// The process terminated with the given signal.
@@ -73,12 +111,18 @@ public enum ExitCondition: Sendable {
73111 /// | FreeBSD | [`<signal.h>`](https://man.freebsd.org/cgi/man.cgi?signal(3)) |
74112 /// | OpenBSD | [`<signal.h>`](https://man.openbsd.org/signal.3) |
75113 /// | Windows | [`<signal.h>`](https://learn.microsoft.com/en-us/cpp/c-runtime-library/signal-constants) |
114+ ///
115+ /// @Metadata {
116+ /// @Available(Swift, introduced: 6.2)
117+ /// }
76118 case signal( _ signal: CInt )
77119}
78120
79121// MARK: - Equatable
80122
81- @_spi ( Experimental)
123+ /// @Metadata {
124+ /// @Available(Swift, introduced: 6.2)
125+ /// }
82126#if SWT_NO_PROCESS_SPAWNING
83127@available ( * , unavailable, message: " Exit tests are not available on this platform. " )
84128#endif
@@ -109,7 +153,11 @@ extension Optional<ExitCondition> {
109153 /// or [`Hashable`](https://developer.apple.com/documentation/swift/hashable).
110154 ///
111155 /// For any values `a` and `b`, `a == b` implies that `a != b` is `false`.
112- public static func == ( lhs: Self , rhs: Self ) -> Bool {
156+ ///
157+ /// @Metadata {
158+ /// @Available(Swift, introduced: 6.2)
159+ /// }
160+ public static func == ( lhs: ExitCondition ? , rhs: ExitCondition ? ) -> Bool {
113161#if !SWT_NO_PROCESS_SPAWNING
114162 return switch ( lhs, rhs) {
115163 case let ( . failure, . exitCode( exitCode) ) , let ( . exitCode( exitCode) , . failure) :
@@ -151,7 +199,11 @@ extension Optional<ExitCondition> {
151199 /// or [`Hashable`](https://developer.apple.com/documentation/swift/hashable).
152200 ///
153201 /// For any values `a` and `b`, `a == b` implies that `a != b` is `false`.
154- public static func != ( lhs: Self , rhs: Self ) -> Bool {
202+ ///
203+ /// @Metadata {
204+ /// @Available(Swift, introduced: 6.2)
205+ /// }
206+ public static func != ( lhs: ExitCondition ? , rhs: ExitCondition ? ) -> Bool {
155207#if !SWT_NO_PROCESS_SPAWNING
156208 !( lhs == rhs)
157209#else
@@ -185,7 +237,11 @@ extension Optional<ExitCondition> {
185237 /// or [`Hashable`](https://developer.apple.com/documentation/swift/hashable).
186238 ///
187239 /// For any values `a` and `b`, `a === b` implies that `a !== b` is `false`.
188- public static func === ( lhs: Self , rhs: Self ) -> Bool {
240+ ///
241+ /// @Metadata {
242+ /// @Available(Swift, introduced: 6.2)
243+ /// }
244+ public static func === ( lhs: ExitCondition ? , rhs: ExitCondition ? ) -> Bool {
189245 return switch ( lhs, rhs) {
190246 case ( . none, . none) :
191247 true
@@ -226,7 +282,11 @@ extension Optional<ExitCondition> {
226282 /// or [`Hashable`](https://developer.apple.com/documentation/swift/hashable).
227283 ///
228284 /// For any values `a` and `b`, `a === b` implies that `a !== b` is `false`.
229- public static func !== ( lhs: Self , rhs: Self ) -> Bool {
285+ ///
286+ /// @Metadata {
287+ /// @Available(Swift, introduced: 6.2)
288+ /// }
289+ public static func !== ( lhs: ExitCondition ? , rhs: ExitCondition ? ) -> Bool {
230290#if !SWT_NO_PROCESS_SPAWNING
231291 !( lhs === rhs)
232292#else
0 commit comments