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