 
                            ...
| Code Block | ||||
|---|---|---|---|---|
| 
 | ||||
| #define END_OF_FILE -1 /* ... */ if (getchar() EOFEND_OF_FILE) { /* ... */ } | 
In this example, the programmer has mistakenly omitted the comparison operator from the conditional statement, which should be getchar() != END_OF_FILE. (See void MSC02-C. Avoid errors of omission.) After macro expansion, the conditional expression is incorrectly evaluated as a binary operation: getchar()-1. This statement is syntactically correct, even though it is certainly not what the programmer intended. Note that this example also violates DCL00-C. Const-qualify immutable objects.
...
| Code Block | ||||
|---|---|---|---|---|
| 
 | ||||
| enum { END_OF_FILE = -1 };
/* ... */
if (getchar() != END_OF_FILE) {
   /* ... */
}
 | 
Exceptions
PRE02-C-EX1: A macro that expands to a single identifier or function call is not affected by the precedence of any operators in the surrounding expression, so its replacement list need not be parenthesized.
| Code Block | 
|---|
| #define MY_PID getpid() | 
PRE02-C-EX2: A macro that expands to an array reference using the array-subscript operator [], or an expression designating a member of a structure or union object using either the member-access . or -> operators is not affected by the precedence of any operators in the surrounding expression, so its replacement list need not be parenthesized.
| Code Block | 
|---|
| #define NEXT_FREE block->next_free #define CID customer_record.account.cid #define TOOFAR array[MAX_ARRAY_SIZE] | 
...
Failing to parenthesize macro replacement lists can cause unexpected results.
| Recommendation | Severity | Likelihood | 
|---|
| Detectable | Repairable | Priority | Level | 
|---|---|---|---|
| PRE02-C | Medium | Probable | Yes | 
| Yes | P12 | L1 | 
Automated Detection
| Tool | Version | Checker | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Axivion Bauhaus Suite | 
 | CertC-PRE02 | |||||||
| CodeSonar | 
 | LANG.PREPROC.MACROEND LANG.PREPROC.MACROSTART | Macro Does Not End With ) or } Macro Does Not Start With ( or { | ||||||
| 
 | CC2.PRE02 | Fully implemented | |||||||
| Helix QAC | 
 | C3409 | |||||||
| Klocwork | 
 | MISRA.DEFINE.BADEXP | |||||||
| LDRA tool suite | 
 | 77 | 
78
|  S | Fully implemented | 
| Parasoft C/C++test | 
 | CERT_C-PRE02-a | Enclose the entire definition of a function-like macro in parentheses | ||||||
| PC-lint Plus | 
 | 773, 973 | Fully supported | 
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Related Guidelines
| SEI CERT C++ | 
| Coding Standard | VOID PRE02-CPP. Macro replacement lists should be parenthesized | 
| ISO/IEC TR 24772:2013 | Operator Precedence/Order of Evaluation [JCW] Pre-processor Directives [NMP] | 
Bibliography
| [Plum 1985] | Rule 1-1 | 
| [Summit 2005] | Question 10.1 | 
...
...