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