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