xref: /xnu-12377.61.12/EXTERNAL_HEADERS/AssertMacros.h (revision 4d495c6e23c53686cf65f45067f79024cf5dcee8)
1*4d495c6eSApple OSS Distributions /*
2*4d495c6eSApple OSS Distributions  * Copyright (c) 2002-2008 by Apple Inc.. All rights reserved.
3*4d495c6eSApple OSS Distributions  *
4*4d495c6eSApple OSS Distributions  * @APPLE_LICENSE_HEADER_START@
5*4d495c6eSApple OSS Distributions  *
6*4d495c6eSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*4d495c6eSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*4d495c6eSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*4d495c6eSApple OSS Distributions  * compliance with the License. Please obtain a copy of the License at
10*4d495c6eSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this
11*4d495c6eSApple OSS Distributions  * file.
12*4d495c6eSApple OSS Distributions  *
13*4d495c6eSApple OSS Distributions  * The Original Code and all software distributed under the License are
14*4d495c6eSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15*4d495c6eSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16*4d495c6eSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17*4d495c6eSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18*4d495c6eSApple OSS Distributions  * Please see the License for the specific language governing rights and
19*4d495c6eSApple OSS Distributions  * limitations under the License.
20*4d495c6eSApple OSS Distributions  *
21*4d495c6eSApple OSS Distributions  * @APPLE_LICENSE_HEADER_END@
22*4d495c6eSApple OSS Distributions  */
23*4d495c6eSApple OSS Distributions 
24*4d495c6eSApple OSS Distributions 
25*4d495c6eSApple OSS Distributions /*
26*4d495c6eSApple OSS Distributions 	File:       AssertMacros.h
27*4d495c6eSApple OSS Distributions 
28*4d495c6eSApple OSS Distributions 	Contains:   This file defines structured error handling and assertion macros for
29*4d495c6eSApple OSS Distributions 				programming in C. Originally used in QuickDraw GX and later enhanced.
30*4d495c6eSApple OSS Distributions 				These macros are used throughout Apple's software.
31*4d495c6eSApple OSS Distributions 
32*4d495c6eSApple OSS Distributions 				New code may not want to begin adopting these macros and instead use
33*4d495c6eSApple OSS Distributions 				existing language functionality.
34*4d495c6eSApple OSS Distributions 
35*4d495c6eSApple OSS Distributions 				See "Living In an Exceptional World" by Sean Parent
36*4d495c6eSApple OSS Distributions 				(develop, The Apple Technical Journal, Issue 11, August/September 1992)
37*4d495c6eSApple OSS Distributions 				<http://developer.apple.com/dev/techsupport/develop/issue11toc.shtml> or
38*4d495c6eSApple OSS Distributions 				<http://www.mactech.com/articles/develop/issue_11/Parent_final.html>
39*4d495c6eSApple OSS Distributions 				for the methodology behind these error handling and assertion macros.
40*4d495c6eSApple OSS Distributions 
41*4d495c6eSApple OSS Distributions 	Bugs?:      For bug reports, consult the following page on
42*4d495c6eSApple OSS Distributions 				the World Wide Web:
43*4d495c6eSApple OSS Distributions 
44*4d495c6eSApple OSS Distributions 	 http://developer.apple.com/bugreporter/
45*4d495c6eSApple OSS Distributions */
46*4d495c6eSApple OSS Distributions #ifndef __ASSERTMACROS__
47*4d495c6eSApple OSS Distributions #define __ASSERTMACROS__
48*4d495c6eSApple OSS Distributions 
49*4d495c6eSApple OSS Distributions /*
50*4d495c6eSApple OSS Distributions  *  Macro overview:
51*4d495c6eSApple OSS Distributions  *
52*4d495c6eSApple OSS Distributions  *      check(assertion)
53*4d495c6eSApple OSS Distributions  *         In production builds, pre-processed away
54*4d495c6eSApple OSS Distributions  *         In debug builds, if assertion evaluates to false, calls DEBUG_ASSERT_MESSAGE
55*4d495c6eSApple OSS Distributions  *
56*4d495c6eSApple OSS Distributions  *      verify(assertion)
57*4d495c6eSApple OSS Distributions  *         In production builds, evaluates assertion and does nothing
58*4d495c6eSApple OSS Distributions  *         In debug builds, if assertion evaluates to false, calls DEBUG_ASSERT_MESSAGE
59*4d495c6eSApple OSS Distributions  *
60*4d495c6eSApple OSS Distributions  *      require(assertion, exceptionLabel)
61*4d495c6eSApple OSS Distributions  *         In production builds, if the assertion expression evaluates to false, goto exceptionLabel
62*4d495c6eSApple OSS Distributions  *         In debug builds, if the assertion expression evaluates to false, calls DEBUG_ASSERT_MESSAGE
63*4d495c6eSApple OSS Distributions  *                          and jumps to exceptionLabel
64*4d495c6eSApple OSS Distributions  *
65*4d495c6eSApple OSS Distributions  *      In addition the following suffixes are available:
66*4d495c6eSApple OSS Distributions  *
67*4d495c6eSApple OSS Distributions  *         _noerr     Adds "!= 0" to assertion.  Useful for asserting and OSStatus or OSErr is noErr (zero)
68*4d495c6eSApple OSS Distributions  *         _action    Adds statement to be executued if assertion fails
69*4d495c6eSApple OSS Distributions  *         _quiet     Suppress call to DEBUG_ASSERT_MESSAGE
70*4d495c6eSApple OSS Distributions  *         _string    Allows you to add explanitory message to DEBUG_ASSERT_MESSAGE
71*4d495c6eSApple OSS Distributions  *
72*4d495c6eSApple OSS Distributions  *        For instance, require_noerr_string(resultCode, label, msg) will do nothing if
73*4d495c6eSApple OSS Distributions  *        resultCode is zero, otherwise it will call DEBUG_ASSERT_MESSAGE with msg
74*4d495c6eSApple OSS Distributions  *        and jump to label.
75*4d495c6eSApple OSS Distributions  *
76*4d495c6eSApple OSS Distributions  *  Configuration:
77*4d495c6eSApple OSS Distributions  *
78*4d495c6eSApple OSS Distributions  *      By default all macros generate "production code" (i.e non-debug).  If
79*4d495c6eSApple OSS Distributions  *      DEBUG_ASSERT_PRODUCTION_CODE is defined to zero or DEBUG is defined to non-zero
80*4d495c6eSApple OSS Distributions  *      while this header is included, the macros will generated debug code.
81*4d495c6eSApple OSS Distributions  *
82*4d495c6eSApple OSS Distributions  *      If DEBUG_ASSERT_COMPONENT_NAME_STRING is defined, all debug messages will
83*4d495c6eSApple OSS Distributions  *      be prefixed with it.
84*4d495c6eSApple OSS Distributions  *
85*4d495c6eSApple OSS Distributions  *      By default, all messages write to stderr.  If you would like to write a custom
86*4d495c6eSApple OSS Distributions  *      error message formater, defined DEBUG_ASSERT_MESSAGE to your function name.
87*4d495c6eSApple OSS Distributions  *
88*4d495c6eSApple OSS Distributions  *      Each individual macro will only be defined if it is not already defined, so
89*4d495c6eSApple OSS Distributions  *      you can redefine their behavior singly by providing your own definition before
90*4d495c6eSApple OSS Distributions  *      this file is included.
91*4d495c6eSApple OSS Distributions  *
92*4d495c6eSApple OSS Distributions  *      If you define __ASSERTMACROS__ before this file is included, then nothing in
93*4d495c6eSApple OSS Distributions  *      this file will take effect.
94*4d495c6eSApple OSS Distributions  *
95*4d495c6eSApple OSS Distributions  *      Prior to Mac OS X 10.6 the macro names used in this file conflicted with some
96*4d495c6eSApple OSS Distributions  *      user code, including libraries in boost and the proposed C++ standards efforts,
97*4d495c6eSApple OSS Distributions  *      and there was no way for a client of this header to resolve this conflict. Because
98*4d495c6eSApple OSS Distributions  *      of this, most of the macros have been changed so that they are prefixed with
99*4d495c6eSApple OSS Distributions  *      __ and contain at least one capital letter, which should alleviate the current
100*4d495c6eSApple OSS Distributions  *      and future conflicts.  However, to allow current sources to continue to compile,
101*4d495c6eSApple OSS Distributions  *      compatibility macros are defined at the end with the old names.  A tops script
102*4d495c6eSApple OSS Distributions  *      at the end of this file will convert all of the old macro names used in a directory
103*4d495c6eSApple OSS Distributions  *      to the new names.  Clients are recommended to migrate over to these new macros as
104*4d495c6eSApple OSS Distributions  *      they update their sources because a future release of Mac OS X will remove the
105*4d495c6eSApple OSS Distributions  *      old macro definitions ( without the double-underscore prefix ).  Clients who
106*4d495c6eSApple OSS Distributions  *      want to compile without the old macro definitions can define the macro
107*4d495c6eSApple OSS Distributions  *      __ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES to 0 before this file is
108*4d495c6eSApple OSS Distributions  *      included.
109*4d495c6eSApple OSS Distributions  */
110*4d495c6eSApple OSS Distributions 
111*4d495c6eSApple OSS Distributions 
112*4d495c6eSApple OSS Distributions /*
113*4d495c6eSApple OSS Distributions  *  Before including this file, #define DEBUG_ASSERT_COMPONENT_NAME_STRING to
114*4d495c6eSApple OSS Distributions  *  a C-string containing the name of your client. This string will be passed to
115*4d495c6eSApple OSS Distributions  *  the DEBUG_ASSERT_MESSAGE macro for inclusion in any assertion messages.
116*4d495c6eSApple OSS Distributions  *
117*4d495c6eSApple OSS Distributions  *  If you do not define DEBUG_ASSERT_COMPONENT_NAME_STRING, the default
118*4d495c6eSApple OSS Distributions  *  DEBUG_ASSERT_COMPONENT_NAME_STRING value, an empty string, will be used by
119*4d495c6eSApple OSS Distributions  *  the assertion macros.
120*4d495c6eSApple OSS Distributions  */
121*4d495c6eSApple OSS Distributions #ifndef DEBUG_ASSERT_COMPONENT_NAME_STRING
122*4d495c6eSApple OSS Distributions     #define DEBUG_ASSERT_COMPONENT_NAME_STRING ""
123*4d495c6eSApple OSS Distributions #endif
124*4d495c6eSApple OSS Distributions 
125*4d495c6eSApple OSS Distributions 
126*4d495c6eSApple OSS Distributions /*
127*4d495c6eSApple OSS Distributions  *  To activate the additional assertion code and messages for non-production builds,
128*4d495c6eSApple OSS Distributions  *  #define DEBUG_ASSERT_PRODUCTION_CODE to zero before including this file.
129*4d495c6eSApple OSS Distributions  *
130*4d495c6eSApple OSS Distributions  *  If you do not define DEBUG_ASSERT_PRODUCTION_CODE, the default value 1 will be used
131*4d495c6eSApple OSS Distributions  *  (production code = no assertion code and no messages).
132*4d495c6eSApple OSS Distributions  */
133*4d495c6eSApple OSS Distributions #ifndef DEBUG_ASSERT_PRODUCTION_CODE
134*4d495c6eSApple OSS Distributions    #define DEBUG_ASSERT_PRODUCTION_CODE !DEBUG
135*4d495c6eSApple OSS Distributions #endif
136*4d495c6eSApple OSS Distributions 
137*4d495c6eSApple OSS Distributions 
138*4d495c6eSApple OSS Distributions /*
139*4d495c6eSApple OSS Distributions  *  DEBUG_ASSERT_MESSAGE(component, assertion, label, error, file, line, errorCode)
140*4d495c6eSApple OSS Distributions  *
141*4d495c6eSApple OSS Distributions  *  Summary:
142*4d495c6eSApple OSS Distributions  *    All assertion messages are routed through this macro. If you wish to use your
143*4d495c6eSApple OSS Distributions  *    own routine to display assertion messages, you can override DEBUG_ASSERT_MESSAGE
144*4d495c6eSApple OSS Distributions  *    by #defining DEBUG_ASSERT_MESSAGE before including this file.
145*4d495c6eSApple OSS Distributions  *
146*4d495c6eSApple OSS Distributions  *  Parameters:
147*4d495c6eSApple OSS Distributions  *
148*4d495c6eSApple OSS Distributions  *    componentNameString:
149*4d495c6eSApple OSS Distributions  *      A pointer to a string constant containing the name of the
150*4d495c6eSApple OSS Distributions  *      component this code is part of. This must be a string constant
151*4d495c6eSApple OSS Distributions  *      (and not a string variable or NULL) because the preprocessor
152*4d495c6eSApple OSS Distributions  *      concatenates it with other string constants.
153*4d495c6eSApple OSS Distributions  *
154*4d495c6eSApple OSS Distributions  *    assertionString:
155*4d495c6eSApple OSS Distributions  *      A pointer to a string constant containing the assertion.
156*4d495c6eSApple OSS Distributions  *      This must be a string constant (and not a string variable or
157*4d495c6eSApple OSS Distributions  *      NULL) because the Preprocessor concatenates it with other
158*4d495c6eSApple OSS Distributions  *      string constants.
159*4d495c6eSApple OSS Distributions  *
160*4d495c6eSApple OSS Distributions  *    exceptionLabelString:
161*4d495c6eSApple OSS Distributions  *      A pointer to a string containing the exceptionLabel, or NULL.
162*4d495c6eSApple OSS Distributions  *
163*4d495c6eSApple OSS Distributions  *    errorString:
164*4d495c6eSApple OSS Distributions  *      A pointer to the error string, or NULL. DEBUG_ASSERT_MESSAGE macros
165*4d495c6eSApple OSS Distributions  *      must not attempt to concatenate this string with constant
166*4d495c6eSApple OSS Distributions  *      character strings.
167*4d495c6eSApple OSS Distributions  *
168*4d495c6eSApple OSS Distributions  *    fileName:
169*4d495c6eSApple OSS Distributions  *      A pointer to the fileName or pathname (generated by the
170*4d495c6eSApple OSS Distributions  *      preprocessor __FILE__ identifier), or NULL.
171*4d495c6eSApple OSS Distributions  *
172*4d495c6eSApple OSS Distributions  *    lineNumber:
173*4d495c6eSApple OSS Distributions  *      The line number in the file (generated by the preprocessor
174*4d495c6eSApple OSS Distributions  *      __LINE__ identifier), or 0 (zero).
175*4d495c6eSApple OSS Distributions  *
176*4d495c6eSApple OSS Distributions  *    errorCode:
177*4d495c6eSApple OSS Distributions  *      A value associated with the assertion, or 0.
178*4d495c6eSApple OSS Distributions  *
179*4d495c6eSApple OSS Distributions  *  Here is an example of a DEBUG_ASSERT_MESSAGE macro and a routine which displays
180*4d495c6eSApple OSS Distributions  *  assertion messsages:
181*4d495c6eSApple OSS Distributions  *
182*4d495c6eSApple OSS Distributions  *      #define DEBUG_ASSERT_COMPONENT_NAME_STRING "MyCoolProgram"
183*4d495c6eSApple OSS Distributions  *
184*4d495c6eSApple OSS Distributions  *      #define DEBUG_ASSERT_MESSAGE(componentNameString, assertionString,                           \
185*4d495c6eSApple OSS Distributions  *                                   exceptionLabelString, errorString, fileName, lineNumber, errorCode) \
186*4d495c6eSApple OSS Distributions  *              MyProgramDebugAssert(componentNameString, assertionString,                           \
187*4d495c6eSApple OSS Distributions  *                                   exceptionLabelString, errorString, fileName, lineNumber, errorCode)
188*4d495c6eSApple OSS Distributions  *
189*4d495c6eSApple OSS Distributions  *      static void
190*4d495c6eSApple OSS Distributions  *      MyProgramDebugAssert(const char *componentNameString, const char *assertionString,
191*4d495c6eSApple OSS Distributions  *                           const char *exceptionLabelString, const char *errorString,
192*4d495c6eSApple OSS Distributions  *                           const char *fileName, long lineNumber, int errorCode)
193*4d495c6eSApple OSS Distributions  *      {
194*4d495c6eSApple OSS Distributions  *          if ( (assertionString != NULL) && (*assertionString != '\0') )
195*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "Assertion failed: %s: %s\n", componentNameString, assertionString);
196*4d495c6eSApple OSS Distributions  *          else
197*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "Check failed: %s:\n", componentNameString);
198*4d495c6eSApple OSS Distributions  *          if ( exceptionLabelString != NULL )
199*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "    %s\n", exceptionLabelString);
200*4d495c6eSApple OSS Distributions  *          if ( errorString != NULL )
201*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "    %s\n", errorString);
202*4d495c6eSApple OSS Distributions  *          if ( fileName != NULL )
203*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "    file: %s\n", fileName);
204*4d495c6eSApple OSS Distributions  *          if ( lineNumber != 0 )
205*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "    line: %ld\n", lineNumber);
206*4d495c6eSApple OSS Distributions  *          if ( errorCode != 0 )
207*4d495c6eSApple OSS Distributions  *              fprintf(stderr, "    error: %d\n", errorCode);
208*4d495c6eSApple OSS Distributions  *      }
209*4d495c6eSApple OSS Distributions  *
210*4d495c6eSApple OSS Distributions  *  If you do not define DEBUG_ASSERT_MESSAGE, a simple printf to stderr will be used.
211*4d495c6eSApple OSS Distributions  */
212*4d495c6eSApple OSS Distributions #ifndef DEBUG_ASSERT_MESSAGE
213*4d495c6eSApple OSS Distributions    #ifdef KERNEL
214*4d495c6eSApple OSS Distributions       #include <libkern/libkern.h>
215*4d495c6eSApple OSS Distributions       #define DEBUG_ASSERT_MESSAGE(name, assertion, label, message, file, line, value) \
216*4d495c6eSApple OSS Distributions                                   printf( "AssertMacros: %s, %s file: %s, line: %d\n", assertion, (message!=0) ? message : "", file, line);
217*4d495c6eSApple OSS Distributions    #else
218*4d495c6eSApple OSS Distributions       #include <stdio.h>
219*4d495c6eSApple OSS Distributions       #define DEBUG_ASSERT_MESSAGE(name, assertion, label, message, file, line, value) \
220*4d495c6eSApple OSS Distributions                                   fprintf(stderr, "AssertMacros: %s, %s file: %s, line: %d\n", assertion, (message!=0) ? message : "", file, line);
221*4d495c6eSApple OSS Distributions    #endif
222*4d495c6eSApple OSS Distributions #endif
223*4d495c6eSApple OSS Distributions 
224*4d495c6eSApple OSS Distributions 
225*4d495c6eSApple OSS Distributions 
226*4d495c6eSApple OSS Distributions 
227*4d495c6eSApple OSS Distributions 
228*4d495c6eSApple OSS Distributions /*
229*4d495c6eSApple OSS Distributions  *  __Debug_String(message)
230*4d495c6eSApple OSS Distributions  *
231*4d495c6eSApple OSS Distributions  *  Summary:
232*4d495c6eSApple OSS Distributions  *    Production builds: does nothing and produces no code.
233*4d495c6eSApple OSS Distributions  *
234*4d495c6eSApple OSS Distributions  *    Non-production builds: call DEBUG_ASSERT_MESSAGE.
235*4d495c6eSApple OSS Distributions  *
236*4d495c6eSApple OSS Distributions  *  Parameters:
237*4d495c6eSApple OSS Distributions  *
238*4d495c6eSApple OSS Distributions  *    message:
239*4d495c6eSApple OSS Distributions  *      The C string to display.
240*4d495c6eSApple OSS Distributions  *
241*4d495c6eSApple OSS Distributions  */
242*4d495c6eSApple OSS Distributions #ifndef __Debug_String
243*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
244*4d495c6eSApple OSS Distributions 	   #define __Debug_String(message)
245*4d495c6eSApple OSS Distributions 	#else
246*4d495c6eSApple OSS Distributions 	   #define __Debug_String(message)                                             \
247*4d495c6eSApple OSS Distributions 		  do                                                                      \
248*4d495c6eSApple OSS Distributions 		  {                                                                       \
249*4d495c6eSApple OSS Distributions 			  DEBUG_ASSERT_MESSAGE(                                               \
250*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_COMPONENT_NAME_STRING,                             \
251*4d495c6eSApple OSS Distributions 				  "",                                                             \
252*4d495c6eSApple OSS Distributions 				  0,                                                              \
253*4d495c6eSApple OSS Distributions 				  message,                                                        \
254*4d495c6eSApple OSS Distributions 				  __FILE__,                                                       \
255*4d495c6eSApple OSS Distributions 				  __LINE__,                                                       \
256*4d495c6eSApple OSS Distributions 				  0);                                                             \
257*4d495c6eSApple OSS Distributions 		  } while ( 0 )
258*4d495c6eSApple OSS Distributions 	#endif
259*4d495c6eSApple OSS Distributions #endif
260*4d495c6eSApple OSS Distributions 
261*4d495c6eSApple OSS Distributions /*
262*4d495c6eSApple OSS Distributions  *  __Check(assertion)
263*4d495c6eSApple OSS Distributions  *
264*4d495c6eSApple OSS Distributions  *  Summary:
265*4d495c6eSApple OSS Distributions  *    Production builds: does nothing and produces no code.
266*4d495c6eSApple OSS Distributions  *
267*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
268*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
269*4d495c6eSApple OSS Distributions  *
270*4d495c6eSApple OSS Distributions  *  Parameters:
271*4d495c6eSApple OSS Distributions  *
272*4d495c6eSApple OSS Distributions  *    assertion:
273*4d495c6eSApple OSS Distributions  *      The assertion expression.
274*4d495c6eSApple OSS Distributions  */
275*4d495c6eSApple OSS Distributions #ifndef __Check
276*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
277*4d495c6eSApple OSS Distributions 	   #define __Check(assertion)
278*4d495c6eSApple OSS Distributions 	#else
279*4d495c6eSApple OSS Distributions 	   #define __Check(assertion)                                                 \
280*4d495c6eSApple OSS Distributions 		  do                                                                      \
281*4d495c6eSApple OSS Distributions 		  {                                                                       \
282*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
283*4d495c6eSApple OSS Distributions 			  {                                                                   \
284*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
285*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
286*4d495c6eSApple OSS Distributions 					  #assertion, 0, 0, __FILE__, __LINE__, 0 );                  \
287*4d495c6eSApple OSS Distributions 			  }                                                                   \
288*4d495c6eSApple OSS Distributions 		  } while ( 0 )
289*4d495c6eSApple OSS Distributions 	#endif
290*4d495c6eSApple OSS Distributions #endif
291*4d495c6eSApple OSS Distributions 
292*4d495c6eSApple OSS Distributions #ifndef __nCheck
293*4d495c6eSApple OSS Distributions 	#define __nCheck(assertion)  __Check(!(assertion))
294*4d495c6eSApple OSS Distributions #endif
295*4d495c6eSApple OSS Distributions 
296*4d495c6eSApple OSS Distributions /*
297*4d495c6eSApple OSS Distributions  *  __Check_String(assertion, message)
298*4d495c6eSApple OSS Distributions  *
299*4d495c6eSApple OSS Distributions  *  Summary:
300*4d495c6eSApple OSS Distributions  *    Production builds: does nothing and produces no code.
301*4d495c6eSApple OSS Distributions  *
302*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
303*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
304*4d495c6eSApple OSS Distributions  *
305*4d495c6eSApple OSS Distributions  *  Parameters:
306*4d495c6eSApple OSS Distributions  *
307*4d495c6eSApple OSS Distributions  *    assertion:
308*4d495c6eSApple OSS Distributions  *      The assertion expression.
309*4d495c6eSApple OSS Distributions  *
310*4d495c6eSApple OSS Distributions  *    message:
311*4d495c6eSApple OSS Distributions  *      The C string to display.
312*4d495c6eSApple OSS Distributions  */
313*4d495c6eSApple OSS Distributions #ifndef __Check_String
314*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
315*4d495c6eSApple OSS Distributions 	   #define __Check_String(assertion, message)
316*4d495c6eSApple OSS Distributions 	#else
317*4d495c6eSApple OSS Distributions 	   #define __Check_String(assertion, message)                                 \
318*4d495c6eSApple OSS Distributions 		  do                                                                      \
319*4d495c6eSApple OSS Distributions 		  {                                                                       \
320*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
321*4d495c6eSApple OSS Distributions 			  {                                                                   \
322*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
323*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
324*4d495c6eSApple OSS Distributions 					  #assertion, 0, message, __FILE__, __LINE__, 0 );            \
325*4d495c6eSApple OSS Distributions 			  }                                                                   \
326*4d495c6eSApple OSS Distributions 		  } while ( 0 )
327*4d495c6eSApple OSS Distributions 	#endif
328*4d495c6eSApple OSS Distributions #endif
329*4d495c6eSApple OSS Distributions 
330*4d495c6eSApple OSS Distributions #ifndef __nCheck_String
331*4d495c6eSApple OSS Distributions 	#define __nCheck_String(assertion, message)  __Check_String(!(assertion), message)
332*4d495c6eSApple OSS Distributions #endif
333*4d495c6eSApple OSS Distributions 
334*4d495c6eSApple OSS Distributions /*
335*4d495c6eSApple OSS Distributions  *  __Check_noErr(errorCode)
336*4d495c6eSApple OSS Distributions  *
337*4d495c6eSApple OSS Distributions  *  Summary:
338*4d495c6eSApple OSS Distributions  *    Production builds: does nothing and produces no code.
339*4d495c6eSApple OSS Distributions  *
340*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
341*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
342*4d495c6eSApple OSS Distributions  *
343*4d495c6eSApple OSS Distributions  *  Parameters:
344*4d495c6eSApple OSS Distributions  *
345*4d495c6eSApple OSS Distributions  *    errorCode:
346*4d495c6eSApple OSS Distributions  *      The errorCode expression to compare with 0.
347*4d495c6eSApple OSS Distributions  */
348*4d495c6eSApple OSS Distributions #ifndef __Check_noErr
349*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
350*4d495c6eSApple OSS Distributions 	   #define __Check_noErr(errorCode)
351*4d495c6eSApple OSS Distributions 	#else
352*4d495c6eSApple OSS Distributions 	   #define __Check_noErr(errorCode)                                           \
353*4d495c6eSApple OSS Distributions 		  do                                                                      \
354*4d495c6eSApple OSS Distributions 		  {                                                                       \
355*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
356*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
357*4d495c6eSApple OSS Distributions 			  {                                                                   \
358*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
359*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
360*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ", 0, 0, __FILE__, __LINE__, evalOnceErrorCode ); \
361*4d495c6eSApple OSS Distributions 			  }                                                                   \
362*4d495c6eSApple OSS Distributions 		  } while ( 0 )
363*4d495c6eSApple OSS Distributions 	#endif
364*4d495c6eSApple OSS Distributions #endif
365*4d495c6eSApple OSS Distributions 
366*4d495c6eSApple OSS Distributions /*
367*4d495c6eSApple OSS Distributions  *  __Check_noErr_String(errorCode, message)
368*4d495c6eSApple OSS Distributions  *
369*4d495c6eSApple OSS Distributions  *  Summary:
370*4d495c6eSApple OSS Distributions  *    Production builds: check_noerr_string() does nothing and produces
371*4d495c6eSApple OSS Distributions  *    no code.
372*4d495c6eSApple OSS Distributions  *
373*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
374*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
375*4d495c6eSApple OSS Distributions  *
376*4d495c6eSApple OSS Distributions  *  Parameters:
377*4d495c6eSApple OSS Distributions  *
378*4d495c6eSApple OSS Distributions  *    errorCode:
379*4d495c6eSApple OSS Distributions  *      The errorCode expression to compare to 0.
380*4d495c6eSApple OSS Distributions  *
381*4d495c6eSApple OSS Distributions  *    message:
382*4d495c6eSApple OSS Distributions  *      The C string to display.
383*4d495c6eSApple OSS Distributions  */
384*4d495c6eSApple OSS Distributions #ifndef __Check_noErr_String
385*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
386*4d495c6eSApple OSS Distributions 	   #define __Check_noErr_String(errorCode, message)
387*4d495c6eSApple OSS Distributions 	#else
388*4d495c6eSApple OSS Distributions 	   #define __Check_noErr_String(errorCode, message)                           \
389*4d495c6eSApple OSS Distributions 		  do                                                                      \
390*4d495c6eSApple OSS Distributions 		  {                                                                       \
391*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
392*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
393*4d495c6eSApple OSS Distributions 			  {                                                                   \
394*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
395*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
396*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ", 0, message, __FILE__, __LINE__, evalOnceErrorCode ); \
397*4d495c6eSApple OSS Distributions 			  }                                                                   \
398*4d495c6eSApple OSS Distributions 		  } while ( 0 )
399*4d495c6eSApple OSS Distributions 	#endif
400*4d495c6eSApple OSS Distributions #endif
401*4d495c6eSApple OSS Distributions 
402*4d495c6eSApple OSS Distributions /*
403*4d495c6eSApple OSS Distributions  *  __Verify(assertion)
404*4d495c6eSApple OSS Distributions  *
405*4d495c6eSApple OSS Distributions  *  Summary:
406*4d495c6eSApple OSS Distributions  *    Production builds: evaluate the assertion expression, but ignore
407*4d495c6eSApple OSS Distributions  *    the result.
408*4d495c6eSApple OSS Distributions  *
409*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
410*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
411*4d495c6eSApple OSS Distributions  *
412*4d495c6eSApple OSS Distributions  *  Parameters:
413*4d495c6eSApple OSS Distributions  *
414*4d495c6eSApple OSS Distributions  *    assertion:
415*4d495c6eSApple OSS Distributions  *      The assertion expression.
416*4d495c6eSApple OSS Distributions  */
417*4d495c6eSApple OSS Distributions #ifndef __Verify
418*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
419*4d495c6eSApple OSS Distributions 	   #define __Verify(assertion)                                                \
420*4d495c6eSApple OSS Distributions 		  do                                                                      \
421*4d495c6eSApple OSS Distributions 		  {                                                                       \
422*4d495c6eSApple OSS Distributions 			  if ( !(assertion) )                                                 \
423*4d495c6eSApple OSS Distributions 			  {                                                                   \
424*4d495c6eSApple OSS Distributions 			  }                                                                   \
425*4d495c6eSApple OSS Distributions 		  } while ( 0 )
426*4d495c6eSApple OSS Distributions 	#else
427*4d495c6eSApple OSS Distributions 	   #define __Verify(assertion)                                                \
428*4d495c6eSApple OSS Distributions 		  do                                                                      \
429*4d495c6eSApple OSS Distributions 		  {                                                                       \
430*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
431*4d495c6eSApple OSS Distributions 			  {                                                                   \
432*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
433*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
434*4d495c6eSApple OSS Distributions 					  #assertion, 0, 0, __FILE__, __LINE__, 0 );                  \
435*4d495c6eSApple OSS Distributions 			  }                                                                   \
436*4d495c6eSApple OSS Distributions 		  } while ( 0 )
437*4d495c6eSApple OSS Distributions 	#endif
438*4d495c6eSApple OSS Distributions #endif
439*4d495c6eSApple OSS Distributions 
440*4d495c6eSApple OSS Distributions #ifndef __nVerify
441*4d495c6eSApple OSS Distributions 	#define __nVerify(assertion)	__Verify(!(assertion))
442*4d495c6eSApple OSS Distributions #endif
443*4d495c6eSApple OSS Distributions 
444*4d495c6eSApple OSS Distributions /*
445*4d495c6eSApple OSS Distributions  *  __Verify_String(assertion, message)
446*4d495c6eSApple OSS Distributions  *
447*4d495c6eSApple OSS Distributions  *  Summary:
448*4d495c6eSApple OSS Distributions  *    Production builds: evaluate the assertion expression, but ignore
449*4d495c6eSApple OSS Distributions  *    the result.
450*4d495c6eSApple OSS Distributions  *
451*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
452*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
453*4d495c6eSApple OSS Distributions  *
454*4d495c6eSApple OSS Distributions  *  Parameters:
455*4d495c6eSApple OSS Distributions  *
456*4d495c6eSApple OSS Distributions  *    assertion:
457*4d495c6eSApple OSS Distributions  *      The assertion expression.
458*4d495c6eSApple OSS Distributions  *
459*4d495c6eSApple OSS Distributions  *    message:
460*4d495c6eSApple OSS Distributions  *      The C string to display.
461*4d495c6eSApple OSS Distributions  */
462*4d495c6eSApple OSS Distributions #ifndef __Verify_String
463*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
464*4d495c6eSApple OSS Distributions 	   #define __Verify_String(assertion, message)                                \
465*4d495c6eSApple OSS Distributions 		  do                                                                      \
466*4d495c6eSApple OSS Distributions 		  {                                                                       \
467*4d495c6eSApple OSS Distributions 			  if ( !(assertion) )                                                 \
468*4d495c6eSApple OSS Distributions 			  {                                                                   \
469*4d495c6eSApple OSS Distributions 			  }                                                                   \
470*4d495c6eSApple OSS Distributions 		  } while ( 0 )
471*4d495c6eSApple OSS Distributions 	#else
472*4d495c6eSApple OSS Distributions 	   #define __Verify_String(assertion, message)                                \
473*4d495c6eSApple OSS Distributions 		  do                                                                      \
474*4d495c6eSApple OSS Distributions 		  {                                                                       \
475*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
476*4d495c6eSApple OSS Distributions 			  {                                                                   \
477*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
478*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
479*4d495c6eSApple OSS Distributions 					  #assertion, 0, message, __FILE__, __LINE__, 0 );            \
480*4d495c6eSApple OSS Distributions 			  }                                                                   \
481*4d495c6eSApple OSS Distributions 		  } while ( 0 )
482*4d495c6eSApple OSS Distributions 	#endif
483*4d495c6eSApple OSS Distributions #endif
484*4d495c6eSApple OSS Distributions 
485*4d495c6eSApple OSS Distributions #ifndef __nVerify_String
486*4d495c6eSApple OSS Distributions 	#define __nVerify_String(assertion, message)  __Verify_String(!(assertion), message)
487*4d495c6eSApple OSS Distributions #endif
488*4d495c6eSApple OSS Distributions 
489*4d495c6eSApple OSS Distributions /*
490*4d495c6eSApple OSS Distributions  *  __Verify_noErr(errorCode)
491*4d495c6eSApple OSS Distributions  *
492*4d495c6eSApple OSS Distributions  *  Summary:
493*4d495c6eSApple OSS Distributions  *    Production builds: evaluate the errorCode expression, but ignore
494*4d495c6eSApple OSS Distributions  *    the result.
495*4d495c6eSApple OSS Distributions  *
496*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
497*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
498*4d495c6eSApple OSS Distributions  *
499*4d495c6eSApple OSS Distributions  *  Parameters:
500*4d495c6eSApple OSS Distributions  *
501*4d495c6eSApple OSS Distributions  *    errorCode:
502*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
503*4d495c6eSApple OSS Distributions  */
504*4d495c6eSApple OSS Distributions #ifndef __Verify_noErr
505*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
506*4d495c6eSApple OSS Distributions 	   #define __Verify_noErr(errorCode)                                          \
507*4d495c6eSApple OSS Distributions 		  do                                                                      \
508*4d495c6eSApple OSS Distributions 		  {                                                                       \
509*4d495c6eSApple OSS Distributions 			  if ( 0 != (errorCode) )                                             \
510*4d495c6eSApple OSS Distributions 			  {                                                                   \
511*4d495c6eSApple OSS Distributions 			  }                                                                   \
512*4d495c6eSApple OSS Distributions 		  } while ( 0 )
513*4d495c6eSApple OSS Distributions 	#else
514*4d495c6eSApple OSS Distributions 	   #define __Verify_noErr(errorCode)                                          \
515*4d495c6eSApple OSS Distributions 		  do                                                                      \
516*4d495c6eSApple OSS Distributions 		  {                                                                       \
517*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
518*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
519*4d495c6eSApple OSS Distributions 			  {                                                                   \
520*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
521*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
522*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ", 0, 0, __FILE__, __LINE__, evalOnceErrorCode ); \
523*4d495c6eSApple OSS Distributions 			  }                                                                   \
524*4d495c6eSApple OSS Distributions 		  } while ( 0 )
525*4d495c6eSApple OSS Distributions 	#endif
526*4d495c6eSApple OSS Distributions #endif
527*4d495c6eSApple OSS Distributions 
528*4d495c6eSApple OSS Distributions /*
529*4d495c6eSApple OSS Distributions  *  __Verify_noErr_String(errorCode, message)
530*4d495c6eSApple OSS Distributions  *
531*4d495c6eSApple OSS Distributions  *  Summary:
532*4d495c6eSApple OSS Distributions  *    Production builds: evaluate the errorCode expression, but ignore
533*4d495c6eSApple OSS Distributions  *    the result.
534*4d495c6eSApple OSS Distributions  *
535*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
536*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE.
537*4d495c6eSApple OSS Distributions  *
538*4d495c6eSApple OSS Distributions  *  Parameters:
539*4d495c6eSApple OSS Distributions  *
540*4d495c6eSApple OSS Distributions  *    errorCode:
541*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
542*4d495c6eSApple OSS Distributions  *
543*4d495c6eSApple OSS Distributions  *    message:
544*4d495c6eSApple OSS Distributions  *      The C string to display.
545*4d495c6eSApple OSS Distributions  */
546*4d495c6eSApple OSS Distributions #ifndef __Verify_noErr_String
547*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
548*4d495c6eSApple OSS Distributions 	   #define __Verify_noErr_String(errorCode, message)                          \
549*4d495c6eSApple OSS Distributions 		  do                                                                      \
550*4d495c6eSApple OSS Distributions 		  {                                                                       \
551*4d495c6eSApple OSS Distributions 			  if ( 0 != (errorCode) )                                             \
552*4d495c6eSApple OSS Distributions 			  {                                                                   \
553*4d495c6eSApple OSS Distributions 			  }                                                                   \
554*4d495c6eSApple OSS Distributions 		  } while ( 0 )
555*4d495c6eSApple OSS Distributions 	#else
556*4d495c6eSApple OSS Distributions 	   #define __Verify_noErr_String(errorCode, message)                          \
557*4d495c6eSApple OSS Distributions 		  do                                                                      \
558*4d495c6eSApple OSS Distributions 		  {                                                                       \
559*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
560*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
561*4d495c6eSApple OSS Distributions 			  {                                                                   \
562*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
563*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
564*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ", 0, message, __FILE__, __LINE__, evalOnceErrorCode ); \
565*4d495c6eSApple OSS Distributions 			  }                                                                   \
566*4d495c6eSApple OSS Distributions 		  } while ( 0 )
567*4d495c6eSApple OSS Distributions 	#endif
568*4d495c6eSApple OSS Distributions #endif
569*4d495c6eSApple OSS Distributions 
570*4d495c6eSApple OSS Distributions /*
571*4d495c6eSApple OSS Distributions  *  __Verify_noErr_Action(errorCode, action)
572*4d495c6eSApple OSS Distributions  *
573*4d495c6eSApple OSS Distributions  *  Summary:
574*4d495c6eSApple OSS Distributions  *    Production builds: if the errorCode expression does not equal 0 (noErr),
575*4d495c6eSApple OSS Distributions  *    execute the action statement or compound statement (block).
576*4d495c6eSApple OSS Distributions  *
577*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
578*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE and then execute the action statement or compound
579*4d495c6eSApple OSS Distributions  *    statement (block).
580*4d495c6eSApple OSS Distributions  *
581*4d495c6eSApple OSS Distributions  *  Parameters:
582*4d495c6eSApple OSS Distributions  *
583*4d495c6eSApple OSS Distributions  *    errorCode:
584*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
585*4d495c6eSApple OSS Distributions  *
586*4d495c6eSApple OSS Distributions  *    action:
587*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
588*4d495c6eSApple OSS Distributions  */
589*4d495c6eSApple OSS Distributions #ifndef __Verify_noErr_Action
590*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
591*4d495c6eSApple OSS Distributions 	   #define __Verify_noErr_Action(errorCode, action)                          \
592*4d495c6eSApple OSS Distributions 		  if ( 0 != (errorCode) ) {                                              \
593*4d495c6eSApple OSS Distributions 			  action;                                                            \
594*4d495c6eSApple OSS Distributions 		  }                                                                      \
595*4d495c6eSApple OSS Distributions 		  else do {} while (0)
596*4d495c6eSApple OSS Distributions 	#else
597*4d495c6eSApple OSS Distributions 	   #define __Verify_noErr_Action(errorCode, action)                          \
598*4d495c6eSApple OSS Distributions                do {                                                                   \
599*4d495c6eSApple OSS Distributions 		  long evalOnceErrorCode = (errorCode);                                  \
600*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) {                   \
601*4d495c6eSApple OSS Distributions 			  DEBUG_ASSERT_MESSAGE(                                              \
602*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_COMPONENT_NAME_STRING,                            \
603*4d495c6eSApple OSS Distributions 				  #errorCode " == 0 ", 0, 0, __FILE__, __LINE__, evalOnceErrorCode );            \
604*4d495c6eSApple OSS Distributions 			  action;                                                            \
605*4d495c6eSApple OSS Distributions 		  }                                                                      \
606*4d495c6eSApple OSS Distributions 	       } while (0)
607*4d495c6eSApple OSS Distributions 	#endif
608*4d495c6eSApple OSS Distributions #endif
609*4d495c6eSApple OSS Distributions 
610*4d495c6eSApple OSS Distributions /*
611*4d495c6eSApple OSS Distributions  *  __Verify_Action(assertion, action)
612*4d495c6eSApple OSS Distributions  *
613*4d495c6eSApple OSS Distributions  *  Summary:
614*4d495c6eSApple OSS Distributions  *    Production builds: if the assertion expression evaluates to false,
615*4d495c6eSApple OSS Distributions  *    then execute the action statement or compound statement (block).
616*4d495c6eSApple OSS Distributions  *
617*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
618*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE and then execute the action statement or compound
619*4d495c6eSApple OSS Distributions  *    statement (block).
620*4d495c6eSApple OSS Distributions  *
621*4d495c6eSApple OSS Distributions  *  Parameters:
622*4d495c6eSApple OSS Distributions  *
623*4d495c6eSApple OSS Distributions  *    assertion:
624*4d495c6eSApple OSS Distributions  *      The assertion expression.
625*4d495c6eSApple OSS Distributions  *
626*4d495c6eSApple OSS Distributions  *    action:
627*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
628*4d495c6eSApple OSS Distributions  */
629*4d495c6eSApple OSS Distributions #ifndef __Verify_Action
630*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
631*4d495c6eSApple OSS Distributions 	   #define __Verify_Action(assertion, action)                                \
632*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(!(assertion), 0) ) {                             \
633*4d495c6eSApple OSS Distributions 			action;                                                              \
634*4d495c6eSApple OSS Distributions 		  }                                                                      \
635*4d495c6eSApple OSS Distributions 		  else do {} while (0)
636*4d495c6eSApple OSS Distributions 	#else
637*4d495c6eSApple OSS Distributions 	   #define __Verify_Action(assertion, action)                                \
638*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(!(assertion), 0) ) {                             \
639*4d495c6eSApple OSS Distributions 			  DEBUG_ASSERT_MESSAGE(                                              \
640*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                        \
641*4d495c6eSApple OSS Distributions 					  #assertion, 0, 0, __FILE__, __LINE__, 0 );                 \
642*4d495c6eSApple OSS Distributions 			  action;                                                            \
643*4d495c6eSApple OSS Distributions 		  }                                                                      \
644*4d495c6eSApple OSS Distributions 		  else do {} while (0)
645*4d495c6eSApple OSS Distributions 	#endif
646*4d495c6eSApple OSS Distributions #endif
647*4d495c6eSApple OSS Distributions 
648*4d495c6eSApple OSS Distributions /*
649*4d495c6eSApple OSS Distributions  *  __Require(assertion, exceptionLabel)
650*4d495c6eSApple OSS Distributions  *
651*4d495c6eSApple OSS Distributions  *  Summary:
652*4d495c6eSApple OSS Distributions  *    Production builds: if the assertion expression evaluates to false,
653*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
654*4d495c6eSApple OSS Distributions  *
655*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
656*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE and then goto exceptionLabel.
657*4d495c6eSApple OSS Distributions  *
658*4d495c6eSApple OSS Distributions  *  Parameters:
659*4d495c6eSApple OSS Distributions  *
660*4d495c6eSApple OSS Distributions  *    assertion:
661*4d495c6eSApple OSS Distributions  *      The assertion expression.
662*4d495c6eSApple OSS Distributions  *
663*4d495c6eSApple OSS Distributions  *    exceptionLabel:
664*4d495c6eSApple OSS Distributions  *      The label.
665*4d495c6eSApple OSS Distributions  */
666*4d495c6eSApple OSS Distributions #ifndef __Require
667*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
668*4d495c6eSApple OSS Distributions 	   #define __Require(assertion, exceptionLabel)                               \
669*4d495c6eSApple OSS Distributions 		  do                                                                      \
670*4d495c6eSApple OSS Distributions 		  {                                                                       \
671*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
672*4d495c6eSApple OSS Distributions 			  {                                                                   \
673*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
674*4d495c6eSApple OSS Distributions 			  }                                                                   \
675*4d495c6eSApple OSS Distributions 		  } while ( 0 )
676*4d495c6eSApple OSS Distributions 	#else
677*4d495c6eSApple OSS Distributions 	   #define __Require(assertion, exceptionLabel)                               \
678*4d495c6eSApple OSS Distributions 		  do                                                                      \
679*4d495c6eSApple OSS Distributions 		  {                                                                       \
680*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) ) {                          \
681*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
682*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
683*4d495c6eSApple OSS Distributions 					  #assertion, #exceptionLabel, 0, __FILE__, __LINE__,  0);    \
684*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
685*4d495c6eSApple OSS Distributions 			  }                                                                   \
686*4d495c6eSApple OSS Distributions 		  } while ( 0 )
687*4d495c6eSApple OSS Distributions 	#endif
688*4d495c6eSApple OSS Distributions #endif
689*4d495c6eSApple OSS Distributions 
690*4d495c6eSApple OSS Distributions #ifndef __nRequire
691*4d495c6eSApple OSS Distributions 	#define __nRequire(assertion, exceptionLabel)  __Require(!(assertion), exceptionLabel)
692*4d495c6eSApple OSS Distributions #endif
693*4d495c6eSApple OSS Distributions 
694*4d495c6eSApple OSS Distributions /*
695*4d495c6eSApple OSS Distributions  *  __Require_Action(assertion, exceptionLabel, action)
696*4d495c6eSApple OSS Distributions  *
697*4d495c6eSApple OSS Distributions  *  Summary:
698*4d495c6eSApple OSS Distributions  *    Production builds: if the assertion expression evaluates to false,
699*4d495c6eSApple OSS Distributions  *    execute the action statement or compound statement (block) and then
700*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
701*4d495c6eSApple OSS Distributions  *
702*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
703*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE, execute the action statement or compound
704*4d495c6eSApple OSS Distributions  *    statement (block), and then goto exceptionLabel.
705*4d495c6eSApple OSS Distributions  *
706*4d495c6eSApple OSS Distributions  *  Parameters:
707*4d495c6eSApple OSS Distributions  *
708*4d495c6eSApple OSS Distributions  *    assertion:
709*4d495c6eSApple OSS Distributions  *      The assertion expression.
710*4d495c6eSApple OSS Distributions  *
711*4d495c6eSApple OSS Distributions  *    exceptionLabel:
712*4d495c6eSApple OSS Distributions  *      The label.
713*4d495c6eSApple OSS Distributions  *
714*4d495c6eSApple OSS Distributions  *    action:
715*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
716*4d495c6eSApple OSS Distributions  */
717*4d495c6eSApple OSS Distributions #ifndef __Require_Action
718*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
719*4d495c6eSApple OSS Distributions 	   #define __Require_Action(assertion, exceptionLabel, action)                \
720*4d495c6eSApple OSS Distributions 		  do                                                                      \
721*4d495c6eSApple OSS Distributions 		  {                                                                       \
722*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
723*4d495c6eSApple OSS Distributions 			  {                                                                   \
724*4d495c6eSApple OSS Distributions 				  {                                                               \
725*4d495c6eSApple OSS Distributions 					  action;                                                     \
726*4d495c6eSApple OSS Distributions 				  }                                                               \
727*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
728*4d495c6eSApple OSS Distributions 			  }                                                                   \
729*4d495c6eSApple OSS Distributions 		  } while ( 0 )
730*4d495c6eSApple OSS Distributions 	#else
731*4d495c6eSApple OSS Distributions 	   #define __Require_Action(assertion, exceptionLabel, action)                \
732*4d495c6eSApple OSS Distributions 		  do                                                                      \
733*4d495c6eSApple OSS Distributions 		  {                                                                       \
734*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
735*4d495c6eSApple OSS Distributions 			  {                                                                   \
736*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
737*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
738*4d495c6eSApple OSS Distributions 					  #assertion, #exceptionLabel, 0,   __FILE__, __LINE__, 0);   \
739*4d495c6eSApple OSS Distributions 				  {                                                               \
740*4d495c6eSApple OSS Distributions 					  action;                                                     \
741*4d495c6eSApple OSS Distributions 				  }                                                               \
742*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
743*4d495c6eSApple OSS Distributions 			  }                                                                   \
744*4d495c6eSApple OSS Distributions 		  } while ( 0 )
745*4d495c6eSApple OSS Distributions 	#endif
746*4d495c6eSApple OSS Distributions #endif
747*4d495c6eSApple OSS Distributions 
748*4d495c6eSApple OSS Distributions #ifndef __nRequire_Action
749*4d495c6eSApple OSS Distributions 	#define __nRequire_Action(assertion, exceptionLabel, action)                  \
750*4d495c6eSApple OSS Distributions 	__Require_Action(!(assertion), exceptionLabel, action)
751*4d495c6eSApple OSS Distributions #endif
752*4d495c6eSApple OSS Distributions 
753*4d495c6eSApple OSS Distributions /*
754*4d495c6eSApple OSS Distributions  *  __Require_Quiet(assertion, exceptionLabel)
755*4d495c6eSApple OSS Distributions  *
756*4d495c6eSApple OSS Distributions  *  Summary:
757*4d495c6eSApple OSS Distributions  *    If the assertion expression evaluates to false, goto exceptionLabel.
758*4d495c6eSApple OSS Distributions  *
759*4d495c6eSApple OSS Distributions  *  Parameters:
760*4d495c6eSApple OSS Distributions  *
761*4d495c6eSApple OSS Distributions  *    assertion:
762*4d495c6eSApple OSS Distributions  *      The assertion expression.
763*4d495c6eSApple OSS Distributions  *
764*4d495c6eSApple OSS Distributions  *    exceptionLabel:
765*4d495c6eSApple OSS Distributions  *      The label.
766*4d495c6eSApple OSS Distributions  */
767*4d495c6eSApple OSS Distributions #ifndef __Require_Quiet
768*4d495c6eSApple OSS Distributions 	#define __Require_Quiet(assertion, exceptionLabel)                            \
769*4d495c6eSApple OSS Distributions 	  do                                                                          \
770*4d495c6eSApple OSS Distributions 	  {                                                                           \
771*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(!(assertion), 0) )                                \
772*4d495c6eSApple OSS Distributions 		  {                                                                       \
773*4d495c6eSApple OSS Distributions 			  goto exceptionLabel;                                                \
774*4d495c6eSApple OSS Distributions 		  }                                                                       \
775*4d495c6eSApple OSS Distributions 	  } while ( 0 )
776*4d495c6eSApple OSS Distributions #endif
777*4d495c6eSApple OSS Distributions 
778*4d495c6eSApple OSS Distributions #ifndef __nRequire_Quiet
779*4d495c6eSApple OSS Distributions 	#define __nRequire_Quiet(assertion, exceptionLabel)  __Require_Quiet(!(assertion), exceptionLabel)
780*4d495c6eSApple OSS Distributions #endif
781*4d495c6eSApple OSS Distributions 
782*4d495c6eSApple OSS Distributions /*
783*4d495c6eSApple OSS Distributions  *  __Require_Action_Quiet(assertion, exceptionLabel, action)
784*4d495c6eSApple OSS Distributions  *
785*4d495c6eSApple OSS Distributions  *  Summary:
786*4d495c6eSApple OSS Distributions  *    If the assertion expression evaluates to false, execute the action
787*4d495c6eSApple OSS Distributions  *    statement or compound statement (block), and goto exceptionLabel.
788*4d495c6eSApple OSS Distributions  *
789*4d495c6eSApple OSS Distributions  *  Parameters:
790*4d495c6eSApple OSS Distributions  *
791*4d495c6eSApple OSS Distributions  *    assertion:
792*4d495c6eSApple OSS Distributions  *      The assertion expression.
793*4d495c6eSApple OSS Distributions  *
794*4d495c6eSApple OSS Distributions  *    exceptionLabel:
795*4d495c6eSApple OSS Distributions  *      The label.
796*4d495c6eSApple OSS Distributions  *
797*4d495c6eSApple OSS Distributions  *    action:
798*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
799*4d495c6eSApple OSS Distributions  */
800*4d495c6eSApple OSS Distributions #ifndef __Require_Action_Quiet
801*4d495c6eSApple OSS Distributions 	#define __Require_Action_Quiet(assertion, exceptionLabel, action)             \
802*4d495c6eSApple OSS Distributions 	  do                                                                          \
803*4d495c6eSApple OSS Distributions 	  {                                                                           \
804*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(!(assertion), 0) )                                \
805*4d495c6eSApple OSS Distributions 		  {                                                                       \
806*4d495c6eSApple OSS Distributions 			  {                                                                   \
807*4d495c6eSApple OSS Distributions 				  action;                                                         \
808*4d495c6eSApple OSS Distributions 			  }                                                                   \
809*4d495c6eSApple OSS Distributions 			  goto exceptionLabel;                                                \
810*4d495c6eSApple OSS Distributions 		  }                                                                       \
811*4d495c6eSApple OSS Distributions 	  } while ( 0 )
812*4d495c6eSApple OSS Distributions #endif
813*4d495c6eSApple OSS Distributions 
814*4d495c6eSApple OSS Distributions #ifndef __nRequire_Action_Quiet
815*4d495c6eSApple OSS Distributions 	#define __nRequire_Action_Quiet(assertion, exceptionLabel, action)              \
816*4d495c6eSApple OSS Distributions 		__Require_Action_Quiet(!(assertion), exceptionLabel, action)
817*4d495c6eSApple OSS Distributions #endif
818*4d495c6eSApple OSS Distributions 
819*4d495c6eSApple OSS Distributions /*
820*4d495c6eSApple OSS Distributions  *  __Require_String(assertion, exceptionLabel, message)
821*4d495c6eSApple OSS Distributions  *
822*4d495c6eSApple OSS Distributions  *  Summary:
823*4d495c6eSApple OSS Distributions  *    Production builds: if the assertion expression evaluates to false,
824*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
825*4d495c6eSApple OSS Distributions  *
826*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
827*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE, and then goto exceptionLabel.
828*4d495c6eSApple OSS Distributions  *
829*4d495c6eSApple OSS Distributions  *  Parameters:
830*4d495c6eSApple OSS Distributions  *
831*4d495c6eSApple OSS Distributions  *    assertion:
832*4d495c6eSApple OSS Distributions  *      The assertion expression.
833*4d495c6eSApple OSS Distributions  *
834*4d495c6eSApple OSS Distributions  *    exceptionLabel:
835*4d495c6eSApple OSS Distributions  *      The label.
836*4d495c6eSApple OSS Distributions  *
837*4d495c6eSApple OSS Distributions  *    message:
838*4d495c6eSApple OSS Distributions  *      The C string to display.
839*4d495c6eSApple OSS Distributions  */
840*4d495c6eSApple OSS Distributions #ifndef __Require_String
841*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
842*4d495c6eSApple OSS Distributions 	   #define __Require_String(assertion, exceptionLabel, message)               \
843*4d495c6eSApple OSS Distributions 		  do                                                                      \
844*4d495c6eSApple OSS Distributions 		  {                                                                       \
845*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
846*4d495c6eSApple OSS Distributions 			  {                                                                   \
847*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
848*4d495c6eSApple OSS Distributions 			  }                                                                   \
849*4d495c6eSApple OSS Distributions 		  } while ( 0 )
850*4d495c6eSApple OSS Distributions 	#else
851*4d495c6eSApple OSS Distributions 	   #define __Require_String(assertion, exceptionLabel, message)               \
852*4d495c6eSApple OSS Distributions 		  do                                                                      \
853*4d495c6eSApple OSS Distributions 		  {                                                                       \
854*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
855*4d495c6eSApple OSS Distributions 			  {                                                                   \
856*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
857*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
858*4d495c6eSApple OSS Distributions 					  #assertion, #exceptionLabel,  message,  __FILE__, __LINE__, 0); \
859*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
860*4d495c6eSApple OSS Distributions 			  }                                                                   \
861*4d495c6eSApple OSS Distributions 		  } while ( 0 )
862*4d495c6eSApple OSS Distributions 	#endif
863*4d495c6eSApple OSS Distributions #endif
864*4d495c6eSApple OSS Distributions 
865*4d495c6eSApple OSS Distributions #ifndef __nRequire_String
866*4d495c6eSApple OSS Distributions 	#define __nRequire_String(assertion, exceptionLabel, string)                  \
867*4d495c6eSApple OSS Distributions 		__Require_String(!(assertion), exceptionLabel, string)
868*4d495c6eSApple OSS Distributions #endif
869*4d495c6eSApple OSS Distributions 
870*4d495c6eSApple OSS Distributions /*
871*4d495c6eSApple OSS Distributions  *  __Require_Action_String(assertion, exceptionLabel, action, message)
872*4d495c6eSApple OSS Distributions  *
873*4d495c6eSApple OSS Distributions  *  Summary:
874*4d495c6eSApple OSS Distributions  *    Production builds: if the assertion expression evaluates to false,
875*4d495c6eSApple OSS Distributions  *    execute the action statement or compound statement (block), and then
876*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
877*4d495c6eSApple OSS Distributions  *
878*4d495c6eSApple OSS Distributions  *    Non-production builds: if the assertion expression evaluates to false,
879*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE, execute the action statement or compound
880*4d495c6eSApple OSS Distributions  *    statement (block), and then goto exceptionLabel.
881*4d495c6eSApple OSS Distributions  *
882*4d495c6eSApple OSS Distributions  *  Parameters:
883*4d495c6eSApple OSS Distributions  *
884*4d495c6eSApple OSS Distributions  *    assertion:
885*4d495c6eSApple OSS Distributions  *      The assertion expression.
886*4d495c6eSApple OSS Distributions  *
887*4d495c6eSApple OSS Distributions  *    exceptionLabel:
888*4d495c6eSApple OSS Distributions  *      The label.
889*4d495c6eSApple OSS Distributions  *
890*4d495c6eSApple OSS Distributions  *    action:
891*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
892*4d495c6eSApple OSS Distributions  *
893*4d495c6eSApple OSS Distributions  *    message:
894*4d495c6eSApple OSS Distributions  *      The C string to display.
895*4d495c6eSApple OSS Distributions  */
896*4d495c6eSApple OSS Distributions #ifndef __Require_Action_String
897*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
898*4d495c6eSApple OSS Distributions 	   #define __Require_Action_String(assertion, exceptionLabel, action, message)  \
899*4d495c6eSApple OSS Distributions 		  do                                                                      \
900*4d495c6eSApple OSS Distributions 		  {                                                                       \
901*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
902*4d495c6eSApple OSS Distributions 			  {                                                                   \
903*4d495c6eSApple OSS Distributions 				  {                                                               \
904*4d495c6eSApple OSS Distributions 					  action;                                                     \
905*4d495c6eSApple OSS Distributions 				  }                                                               \
906*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
907*4d495c6eSApple OSS Distributions 			  }                                                                   \
908*4d495c6eSApple OSS Distributions 		  } while ( 0 )
909*4d495c6eSApple OSS Distributions 	#else
910*4d495c6eSApple OSS Distributions 	   #define __Require_Action_String(assertion, exceptionLabel, action, message)  \
911*4d495c6eSApple OSS Distributions 		  do                                                                      \
912*4d495c6eSApple OSS Distributions 		  {                                                                       \
913*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(!(assertion), 0) )                            \
914*4d495c6eSApple OSS Distributions 			  {                                                                   \
915*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
916*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
917*4d495c6eSApple OSS Distributions 					  #assertion, #exceptionLabel,  message,  __FILE__,  __LINE__, 0); \
918*4d495c6eSApple OSS Distributions 				  {                                                               \
919*4d495c6eSApple OSS Distributions 					  action;                                                     \
920*4d495c6eSApple OSS Distributions 				  }                                                               \
921*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
922*4d495c6eSApple OSS Distributions 			  }                                                                   \
923*4d495c6eSApple OSS Distributions 		  } while ( 0 )
924*4d495c6eSApple OSS Distributions 	#endif
925*4d495c6eSApple OSS Distributions #endif
926*4d495c6eSApple OSS Distributions 
927*4d495c6eSApple OSS Distributions #ifndef __nRequire_Action_String
928*4d495c6eSApple OSS Distributions 	#define __nRequire_Action_String(assertion, exceptionLabel, action, message)    \
929*4d495c6eSApple OSS Distributions 		__Require_Action_String(!(assertion), exceptionLabel, action, message)
930*4d495c6eSApple OSS Distributions #endif
931*4d495c6eSApple OSS Distributions 
932*4d495c6eSApple OSS Distributions /*
933*4d495c6eSApple OSS Distributions  *  __Require_noErr(errorCode, exceptionLabel)
934*4d495c6eSApple OSS Distributions  *
935*4d495c6eSApple OSS Distributions  *  Summary:
936*4d495c6eSApple OSS Distributions  *    Production builds: if the errorCode expression does not equal 0 (noErr),
937*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
938*4d495c6eSApple OSS Distributions  *
939*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
940*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE and then goto exceptionLabel.
941*4d495c6eSApple OSS Distributions  *
942*4d495c6eSApple OSS Distributions  *  Parameters:
943*4d495c6eSApple OSS Distributions  *
944*4d495c6eSApple OSS Distributions  *    errorCode:
945*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
946*4d495c6eSApple OSS Distributions  *
947*4d495c6eSApple OSS Distributions  *    exceptionLabel:
948*4d495c6eSApple OSS Distributions  *      The label.
949*4d495c6eSApple OSS Distributions  */
950*4d495c6eSApple OSS Distributions #ifndef __Require_noErr
951*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
952*4d495c6eSApple OSS Distributions 	   #define __Require_noErr(errorCode, exceptionLabel)                         \
953*4d495c6eSApple OSS Distributions 		  do                                                                      \
954*4d495c6eSApple OSS Distributions 		  {                                                                       \
955*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != (errorCode), 0) )                        \
956*4d495c6eSApple OSS Distributions 			  {                                                                   \
957*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
958*4d495c6eSApple OSS Distributions 			  }                                                                   \
959*4d495c6eSApple OSS Distributions 		  } while ( 0 )
960*4d495c6eSApple OSS Distributions 	#else
961*4d495c6eSApple OSS Distributions 	   #define __Require_noErr(errorCode, exceptionLabel)                         \
962*4d495c6eSApple OSS Distributions 		  do                                                                      \
963*4d495c6eSApple OSS Distributions 		  {                                                                       \
964*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
965*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
966*4d495c6eSApple OSS Distributions 			  {                                                                   \
967*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
968*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
969*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ",  #exceptionLabel,  0,  __FILE__, __LINE__, evalOnceErrorCode); \
970*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
971*4d495c6eSApple OSS Distributions 			  }                                                                   \
972*4d495c6eSApple OSS Distributions 		  } while ( 0 )
973*4d495c6eSApple OSS Distributions 	#endif
974*4d495c6eSApple OSS Distributions #endif
975*4d495c6eSApple OSS Distributions 
976*4d495c6eSApple OSS Distributions /*
977*4d495c6eSApple OSS Distributions  *  __Require_noErr_Action(errorCode, exceptionLabel, action)
978*4d495c6eSApple OSS Distributions  *
979*4d495c6eSApple OSS Distributions  *  Summary:
980*4d495c6eSApple OSS Distributions  *    Production builds: if the errorCode expression does not equal 0 (noErr),
981*4d495c6eSApple OSS Distributions  *    execute the action statement or compound statement (block) and
982*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
983*4d495c6eSApple OSS Distributions  *
984*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
985*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE, execute the action statement or
986*4d495c6eSApple OSS Distributions  *    compound statement (block), and then goto exceptionLabel.
987*4d495c6eSApple OSS Distributions  *
988*4d495c6eSApple OSS Distributions  *  Parameters:
989*4d495c6eSApple OSS Distributions  *
990*4d495c6eSApple OSS Distributions  *    errorCode:
991*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
992*4d495c6eSApple OSS Distributions  *
993*4d495c6eSApple OSS Distributions  *    exceptionLabel:
994*4d495c6eSApple OSS Distributions  *      The label.
995*4d495c6eSApple OSS Distributions  *
996*4d495c6eSApple OSS Distributions  *    action:
997*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
998*4d495c6eSApple OSS Distributions  */
999*4d495c6eSApple OSS Distributions #ifndef __Require_noErr_Action
1000*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
1001*4d495c6eSApple OSS Distributions 	   #define __Require_noErr_Action(errorCode, exceptionLabel, action)          \
1002*4d495c6eSApple OSS Distributions 		  do                                                                      \
1003*4d495c6eSApple OSS Distributions 		  {                                                                       \
1004*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != (errorCode), 0) )                        \
1005*4d495c6eSApple OSS Distributions 			  {                                                                   \
1006*4d495c6eSApple OSS Distributions 				  {                                                               \
1007*4d495c6eSApple OSS Distributions 					  action;                                                     \
1008*4d495c6eSApple OSS Distributions 				  }                                                               \
1009*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
1010*4d495c6eSApple OSS Distributions 			  }                                                                   \
1011*4d495c6eSApple OSS Distributions 		  } while ( 0 )
1012*4d495c6eSApple OSS Distributions 	#else
1013*4d495c6eSApple OSS Distributions 	   #define __Require_noErr_Action(errorCode, exceptionLabel, action)          \
1014*4d495c6eSApple OSS Distributions 		  do                                                                      \
1015*4d495c6eSApple OSS Distributions 		  {                                                                       \
1016*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
1017*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
1018*4d495c6eSApple OSS Distributions 			  {                                                                   \
1019*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
1020*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
1021*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ", #exceptionLabel,  0,  __FILE__, __LINE__,  evalOnceErrorCode); \
1022*4d495c6eSApple OSS Distributions 				  {                                                               \
1023*4d495c6eSApple OSS Distributions 					  action;                                                     \
1024*4d495c6eSApple OSS Distributions 				  }                                                               \
1025*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
1026*4d495c6eSApple OSS Distributions 			  }                                                                   \
1027*4d495c6eSApple OSS Distributions 		  } while ( 0 )
1028*4d495c6eSApple OSS Distributions 	#endif
1029*4d495c6eSApple OSS Distributions #endif
1030*4d495c6eSApple OSS Distributions 
1031*4d495c6eSApple OSS Distributions /*
1032*4d495c6eSApple OSS Distributions  *  __Require_noErr_Quiet(errorCode, exceptionLabel)
1033*4d495c6eSApple OSS Distributions  *
1034*4d495c6eSApple OSS Distributions  *  Summary:
1035*4d495c6eSApple OSS Distributions  *    If the errorCode expression does not equal 0 (noErr),
1036*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
1037*4d495c6eSApple OSS Distributions  *
1038*4d495c6eSApple OSS Distributions  *  Parameters:
1039*4d495c6eSApple OSS Distributions  *
1040*4d495c6eSApple OSS Distributions  *    errorCode:
1041*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
1042*4d495c6eSApple OSS Distributions  *
1043*4d495c6eSApple OSS Distributions  *    exceptionLabel:
1044*4d495c6eSApple OSS Distributions  *      The label.
1045*4d495c6eSApple OSS Distributions  */
1046*4d495c6eSApple OSS Distributions #ifndef __Require_noErr_Quiet
1047*4d495c6eSApple OSS Distributions 	#define __Require_noErr_Quiet(errorCode, exceptionLabel)                      \
1048*4d495c6eSApple OSS Distributions 	  do                                                                          \
1049*4d495c6eSApple OSS Distributions 	  {                                                                           \
1050*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(0 != (errorCode), 0) )                            \
1051*4d495c6eSApple OSS Distributions 		  {                                                                       \
1052*4d495c6eSApple OSS Distributions 			  goto exceptionLabel;                                                \
1053*4d495c6eSApple OSS Distributions 		  }                                                                       \
1054*4d495c6eSApple OSS Distributions 	  } while ( 0 )
1055*4d495c6eSApple OSS Distributions #endif
1056*4d495c6eSApple OSS Distributions 
1057*4d495c6eSApple OSS Distributions /*
1058*4d495c6eSApple OSS Distributions  *  __Require_noErr_Action_Quiet(errorCode, exceptionLabel, action)
1059*4d495c6eSApple OSS Distributions  *
1060*4d495c6eSApple OSS Distributions  *  Summary:
1061*4d495c6eSApple OSS Distributions  *    If the errorCode expression does not equal 0 (noErr),
1062*4d495c6eSApple OSS Distributions  *    execute the action statement or compound statement (block) and
1063*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
1064*4d495c6eSApple OSS Distributions  *
1065*4d495c6eSApple OSS Distributions  *  Parameters:
1066*4d495c6eSApple OSS Distributions  *
1067*4d495c6eSApple OSS Distributions  *    errorCode:
1068*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
1069*4d495c6eSApple OSS Distributions  *
1070*4d495c6eSApple OSS Distributions  *    exceptionLabel:
1071*4d495c6eSApple OSS Distributions  *      The label.
1072*4d495c6eSApple OSS Distributions  *
1073*4d495c6eSApple OSS Distributions  *    action:
1074*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
1075*4d495c6eSApple OSS Distributions  */
1076*4d495c6eSApple OSS Distributions #ifndef __Require_noErr_Action_Quiet
1077*4d495c6eSApple OSS Distributions 	#define __Require_noErr_Action_Quiet(errorCode, exceptionLabel, action)       \
1078*4d495c6eSApple OSS Distributions 	  do                                                                          \
1079*4d495c6eSApple OSS Distributions 	  {                                                                           \
1080*4d495c6eSApple OSS Distributions 		  if ( __builtin_expect(0 != (errorCode), 0) )                            \
1081*4d495c6eSApple OSS Distributions 		  {                                                                       \
1082*4d495c6eSApple OSS Distributions 			  {                                                                   \
1083*4d495c6eSApple OSS Distributions 				  action;                                                         \
1084*4d495c6eSApple OSS Distributions 			  }                                                                   \
1085*4d495c6eSApple OSS Distributions 			  goto exceptionLabel;                                                \
1086*4d495c6eSApple OSS Distributions 		  }                                                                       \
1087*4d495c6eSApple OSS Distributions 	  } while ( 0 )
1088*4d495c6eSApple OSS Distributions #endif
1089*4d495c6eSApple OSS Distributions 
1090*4d495c6eSApple OSS Distributions /*
1091*4d495c6eSApple OSS Distributions  *  __Require_noErr_String(errorCode, exceptionLabel, message)
1092*4d495c6eSApple OSS Distributions  *
1093*4d495c6eSApple OSS Distributions  *  Summary:
1094*4d495c6eSApple OSS Distributions  *    Production builds: if the errorCode expression does not equal 0 (noErr),
1095*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
1096*4d495c6eSApple OSS Distributions  *
1097*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
1098*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE, and then goto exceptionLabel.
1099*4d495c6eSApple OSS Distributions  *
1100*4d495c6eSApple OSS Distributions  *  Parameters:
1101*4d495c6eSApple OSS Distributions  *
1102*4d495c6eSApple OSS Distributions  *    errorCode:
1103*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
1104*4d495c6eSApple OSS Distributions  *
1105*4d495c6eSApple OSS Distributions  *    exceptionLabel:
1106*4d495c6eSApple OSS Distributions  *      The label.
1107*4d495c6eSApple OSS Distributions  *
1108*4d495c6eSApple OSS Distributions  *    message:
1109*4d495c6eSApple OSS Distributions  *      The C string to display.
1110*4d495c6eSApple OSS Distributions  */
1111*4d495c6eSApple OSS Distributions #ifndef __Require_noErr_String
1112*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
1113*4d495c6eSApple OSS Distributions 	   #define __Require_noErr_String(errorCode, exceptionLabel, message)         \
1114*4d495c6eSApple OSS Distributions 		  do                                                                      \
1115*4d495c6eSApple OSS Distributions 		  {                                                                       \
1116*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != (errorCode), 0) )                        \
1117*4d495c6eSApple OSS Distributions 			  {                                                                   \
1118*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
1119*4d495c6eSApple OSS Distributions 			  }                                                                   \
1120*4d495c6eSApple OSS Distributions 		  } while ( 0 )
1121*4d495c6eSApple OSS Distributions 	#else
1122*4d495c6eSApple OSS Distributions 	   #define __Require_noErr_String(errorCode, exceptionLabel, message)         \
1123*4d495c6eSApple OSS Distributions 		  do                                                                      \
1124*4d495c6eSApple OSS Distributions 		  {                                                                       \
1125*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
1126*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
1127*4d495c6eSApple OSS Distributions 			  {                                                                   \
1128*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
1129*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
1130*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ",  #exceptionLabel, message, __FILE__,  __LINE__,  evalOnceErrorCode); \
1131*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
1132*4d495c6eSApple OSS Distributions 			  }                                                                   \
1133*4d495c6eSApple OSS Distributions 		  } while ( 0 )
1134*4d495c6eSApple OSS Distributions 	#endif
1135*4d495c6eSApple OSS Distributions #endif
1136*4d495c6eSApple OSS Distributions 
1137*4d495c6eSApple OSS Distributions /*
1138*4d495c6eSApple OSS Distributions  *  __Require_noErr_Action_String(errorCode, exceptionLabel, action, message)
1139*4d495c6eSApple OSS Distributions  *
1140*4d495c6eSApple OSS Distributions  *  Summary:
1141*4d495c6eSApple OSS Distributions  *    Production builds: if the errorCode expression does not equal 0 (noErr),
1142*4d495c6eSApple OSS Distributions  *    execute the action statement or compound statement (block) and
1143*4d495c6eSApple OSS Distributions  *    goto exceptionLabel.
1144*4d495c6eSApple OSS Distributions  *
1145*4d495c6eSApple OSS Distributions  *    Non-production builds: if the errorCode expression does not equal 0 (noErr),
1146*4d495c6eSApple OSS Distributions  *    call DEBUG_ASSERT_MESSAGE, execute the action statement or compound
1147*4d495c6eSApple OSS Distributions  *    statement (block), and then goto exceptionLabel.
1148*4d495c6eSApple OSS Distributions  *
1149*4d495c6eSApple OSS Distributions  *  Parameters:
1150*4d495c6eSApple OSS Distributions  *
1151*4d495c6eSApple OSS Distributions  *    errorCode:
1152*4d495c6eSApple OSS Distributions  *      The expression to compare to 0.
1153*4d495c6eSApple OSS Distributions  *
1154*4d495c6eSApple OSS Distributions  *    exceptionLabel:
1155*4d495c6eSApple OSS Distributions  *      The label.
1156*4d495c6eSApple OSS Distributions  *
1157*4d495c6eSApple OSS Distributions  *    action:
1158*4d495c6eSApple OSS Distributions  *      The statement or compound statement (block).
1159*4d495c6eSApple OSS Distributions  *
1160*4d495c6eSApple OSS Distributions  *    message:
1161*4d495c6eSApple OSS Distributions  *      The C string to display.
1162*4d495c6eSApple OSS Distributions  */
1163*4d495c6eSApple OSS Distributions #ifndef __Require_noErr_Action_String
1164*4d495c6eSApple OSS Distributions 	#if DEBUG_ASSERT_PRODUCTION_CODE
1165*4d495c6eSApple OSS Distributions 	   #define __Require_noErr_Action_String(errorCode, exceptionLabel, action, message) \
1166*4d495c6eSApple OSS Distributions 		  do                                                                      \
1167*4d495c6eSApple OSS Distributions 		  {                                                                       \
1168*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != (errorCode), 0) )                        \
1169*4d495c6eSApple OSS Distributions 			  {                                                                   \
1170*4d495c6eSApple OSS Distributions 				  {                                                               \
1171*4d495c6eSApple OSS Distributions 					  action;                                                     \
1172*4d495c6eSApple OSS Distributions 				  }                                                               \
1173*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
1174*4d495c6eSApple OSS Distributions 			  }                                                                   \
1175*4d495c6eSApple OSS Distributions 		  } while ( 0 )
1176*4d495c6eSApple OSS Distributions 	#else
1177*4d495c6eSApple OSS Distributions 	   #define __Require_noErr_Action_String(errorCode, exceptionLabel, action, message) \
1178*4d495c6eSApple OSS Distributions 		  do                                                                      \
1179*4d495c6eSApple OSS Distributions 		  {                                                                       \
1180*4d495c6eSApple OSS Distributions 			  long evalOnceErrorCode = (errorCode);                               \
1181*4d495c6eSApple OSS Distributions 			  if ( __builtin_expect(0 != evalOnceErrorCode, 0) )                  \
1182*4d495c6eSApple OSS Distributions 			  {                                                                   \
1183*4d495c6eSApple OSS Distributions 				  DEBUG_ASSERT_MESSAGE(                                           \
1184*4d495c6eSApple OSS Distributions 					  DEBUG_ASSERT_COMPONENT_NAME_STRING,                         \
1185*4d495c6eSApple OSS Distributions 					  #errorCode " == 0 ", #exceptionLabel, message, __FILE__, __LINE__, evalOnceErrorCode); \
1186*4d495c6eSApple OSS Distributions 				  {                                                               \
1187*4d495c6eSApple OSS Distributions 					  action;                                                     \
1188*4d495c6eSApple OSS Distributions 				  }                                                               \
1189*4d495c6eSApple OSS Distributions 				  goto exceptionLabel;                                            \
1190*4d495c6eSApple OSS Distributions 			  }                                                                   \
1191*4d495c6eSApple OSS Distributions 		  } while ( 0 )
1192*4d495c6eSApple OSS Distributions 	#endif
1193*4d495c6eSApple OSS Distributions #endif
1194*4d495c6eSApple OSS Distributions 
1195*4d495c6eSApple OSS Distributions /*
1196*4d495c6eSApple OSS Distributions  *  __Check_Compile_Time(expr)
1197*4d495c6eSApple OSS Distributions  *
1198*4d495c6eSApple OSS Distributions  *  Summary:
1199*4d495c6eSApple OSS Distributions  *    any build: if the expression is not true, generated a compile time error.
1200*4d495c6eSApple OSS Distributions  *
1201*4d495c6eSApple OSS Distributions  *  Parameters:
1202*4d495c6eSApple OSS Distributions  *
1203*4d495c6eSApple OSS Distributions  *    expr:
1204*4d495c6eSApple OSS Distributions  *      The compile time expression that should evaluate to non-zero.
1205*4d495c6eSApple OSS Distributions  *
1206*4d495c6eSApple OSS Distributions  *  Discussion:
1207*4d495c6eSApple OSS Distributions  *     This declares an array with a size that is determined by a compile-time expression.
1208*4d495c6eSApple OSS Distributions  *     If false, it declares a negatively sized array, which generates a compile-time error.
1209*4d495c6eSApple OSS Distributions  *
1210*4d495c6eSApple OSS Distributions  * Examples:
1211*4d495c6eSApple OSS Distributions  *     __Check_Compile_Time( sizeof( int ) == 4 );
1212*4d495c6eSApple OSS Distributions  *     __Check_Compile_Time( offsetof( MyStruct, myField ) == 4 );
1213*4d495c6eSApple OSS Distributions  *     __Check_Compile_Time( ( kMyBufferSize % 512 ) == 0 );
1214*4d495c6eSApple OSS Distributions  *
1215*4d495c6eSApple OSS Distributions  *  Note: This only works with compile-time expressions.
1216*4d495c6eSApple OSS Distributions  *  Note: This only works in places where extern declarations are allowed (e.g. global scope).
1217*4d495c6eSApple OSS Distributions  */
1218*4d495c6eSApple OSS Distributions #ifndef __Check_Compile_Time
1219*4d495c6eSApple OSS Distributions     #ifdef __GNUC__
1220*4d495c6eSApple OSS Distributions         #define __Check_Compile_Time( expr )    \
1221*4d495c6eSApple OSS Distributions             extern int compile_time_assert_failed[ ( expr ) ? 1 : -1 ] __attribute__( ( unused ) )
1222*4d495c6eSApple OSS Distributions     #else
1223*4d495c6eSApple OSS Distributions         #define __Check_Compile_Time( expr )    \
1224*4d495c6eSApple OSS Distributions             extern int compile_time_assert_failed[ ( expr ) ? 1 : -1 ]
1225*4d495c6eSApple OSS Distributions     #endif
1226*4d495c6eSApple OSS Distributions #endif
1227*4d495c6eSApple OSS Distributions 
1228*4d495c6eSApple OSS Distributions /*
1229*4d495c6eSApple OSS Distributions  *	For time immemorial, Mac OS X has defined version of most of these macros without the __ prefix, which
1230*4d495c6eSApple OSS Distributions  *	could collide with similarly named functions or macros in user code, including new functionality in
1231*4d495c6eSApple OSS Distributions  *	Boost and the C++ standard library.
1232*4d495c6eSApple OSS Distributions  *
1233*4d495c6eSApple OSS Distributions  *	A future release of Mac OS X will no longer do this, and will require that clients move to the
1234*4d495c6eSApple OSS Distributions  *  new macros as defined above.  However, in the interim both the new and old macros will work, unless
1235*4d495c6eSApple OSS Distributions  *  clients define a macro __ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES before this file is included
1236*4d495c6eSApple OSS Distributions  *  in their compilations.  Clients who do not want the older macros defined can accomplish this by adding
1237*4d495c6eSApple OSS Distributions  *    #define __ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES 0
1238*4d495c6eSApple OSS Distributions  *  at the top of their sources, or my adding -D__ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES=0 to the
1239*4d495c6eSApple OSS Distributions  *  gcc compilation options.
1240*4d495c6eSApple OSS Distributions  *
1241*4d495c6eSApple OSS Distributions  *  To aid users of these macros in converting their sources, the following tops script will convert usages
1242*4d495c6eSApple OSS Distributions  *  of the old macros into the new equivalents.  To do so, in Terminal go into the directory containing the
1243*4d495c6eSApple OSS Distributions  *  sources to be converted and run this command.
1244*4d495c6eSApple OSS Distributions  *
1245*4d495c6eSApple OSS Distributions     find . -name '*.[c|cc|cp|cpp|m|mm|h]' -print0 |  xargs -0 tops -verbose \
1246*4d495c6eSApple OSS Distributions       replace "check(<b args>)" with "__Check(<args>)" \
1247*4d495c6eSApple OSS Distributions       replace "check_noerr(<b args>)" with "__Check_noErr(<args>)" \
1248*4d495c6eSApple OSS Distributions       replace "check_noerr_string(<b args>)" with "__Check_noErr_String(<args>)" \
1249*4d495c6eSApple OSS Distributions       replace "check_string(<b args>)" with "__Check_String(<args>)" \
1250*4d495c6eSApple OSS Distributions       replace "require(<b args>)" with "__Require(<args>)" \
1251*4d495c6eSApple OSS Distributions       replace "require_action(<b args>)" with "__Require_Action(<args>)" \
1252*4d495c6eSApple OSS Distributions       replace "require_action_string(<b args>)" with "__Require_Action_String(<args>)" \
1253*4d495c6eSApple OSS Distributions       replace "require_noerr(<b args>)" with "__Require_noErr(<args>)" \
1254*4d495c6eSApple OSS Distributions       replace "require_noerr_action(<b args>)" with "__Require_noErr_Action(<args>)" \
1255*4d495c6eSApple OSS Distributions       replace "require_noerr_action_string(<b args>)" with "__Require_noErr_Action_String(<args>)" \
1256*4d495c6eSApple OSS Distributions       replace "require_noerr_string(<b args>)" with "__Require_noErr_String(<args>)" \
1257*4d495c6eSApple OSS Distributions       replace "require_string(<b args>)" with "__Require_String(<args>)" \
1258*4d495c6eSApple OSS Distributions       replace "verify(<b args>)" with "__Verify(<args>)" \
1259*4d495c6eSApple OSS Distributions       replace "verify_action(<b args>)" with "__Verify_Action(<args>)" \
1260*4d495c6eSApple OSS Distributions       replace "verify_noerr(<b args>)" with "__Verify_noErr(<args>)" \
1261*4d495c6eSApple OSS Distributions       replace "verify_noerr_action(<b args>)" with "__Verify_noErr_Action(<args>)" \
1262*4d495c6eSApple OSS Distributions       replace "verify_noerr_string(<b args>)" with "__Verify_noErr_String(<args>)" \
1263*4d495c6eSApple OSS Distributions       replace "verify_string(<b args>)" with "__Verify_String(<args>)" \
1264*4d495c6eSApple OSS Distributions       replace "ncheck(<b args>)" with "__nCheck(<args>)" \
1265*4d495c6eSApple OSS Distributions       replace "ncheck_string(<b args>)" with "__nCheck_String(<args>)" \
1266*4d495c6eSApple OSS Distributions       replace "nrequire(<b args>)" with "__nRequire(<args>)" \
1267*4d495c6eSApple OSS Distributions       replace "nrequire_action(<b args>)" with "__nRequire_Action(<args>)" \
1268*4d495c6eSApple OSS Distributions       replace "nrequire_action_quiet(<b args>)" with "__nRequire_Action_Quiet(<args>)" \
1269*4d495c6eSApple OSS Distributions       replace "nrequire_action_string(<b args>)" with "__nRequire_Action_String(<args>)" \
1270*4d495c6eSApple OSS Distributions       replace "nrequire_quiet(<b args>)" with "__nRequire_Quiet(<args>)" \
1271*4d495c6eSApple OSS Distributions       replace "nrequire_string(<b args>)" with "__nRequire_String(<args>)" \
1272*4d495c6eSApple OSS Distributions       replace "nverify(<b args>)" with "__nVerify(<args>)" \
1273*4d495c6eSApple OSS Distributions       replace "nverify_string(<b args>)" with "__nVerify_String(<args>)" \
1274*4d495c6eSApple OSS Distributions       replace "require_action_quiet(<b args>)" with "__Require_Action_Quiet(<args>)" \
1275*4d495c6eSApple OSS Distributions       replace "require_noerr_action_quiet(<b args>)" with "__Require_noErr_Action_Quiet(<args>)" \
1276*4d495c6eSApple OSS Distributions       replace "require_noerr_quiet(<b args>)" with "__Require_noErr_Quiet(<args>)" \
1277*4d495c6eSApple OSS Distributions       replace "require_quiet(<b args>)" with "__Require_Quiet(<args>)" \
1278*4d495c6eSApple OSS Distributions       replace "check_compile_time(<b args>)" with "__Check_Compile_Time(<args>)" \
1279*4d495c6eSApple OSS Distributions       replace "debug_string(<b args>)" with "__Debug_String(<args>)"
1280*4d495c6eSApple OSS Distributions  *
1281*4d495c6eSApple OSS Distributions  */
1282*4d495c6eSApple OSS Distributions 
1283*4d495c6eSApple OSS Distributions #ifndef __ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES
1284*4d495c6eSApple OSS Distributions 	/* If we haven't set this yet, it defaults to on.  In the next release, this will default to off. */
1285*4d495c6eSApple OSS Distributions 	#define	__ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES	1
1286*4d495c6eSApple OSS Distributions #endif
1287*4d495c6eSApple OSS Distributions 
1288*4d495c6eSApple OSS Distributions #if	__ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES
1289*4d495c6eSApple OSS Distributions 
1290*4d495c6eSApple OSS Distributions 	#ifndef check
1291*4d495c6eSApple OSS Distributions 	#define check(assertion)  __Check(assertion)
1292*4d495c6eSApple OSS Distributions 	#endif
1293*4d495c6eSApple OSS Distributions 
1294*4d495c6eSApple OSS Distributions 	#ifndef check_noerr
1295*4d495c6eSApple OSS Distributions 	#define check_noerr(errorCode)  __Check_noErr(errorCode)
1296*4d495c6eSApple OSS Distributions 	#endif
1297*4d495c6eSApple OSS Distributions 
1298*4d495c6eSApple OSS Distributions 	#ifndef check_noerr_string
1299*4d495c6eSApple OSS Distributions 		#define check_noerr_string(errorCode, message)  __Check_noErr_String(errorCode, message)
1300*4d495c6eSApple OSS Distributions 	#endif
1301*4d495c6eSApple OSS Distributions 
1302*4d495c6eSApple OSS Distributions 	#ifndef check_string
1303*4d495c6eSApple OSS Distributions 		#define check_string(assertion, message)  __Check_String(assertion, message)
1304*4d495c6eSApple OSS Distributions 	#endif
1305*4d495c6eSApple OSS Distributions 
1306*4d495c6eSApple OSS Distributions 	#ifndef require
1307*4d495c6eSApple OSS Distributions 		#define require(assertion, exceptionLabel)  __Require(assertion, exceptionLabel)
1308*4d495c6eSApple OSS Distributions 	#endif
1309*4d495c6eSApple OSS Distributions 
1310*4d495c6eSApple OSS Distributions 	#ifndef require_action
1311*4d495c6eSApple OSS Distributions 		#define require_action(assertion, exceptionLabel, action)  __Require_Action(assertion, exceptionLabel, action)
1312*4d495c6eSApple OSS Distributions 	#endif
1313*4d495c6eSApple OSS Distributions 
1314*4d495c6eSApple OSS Distributions 	#ifndef require_action_string
1315*4d495c6eSApple OSS Distributions 		#define require_action_string(assertion, exceptionLabel, action, message)  __Require_Action_String(assertion, exceptionLabel, action, message)
1316*4d495c6eSApple OSS Distributions 	#endif
1317*4d495c6eSApple OSS Distributions 
1318*4d495c6eSApple OSS Distributions 	#ifndef require_noerr
1319*4d495c6eSApple OSS Distributions 		#define require_noerr(errorCode, exceptionLabel)  __Require_noErr(errorCode, exceptionLabel)
1320*4d495c6eSApple OSS Distributions 	#endif
1321*4d495c6eSApple OSS Distributions 
1322*4d495c6eSApple OSS Distributions 	#ifndef require_noerr_action
1323*4d495c6eSApple OSS Distributions 		#define require_noerr_action(errorCode, exceptionLabel, action)  __Require_noErr_Action(errorCode, exceptionLabel, action)
1324*4d495c6eSApple OSS Distributions 	#endif
1325*4d495c6eSApple OSS Distributions 
1326*4d495c6eSApple OSS Distributions 	#ifndef require_noerr_action_string
1327*4d495c6eSApple OSS Distributions 		#define require_noerr_action_string(errorCode, exceptionLabel, action, message)  __Require_noErr_Action_String(errorCode, exceptionLabel, action, message)
1328*4d495c6eSApple OSS Distributions 	#endif
1329*4d495c6eSApple OSS Distributions 
1330*4d495c6eSApple OSS Distributions 	#ifndef require_noerr_string
1331*4d495c6eSApple OSS Distributions 		#define require_noerr_string(errorCode, exceptionLabel, message)  __Require_noErr_String(errorCode, exceptionLabel, message)
1332*4d495c6eSApple OSS Distributions 	#endif
1333*4d495c6eSApple OSS Distributions 
1334*4d495c6eSApple OSS Distributions 	#ifndef require_string
1335*4d495c6eSApple OSS Distributions 		#define require_string(assertion, exceptionLabel, message)  __Require_String(assertion, exceptionLabel, message)
1336*4d495c6eSApple OSS Distributions 	#endif
1337*4d495c6eSApple OSS Distributions 
1338*4d495c6eSApple OSS Distributions 	#ifndef verify
1339*4d495c6eSApple OSS Distributions 		#define verify(assertion) __Verify(assertion)
1340*4d495c6eSApple OSS Distributions 	#endif
1341*4d495c6eSApple OSS Distributions 
1342*4d495c6eSApple OSS Distributions 	#ifndef verify_action
1343*4d495c6eSApple OSS Distributions 		#define verify_action(assertion, action)  __Verify_Action(assertion, action)
1344*4d495c6eSApple OSS Distributions 	#endif
1345*4d495c6eSApple OSS Distributions 
1346*4d495c6eSApple OSS Distributions 	#ifndef verify_noerr
1347*4d495c6eSApple OSS Distributions 		#define verify_noerr(errorCode)  __Verify_noErr(errorCode)
1348*4d495c6eSApple OSS Distributions 	#endif
1349*4d495c6eSApple OSS Distributions 
1350*4d495c6eSApple OSS Distributions 	#ifndef verify_noerr_action
1351*4d495c6eSApple OSS Distributions 		#define verify_noerr_action(errorCode, action)  __Verify_noErr_Action(errorCode, action)
1352*4d495c6eSApple OSS Distributions 	#endif
1353*4d495c6eSApple OSS Distributions 
1354*4d495c6eSApple OSS Distributions 	#ifndef verify_noerr_string
1355*4d495c6eSApple OSS Distributions 		#define verify_noerr_string(errorCode, message)  __Verify_noErr_String(errorCode, message)
1356*4d495c6eSApple OSS Distributions 	#endif
1357*4d495c6eSApple OSS Distributions 
1358*4d495c6eSApple OSS Distributions 	#ifndef verify_string
1359*4d495c6eSApple OSS Distributions 		#define verify_string(assertion, message)  __Verify_String(assertion, message)
1360*4d495c6eSApple OSS Distributions 	#endif
1361*4d495c6eSApple OSS Distributions 
1362*4d495c6eSApple OSS Distributions 	#ifndef ncheck
1363*4d495c6eSApple OSS Distributions 		#define ncheck(assertion)  __nCheck(assertion)
1364*4d495c6eSApple OSS Distributions 	#endif
1365*4d495c6eSApple OSS Distributions 
1366*4d495c6eSApple OSS Distributions 	#ifndef ncheck_string
1367*4d495c6eSApple OSS Distributions 		#define ncheck_string(assertion, message)  __nCheck_String(assertion, message)
1368*4d495c6eSApple OSS Distributions 	#endif
1369*4d495c6eSApple OSS Distributions 
1370*4d495c6eSApple OSS Distributions 	#ifndef nrequire
1371*4d495c6eSApple OSS Distributions 		#define nrequire(assertion, exceptionLabel)  __nRequire(assertion, exceptionLabel)
1372*4d495c6eSApple OSS Distributions 	#endif
1373*4d495c6eSApple OSS Distributions 
1374*4d495c6eSApple OSS Distributions 	#ifndef nrequire_action
1375*4d495c6eSApple OSS Distributions 		#define nrequire_action(assertion, exceptionLabel, action)  __nRequire_Action(assertion, exceptionLabel, action)
1376*4d495c6eSApple OSS Distributions 	#endif
1377*4d495c6eSApple OSS Distributions 
1378*4d495c6eSApple OSS Distributions 	#ifndef nrequire_action_quiet
1379*4d495c6eSApple OSS Distributions 		#define nrequire_action_quiet(assertion, exceptionLabel, action)  __nRequire_Action_Quiet(assertion, exceptionLabel, action)
1380*4d495c6eSApple OSS Distributions 	#endif
1381*4d495c6eSApple OSS Distributions 
1382*4d495c6eSApple OSS Distributions 	#ifndef nrequire_action_string
1383*4d495c6eSApple OSS Distributions 		#define nrequire_action_string(assertion, exceptionLabel, action, message)  __nRequire_Action_String(assertion, exceptionLabel, action, message)
1384*4d495c6eSApple OSS Distributions 	#endif
1385*4d495c6eSApple OSS Distributions 
1386*4d495c6eSApple OSS Distributions 	#ifndef nrequire_quiet
1387*4d495c6eSApple OSS Distributions 		#define nrequire_quiet(assertion, exceptionLabel)  __nRequire_Quiet(assertion, exceptionLabel)
1388*4d495c6eSApple OSS Distributions 	#endif
1389*4d495c6eSApple OSS Distributions 
1390*4d495c6eSApple OSS Distributions 	#ifndef nrequire_string
1391*4d495c6eSApple OSS Distributions 		#define nrequire_string(assertion, exceptionLabel, string)  __nRequire_String(assertion, exceptionLabel, string)
1392*4d495c6eSApple OSS Distributions 	#endif
1393*4d495c6eSApple OSS Distributions 
1394*4d495c6eSApple OSS Distributions 	#ifndef nverify
1395*4d495c6eSApple OSS Distributions 		#define nverify(assertion)  __nVerify(assertion)
1396*4d495c6eSApple OSS Distributions 	#endif
1397*4d495c6eSApple OSS Distributions 
1398*4d495c6eSApple OSS Distributions 	#ifndef nverify_string
1399*4d495c6eSApple OSS Distributions 		#define nverify_string(assertion, message)  __nVerify_String(assertion, message)
1400*4d495c6eSApple OSS Distributions 	#endif
1401*4d495c6eSApple OSS Distributions 
1402*4d495c6eSApple OSS Distributions 	#ifndef require_action_quiet
1403*4d495c6eSApple OSS Distributions 		#define require_action_quiet(assertion, exceptionLabel, action)  __Require_Action_Quiet(assertion, exceptionLabel, action)
1404*4d495c6eSApple OSS Distributions 	#endif
1405*4d495c6eSApple OSS Distributions 
1406*4d495c6eSApple OSS Distributions 	#ifndef require_noerr_action_quiet
1407*4d495c6eSApple OSS Distributions 		#define require_noerr_action_quiet(errorCode, exceptionLabel, action)  __Require_noErr_Action_Quiet(errorCode, exceptionLabel, action)
1408*4d495c6eSApple OSS Distributions 	#endif
1409*4d495c6eSApple OSS Distributions 
1410*4d495c6eSApple OSS Distributions 	#ifndef require_noerr_quiet
1411*4d495c6eSApple OSS Distributions 		#define require_noerr_quiet(errorCode, exceptionLabel)  __Require_noErr_Quiet(errorCode, exceptionLabel)
1412*4d495c6eSApple OSS Distributions 	#endif
1413*4d495c6eSApple OSS Distributions 
1414*4d495c6eSApple OSS Distributions 	#ifndef require_quiet
1415*4d495c6eSApple OSS Distributions 		#define require_quiet(assertion, exceptionLabel)  __Require_Quiet(assertion, exceptionLabel)
1416*4d495c6eSApple OSS Distributions 	#endif
1417*4d495c6eSApple OSS Distributions 
1418*4d495c6eSApple OSS Distributions 	#ifndef check_compile_time
1419*4d495c6eSApple OSS Distributions 		#define check_compile_time( expr )  __Check_Compile_Time( expr )
1420*4d495c6eSApple OSS Distributions 	#endif
1421*4d495c6eSApple OSS Distributions 
1422*4d495c6eSApple OSS Distributions 	#ifndef debug_string
1423*4d495c6eSApple OSS Distributions 		#define debug_string(message)  __Debug_String(message)
1424*4d495c6eSApple OSS Distributions 	#endif
1425*4d495c6eSApple OSS Distributions 
1426*4d495c6eSApple OSS Distributions #endif	/* ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES */
1427*4d495c6eSApple OSS Distributions 
1428*4d495c6eSApple OSS Distributions 
1429*4d495c6eSApple OSS Distributions #endif /* __ASSERTMACROS__ */
1430