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