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