-
Notifications
You must be signed in to change notification settings - Fork 0
/
AssertMacros.h
1441 lines (1348 loc) · 58.1 KB
/
AssertMacros.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2002-2017 by Apple Inc.. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*
File: AssertMacros.h
Contains: This file defines structured error handling and assertion macros for
programming in C. Originally used in QuickDraw GX and later enhanced.
These macros are used throughout Apple's software.
New code may not want to begin adopting these macros and instead use
existing language functionality.
See "Living In an Exceptional World" by Sean Parent
(develop, The Apple Technical Journal, Issue 11, August/September 1992)
<http://developer.apple.com/dev/techsupport/develop/issue11toc.shtml> or
<http://www.mactech.com/articles/develop/issue_11/Parent_final.html>
for the methodology behind these error handling and assertion macros.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __ASSERTMACROS__
#define __ASSERTMACROS__
#ifdef DEBUG_ASSERT_CONFIG_INCLUDE
#include DEBUG_ASSERT_CONFIG_INCLUDE
#endif
/*
* Macro overview:
*
* check(assertion)
* In production builds, pre-processed away
* In debug builds, if assertion evaluates to false, calls DEBUG_ASSERT_MESSAGE
*
* verify(assertion)
* In production builds, evaluates assertion and does nothing
* In debug builds, if assertion evaluates to false, calls DEBUG_ASSERT_MESSAGE
*
* require(assertion, exceptionLabel)
* In production builds, if the assertion expression evaluates to false, goto exceptionLabel
* In debug builds, if the assertion expression evaluates to false, calls DEBUG_ASSERT_MESSAGE
* and jumps to exceptionLabel
*
* In addition the following suffixes are available:
*
* _noerr Adds "!= 0" to assertion. Useful for asserting and OSStatus or OSErr is noErr (zero)
* _action Adds statement to be executued if assertion fails
* _quiet Suppress call to DEBUG_ASSERT_MESSAGE
* _string Allows you to add explanitory message to DEBUG_ASSERT_MESSAGE
*
* For instance, require_noerr_string(resultCode, label, msg) will do nothing if
* resultCode is zero, otherwise it will call DEBUG_ASSERT_MESSAGE with msg
* and jump to label.
*
* Configuration:
*
* By default all macros generate "production code" (i.e non-debug). If
* DEBUG_ASSERT_PRODUCTION_CODE is defined to zero or DEBUG is defined to non-zero
* while this header is included, the macros will generated debug code.
*
* If DEBUG_ASSERT_COMPONENT_NAME_STRING is defined, all debug messages will
* be prefixed with it.
*
* By default, all messages write to stderr. If you would like to write a custom
* error message formater, defined DEBUG_ASSERT_MESSAGE to your function name.
*
* Each individual macro will only be defined if it is not already defined, so
* you can redefine their behavior singly by providing your own definition before
* this file is included.
*
* If you define __ASSERTMACROS__ before this file is included, then nothing in
* this file will take effect.
*
* Prior to Mac OS X 10.6 the macro names used in this file conflicted with some
* user code, including libraries in boost and the proposed C++ standards efforts,
* and there was no way for a client of this header to resolve this conflict. Because
* of this, most of the macros have been changed so that they are prefixed with
* __ and contain at least one capital letter, which should alleviate the current
* and future conflicts. However, to allow current sources to continue to compile,
* compatibility macros are defined at the end with the old names. A tops script
* at the end of this file will convert all of the old macro names used in a directory
* to the new names. Clients are recommended to migrate over to these new macros as
* they update their sources because a future release of Mac OS X will remove the
* old macro definitions ( without the double-underscore prefix ). Clients who
* want to compile without the old macro definitions can define the macro
* __ASSERT_MACROS_DEFINE_VERSIONS_WITHOUT_UNDERSCORES to 0 before this file is
* included.
*/
/*
* Before including this file, #define DEBUG_ASSERT_COMPONENT_NAME_STRING to
* a C-string containing the name of your client. This string will be passed to
* the DEBUG_ASSERT_MESSAGE macro for inclusion in any assertion messages.
*
* If you do not define DEBUG_ASSERT_COMPONENT_NAME_STRING, the default
* DEBUG_ASSERT_COMPONENT_NAME_STRING value, an empty string, will be used by
* the assertion macros.
*/
#ifndef DEBUG_ASSERT_COMPONENT_NAME_STRING
#define DEBUG_ASSERT_COMPONENT_NAME_STRING ""
#endif
/*
* To activate the additional assertion code and messages for non-production builds,
* #define DEBUG_ASSERT_PRODUCTION_CODE to zero before including this file.
*
* If you do not define DEBUG_ASSERT_PRODUCTION_CODE, the default value 1 will be used
* (production code = no assertion code and no messages).
*/
#ifndef DEBUG_ASSERT_PRODUCTION_CODE
#define DEBUG_ASSERT_PRODUCTION_CODE !DEBUG
#endif
/*
* DEBUG_ASSERT_MESSAGE(component, assertion, label, error, file, line, errorCode)
*
* Summary:
* All assertion messages are routed through this macro. If you wish to use your
* own routine to display assertion messages, you can override DEBUG_ASSERT_MESSAGE
* by #defining DEBUG_ASSERT_MESSAGE before including this file.
*
* Parameters:
*
* componentNameString:
* A pointer to a string constant containing the name of the
* component this code is part of. This must be a string constant
* (and not a string variable or NULL) because the preprocessor
* concatenates it with other string constants.
*
* assertionString:
* A pointer to a string constant containing the assertion.
* This must be a string constant (and not a string variable or
* NULL) because the Preprocessor concatenates it with other
* string constants.
*
* exceptionLabelString:
* A pointer to a string containing the exceptionLabel, or NULL.
*
* errorString:
* A pointer to the error string, or NULL. DEBUG_ASSERT_MESSAGE macros
* must not attempt to concatenate this string with constant
* character strings.
*
* fileName:
* A pointer to the fileName or pathname (generated by the
* preprocessor __FILE__ identifier), or NULL.
*
* lineNumber:
* The line number in the file (generated by the preprocessor
* __LINE__ identifier), or 0 (zero).
*
* errorCode:
* A value associated with the assertion, or 0.
*
* Here is an example of a DEBUG_ASSERT_MESSAGE macro and a routine which displays
* assertion messsages:
*
* #define DEBUG_ASSERT_COMPONENT_NAME_STRING "MyCoolProgram"
*
* #define DEBUG_ASSERT_MESSAGE(componentNameString, assertionString, \
* exceptionLabelString, errorString, fileName, lineNumber, errorCode) \
* MyProgramDebugAssert(componentNameString, assertionString, \
* exceptionLabelString, errorString, fileName, lineNumber, errorCode)
*
* static void
* MyProgramDebugAssert(const char *componentNameString, const char *assertionString,
* const char *exceptionLabelString, const char *errorString,
* const char *fileName, long lineNumber, int errorCode)
* {
* if ( (assertionString != NULL) && (*assertionString != '\0') )
* fprintf(stderr, "Assertion failed: %s: %s\n", componentNameString, assertionString);
* else
* fprintf(stderr, "Check failed: %s:\n", componentNameString);
* if ( exceptionLabelString != NULL )
* fprintf(stderr, " %s\n", exceptionLabelString);
* if ( errorString != NULL )
* fprintf(stderr, " %s\n", errorString);
* if ( fileName != NULL )
* fprintf(stderr, " file: %s\n", fileName);
* if ( lineNumber != 0 )
* fprintf(stderr, " line: %ld\n", lineNumber);
* if ( errorCode != 0 )
* fprintf(stderr, " error: %d\n", errorCode);
* }
*
* If you do not define DEBUG_ASSERT_MESSAGE, a simple printf to stderr will be used.
*/
#ifndef DEBUG_ASSERT_MESSAGE
#ifdef KERNEL
#include <libkern/libkern.h>
#define DEBUG_ASSERT_MESSAGE(name, assertion, label, message, file, line, value) \
printf( "AssertMacros: %s, %s file: %s, line: %d, value: %ld\n", assertion, (message!=0) ? message : "", file, line, (long) (value));
#else
#include <stdio.h>
#define DEBUG_ASSERT_MESSAGE(name, assertion, label, message, file, line, value) \
fprintf(stderr, "AssertMacros: %s, %s file: %s, line: %d, value: %ld\n", assertion, (message!=0) ? message : "", file, line, (long) (value));
#endif
#endif
/*
* __Debug_String(message)
*
* Summary:
* Production builds: does nothing and produces no code.
*
* Non-production builds: call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* message:
* The C string to display.
*
*/
#ifndef __Debug_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Debug_String(message)
#else
#define __Debug_String(message) \
do \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
"", \
0, \
message, \
__FILE__, \
__LINE__, \
0); \
} while ( 0 )
#endif
#endif
/*
* __Check(assertion)
*
* Summary:
* Production builds: does nothing and produces no code.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* assertion:
* The assertion expression.
*/
#ifndef __Check
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Check(assertion)
#else
#define __Check(assertion) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, 0, 0, __FILE__, __LINE__, 0 ); \
} \
} while ( 0 )
#endif
#endif
#ifndef __nCheck
#define __nCheck(assertion) __Check(!(assertion))
#endif
/*
* __Check_String(assertion, message)
*
* Summary:
* Production builds: does nothing and produces no code.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* message:
* The C string to display.
*/
#ifndef __Check_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Check_String(assertion, message)
#else
#define __Check_String(assertion, message) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, 0, message, __FILE__, __LINE__, 0 ); \
} \
} while ( 0 )
#endif
#endif
#ifndef __nCheck_String
#define __nCheck_String(assertion, message) __Check_String(!(assertion), message)
#endif
/*
* __Check_noErr(errorCode)
*
* Summary:
* Production builds: does nothing and produces no code.
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* errorCode:
* The errorCode expression to compare with 0.
*/
#ifndef __Check_noErr
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Check_noErr(errorCode)
#else
#define __Check_noErr(errorCode) \
do \
{ \
long evalOnceErrorCode = (errorCode); \
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#errorCode " == 0 ", 0, 0, __FILE__, __LINE__, evalOnceErrorCode ); \
} \
} while ( 0 )
#endif
#endif
/*
* __Check_noErr_String(errorCode, message)
*
* Summary:
* Production builds: check_noerr_string() does nothing and produces
* no code.
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* errorCode:
* The errorCode expression to compare to 0.
*
* message:
* The C string to display.
*/
#ifndef __Check_noErr_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Check_noErr_String(errorCode, message)
#else
#define __Check_noErr_String(errorCode, message) \
do \
{ \
long evalOnceErrorCode = (errorCode); \
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#errorCode " == 0 ", 0, message, __FILE__, __LINE__, evalOnceErrorCode ); \
} \
} while ( 0 )
#endif
#endif
/*
* __Verify(assertion)
*
* Summary:
* Production builds: evaluate the assertion expression, but ignore
* the result.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* assertion:
* The assertion expression.
*/
#ifndef __Verify
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Verify(assertion) \
do \
{ \
if ( !(assertion) ) \
{ \
} \
} while ( 0 )
#else
#define __Verify(assertion) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, 0, 0, __FILE__, __LINE__, 0 ); \
} \
} while ( 0 )
#endif
#endif
#ifndef __nVerify
#define __nVerify(assertion) __Verify(!(assertion))
#endif
/*
* __Verify_String(assertion, message)
*
* Summary:
* Production builds: evaluate the assertion expression, but ignore
* the result.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* message:
* The C string to display.
*/
#ifndef __Verify_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Verify_String(assertion, message) \
do \
{ \
if ( !(assertion) ) \
{ \
} \
} while ( 0 )
#else
#define __Verify_String(assertion, message) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, 0, message, __FILE__, __LINE__, 0 ); \
} \
} while ( 0 )
#endif
#endif
#ifndef __nVerify_String
#define __nVerify_String(assertion, message) __Verify_String(!(assertion), message)
#endif
/*
* __Verify_noErr(errorCode)
*
* Summary:
* Production builds: evaluate the errorCode expression, but ignore
* the result.
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* errorCode:
* The expression to compare to 0.
*/
#ifndef __Verify_noErr
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Verify_noErr(errorCode) \
do \
{ \
if ( 0 != (errorCode) ) \
{ \
} \
} while ( 0 )
#else
#define __Verify_noErr(errorCode) \
do \
{ \
long evalOnceErrorCode = (errorCode); \
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#errorCode " == 0 ", 0, 0, __FILE__, __LINE__, evalOnceErrorCode ); \
} \
} while ( 0 )
#endif
#endif
/*
* __Verify_noErr_String(errorCode, message)
*
* Summary:
* Production builds: evaluate the errorCode expression, but ignore
* the result.
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE.
*
* Parameters:
*
* errorCode:
* The expression to compare to 0.
*
* message:
* The C string to display.
*/
#ifndef __Verify_noErr_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Verify_noErr_String(errorCode, message) \
do \
{ \
if ( 0 != (errorCode) ) \
{ \
} \
} while ( 0 )
#else
#define __Verify_noErr_String(errorCode, message) \
do \
{ \
long evalOnceErrorCode = (errorCode); \
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#errorCode " == 0 ", 0, message, __FILE__, __LINE__, evalOnceErrorCode ); \
} \
} while ( 0 )
#endif
#endif
/*
* __Verify_noErr_Action(errorCode, action)
*
* Summary:
* Production builds: if the errorCode expression does not equal 0 (noErr),
* execute the action statement or compound statement (block).
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE and then execute the action statement or compound
* statement (block).
*
* Parameters:
*
* errorCode:
* The expression to compare to 0.
*
* action:
* The statement or compound statement (block).
*/
#ifndef __Verify_noErr_Action
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Verify_noErr_Action(errorCode, action) \
if ( 0 != (errorCode) ) { \
action; \
} \
else do {} while (0)
#else
#define __Verify_noErr_Action(errorCode, action) \
do { \
long evalOnceErrorCode = (errorCode); \
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) { \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#errorCode " == 0 ", 0, 0, __FILE__, __LINE__, evalOnceErrorCode ); \
action; \
} \
} while (0)
#endif
#endif
/*
* __Verify_Action(assertion, action)
*
* Summary:
* Production builds: if the assertion expression evaluates to false,
* then execute the action statement or compound statement (block).
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE and then execute the action statement or compound
* statement (block).
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* action:
* The statement or compound statement (block).
*/
#ifndef __Verify_Action
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Verify_Action(assertion, action) \
if ( __builtin_expect(!(assertion), 0) ) { \
action; \
} \
else do {} while (0)
#else
#define __Verify_Action(assertion, action) \
if ( __builtin_expect(!(assertion), 0) ) { \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, 0, 0, __FILE__, __LINE__, 0 ); \
action; \
} \
else do {} while (0)
#endif
#endif
/*
* __Require(assertion, exceptionLabel)
*
* Summary:
* Production builds: if the assertion expression evaluates to false,
* goto exceptionLabel.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE and then goto exceptionLabel.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* exceptionLabel:
* The label.
*/
#ifndef __Require
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Require(assertion, exceptionLabel) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
goto exceptionLabel; \
} \
} while ( 0 )
#else
#define __Require(assertion, exceptionLabel) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) { \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, #exceptionLabel, 0, __FILE__, __LINE__, 0); \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#endif
#ifndef __nRequire
#define __nRequire(assertion, exceptionLabel) __Require(!(assertion), exceptionLabel)
#endif
/*
* __Require_Action(assertion, exceptionLabel, action)
*
* Summary:
* Production builds: if the assertion expression evaluates to false,
* execute the action statement or compound statement (block) and then
* goto exceptionLabel.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE, execute the action statement or compound
* statement (block), and then goto exceptionLabel.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* exceptionLabel:
* The label.
*
* action:
* The statement or compound statement (block).
*/
#ifndef __Require_Action
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Require_Action(assertion, exceptionLabel, action) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
{ \
action; \
} \
goto exceptionLabel; \
} \
} while ( 0 )
#else
#define __Require_Action(assertion, exceptionLabel, action) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, #exceptionLabel, 0, __FILE__, __LINE__, 0); \
{ \
action; \
} \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#endif
#ifndef __nRequire_Action
#define __nRequire_Action(assertion, exceptionLabel, action) \
__Require_Action(!(assertion), exceptionLabel, action)
#endif
/*
* __Require_Quiet(assertion, exceptionLabel)
*
* Summary:
* If the assertion expression evaluates to false, goto exceptionLabel.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* exceptionLabel:
* The label.
*/
#ifndef __Require_Quiet
#define __Require_Quiet(assertion, exceptionLabel) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#ifndef __nRequire_Quiet
#define __nRequire_Quiet(assertion, exceptionLabel) __Require_Quiet(!(assertion), exceptionLabel)
#endif
/*
* __Require_Action_Quiet(assertion, exceptionLabel, action)
*
* Summary:
* If the assertion expression evaluates to false, execute the action
* statement or compound statement (block), and goto exceptionLabel.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* exceptionLabel:
* The label.
*
* action:
* The statement or compound statement (block).
*/
#ifndef __Require_Action_Quiet
#define __Require_Action_Quiet(assertion, exceptionLabel, action) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
{ \
action; \
} \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#ifndef __nRequire_Action_Quiet
#define __nRequire_Action_Quiet(assertion, exceptionLabel, action) \
__Require_Action_Quiet(!(assertion), exceptionLabel, action)
#endif
/*
* __Require_String(assertion, exceptionLabel, message)
*
* Summary:
* Production builds: if the assertion expression evaluates to false,
* goto exceptionLabel.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE, and then goto exceptionLabel.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* exceptionLabel:
* The label.
*
* message:
* The C string to display.
*/
#ifndef __Require_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Require_String(assertion, exceptionLabel, message) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
goto exceptionLabel; \
} \
} while ( 0 )
#else
#define __Require_String(assertion, exceptionLabel, message) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, #exceptionLabel, message, __FILE__, __LINE__, 0); \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#endif
#ifndef __nRequire_String
#define __nRequire_String(assertion, exceptionLabel, string) \
__Require_String(!(assertion), exceptionLabel, string)
#endif
/*
* __Require_Action_String(assertion, exceptionLabel, action, message)
*
* Summary:
* Production builds: if the assertion expression evaluates to false,
* execute the action statement or compound statement (block), and then
* goto exceptionLabel.
*
* Non-production builds: if the assertion expression evaluates to false,
* call DEBUG_ASSERT_MESSAGE, execute the action statement or compound
* statement (block), and then goto exceptionLabel.
*
* Parameters:
*
* assertion:
* The assertion expression.
*
* exceptionLabel:
* The label.
*
* action:
* The statement or compound statement (block).
*
* message:
* The C string to display.
*/
#ifndef __Require_Action_String
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Require_Action_String(assertion, exceptionLabel, action, message) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
{ \
action; \
} \
goto exceptionLabel; \
} \
} while ( 0 )
#else
#define __Require_Action_String(assertion, exceptionLabel, action, message) \
do \
{ \
if ( __builtin_expect(!(assertion), 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#assertion, #exceptionLabel, message, __FILE__, __LINE__, 0); \
{ \
action; \
} \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#endif
#ifndef __nRequire_Action_String
#define __nRequire_Action_String(assertion, exceptionLabel, action, message) \
__Require_Action_String(!(assertion), exceptionLabel, action, message)
#endif
/*
* __Require_noErr(errorCode, exceptionLabel)
*
* Summary:
* Production builds: if the errorCode expression does not equal 0 (noErr),
* goto exceptionLabel.
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE and then goto exceptionLabel.
*
* Parameters:
*
* errorCode:
* The expression to compare to 0.
*
* exceptionLabel:
* The label.
*/
#ifndef __Require_noErr
#if DEBUG_ASSERT_PRODUCTION_CODE
#define __Require_noErr(errorCode, exceptionLabel) \
do \
{ \
if ( __builtin_expect(0 != (errorCode), 0) ) \
{ \
goto exceptionLabel; \
} \
} while ( 0 )
#else
#define __Require_noErr(errorCode, exceptionLabel) \
do \
{ \
long evalOnceErrorCode = (errorCode); \
if ( __builtin_expect(0 != evalOnceErrorCode, 0) ) \
{ \
DEBUG_ASSERT_MESSAGE( \
DEBUG_ASSERT_COMPONENT_NAME_STRING, \
#errorCode " == 0 ", #exceptionLabel, 0, __FILE__, __LINE__, evalOnceErrorCode); \
goto exceptionLabel; \
} \
} while ( 0 )
#endif
#endif
/*
* __Require_noErr_Action(errorCode, exceptionLabel, action)
*
* Summary:
* Production builds: if the errorCode expression does not equal 0 (noErr),
* execute the action statement or compound statement (block) and
* goto exceptionLabel.
*
* Non-production builds: if the errorCode expression does not equal 0 (noErr),
* call DEBUG_ASSERT_MESSAGE, execute the action statement or
* compound statement (block), and then goto exceptionLabel.
*
* Parameters:
*
* errorCode:
* The expression to compare to 0.
*
* exceptionLabel:
* The label.
*
* action: