xref: /xnu-11215.61.5/EXTERNAL_HEADERS/CoreEntitlements/Result.h (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions //
2*4f1223e8SApple OSS Distributions //  Result.h
3*4f1223e8SApple OSS Distributions //  CoreEntitlements
4*4f1223e8SApple OSS Distributions //
5*4f1223e8SApple OSS Distributions 
6*4f1223e8SApple OSS Distributions #ifndef CORE_ENTITLEMENTS_RESULT_H
7*4f1223e8SApple OSS Distributions #define CORE_ENTITLEMENTS_RESULT_H
8*4f1223e8SApple OSS Distributions 
9*4f1223e8SApple OSS Distributions #ifndef _CE_INDIRECT
10*4f1223e8SApple OSS Distributions #error "Please include <CoreEntitlements/CoreEntitlements.h> instead of this file"
11*4f1223e8SApple OSS Distributions #endif
12*4f1223e8SApple OSS Distributions 
13*4f1223e8SApple OSS Distributions #include <sys/cdefs.h>
14*4f1223e8SApple OSS Distributions __ptrcheck_abi_assume_single();
15*4f1223e8SApple OSS Distributions 
16*4f1223e8SApple OSS Distributions #include <CoreEntitlements/Errors.h>
17*4f1223e8SApple OSS Distributions #include <stdint.h>
18*4f1223e8SApple OSS Distributions 
19*4f1223e8SApple OSS Distributions /*!
20*4f1223e8SApple OSS Distributions  * @function CEErrorPassThrough
21*4f1223e8SApple OSS Distributions  * Returns its argument. Convenient breakpoint location for when anything raises an error.
22*4f1223e8SApple OSS Distributions  */
CEErrorPassThrough(CEError_t E)23*4f1223e8SApple OSS Distributions static inline CEError_t CEErrorPassThrough(CEError_t E) {
24*4f1223e8SApple OSS Distributions     return E;
25*4f1223e8SApple OSS Distributions }
26*4f1223e8SApple OSS Distributions 
27*4f1223e8SApple OSS Distributions /*!
28*4f1223e8SApple OSS Distributions  * @function CE_CHECK
29*4f1223e8SApple OSS Distributions  * Checks if the passed in return value from one of CoreEntitlements function is an error, and if so returns that error in the current function
30*4f1223e8SApple OSS Distributions  */
31*4f1223e8SApple OSS Distributions #define CE_CHECK(ret) do { CEError_t _ce_error = ret; if (_ce_error != kCENoError) {return CEErrorPassThrough(_ce_error);} } while(0)
32*4f1223e8SApple OSS Distributions 
33*4f1223e8SApple OSS Distributions /*!
34*4f1223e8SApple OSS Distributions  * @function CE_THROW
35*4f1223e8SApple OSS Distributions  * Macro to "throw" (return) one of the CEErrors
36*4f1223e8SApple OSS Distributions  */
37*4f1223e8SApple OSS Distributions #define CE_THROW(err) return CEErrorPassThrough(err)
38*4f1223e8SApple OSS Distributions 
39*4f1223e8SApple OSS Distributions /*!
40*4f1223e8SApple OSS Distributions  * @function CE_OK
41*4f1223e8SApple OSS Distributions  * Returns a true if the passed in value corresponds to kCENoError
42*4f1223e8SApple OSS Distributions  */
43*4f1223e8SApple OSS Distributions #define CE_OK(ret) ((ret) == kCENoError)
44*4f1223e8SApple OSS Distributions 
45*4f1223e8SApple OSS Distributions #endif
46