Bring gcc-4.4.0 to up-to-date.
[asac-android-toolchain:gcc-linaro.git] / gcc-4.4.0 / gcc / doc / cpp.texi
1 \input texinfo
2 @setfilename cpp.info
3 @settitle The C Preprocessor
4 @setchapternewpage off
5 @c @smallbook
6 @c @cropmarks
7 @c @finalout
8
9 @include gcc-common.texi
10
11 @copying
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1987, 1989, 1991, 1992, 1993, 1994, 1995, 1996,
14 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
15 Free Software Foundation, Inc.
16
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation.  A copy of
20 the license is included in the
21 @c man end
22 section entitled ``GNU Free Documentation License''.
23 @ignore
24 @c man begin COPYRIGHT
25 man page gfdl(7).
26 @c man end
27 @end ignore
28
29 @c man begin COPYRIGHT
30 This manual contains no Invariant Sections.  The Front-Cover Texts are
31 (a) (see below), and the Back-Cover Texts are (b) (see below).
32
33 (a) The FSF's Front-Cover Text is:
34
35      A GNU Manual
36
37 (b) The FSF's Back-Cover Text is:
38
39      You have freedom to copy and modify this GNU Manual, like GNU
40      software.  Copies published by the Free Software Foundation raise
41      funds for GNU development.
42 @c man end
43 @end copying
44
45 @c Create a separate index for command line options.
46 @defcodeindex op
47 @syncodeindex vr op
48
49 @c Used in cppopts.texi and cppenv.texi.
50 @set cppmanual
51
52 @ifinfo
53 @dircategory Software development
54 @direntry
55 * Cpp: (cpp).                  The GNU C preprocessor.
56 @end direntry
57 @end ifinfo
58
59 @titlepage
60 @title The C Preprocessor
61 @versionsubtitle
62 @author Richard M. Stallman, Zachary Weinberg
63 @page
64 @c There is a fill at the bottom of the page, so we need a filll to
65 @c override it.
66 @vskip 0pt plus 1filll
67 @insertcopying
68 @end titlepage
69 @contents
70 @page
71
72 @ifnottex
73 @node Top
74 @top
75 The C preprocessor implements the macro language used to transform C,
76 C++, and Objective-C programs before they are compiled.  It can also be
77 useful on its own.
78
79 @menu
80 * Overview::
81 * Header Files::
82 * Macros::
83 * Conditionals::
84 * Diagnostics::
85 * Line Control::
86 * Pragmas::
87 * Other Directives::
88 * Preprocessor Output::
89 * Traditional Mode::
90 * Implementation Details::
91 * Invocation::
92 * Environment Variables::
93 * GNU Free Documentation License::
94 * Index of Directives::
95 * Option Index::
96 * Concept Index::
97
98 @detailmenu
99  --- The Detailed Node Listing ---
100
101 Overview
102
103 * Character sets::
104 * Initial processing::
105 * Tokenization::
106 * The preprocessing language::
107
108 Header Files
109
110 * Include Syntax::
111 * Include Operation::
112 * Search Path::
113 * Once-Only Headers::
114 * Alternatives to Wrapper #ifndef::
115 * Computed Includes::
116 * Wrapper Headers::
117 * System Headers::
118
119 Macros
120
121 * Object-like Macros::
122 * Function-like Macros::
123 * Macro Arguments::
124 * Stringification::
125 * Concatenation::
126 * Variadic Macros::
127 * Predefined Macros::
128 * Undefining and Redefining Macros::
129 * Directives Within Macro Arguments::
130 * Macro Pitfalls::
131
132 Predefined Macros
133
134 * Standard Predefined Macros::
135 * Common Predefined Macros::
136 * System-specific Predefined Macros::
137 * C++ Named Operators::
138
139 Macro Pitfalls
140
141 * Misnesting::
142 * Operator Precedence Problems::
143 * Swallowing the Semicolon::
144 * Duplication of Side Effects::
145 * Self-Referential Macros::
146 * Argument Prescan::
147 * Newlines in Arguments::
148
149 Conditionals
150
151 * Conditional Uses::
152 * Conditional Syntax::
153 * Deleted Code::
154
155 Conditional Syntax
156
157 * Ifdef::
158 * If::
159 * Defined::
160 * Else::
161 * Elif::
162
163 Implementation Details
164
165 * Implementation-defined behavior::
166 * Implementation limits::
167 * Obsolete Features::
168 * Differences from previous versions::
169
170 Obsolete Features
171
172 * Obsolete Features::
173
174 @end detailmenu
175 @end menu
176
177 @insertcopying
178 @end ifnottex
179
180 @node Overview
181 @chapter Overview
182 @c man begin DESCRIPTION
183 The C preprocessor, often known as @dfn{cpp}, is a @dfn{macro processor}
184 that is used automatically by the C compiler to transform your program
185 before compilation.  It is called a macro processor because it allows
186 you to define @dfn{macros}, which are brief abbreviations for longer
187 constructs.
188
189 The C preprocessor is intended to be used only with C, C++, and
190 Objective-C source code.  In the past, it has been abused as a general
191 text processor.  It will choke on input which does not obey C's lexical
192 rules.  For example, apostrophes will be interpreted as the beginning of
193 character constants, and cause errors.  Also, you cannot rely on it
194 preserving characteristics of the input which are not significant to
195 C-family languages.  If a Makefile is preprocessed, all the hard tabs
196 will be removed, and the Makefile will not work.
197
198 Having said that, you can often get away with using cpp on things which
199 are not C@.  Other Algol-ish programming languages are often safe
200 (Pascal, Ada, etc.) So is assembly, with caution.  @option{-traditional-cpp}
201 mode preserves more white space, and is otherwise more permissive.  Many
202 of the problems can be avoided by writing C or C++ style comments
203 instead of native language comments, and keeping macros simple.
204
205 Wherever possible, you should use a preprocessor geared to the language
206 you are writing in.  Modern versions of the GNU assembler have macro
207 facilities.  Most high level programming languages have their own
208 conditional compilation and inclusion mechanism.  If all else fails,
209 try a true general text processor, such as GNU M4.
210
211 C preprocessors vary in some details.  This manual discusses the GNU C
212 preprocessor, which provides a small superset of the features of ISO
213 Standard C@.  In its default mode, the GNU C preprocessor does not do a
214 few things required by the standard.  These are features which are
215 rarely, if ever, used, and may cause surprising changes to the meaning
216 of a program which does not expect them.  To get strict ISO Standard C,
217 you should use the @option{-std=c89} or @option{-std=c99} options, depending
218 on which version of the standard you want.  To get all the mandatory
219 diagnostics, you must also use @option{-pedantic}.  @xref{Invocation}.
220
221 This manual describes the behavior of the ISO preprocessor.  To
222 minimize gratuitous differences, where the ISO preprocessor's
223 behavior does not conflict with traditional semantics, the
224 traditional preprocessor should behave the same way.  The various
225 differences that do exist are detailed in the section @ref{Traditional
226 Mode}.
227
228 For clarity, unless noted otherwise, references to @samp{CPP} in this
229 manual refer to GNU CPP@.
230 @c man end
231
232 @menu
233 * Character sets::
234 * Initial processing::
235 * Tokenization::
236 * The preprocessing language::
237 @end menu
238
239 @node Character sets
240 @section Character sets
241
242 Source code character set processing in C and related languages is
243 rather complicated.  The C standard discusses two character sets, but
244 there are really at least four.
245
246 The files input to CPP might be in any character set at all.  CPP's
247 very first action, before it even looks for line boundaries, is to
248 convert the file into the character set it uses for internal
249 processing.  That set is what the C standard calls the @dfn{source}
250 character set.  It must be isomorphic with ISO 10646, also known as
251 Unicode.  CPP uses the UTF-8 encoding of Unicode.
252
253 The character sets of the input files are specified using the
254 @option{-finput-charset=} option.
255
256 All preprocessing work (the subject of the rest of this manual) is
257 carried out in the source character set.  If you request textual
258 output from the preprocessor with the @option{-E} option, it will be
259 in UTF-8.
260
261 After preprocessing is complete, string and character constants are
262 converted again, into the @dfn{execution} character set.  This
263 character set is under control of the user; the default is UTF-8,
264 matching the source character set.  Wide string and character
265 constants have their own character set, which is not called out
266 specifically in the standard.  Again, it is under control of the user.
267 The default is UTF-16 or UTF-32, whichever fits in the target's
268 @code{wchar_t} type, in the target machine's byte
269 order.@footnote{UTF-16 does not meet the requirements of the C
270 standard for a wide character set, but the choice of 16-bit
271 @code{wchar_t} is enshrined in some system ABIs so we cannot fix
272 this.}  Octal and hexadecimal escape sequences do not undergo
273 conversion; @t{'\x12'} has the value 0x12 regardless of the currently
274 selected execution character set.  All other escapes are replaced by
275 the character in the source character set that they represent, then
276 converted to the execution character set, just like unescaped
277 characters.
278
279 Unless the experimental @option{-fextended-identifiers} option is used,
280 GCC does not permit the use of characters outside the ASCII range, nor
281 @samp{\u} and @samp{\U} escapes, in identifiers.  Even with that
282 option, characters outside the ASCII range can only be specified with
283 the @samp{\u} and @samp{\U} escapes, not used directly in identifiers.
284
285 @node Initial processing
286 @section Initial processing
287
288 The preprocessor performs a series of textual transformations on its
289 input.  These happen before all other processing.  Conceptually, they
290 happen in a rigid order, and the entire file is run through each
291 transformation before the next one begins.  CPP actually does them
292 all at once, for performance reasons.  These transformations correspond
293 roughly to the first three ``phases of translation'' described in the C
294 standard.
295
296 @enumerate
297 @item
298 @cindex line endings
299 The input file is read into memory and broken into lines.
300
301 Different systems use different conventions to indicate the end of a
302 line.  GCC accepts the ASCII control sequences @kbd{LF}, @kbd{@w{CR
303 LF}} and @kbd{CR} as end-of-line markers.  These are the canonical
304 sequences used by Unix, DOS and VMS, and the classic Mac OS (before
305 OSX) respectively.  You may therefore safely copy source code written
306 on any of those systems to a different one and use it without
307 conversion.  (GCC may lose track of the current line number if a file
308 doesn't consistently use one convention, as sometimes happens when it
309 is edited on computers with different conventions that share a network
310 file system.)
311
312 If the last line of any input file lacks an end-of-line marker, the end
313 of the file is considered to implicitly supply one.  The C standard says
314 that this condition provokes undefined behavior, so GCC will emit a
315 warning message.
316
317 @item
318 @cindex trigraphs
319 @anchor{trigraphs}If trigraphs are enabled, they are replaced by their
320 corresponding single characters.  By default GCC ignores trigraphs,
321 but if you request a strictly conforming mode with the @option{-std}
322 option, or you specify the @option{-trigraphs} option, then it
323 converts them.
324
325 These are nine three-character sequences, all starting with @samp{??},
326 that are defined by ISO C to stand for single characters.  They permit
327 obsolete systems that lack some of C's punctuation to use C@.  For
328 example, @samp{??/} stands for @samp{\}, so @t{'??/n'} is a character
329 constant for a newline.
330
331 Trigraphs are not popular and many compilers implement them
332 incorrectly.  Portable code should not rely on trigraphs being either
333 converted or ignored.  With @option{-Wtrigraphs} GCC will warn you
334 when a trigraph may change the meaning of your program if it were
335 converted.  @xref{Wtrigraphs}.
336
337 In a string constant, you can prevent a sequence of question marks
338 from being confused with a trigraph by inserting a backslash between
339 the question marks, or by separating the string literal at the
340 trigraph and making use of string literal concatenation.  @t{"(??\?)"}
341 is the string @samp{(???)}, not @samp{(?]}.  Traditional C compilers
342 do not recognize these idioms.
343
344 The nine trigraphs and their replacements are
345
346 @smallexample
347 Trigraph:       ??(  ??)  ??<  ??>  ??=  ??/  ??'  ??!  ??-
348 Replacement:      [    ]    @{    @}    #    \    ^    |    ~
349 @end smallexample
350
351 @item
352 @cindex continued lines
353 @cindex backslash-newline
354 Continued lines are merged into one long line.
355
356 A continued line is a line which ends with a backslash, @samp{\}.  The
357 backslash is removed and the following line is joined with the current
358 one.  No space is inserted, so you may split a line anywhere, even in
359 the middle of a word.  (It is generally more readable to split lines
360 only at white space.)
361
362 The trailing backslash on a continued line is commonly referred to as a
363 @dfn{backslash-newline}.
364
365 If there is white space between a backslash and the end of a line, that
366 is still a continued line.  However, as this is usually the result of an
367 editing mistake, and many compilers will not accept it as a continued
368 line, GCC will warn you about it.
369
370 @item
371 @cindex comments
372 @cindex line comments
373 @cindex block comments
374 All comments are replaced with single spaces.
375
376 There are two kinds of comments.  @dfn{Block comments} begin with
377 @samp{/*} and continue until the next @samp{*/}.  Block comments do not
378 nest:
379
380 @smallexample
381 /* @r{this is} /* @r{one comment} */ @r{text outside comment}
382 @end smallexample
383
384 @dfn{Line comments} begin with @samp{//} and continue to the end of the
385 current line.  Line comments do not nest either, but it does not matter,
386 because they would end in the same place anyway.
387
388 @smallexample
389 // @r{this is} // @r{one comment}
390 @r{text outside comment}
391 @end smallexample
392 @end enumerate
393
394 It is safe to put line comments inside block comments, or vice versa.
395
396 @smallexample
397 @group
398 /* @r{block comment}
399    // @r{contains line comment}
400    @r{yet more comment}
401  */ @r{outside comment}
402
403 // @r{line comment} /* @r{contains block comment} */
404 @end group
405 @end smallexample
406
407 But beware of commenting out one end of a block comment with a line
408 comment.
409
410 @smallexample
411 @group
412  // @r{l.c.}  /* @r{block comment begins}
413     @r{oops! this isn't a comment anymore} */
414 @end group
415 @end smallexample
416
417 Comments are not recognized within string literals.
418 @t{@w{"/* blah */"}} is the string constant @samp{@w{/* blah */}}, not
419 an empty string.
420
421 Line comments are not in the 1989 edition of the C standard, but they
422 are recognized by GCC as an extension.  In C++ and in the 1999 edition
423 of the C standard, they are an official part of the language.
424
425 Since these transformations happen before all other processing, you can
426 split a line mechanically with backslash-newline anywhere.  You can
427 comment out the end of a line.  You can continue a line comment onto the
428 next line with backslash-newline.  You can even split @samp{/*},
429 @samp{*/}, and @samp{//} onto multiple lines with backslash-newline.
430 For example:
431
432 @smallexample
433 @group
434 /\
435 *
436 */ # /*
437 */ defi\
438 ne FO\
439 O 10\
440 20
441 @end group
442 @end smallexample
443
444 @noindent
445 is equivalent to @code{@w{#define FOO 1020}}.  All these tricks are
446 extremely confusing and should not be used in code intended to be
447 readable.
448
449 There is no way to prevent a backslash at the end of a line from being
450 interpreted as a backslash-newline.  This cannot affect any correct
451 program, however.
452
453 @node Tokenization
454 @section Tokenization
455
456 @cindex tokens
457 @cindex preprocessing tokens
458 After the textual transformations are finished, the input file is
459 converted into a sequence of @dfn{preprocessing tokens}.  These mostly
460 correspond to the syntactic tokens used by the C compiler, but there are
461 a few differences.  White space separates tokens; it is not itself a
462 token of any kind.  Tokens do not have to be separated by white space,
463 but it is often necessary to avoid ambiguities.
464
465 When faced with a sequence of characters that has more than one possible
466 tokenization, the preprocessor is greedy.  It always makes each token,
467 starting from the left, as big as possible before moving on to the next
468 token.  For instance, @code{a+++++b} is interpreted as
469 @code{@w{a ++ ++ + b}}, not as @code{@w{a ++ + ++ b}}, even though the
470 latter tokenization could be part of a valid C program and the former
471 could not.
472
473 Once the input file is broken into tokens, the token boundaries never
474 change, except when the @samp{##} preprocessing operator is used to paste
475 tokens together.  @xref{Concatenation}.  For example,
476
477 @smallexample
478 @group
479 #define foo() bar
480 foo()baz
481      @expansion{} bar baz
482 @emph{not}
483      @expansion{} barbaz
484 @end group
485 @end smallexample
486
487 The compiler does not re-tokenize the preprocessor's output.  Each
488 preprocessing token becomes one compiler token.
489
490 @cindex identifiers
491 Preprocessing tokens fall into five broad classes: identifiers,
492 preprocessing numbers, string literals, punctuators, and other.  An
493 @dfn{identifier} is the same as an identifier in C: any sequence of
494 letters, digits, or underscores, which begins with a letter or
495 underscore.  Keywords of C have no significance to the preprocessor;
496 they are ordinary identifiers.  You can define a macro whose name is a
497 keyword, for instance.  The only identifier which can be considered a
498 preprocessing keyword is @code{defined}.  @xref{Defined}.
499
500 This is mostly true of other languages which use the C preprocessor.
501 However, a few of the keywords of C++ are significant even in the
502 preprocessor.  @xref{C++ Named Operators}.
503
504 In the 1999 C standard, identifiers may contain letters which are not
505 part of the ``basic source character set'', at the implementation's
506 discretion (such as accented Latin letters, Greek letters, or Chinese
507 ideograms).  This may be done with an extended character set, or the
508 @samp{\u} and @samp{\U} escape sequences.  The implementation of this
509 feature in GCC is experimental; such characters are only accepted in
510 the @samp{\u} and @samp{\U} forms and only if
511 @option{-fextended-identifiers} is used.
512
513 As an extension, GCC treats @samp{$} as a letter.  This is for
514 compatibility with some systems, such as VMS, where @samp{$} is commonly
515 used in system-defined function and object names.  @samp{$} is not a
516 letter in strictly conforming mode, or if you specify the @option{-$}
517 option.  @xref{Invocation}.
518
519 @cindex numbers
520 @cindex preprocessing numbers
521 A @dfn{preprocessing number} has a rather bizarre definition.  The
522 category includes all the normal integer and floating point constants
523 one expects of C, but also a number of other things one might not
524 initially recognize as a number.  Formally, preprocessing numbers begin
525 with an optional period, a required decimal digit, and then continue
526 with any sequence of letters, digits, underscores, periods, and
527 exponents.  Exponents are the two-character sequences @samp{e+},
528 @samp{e-}, @samp{E+}, @samp{E-}, @samp{p+}, @samp{p-}, @samp{P+}, and
529 @samp{P-}.  (The exponents that begin with @samp{p} or @samp{P} are new
530 to C99.  They are used for hexadecimal floating-point constants.)
531
532 The purpose of this unusual definition is to isolate the preprocessor
533 from the full complexity of numeric constants.  It does not have to
534 distinguish between lexically valid and invalid floating-point numbers,
535 which is complicated.  The definition also permits you to split an
536 identifier at any position and get exactly two tokens, which can then be
537 pasted back together with the @samp{##} operator.
538
539 It's possible for preprocessing numbers to cause programs to be
540 misinterpreted.  For example, @code{0xE+12} is a preprocessing number
541 which does not translate to any valid numeric constant, therefore a
542 syntax error.  It does not mean @code{@w{0xE + 12}}, which is what you
543 might have intended.
544
545 @cindex string literals
546 @cindex string constants
547 @cindex character constants
548 @cindex header file names
549 @c the @: prevents makeinfo from turning '' into ".
550 @dfn{String literals} are string constants, character constants, and
551 header file names (the argument of @samp{#include}).@footnote{The C
552 standard uses the term @dfn{string literal} to refer only to what we are
553 calling @dfn{string constants}.}  String constants and character
554 constants are straightforward: @t{"@dots{}"} or @t{'@dots{}'}.  In
555 either case embedded quotes should be escaped with a backslash:
556 @t{'\'@:'} is the character constant for @samp{'}.  There is no limit on
557 the length of a character constant, but the value of a character
558 constant that contains more than one character is
559 implementation-defined.  @xref{Implementation Details}.
560
561 Header file names either look like string constants, @t{"@dots{}"}, or are
562 written with angle brackets instead, @t{<@dots{}>}.  In either case,
563 backslash is an ordinary character.  There is no way to escape the
564 closing quote or angle bracket.  The preprocessor looks for the header
565 file in different places depending on which form you use.  @xref{Include
566 Operation}.
567
568 No string literal may extend past the end of a line.  Older versions
569 of GCC accepted multi-line string constants.  You may use continued
570 lines instead, or string constant concatenation.  @xref{Differences
571 from previous versions}.
572
573 @cindex punctuators
574 @cindex digraphs
575 @cindex alternative tokens
576 @dfn{Punctuators} are all the usual bits of punctuation which are
577 meaningful to C and C++.  All but three of the punctuation characters in
578 ASCII are C punctuators.  The exceptions are @samp{@@}, @samp{$}, and
579 @samp{`}.  In addition, all the two- and three-character operators are
580 punctuators.  There are also six @dfn{digraphs}, which the C++ standard
581 calls @dfn{alternative tokens}, which are merely alternate ways to spell
582 other punctuators.  This is a second attempt to work around missing
583 punctuation in obsolete systems.  It has no negative side effects,
584 unlike trigraphs, but does not cover as much ground.  The digraphs and
585 their corresponding normal punctuators are:
586
587 @smallexample
588 Digraph:        <%  %>  <:  :>  %:  %:%:
589 Punctuator:      @{   @}   [   ]   #    ##
590 @end smallexample
591
592 @cindex other tokens
593 Any other single character is considered ``other''.  It is passed on to
594 the preprocessor's output unmolested.  The C compiler will almost
595 certainly reject source code containing ``other'' tokens.  In ASCII, the
596 only other characters are @samp{@@}, @samp{$}, @samp{`}, and control
597 characters other than NUL (all bits zero).  (Note that @samp{$} is
598 normally considered a letter.)  All characters with the high bit set
599 (numeric range 0x7F--0xFF) are also ``other'' in the present
600 implementation.  This will change when proper support for international
601 character sets is added to GCC@.
602
603 NUL is a special case because of the high probability that its
604 appearance is accidental, and because it may be invisible to the user
605 (many terminals do not display NUL at all).  Within comments, NULs are
606 silently ignored, just as any other character would be.  In running
607 text, NUL is considered white space.  For example, these two directives
608 have the same meaning.
609
610 @smallexample
611 #define X^@@1
612 #define X 1
613 @end smallexample
614
615 @noindent
616 (where @samp{^@@} is ASCII NUL)@.  Within string or character constants,
617 NULs are preserved.  In the latter two cases the preprocessor emits a
618 warning message.
619
620 @node The preprocessing language
621 @section The preprocessing language
622 @cindex directives
623 @cindex preprocessing directives
624 @cindex directive line
625 @cindex directive name
626
627 After tokenization, the stream of tokens may simply be passed straight
628 to the compiler's parser.  However, if it contains any operations in the
629 @dfn{preprocessing language}, it will be transformed first.  This stage
630 corresponds roughly to the standard's ``translation phase 4'' and is
631 what most people think of as the preprocessor's job.
632
633 The preprocessing language consists of @dfn{directives} to be executed
634 and @dfn{macros} to be expanded.  Its primary capabilities are:
635
636 @itemize @bullet
637 @item
638 Inclusion of header files.  These are files of declarations that can be
639 substituted into your program.
640
641 @item
642 Macro expansion.  You can define @dfn{macros}, which are abbreviations
643 for arbitrary fragments of C code.  The preprocessor will replace the
644 macros with their definitions throughout the program.  Some macros are
645 automatically defined for you.
646
647 @item
648 Conditional compilation.  You can include or exclude parts of the
649 program according to various conditions.
650
651 @item
652 Line control.  If you use a program to combine or rearrange source files
653 into an intermediate file which is then compiled, you can use line
654 control to inform the compiler where each source line originally came
655 from.
656
657 @item
658 Diagnostics.  You can detect problems at compile time and issue errors
659 or warnings.
660 @end itemize
661
662 There are a few more, less useful, features.
663
664 Except for expansion of predefined macros, all these operations are
665 triggered with @dfn{preprocessing directives}.  Preprocessing directives
666 are lines in your program that start with @samp{#}.  Whitespace is
667 allowed before and after the @samp{#}.  The @samp{#} is followed by an
668 identifier, the @dfn{directive name}.  It specifies the operation to
669 perform.  Directives are commonly referred to as @samp{#@var{name}}
670 where @var{name} is the directive name.  For example, @samp{#define} is
671 the directive that defines a macro.
672
673 The @samp{#} which begins a directive cannot come from a macro
674 expansion.  Also, the directive name is not macro expanded.  Thus, if
675 @code{foo} is defined as a macro expanding to @code{define}, that does
676 not make @samp{#foo} a valid preprocessing directive.
677
678 The set of valid directive names is fixed.  Programs cannot define new
679 preprocessing directives.
680
681 Some directives require arguments; these make up the rest of the
682 directive line and must be separated from the directive name by
683 whitespace.  For example, @samp{#define} must be followed by a macro
684 name and the intended expansion of the macro.
685
686 A preprocessing directive cannot cover more than one line.  The line
687 may, however, be continued with backslash-newline, or by a block comment
688 which extends past the end of the line.  In either case, when the
689 directive is processed, the continuations have already been merged with
690 the first line to make one long line.
691
692 @node Header Files
693 @chapter Header Files
694
695 @cindex header file
696 A header file is a file containing C declarations and macro definitions
697 (@pxref{Macros}) to be shared between several source files.  You request
698 the use of a header file in your program by @dfn{including} it, with the
699 C preprocessing directive @samp{#include}.
700
701 Header files serve two purposes.
702
703 @itemize @bullet
704 @item
705 @cindex system header files
706 System header files declare the interfaces to parts of the operating
707 system.  You include them in your program to supply the definitions and
708 declarations you need to invoke system calls and libraries.
709
710 @item
711 Your own header files contain declarations for interfaces between the
712 source files of your program.  Each time you have a group of related
713 declarations and macro definitions all or most of which are needed in
714 several different source files, it is a good idea to create a header
715 file for them.
716 @end itemize
717
718 Including a header file produces the same results as copying the header
719 file into each source file that needs it.  Such copying would be
720 time-consuming and error-prone.  With a header file, the related
721 declarations appear in only one place.  If they need to be changed, they
722 can be changed in one place, and programs that include the header file
723 will automatically use the new version when next recompiled.  The header
724 file eliminates the labor of finding and changing all the copies as well
725 as the risk that a failure to find one copy will result in
726 inconsistencies within a program.
727
728 In C, the usual convention is to give header files names that end with
729 @file{.h}.  It is most portable to use only letters, digits, dashes, and
730 underscores in header file names, and at most one dot.
731
732 @menu
733 * Include Syntax::
734 * Include Operation::
735 * Search Path::
736 * Once-Only Headers::
737 * Alternatives to Wrapper #ifndef::
738 * Computed Includes::
739 * Wrapper Headers::
740 * System Headers::
741 @end menu
742
743 @node Include Syntax
744 @section Include Syntax
745
746 @findex #include
747 Both user and system header files are included using the preprocessing
748 directive @samp{#include}.  It has two variants:
749
750 @table @code
751 @item #include <@var{file}>
752 This variant is used for system header files.  It searches for a file
753 named @var{file} in a standard list of system directories.  You can prepend
754 directories to this list with the @option{-I} option (@pxref{Invocation}).
755
756 @item #include "@var{file}"
757 This variant is used for header files of your own program.  It
758 searches for a file named @var{file} first in the directory containing
759 the current file, then in the quote directories and then the same
760 directories used for @code{<@var{file}>}.  You can prepend directories
761 to the list of quote directories with the @option{-iquote} option.
762 @end table
763
764 The argument of @samp{#include}, whether delimited with quote marks or
765 angle brackets, behaves like a string constant in that comments are not
766 recognized, and macro names are not expanded.  Thus, @code{@w{#include
767 <x/*y>}} specifies inclusion of a system header file named @file{x/*y}.
768
769 However, if backslashes occur within @var{file}, they are considered
770 ordinary text characters, not escape characters.  None of the character
771 escape sequences appropriate to string constants in C are processed.
772 Thus, @code{@w{#include "x\n\\y"}} specifies a filename containing three
773 backslashes.  (Some systems interpret @samp{\} as a pathname separator.
774 All of these also interpret @samp{/} the same way.  It is most portable
775 to use only @samp{/}.)
776
777 It is an error if there is anything (other than comments) on the line
778 after the file name.
779
780 @node Include Operation
781 @section Include Operation
782
783 The @samp{#include} directive works by directing the C preprocessor to
784 scan the specified file as input before continuing with the rest of the
785 current file.  The output from the preprocessor contains the output
786 already generated, followed by the output resulting from the included
787 file, followed by the output that comes from the text after the
788 @samp{#include} directive.  For example, if you have a header file
789 @file{header.h} as follows,
790
791 @smallexample
792 char *test (void);
793 @end smallexample
794
795 @noindent
796 and a main program called @file{program.c} that uses the header file,
797 like this,
798
799 @smallexample
800 int x;
801 #include "header.h"
802
803 int
804 main (void)
805 @{
806   puts (test ());
807 @}
808 @end smallexample
809
810 @noindent
811 the compiler will see the same token stream as it would if
812 @file{program.c} read
813
814 @smallexample
815 int x;
816 char *test (void);
817
818 int
819 main (void)
820 @{
821   puts (test ());
822 @}
823 @end smallexample
824
825 Included files are not limited to declarations and macro definitions;
826 those are merely the typical uses.  Any fragment of a C program can be
827 included from another file.  The include file could even contain the
828 beginning of a statement that is concluded in the containing file, or
829 the end of a statement that was started in the including file.  However,
830 an included file must consist of complete tokens.  Comments and string
831 literals which have not been closed by the end of an included file are
832 invalid.  For error recovery, they are considered to end at the end of
833 the file.
834
835 To avoid confusion, it is best if header files contain only complete
836 syntactic units---function declarations or definitions, type
837 declarations, etc.
838
839 The line following the @samp{#include} directive is always treated as a
840 separate line by the C preprocessor, even if the included file lacks a
841 final newline.
842
843 @node Search Path
844 @section Search Path
845
846 GCC looks in several different places for headers.  On a normal Unix
847 system, if you do not instruct it otherwise, it will look for headers
848 requested with @code{@w{#include <@var{file}>}} in:
849
850 @smallexample
851 /usr/local/include
852 @var{libdir}/gcc/@var{target}/@var{version}/include
853 /usr/@var{target}/include
854 /usr/include
855 @end smallexample
856
857 For C++ programs, it will also look in @file{/usr/include/g++-v3},
858 first.  In the above, @var{target} is the canonical name of the system
859 GCC was configured to compile code for; often but not always the same as
860 the canonical name of the system it runs on.  @var{version} is the
861 version of GCC in use.
862
863 You can add to this list with the @option{-I@var{dir}} command line
864 option.  All the directories named by @option{-I} are searched, in
865 left-to-right order, @emph{before} the default directories.  The only
866 exception is when @file{dir} is already searched by default.  In
867 this case, the option is ignored and the search order for system
868 directories remains unchanged.
869
870 Duplicate directories are removed from the quote and bracket search
871 chains before the two chains are merged to make the final search chain.
872 Thus, it is possible for a directory to occur twice in the final search
873 chain if it was specified in both the quote and bracket chains.
874
875 You can prevent GCC from searching any of the default directories with
876 the @option{-nostdinc} option.  This is useful when you are compiling an
877 operating system kernel or some other program that does not use the
878 standard C library facilities, or the standard C library itself.
879 @option{-I} options are not ignored as described above when
880 @option{-nostdinc} is in effect.
881
882 GCC looks for headers requested with @code{@w{#include "@var{file}"}}
883 first in the directory containing the current file, then in the
884 directories as specified by @option{-iquote} options, then in the same
885 places it would have looked for a header requested with angle
886 brackets.  For example, if @file{/usr/include/sys/stat.h} contains
887 @code{@w{#include "types.h"}}, GCC looks for @file{types.h} first in
888 @file{/usr/include/sys}, then in its usual search path.
889
890 @samp{#line} (@pxref{Line Control}) does not change GCC's idea of the
891 directory containing the current file.
892
893 You may put @option{-I-} at any point in your list of @option{-I} options.
894 This has two effects.  First, directories appearing before the
895 @option{-I-} in the list are searched only for headers requested with
896 quote marks.  Directories after @option{-I-} are searched for all
897 headers.  Second, the directory containing the current file is not
898 searched for anything, unless it happens to be one of the directories
899 named by an @option{-I} switch.  @option{-I-} is deprecated, @option{-iquote}
900 should be used instead.
901
902 @option{-I. -I-} is not the same as no @option{-I} options at all, and does
903 not cause the same behavior for @samp{<>} includes that @samp{""}
904 includes get with no special options.  @option{-I.} searches the
905 compiler's current working directory for header files.  That may or may
906 not be the same as the directory containing the current file.
907
908 If you need to look for headers in a directory named @file{-}, write
909 @option{-I./-}.
910
911 There are several more ways to adjust the header search path.  They are
912 generally less useful.  @xref{Invocation}.
913
914 @node Once-Only Headers
915 @section Once-Only Headers
916 @cindex repeated inclusion
917 @cindex including just once
918 @cindex wrapper @code{#ifndef}
919
920 If a header file happens to be included twice, the compiler will process
921 its contents twice.  This is very likely to cause an error, e.g.@: when the
922 compiler sees the same structure definition twice.  Even if it does not,
923 it will certainly waste time.
924
925 The standard way to prevent this is to enclose the entire real contents
926 of the file in a conditional, like this:
927
928 @smallexample
929 @group
930 /* File foo.  */
931 #ifndef FILE_FOO_SEEN
932 #define FILE_FOO_SEEN
933
934 @var{the entire file}
935
936 #endif /* !FILE_FOO_SEEN */
937 @end group
938 @end smallexample
939
940 This construct is commonly known as a @dfn{wrapper #ifndef}.
941 When the header is included again, the conditional will be false,
942 because @code{FILE_FOO_SEEN} is defined.  The preprocessor will skip
943 over the entire contents of the file, and the compiler will not see it
944 twice.
945
946 CPP optimizes even further.  It remembers when a header file has a
947 wrapper @samp{#ifndef}.  If a subsequent @samp{#include} specifies that
948 header, and the macro in the @samp{#ifndef} is still defined, it does
949 not bother to rescan the file at all.
950
951 You can put comments outside the wrapper.  They will not interfere with
952 this optimization.
953
954 @cindex controlling macro
955 @cindex guard macro
956 The macro @code{FILE_FOO_SEEN} is called the @dfn{controlling macro} or
957 @dfn{guard macro}.  In a user header file, the macro name should not
958 begin with @samp{_}.  In a system header file, it should begin with
959 @samp{__} to avoid conflicts with user programs.  In any kind of header
960 file, the macro name should contain the name of the file and some
961 additional text, to avoid conflicts with other header files.
962
963 @node Alternatives to Wrapper #ifndef
964 @section Alternatives to Wrapper #ifndef
965
966 CPP supports two more ways of indicating that a header file should be
967 read only once.  Neither one is as portable as a wrapper @samp{#ifndef}
968 and we recommend you do not use them in new programs, with the caveat
969 that @samp{#import} is standard practice in Objective-C.
970
971 @findex #import
972 CPP supports a variant of @samp{#include} called @samp{#import} which
973 includes a file, but does so at most once.  If you use @samp{#import}
974 instead of @samp{#include}, then you don't need the conditionals
975 inside the header file to prevent multiple inclusion of the contents.
976 @samp{#import} is standard in Objective-C, but is considered a
977 deprecated extension in C and C++.
978
979 @samp{#import} is not a well designed feature.  It requires the users of
980 a header file to know that it should only be included once.  It is much
981 better for the header file's implementor to write the file so that users
982 don't need to know this.  Using a wrapper @samp{#ifndef} accomplishes
983 this goal.
984
985 In the present implementation, a single use of @samp{#import} will
986 prevent the file from ever being read again, by either @samp{#import} or
987 @samp{#include}.  You should not rely on this; do not use both
988 @samp{#import} and @samp{#include} to refer to the same header file.
989
990 Another way to prevent a header file from being included more than once
991 is with the @samp{#pragma once} directive.  If @samp{#pragma once} is
992 seen when scanning a header file, that file will never be read again, no
993 matter what.
994
995 @samp{#pragma once} does not have the problems that @samp{#import} does,
996 but it is not recognized by all preprocessors, so you cannot rely on it
997 in a portable program.
998
999 @node Computed Includes
1000 @section Computed Includes
1001 @cindex computed includes
1002 @cindex macros in include
1003
1004 Sometimes it is necessary to select one of several different header
1005 files to be included into your program.  They might specify
1006 configuration parameters to be used on different sorts of operating
1007 systems, for instance.  You could do this with a series of conditionals,
1008
1009 @smallexample
1010 #if SYSTEM_1
1011 # include "system_1.h"
1012 #elif SYSTEM_2
1013 # include "system_2.h"
1014 #elif SYSTEM_3
1015 @dots{}
1016 #endif
1017 @end smallexample
1018
1019 That rapidly becomes tedious.  Instead, the preprocessor offers the
1020 ability to use a macro for the header name.  This is called a
1021 @dfn{computed include}.  Instead of writing a header name as the direct
1022 argument of @samp{#include}, you simply put a macro name there instead:
1023
1024 @smallexample
1025 #define SYSTEM_H "system_1.h"
1026 @dots{}
1027 #include SYSTEM_H
1028 @end smallexample
1029
1030 @noindent
1031 @code{SYSTEM_H} will be expanded, and the preprocessor will look for
1032 @file{system_1.h} as if the @samp{#include} had been written that way
1033 originally.  @code{SYSTEM_H} could be defined by your Makefile with a
1034 @option{-D} option.
1035
1036 You must be careful when you define the macro.  @samp{#define} saves
1037 tokens, not text.  The preprocessor has no way of knowing that the macro
1038 will be used as the argument of @samp{#include}, so it generates
1039 ordinary tokens, not a header name.  This is unlikely to cause problems
1040 if you use double-quote includes, which are close enough to string
1041 constants.  If you use angle brackets, however, you may have trouble.
1042
1043 The syntax of a computed include is actually a bit more general than the
1044 above.  If the first non-whitespace character after @samp{#include} is
1045 not @samp{"} or @samp{<}, then the entire line is macro-expanded
1046 like running text would be.
1047
1048 If the line expands to a single string constant, the contents of that
1049 string constant are the file to be included.  CPP does not re-examine the
1050 string for embedded quotes, but neither does it process backslash
1051 escapes in the string.  Therefore
1052
1053 @smallexample
1054 #define HEADER "a\"b"
1055 #include HEADER
1056 @end smallexample
1057
1058 @noindent
1059 looks for a file named @file{a\"b}.  CPP searches for the file according
1060 to the rules for double-quoted includes.
1061
1062 If the line expands to a token stream beginning with a @samp{<} token
1063 and including a @samp{>} token, then the tokens between the @samp{<} and
1064 the first @samp{>} are combined to form the filename to be included.
1065 Any whitespace between tokens is reduced to a single space; then any
1066 space after the initial @samp{<} is retained, but a trailing space
1067 before the closing @samp{>} is ignored.  CPP searches for the file
1068 according to the rules for angle-bracket includes.
1069
1070 In either case, if there are any tokens on the line after the file name,
1071 an error occurs and the directive is not processed.  It is also an error
1072 if the result of expansion does not match either of the two expected
1073 forms.
1074
1075 These rules are implementation-defined behavior according to the C
1076 standard.  To minimize the risk of different compilers interpreting your
1077 computed includes differently, we recommend you use only a single
1078 object-like macro which expands to a string constant.  This will also
1079 minimize confusion for people reading your program.
1080
1081 @node Wrapper Headers
1082 @section Wrapper Headers
1083 @cindex wrapper headers
1084 @cindex overriding a header file
1085 @findex #include_next
1086
1087 Sometimes it is necessary to adjust the contents of a system-provided
1088 header file without editing it directly.  GCC's @command{fixincludes}
1089 operation does this, for example.  One way to do that would be to create
1090 a new header file with the same name and insert it in the search path
1091 before the original header.  That works fine as long as you're willing
1092 to replace the old header entirely.  But what if you want to refer to
1093 the old header from the new one?
1094
1095 You cannot simply include the old header with @samp{#include}.  That
1096 will start from the beginning, and find your new header again.  If your
1097 header is not protected from multiple inclusion (@pxref{Once-Only
1098 Headers}), it will recurse infinitely and cause a fatal error.
1099
1100 You could include the old header with an absolute pathname:
1101 @smallexample
1102 #include "/usr/include/old-header.h"
1103 @end smallexample
1104 @noindent
1105 This works, but is not clean; should the system headers ever move, you
1106 would have to edit the new headers to match.
1107
1108 There is no way to solve this problem within the C standard, but you can
1109 use the GNU extension @samp{#include_next}.  It means, ``Include the
1110 @emph{next} file with this name''.  This directive works like
1111 @samp{#include} except in searching for the specified file: it starts
1112 searching the list of header file directories @emph{after} the directory
1113 in which the current file was found.
1114
1115 Suppose you specify @option{-I /usr/local/include}, and the list of
1116 directories to search also includes @file{/usr/include}; and suppose
1117 both directories contain @file{signal.h}.  Ordinary @code{@w{#include
1118 <signal.h>}} finds the file under @file{/usr/local/include}.  If that
1119 file contains @code{@w{#include_next <signal.h>}}, it starts searching
1120 after that directory, and finds the file in @file{/usr/include}.
1121
1122 @samp{#include_next} does not distinguish between @code{<@var{file}>}
1123 and @code{"@var{file}"} inclusion, nor does it check that the file you
1124 specify has the same name as the current file.  It simply looks for the
1125 file named, starting with the directory in the search path after the one
1126 where the current file was found.
1127
1128 The use of @samp{#include_next} can lead to great confusion.  We
1129 recommend it be used only when there is no other alternative.  In
1130 particular, it should not be used in the headers belonging to a specific
1131 program; it should be used only to make global corrections along the
1132 lines of @command{fixincludes}.
1133
1134 @node System Headers
1135 @section System Headers
1136 @cindex system header files
1137
1138 The header files declaring interfaces to the operating system and
1139 runtime libraries often cannot be written in strictly conforming C@.
1140 Therefore, GCC gives code found in @dfn{system headers} special
1141 treatment.  All warnings, other than those generated by @samp{#warning}
1142 (@pxref{Diagnostics}), are suppressed while GCC is processing a system
1143 header.  Macros defined in a system header are immune to a few warnings
1144 wherever they are expanded.  This immunity is granted on an ad-hoc
1145 basis, when we find that a warning generates lots of false positives
1146 because of code in macros defined in system headers.
1147
1148 Normally, only the headers found in specific directories are considered
1149 system headers.  These directories are determined when GCC is compiled.
1150 There are, however, two ways to make normal headers into system headers.
1151
1152 The @option{-isystem} command line option adds its argument to the list of
1153 directories to search for headers, just like @option{-I}.  Any headers
1154 found in that directory will be considered system headers.
1155
1156 All directories named by @option{-isystem} are searched @emph{after} all
1157 directories named by @option{-I}, no matter what their order was on the
1158 command line.  If the same directory is named by both @option{-I} and
1159 @option{-isystem}, the @option{-I} option is ignored.  GCC provides an
1160 informative message when this occurs if @option{-v} is used.
1161
1162 @findex #pragma GCC system_header
1163 There is also a directive, @code{@w{#pragma GCC system_header}}, which
1164 tells GCC to consider the rest of the current include file a system
1165 header, no matter where it was found.  Code that comes before the
1166 @samp{#pragma} in the file will not be affected.  @code{@w{#pragma GCC
1167 system_header}} has no effect in the primary source file.
1168
1169 On very old systems, some of the pre-defined system header directories
1170 get even more special treatment.  GNU C++ considers code in headers
1171 found in those directories to be surrounded by an @code{@w{extern "C"}}
1172 block.  There is no way to request this behavior with a @samp{#pragma},
1173 or from the command line.
1174
1175 @node Macros
1176 @chapter Macros
1177
1178 A @dfn{macro} is a fragment of code which has been given a name.
1179 Whenever the name is used, it is replaced by the contents of the macro.
1180 There are two kinds of macros.  They differ mostly in what they look
1181 like when they are used.  @dfn{Object-like} macros resemble data objects
1182 when used, @dfn{function-like} macros resemble function calls.
1183
1184 You may define any valid identifier as a macro, even if it is a C
1185 keyword.  The preprocessor does not know anything about keywords.  This
1186 can be useful if you wish to hide a keyword such as @code{const} from an
1187 older compiler that does not understand it.  However, the preprocessor
1188 operator @code{defined} (@pxref{Defined}) can never be defined as a
1189 macro, and C++'s named operators (@pxref{C++ Named Operators}) cannot be
1190 macros when you are compiling C++.
1191
1192 @menu
1193 * Object-like Macros::
1194 * Function-like Macros::
1195 * Macro Arguments::
1196 * Stringification::
1197 * Concatenation::
1198 * Variadic Macros::
1199 * Predefined Macros::
1200 * Undefining and Redefining Macros::
1201 * Directives Within Macro Arguments::
1202 * Macro Pitfalls::
1203 @end menu
1204
1205 @node Object-like Macros
1206 @section Object-like Macros
1207 @cindex object-like macro
1208 @cindex symbolic constants
1209 @cindex manifest constants
1210
1211 An @dfn{object-like macro} is a simple identifier which will be replaced
1212 by a code fragment.  It is called object-like because it looks like a
1213 data object in code that uses it.  They are most commonly used to give
1214 symbolic names to numeric constants.
1215
1216 @findex #define
1217 You create macros with the @samp{#define} directive.  @samp{#define} is
1218 followed by the name of the macro and then the token sequence it should
1219 be an abbreviation for, which is variously referred to as the macro's
1220 @dfn{body}, @dfn{expansion} or @dfn{replacement list}.  For example,
1221
1222 @smallexample
1223 #define BUFFER_SIZE 1024
1224 @end smallexample
1225
1226 @noindent
1227 defines a macro named @code{BUFFER_SIZE} as an abbreviation for the
1228 token @code{1024}.  If somewhere after this @samp{#define} directive
1229 there comes a C statement of the form
1230
1231 @smallexample
1232 foo = (char *) malloc (BUFFER_SIZE);
1233 @end smallexample
1234
1235 @noindent
1236 then the C preprocessor will recognize and @dfn{expand} the macro
1237 @code{BUFFER_SIZE}.  The C compiler will see the same tokens as it would
1238 if you had written
1239
1240 @smallexample
1241 foo = (char *) malloc (1024);
1242 @end smallexample
1243
1244 By convention, macro names are written in uppercase.  Programs are
1245 easier to read when it is possible to tell at a glance which names are
1246 macros.
1247
1248 The macro's body ends at the end of the @samp{#define} line.  You may
1249 continue the definition onto multiple lines, if necessary, using
1250 backslash-newline.  When the macro is expanded, however, it will all
1251 come out on one line.  For example,
1252
1253 @smallexample
1254 #define NUMBERS 1, \
1255                 2, \
1256                 3
1257 int x[] = @{ NUMBERS @};
1258      @expansion{} int x[] = @{ 1, 2, 3 @};
1259 @end smallexample
1260
1261 @noindent
1262 The most common visible consequence of this is surprising line numbers
1263 in error messages.
1264
1265 There is no restriction on what can go in a macro body provided it
1266 decomposes into valid preprocessing tokens.  Parentheses need not
1267 balance, and the body need not resemble valid C code.  (If it does not,
1268 you may get error messages from the C compiler when you use the macro.)
1269
1270 The C preprocessor scans your program sequentially.  Macro definitions
1271 take effect at the place you write them.  Therefore, the following input
1272 to the C preprocessor
1273
1274 @smallexample
1275 foo = X;
1276 #define X 4
1277 bar = X;
1278 @end smallexample
1279
1280 @noindent
1281 produces
1282
1283 @smallexample
1284 foo = X;
1285 bar = 4;
1286 @end smallexample
1287
1288 When the preprocessor expands a macro name, the macro's expansion
1289 replaces the macro invocation, then the expansion is examined for more
1290 macros to expand.  For example,
1291
1292 @smallexample
1293 @group
1294 #define TABLESIZE BUFSIZE
1295 #define BUFSIZE 1024
1296 TABLESIZE
1297      @expansion{} BUFSIZE
1298      @expansion{} 1024
1299 @end group
1300 @end smallexample
1301
1302 @noindent
1303 @code{TABLESIZE} is expanded first to produce @code{BUFSIZE}, then that
1304 macro is expanded to produce the final result, @code{1024}.
1305
1306 Notice that @code{BUFSIZE} was not defined when @code{TABLESIZE} was
1307 defined.  The @samp{#define} for @code{TABLESIZE} uses exactly the
1308 expansion you specify---in this case, @code{BUFSIZE}---and does not
1309 check to see whether it too contains macro names.  Only when you
1310 @emph{use} @code{TABLESIZE} is the result of its expansion scanned for
1311 more macro names.
1312
1313 This makes a difference if you change the definition of @code{BUFSIZE}
1314 at some point in the source file.  @code{TABLESIZE}, defined as shown,
1315 will always expand using the definition of @code{BUFSIZE} that is
1316 currently in effect:
1317
1318 @smallexample
1319 #define BUFSIZE 1020
1320 #define TABLESIZE BUFSIZE
1321 #undef BUFSIZE
1322 #define BUFSIZE 37
1323 @end smallexample
1324
1325 @noindent
1326 Now @code{TABLESIZE} expands (in two stages) to @code{37}.
1327
1328 If the expansion of a macro contains its own name, either directly or
1329 via intermediate macros, it is not expanded again when the expansion is
1330 examined for more macros.  This prevents infinite recursion.
1331 @xref{Self-Referential Macros}, for the precise details.
1332
1333 @node Function-like Macros
1334 @section Function-like Macros
1335 @cindex function-like macros
1336
1337 You can also define macros whose use looks like a function call.  These
1338 are called @dfn{function-like macros}.  To define a function-like macro,
1339 you use the same @samp{#define} directive, but you put a pair of
1340 parentheses immediately after the macro name.  For example,
1341
1342 @smallexample
1343 #define lang_init()  c_init()
1344 lang_init()
1345      @expansion{} c_init()
1346 @end smallexample
1347
1348 A function-like macro is only expanded if its name appears with a pair
1349 of parentheses after it.  If you write just the name, it is left alone.
1350 This can be useful when you have a function and a macro of the same
1351 name, and you wish to use the function sometimes.
1352
1353 @smallexample
1354 extern void foo(void);
1355 #define foo() /* @r{optimized inline version} */
1356 @dots{}
1357   foo();
1358   funcptr = foo;
1359 @end smallexample
1360
1361 Here the call to @code{foo()} will use the macro, but the function
1362 pointer will get the address of the real function.  If the macro were to
1363 be expanded, it would cause a syntax error.
1364
1365 If you put spaces between the macro name and the parentheses in the
1366 macro definition, that does not define a function-like macro, it defines
1367 an object-like macro whose expansion happens to begin with a pair of
1368 parentheses.
1369
1370 @smallexample
1371 #define lang_init ()    c_init()
1372 lang_init()
1373      @expansion{} () c_init()()
1374 @end smallexample
1375
1376 The first two pairs of parentheses in this expansion come from the
1377 macro.  The third is the pair that was originally after the macro
1378 invocation.  Since @code{lang_init} is an object-like macro, it does not
1379 consume those parentheses.
1380
1381 @node Macro Arguments
1382 @section Macro Arguments
1383 @cindex arguments
1384 @cindex macros with arguments
1385 @cindex arguments in macro definitions
1386
1387 Function-like macros can take @dfn{arguments}, just like true functions.
1388 To define a macro that uses arguments, you insert @dfn{parameters}
1389 between the pair of parentheses in the macro definition that make the
1390 macro function-like.  The parameters must be valid C identifiers,
1391 separated by commas and optionally whitespace.
1392
1393 To invoke a macro that takes arguments, you write the name of the macro
1394 followed by a list of @dfn{actual arguments} in parentheses, separated
1395 by commas.  The invocation of the macro need not be restricted to a
1396 single logical line---it can cross as many lines in the source file as
1397 you wish.  The number of arguments you give must match the number of
1398 parameters in the macro definition.  When the macro is expanded, each
1399 use of a parameter in its body is replaced by the tokens of the
1400 corresponding argument.  (You need not use all of the parameters in the
1401 macro body.)
1402
1403 As an example, here is a macro that computes the minimum of two numeric
1404 values, as it is defined in many C programs, and some uses.
1405
1406 @smallexample
1407 #define min(X, Y)  ((X) < (Y) ? (X) : (Y))
1408   x = min(a, b);          @expansion{}  x = ((a) < (b) ? (a) : (b));
1409   y = min(1, 2);          @expansion{}  y = ((1) < (2) ? (1) : (2));
1410   z = min(a + 28, *p);    @expansion{}  z = ((a + 28) < (*p) ? (a + 28) : (*p));
1411 @end smallexample
1412
1413 @noindent
1414 (In this small example you can already see several of the dangers of
1415 macro arguments.  @xref{Macro Pitfalls}, for detailed explanations.)
1416
1417 Leading and trailing whitespace in each argument is dropped, and all
1418 whitespace between the tokens of an argument is reduced to a single
1419 space.  Parentheses within each argument must balance; a comma within
1420 such parentheses does not end the argument.  However, there is no
1421 requirement for square brackets or braces to balance, and they do not
1422 prevent a comma from separating arguments.  Thus,
1423
1424 @smallexample
1425 macro (array[x = y, x + 1])
1426 @end smallexample
1427
1428 @noindent
1429 passes two arguments to @code{macro}: @code{array[x = y} and @code{x +
1430 1]}.  If you want to supply @code{array[x = y, x + 1]} as an argument,
1431 you can write it as @code{array[(x = y, x + 1)]}, which is equivalent C
1432 code.
1433
1434 All arguments to a macro are completely macro-expanded before they are
1435 substituted into the macro body.  After substitution, the complete text
1436 is scanned again for macros to expand, including the arguments.  This rule
1437 may seem strange, but it is carefully designed so you need not worry
1438 about whether any function call is actually a macro invocation.  You can
1439 run into trouble if you try to be too clever, though.  @xref{Argument
1440 Prescan}, for detailed discussion.
1441
1442 For example, @code{min (min (a, b), c)} is first expanded to
1443
1444 @smallexample
1445   min (((a) < (b) ? (a) : (b)), (c))
1446 @end smallexample
1447
1448 @noindent
1449 and then to
1450
1451 @smallexample
1452 @group
1453 ((((a) < (b) ? (a) : (b))) < (c)
1454  ? (((a) < (b) ? (a) : (b)))
1455  : (c))
1456 @end group
1457 @end smallexample
1458
1459 @noindent
1460 (Line breaks shown here for clarity would not actually be generated.)
1461
1462 @cindex empty macro arguments
1463 You can leave macro arguments empty; this is not an error to the
1464 preprocessor (but many macros will then expand to invalid code).
1465 You cannot leave out arguments entirely; if a macro takes two arguments,
1466 there must be exactly one comma at the top level of its argument list.
1467 Here are some silly examples using @code{min}:
1468
1469 @smallexample
1470 min(, b)        @expansion{} ((   ) < (b) ? (   ) : (b))
1471 min(a, )        @expansion{} ((a  ) < ( ) ? (a  ) : ( ))
1472 min(,)          @expansion{} ((   ) < ( ) ? (   ) : ( ))
1473 min((,),)       @expansion{} (((,)) < ( ) ? ((,)) : ( ))
1474
1475 min()      @error{} macro "min" requires 2 arguments, but only 1 given
1476 min(,,)    @error{} macro "min" passed 3 arguments, but takes just 2
1477 @end smallexample
1478
1479 Whitespace is not a preprocessing token, so if a macro @code{foo} takes
1480 one argument, @code{@w{foo ()}} and @code{@w{foo ( )}} both supply it an
1481 empty argument.  Previous GNU preprocessor implementations and
1482 documentation were incorrect on this point, insisting that a
1483 function-like macro that takes a single argument be passed a space if an
1484 empty argument was required.
1485
1486 Macro parameters appearing inside string literals are not replaced by
1487 their corresponding actual arguments.
1488
1489 @smallexample
1490 #define foo(x) x, "x"
1491 foo(bar)        @expansion{} bar, "x"
1492 @end smallexample
1493
1494 @node Stringification
1495 @section Stringification
1496 @cindex stringification
1497 @cindex @samp{#} operator
1498
1499 Sometimes you may want to convert a macro argument into a string
1500 constant.  Parameters are not replaced inside string constants, but you
1501 can use the @samp{#} preprocessing operator instead.  When a macro
1502 parameter is used with a leading @samp{#}, the preprocessor replaces it
1503 with the literal text of the actual argument, converted to a string
1504 constant.  Unlike normal parameter replacement, the argument is not
1505 macro-expanded first.  This is called @dfn{stringification}.
1506
1507 There is no way to combine an argument with surrounding text and
1508 stringify it all together.  Instead, you can write a series of adjacent
1509 string constants and stringified arguments.  The preprocessor will
1510 replace the stringified arguments with string constants.  The C
1511 compiler will then combine all the adjacent string constants into one
1512 long string.
1513
1514 Here is an example of a macro definition that uses stringification:
1515
1516 @smallexample
1517 @group
1518 #define WARN_IF(EXP) \
1519 do @{ if (EXP) \
1520         fprintf (stderr, "Warning: " #EXP "\n"); @} \
1521 while (0)
1522 WARN_IF (x == 0);
1523      @expansion{} do @{ if (x == 0)
1524            fprintf (stderr, "Warning: " "x == 0" "\n"); @} while (0);
1525 @end group
1526 @end smallexample
1527
1528 @noindent
1529 The argument for @code{EXP} is substituted once, as-is, into the
1530 @code{if} statement, and once, stringified, into the argument to
1531 @code{fprintf}.  If @code{x} were a macro, it would be expanded in the
1532 @code{if} statement, but not in the string.
1533
1534 The @code{do} and @code{while (0)} are a kludge to make it possible to
1535 write @code{WARN_IF (@var{arg});}, which the resemblance of
1536 @code{WARN_IF} to a function would make C programmers want to do; see
1537 @ref{Swallowing the Semicolon}.
1538
1539 Stringification in C involves more than putting double-quote characters
1540 around the fragment.  The preprocessor backslash-escapes the quotes
1541 surrounding embedded string constants, and all backslashes within string and
1542 character constants, in order to get a valid C string constant with the
1543 proper contents.  Thus, stringifying @code{@w{p = "foo\n";}} results in
1544 @t{@w{"p = \"foo\\n\";"}}.  However, backslashes that are not inside string
1545 or character constants are not duplicated: @samp{\n} by itself
1546 stringifies to @t{"\n"}.
1547
1548 All leading and trailing whitespace in text being stringified is
1549 ignored.  Any sequence of whitespace in the middle of the text is
1550 converted to a single space in the stringified result.  Comments are
1551 replaced by whitespace long before stringification happens, so they
1552 never appear in stringified text.
1553
1554 There is no way to convert a macro argument into a character constant.
1555
1556 If you want to stringify the result of expansion of a macro argument,
1557 you have to use two levels of macros.
1558
1559 @smallexample
1560 #define xstr(s) str(s)
1561 #define str(s) #s
1562 #define foo 4
1563 str (foo)
1564      @expansion{} "foo"
1565 xstr (foo)
1566      @expansion{} xstr (4)
1567      @expansion{} str (4)
1568      @expansion{} "4"
1569 @end smallexample
1570
1571 @code{s} is stringified when it is used in @code{str}, so it is not
1572 macro-expanded first.  But @code{s} is an ordinary argument to
1573 @code{xstr}, so it is completely macro-expanded before @code{xstr}
1574 itself is expanded (@pxref{Argument Prescan}).  Therefore, by the time
1575 @code{str} gets to its argument, it has already been macro-expanded.
1576
1577 @node Concatenation
1578 @section Concatenation
1579 @cindex concatenation
1580 @cindex token pasting
1581 @cindex token concatenation
1582 @cindex @samp{##} operator
1583
1584 It is often useful to merge two tokens into one while expanding macros.
1585 This is called @dfn{token pasting} or @dfn{token concatenation}.  The
1586 @samp{##} preprocessing operator performs token pasting.  When a macro
1587 is expanded, the two tokens on either side of each @samp{##} operator
1588 are combined into a single token, which then replaces the @samp{##} and
1589 the two original tokens in the macro expansion.  Usually both will be
1590 identifiers, or one will be an identifier and the other a preprocessing
1591 number.  When pasted, they make a longer identifier.  This isn't the
1592 only valid case.  It is also possible to concatenate two numbers (or a
1593 number and a name, such as @code{1.5} and @code{e3}) into a number.
1594 Also, multi-character operators such as @code{+=} can be formed by
1595 token pasting.
1596
1597 However, two tokens that don't together form a valid token cannot be
1598 pasted together.  For example, you cannot concatenate @code{x} with
1599 @code{+} in either order.  If you try, the preprocessor issues a warning
1600 and emits the two tokens.  Whether it puts white space between the
1601 tokens is undefined.  It is common to find unnecessary uses of @samp{##}
1602 in complex macros.  If you get this warning, it is likely that you can
1603 simply remove the @samp{##}.
1604
1605 Both the tokens combined by @samp{##} could come from the macro body,
1606 but you could just as well write them as one token in the first place.
1607 Token pasting is most useful when one or both of the tokens comes from a
1608 macro argument.  If either of the tokens next to an @samp{##} is a
1609 parameter name, it is replaced by its actual argument before @samp{##}
1610 executes.  As with stringification, the actual argument is not
1611 macro-expanded first.  If the argument is empty, that @samp{##} has no
1612 effect.
1613
1614 Keep in mind that the C preprocessor converts comments to whitespace
1615 before macros are even considered.  Therefore, you cannot create a
1616 comment by concatenating @samp{/} and @samp{*}.  You can put as much
1617 whitespace between @samp{##} and its operands as you like, including
1618 comments, and you can put comments in arguments that will be
1619 concatenated.  However, it is an error if @samp{##} appears at either
1620 end of a macro body.
1621
1622 Consider a C program that interprets named commands.  There probably
1623 needs to be a table of commands, perhaps an array of structures declared
1624 as follows:
1625
1626 @smallexample
1627 @group
1628 struct command
1629 @{
1630   char *name;
1631   void (*function) (void);
1632 @};
1633 @end group
1634
1635 @group
1636 struct command commands[] =
1637 @{
1638   @{ "quit", quit_command @},
1639   @{ "help", help_command @},
1640   @dots{}
1641 @};
1642 @end group
1643 @end smallexample
1644
1645 It would be cleaner not to have to give each command name twice, once in
1646 the string constant and once in the function name.  A macro which takes the
1647 name of a command as an argument can make this unnecessary.  The string
1648 constant can be created with stringification, and the function name by
1649 concatenating the argument with @samp{_command}.  Here is how it is done:
1650
1651 @smallexample
1652 #define COMMAND(NAME)  @{ #NAME, NAME ## _command @}
1653
1654 struct command commands[] =
1655 @{
1656   COMMAND (quit),
1657   COMMAND (help),
1658   @dots{}
1659 @};
1660 @end smallexample
1661
1662 @node Variadic Macros
1663 @section Variadic Macros
1664 @cindex variable number of arguments
1665 @cindex macros with variable arguments
1666 @cindex variadic macros
1667
1668 A macro can be declared to accept a variable number of arguments much as
1669 a function can.  The syntax for defining the macro is similar to that of
1670 a function.  Here is an example:
1671
1672 @smallexample
1673 #define eprintf(@dots{}) fprintf (stderr, __VA_ARGS__)
1674 @end smallexample
1675
1676 This kind of macro is called @dfn{variadic}.  When the macro is invoked,
1677 all the tokens in its argument list after the last named argument (this
1678 macro has none), including any commas, become the @dfn{variable
1679 argument}.  This sequence of tokens replaces the identifier
1680 @code{@w{__VA_ARGS__}} in the macro body wherever it appears.  Thus, we
1681 have this expansion:
1682
1683 @smallexample
1684 eprintf ("%s:%d: ", input_file, lineno)
1685      @expansion{}  fprintf (stderr, "%s:%d: ", input_file, lineno)
1686 @end smallexample
1687
1688 The variable argument is completely macro-expanded before it is inserted
1689 into the macro expansion, just like an ordinary argument.  You may use
1690 the @samp{#} and @samp{##} operators to stringify the variable argument
1691 or to paste its leading or trailing token with another token.  (But see
1692 below for an important special case for @samp{##}.)
1693
1694 If your macro is complicated, you may want a more descriptive name for
1695 the variable argument than @code{@w{__VA_ARGS__}}.  CPP permits
1696 this, as an extension.  You may write an argument name immediately
1697 before the @samp{@dots{}}; that name is used for the variable argument.
1698 The @code{eprintf} macro above could be written
1699
1700 @smallexample
1701 #define eprintf(args@dots{}) fprintf (stderr, args)
1702 @end smallexample
1703
1704 @noindent
1705 using this extension.  You cannot use @code{@w{__VA_ARGS__}} and this
1706 extension in the same macro.
1707
1708 You can have named arguments as well as variable arguments in a variadic
1709 macro.  We could define @code{eprintf} like this, instead:
1710
1711 @smallexample
1712 #define eprintf(format, @dots{}) fprintf (stderr, format, __VA_ARGS__)
1713 @end smallexample
1714
1715 @noindent
1716 This formulation looks more descriptive, but unfortunately it is less
1717 flexible: you must now supply at least one argument after the format
1718 string.  In standard C, you cannot omit the comma separating the named
1719 argument from the variable arguments.  Furthermore, if you leave the
1720 variable argument empty, you will get a syntax error, because
1721 there will be an extra comma after the format string.
1722
1723 @smallexample
1724 eprintf("success!\n", );
1725      @expansion{} fprintf(stderr, "success!\n", );
1726 @end smallexample
1727
1728 GNU CPP has a pair of extensions which deal with this problem.  First,
1729 you are allowed to leave the variable argument out entirely:
1730
1731 @smallexample
1732 eprintf ("success!\n")
1733      @expansion{} fprintf(stderr, "success!\n", );
1734 @end smallexample
1735
1736 @noindent
1737 Second, the @samp{##} token paste operator has a special meaning when
1738 placed between a comma and a variable argument.  If you write
1739
1740 @smallexample
1741 #define eprintf(format, @dots{}) fprintf (stderr, format, ##__VA_ARGS__)
1742 @end smallexample
1743
1744 @noindent
1745 and the variable argument is left out when the @code{eprintf} macro is
1746 used, then the comma before the @samp{##} will be deleted.  This does
1747 @emph{not} happen if you pass an empty argument, nor does it happen if
1748 the token preceding @samp{##} is anything other than a comma.
1749
1750 @smallexample
1751 eprintf ("success!\n")
1752      @expansion{} fprintf(stderr, "success!\n");
1753 @end smallexample
1754
1755 @noindent
1756 The above explanation is ambiguous about the case where the only macro
1757 parameter is a variable arguments parameter, as it is meaningless to
1758 try to distinguish whether no argument at all is an empty argument or
1759 a missing argument.  In this case the C99 standard is clear that the
1760 comma must remain, however the existing GCC extension used to swallow
1761 the comma.  So CPP retains the comma when conforming to a specific C
1762 standard, and drops it otherwise.
1763
1764 C99 mandates that the only place the identifier @code{@w{__VA_ARGS__}}
1765 can appear is in the replacement list of a variadic macro.  It may not
1766 be used as a macro name, macro argument name, or within a different type
1767 of macro.  It may also be forbidden in open text; the standard is
1768 ambiguous.  We recommend you avoid using it except for its defined
1769 purpose.
1770
1771 Variadic macros are a new feature in C99.  GNU CPP has supported them
1772 for a long time, but only with a named variable argument
1773 (@samp{args@dots{}}, not @samp{@dots{}} and @code{@w{__VA_ARGS__}}).  If you are
1774 concerned with portability to previous versions of GCC, you should use
1775 only named variable arguments.  On the other hand, if you are concerned
1776 with portability to other conforming implementations of C99, you should
1777 use only @code{@w{__VA_ARGS__}}.
1778
1779 Previous versions of CPP implemented the comma-deletion extension
1780 much more generally.  We have restricted it in this release to minimize
1781 the differences from C99.  To get the same effect with both this and
1782 previous versions of GCC, the token preceding the special @samp{##} must
1783 be a comma, and there must be white space between that comma and
1784 whatever comes immediately before it:
1785
1786 @smallexample
1787 #define eprintf(format, args@dots{}) fprintf (stderr, format , ##args)
1788 @end smallexample
1789
1790 @noindent
1791 @xref{Differences from previous versions}, for the gory details.
1792
1793 @node Predefined Macros
1794 @section Predefined Macros
1795
1796 @cindex predefined macros
1797 Several object-like macros are predefined; you use them without
1798 supplying their definitions.  They fall into three classes: standard,
1799 common, and system-specific.
1800
1801 In C++, there is a fourth category, the named operators.  They act like
1802 predefined macros, but you cannot undefine them.
1803
1804 @menu
1805 * Standard Predefined Macros::
1806 * Common Predefined Macros::
1807 * System-specific Predefined Macros::
1808 * C++ Named Operators::
1809 @end menu
1810
1811 @node Standard Predefined Macros
1812 @subsection Standard Predefined Macros
1813 @cindex standard predefined macros.
1814
1815 The standard predefined macros are specified by the relevant
1816 language standards, so they are available with all compilers that
1817 implement those standards.  Older compilers may not provide all of
1818 them.  Their names all start with double underscores.
1819
1820 @table @code
1821 @item __FILE__
1822 This macro expands to the name of the current input file, in the form of
1823 a C string constant.  This is the path by which the preprocessor opened
1824 the file, not the short name specified in @samp{#include} or as the
1825 input file name argument.  For example,
1826 @code{"/usr/local/include/myheader.h"} is a possible expansion of this
1827 macro.
1828
1829 @item __LINE__
1830 This macro expands to the current input line number, in the form of a
1831 decimal integer constant.  While we call it a predefined macro, it's
1832 a pretty strange macro, since its ``definition'' changes with each
1833 new line of source code.
1834 @end table
1835
1836 @code{__FILE__} and @code{__LINE__} are useful in generating an error
1837 message to report an inconsistency detected by the program; the message
1838 can state the source line at which the inconsistency was detected.  For
1839 example,
1840
1841 @smallexample
1842 fprintf (stderr, "Internal error: "
1843                  "negative string length "
1844                  "%d at %s, line %d.",
1845          length, __FILE__, __LINE__);
1846 @end smallexample
1847
1848 An @samp{#include} directive changes the expansions of @code{__FILE__}
1849 and @code{__LINE__} to correspond to the included file.  At the end of
1850 that file, when processing resumes on the input file that contained
1851 the @samp{#include} directive, the expansions of @code{__FILE__} and
1852 @code{__LINE__} revert to the values they had before the
1853 @samp{#include} (but @code{__LINE__} is then incremented by one as
1854 processing moves to the line after the @samp{#include}).
1855
1856 A @samp{#line} directive changes @code{__LINE__}, and may change
1857 @code{__FILE__} as well.  @xref{Line Control}.
1858
1859 C99 introduces @code{__func__}, and GCC has provided @code{__FUNCTION__}
1860 for a long time.  Both of these are strings containing the name of the
1861 current function (there are slight semantic differences; see the GCC
1862 manual).  Neither of them is a macro; the preprocessor does not know the
1863 name of the current function.  They tend to be useful in conjunction
1864 with @code{__FILE__} and @code{__LINE__}, though.
1865
1866 @table @code
1867
1868 @item __DATE__
1869 This macro expands to a string constant that describes the date on which
1870 the preprocessor is being run.  The string constant contains eleven
1871 characters and looks like @code{@w{"Feb 12 1996"}}.  If the day of the
1872 month is less than 10, it is padded with a space on the left.
1873
1874 If GCC cannot determine the current date, it will emit a warning message
1875 (once per compilation) and @code{__DATE__} will expand to
1876 @code{@w{"??? ?? ????"}}.
1877
1878 @item __TIME__
1879 This macro expands to a string constant that describes the time at
1880 which the preprocessor is being run.  The string constant contains
1881 eight characters and looks like @code{"23:59:01"}.
1882
1883 If GCC cannot determine the current time, it will emit a warning message
1884 (once per compilation) and @code{__TIME__} will expand to
1885 @code{"??:??:??"}.
1886
1887 @item __STDC__
1888 In normal operation, this macro expands to the constant 1, to signify
1889 that this compiler conforms to ISO Standard C@.  If GNU CPP is used with
1890 a compiler other than GCC, this is not necessarily true; however, the
1891 preprocessor always conforms to the standard unless the
1892 @option{-traditional-cpp} option is used.
1893
1894 This macro is not defined if the @option{-traditional-cpp} option is used.
1895
1896 On some hosts, the system compiler uses a different convention, where
1897 @code{__STDC__} is normally 0, but is 1 if the user specifies strict
1898 conformance to the C Standard.  CPP follows the host convention when
1899 processing system header files, but when processing user files
1900 @code{__STDC__} is always 1.  This has been reported to cause problems;
1901 for instance, some versions of Solaris provide X Windows headers that
1902 expect @code{__STDC__} to be either undefined or 1.  @xref{Invocation}.
1903
1904 @item __STDC_VERSION__
1905 This macro expands to the C Standard's version number, a long integer
1906 constant of the form @code{@var{yyyy}@var{mm}L} where @var{yyyy} and
1907 @var{mm} are the year and month of the Standard version.  This signifies
1908 which version of the C Standard the compiler conforms to.  Like
1909 @code{__STDC__}, this is not necessarily accurate for the entire
1910 implementation, unless GNU CPP is being used with GCC@.
1911
1912 The value @code{199409L} signifies the 1989 C standard as amended in
1913 1994, which is the current default; the value @code{199901L} signifies
1914 the 1999 revision of the C standard.  Support for the 1999 revision is
1915 not yet complete.
1916
1917 This macro is not defined if the @option{-traditional-cpp} option is
1918 used, nor when compiling C++ or Objective-C@.
1919
1920 @item __STDC_HOSTED__
1921 This macro is defined, with value 1, if the compiler's target is a
1922 @dfn{hosted environment}.  A hosted environment has the complete
1923 facilities of the standard C library available.
1924
1925 @item __cplusplus
1926 This macro is defined when the C++ compiler is in use.  You can use
1927 @code{__cplusplus} to test whether a header is compiled by a C compiler
1928 or a C++ compiler.  This macro is similar to @code{__STDC_VERSION__}, in
1929 that it expands to a version number.  A fully conforming implementation
1930 of the 1998 C++ standard will define this macro to @code{199711L}.  The
1931 GNU C++ compiler is not yet fully conforming, so it uses @code{1}
1932 instead.  It is hoped to complete the implementation of standard C++
1933 in the near future.
1934
1935 @item __OBJC__
1936 This macro is defined, with value 1, when the Objective-C compiler is in
1937 use.  You can use @code{__OBJC__} to test whether a header is compiled
1938 by a C compiler or a Objective-C compiler.
1939
1940 @item __ASSEMBLER__
1941 This macro is defined with value 1 when preprocessing assembly
1942 language.
1943
1944 @end table
1945
1946 @node Common Predefined Macros
1947 @subsection Common Predefined Macros
1948 @cindex common predefined macros
1949
1950 The common predefined macros are GNU C extensions.  They are available
1951 with the same meanings regardless of the machine or operating system on
1952 which you are using GNU C or GNU Fortran.  Their names all start with
1953 double underscores.
1954
1955 @table @code
1956
1957 @item __COUNTER__
1958 This macro expands to sequential integral values starting from 0.  In
1959 conjunction with the @code{##} operator, this provides a convenient means to
1960 generate unique identifiers.  Care must be taken to ensure that
1961 @code{__COUNTER__} is not expanded prior to inclusion of precompiled headers
1962 which use it.  Otherwise, the precompiled headers will not be used.
1963
1964 @item __GFORTRAN__
1965 The GNU Fortran compiler defines this. 
1966
1967 @item __GNUC__
1968 @itemx __GNUC_MINOR__
1969 @itemx __GNUC_PATCHLEVEL__
1970 These macros are defined by all GNU compilers that use the C
1971 preprocessor: C, C++, Objective-C and Fortran.  Their values are the major
1972 version, minor version, and patch level of the compiler, as integer
1973 constants.  For example, GCC 3.2.1 will define @code{__GNUC__} to 3,
1974 @code{__GNUC_MINOR__} to 2, and @code{__GNUC_PATCHLEVEL__} to 1.  These
1975 macros are also defined if you invoke the preprocessor directly.
1976
1977 @code{__GNUC_PATCHLEVEL__} is new to GCC 3.0; it is also present in the
1978 widely-used development snapshots leading up to 3.0 (which identify
1979 themselves as GCC 2.96 or 2.97, depending on which snapshot you have).
1980
1981 If all you need to know is whether or not your program is being compiled
1982 by GCC, or a non-GCC compiler that claims to accept the GNU C dialects,
1983 you can simply test @code{__GNUC__}.  If you need to write code
1984 which depends on a specific version, you must be more careful.  Each
1985 time the minor version is increased, the patch level is reset to zero;
1986 each time the major version is increased (which happens rarely), the
1987 minor version and patch level are reset.  If you wish to use the
1988 predefined macros directly in the conditional, you will need to write it
1989 like this:
1990
1991 @smallexample
1992 /* @r{Test for GCC > 3.2.0} */
1993 #if __GNUC__ > 3 || \
1994     (__GNUC__ == 3 && (__GNUC_MINOR__ > 2 || \
1995                        (__GNUC_MINOR__ == 2 && \
1996                         __GNUC_PATCHLEVEL__ > 0))
1997 @end smallexample
1998
1999 @noindent
2000 Another approach is to use the predefined macros to
2001 calculate a single number, then compare that against a threshold:
2002
2003 @smallexample
2004 #define GCC_VERSION (__GNUC__ * 10000 \
2005                      + __GNUC_MINOR__ * 100 \
2006                      + __GNUC_PATCHLEVEL__)
2007 @dots{}
2008 /* @r{Test for GCC > 3.2.0} */
2009 #if GCC_VERSION > 30200
2010 @end smallexample
2011
2012 @noindent
2013 Many people find this form easier to understand.
2014
2015 @item __GNUG__
2016 The GNU C++ compiler defines this.  Testing it is equivalent to
2017 testing @code{@w{(__GNUC__ && __cplusplus)}}.
2018
2019 @item __STRICT_ANSI__
2020 GCC defines this macro if and only if the @option{-ansi} switch, or a
2021 @option{-std} switch specifying strict conformance to some version of ISO C,
2022 was specified when GCC was invoked.  It is defined to @samp{1}.
2023 This macro exists primarily to direct GNU libc's header files to
2024 restrict their definitions to the minimal set found in the 1989 C
2025 standard.
2026
2027 @item __BASE_FILE__
2028 This macro expands to the name of the main input file, in the form
2029 of a C string constant.  This is the source file that was specified
2030 on the command line of the preprocessor or C compiler.
2031
2032 @item __INCLUDE_LEVEL__
2033 This macro expands to a decimal integer constant that represents the
2034 depth of nesting in include files.  The value of this macro is
2035 incremented on every @samp{#include} directive and decremented at the
2036 end of every included file.  It starts out at 0, its value within the
2037 base file specified on the command line.
2038
2039 @item __ELF__
2040 This macro is defined if the target uses the ELF object format.
2041
2042 @item __VERSION__
2043 This macro expands to a string constant which describes the version of
2044 the compiler in use.  You should not rely on its contents having any
2045 particular form, but it can be counted on to contain at least the
2046 release number.
2047
2048 @item __OPTIMIZE__
2049 @itemx __OPTIMIZE_SIZE__
2050 @itemx __NO_INLINE__
2051 These macros describe the compilation mode.  @code{__OPTIMIZE__} is
2052 defined in all optimizing compilations.  @code{__OPTIMIZE_SIZE__} is
2053 defined if the compiler is optimizing for size, not speed.
2054 @code{__NO_INLINE__} is defined if no functions will be inlined into
2055 their callers (when not optimizing, or when inlining has been
2056 specifically disabled by @option{-fno-inline}).
2057
2058 These macros cause certain GNU header files to provide optimized
2059 definitions, using macros or inline functions, of system library
2060 functions.  You should not use these macros in any way unless you make
2061 sure that programs will execute with the same effect whether or not they
2062 are defined.  If they are defined, their value is 1.
2063
2064 @item __GNUC_GNU_INLINE__
2065 GCC defines this macro if functions declared @code{inline} will be
2066 handled in GCC's traditional gnu89 mode.  Object files will contain
2067 externally visible definitions of all functions declared @code{inline}
2068 without @code{extern} or @code{static}.  They will not contain any
2069 definitions of any functions declared @code{extern inline}.
2070
2071 @item __GNUC_STDC_INLINE__
2072 GCC defines this macro if functions declared @code{inline} will be
2073 handled according to the ISO C99 standard.  Object files will contain
2074 externally visible definitions of all functions declared @code{extern
2075 inline}.  They will not contain definitions of any functions declared
2076 @code{inline} without @code{extern}.
2077
2078 If this macro is defined, GCC supports the @code{gnu_inline} function
2079 attribute as a way to always get the gnu89 behavior.  Support for
2080 this and @code{__GNUC_GNU_INLINE__} was added in GCC 4.1.3.  If
2081 neither macro is defined, an older version of GCC is being used:
2082 @code{inline} functions will be compiled in gnu89 mode, and the
2083 @code{gnu_inline} function attribute will not be recognized.
2084
2085 @item __CHAR_UNSIGNED__
2086 GCC defines this macro if and only if the data type @code{char} is
2087 unsigned on the target machine.  It exists to cause the standard header
2088 file @file{limits.h} to work correctly.  You should not use this macro
2089 yourself; instead, refer to the standard macros defined in @file{limits.h}.
2090
2091 @item __WCHAR_UNSIGNED__
2092 Like @code{__CHAR_UNSIGNED__}, this macro is defined if and only if the
2093 data type @code{wchar_t} is unsigned and the front-end is in C++ mode.
2094
2095 @item __REGISTER_PREFIX__
2096 This macro expands to a single token (not a string constant) which is
2097 the prefix applied to CPU register names in assembly language for this
2098 target.  You can use it to write assembly that is usable in multiple
2099 environments.  For example, in the @code{m68k-aout} environment it
2100 expands to nothing, but in the @code{m68k-coff} environment it expands
2101 to a single @samp{%}.
2102
2103 @item __USER_LABEL_PREFIX__
2104 This macro expands to a single token which is the prefix applied to
2105 user labels (symbols visible to C code) in assembly.  For example, in
2106 the @code{m68k-aout} environment it expands to an @samp{_}, but in the
2107 @code{m68k-coff} environment it expands to nothing.
2108
2109 This macro will have the correct definition even if
2110 @option{-f(no-)underscores} is in use, but it will not be correct if
2111 target-specific options that adjust this prefix are used (e.g.@: the
2112 OSF/rose @option{-mno-underscores} option).
2113
2114 @item __SIZE_TYPE__
2115 @itemx __PTRDIFF_TYPE__
2116 @itemx __WCHAR_TYPE__
2117 @itemx __WINT_TYPE__
2118 @itemx __INTMAX_TYPE__
2119 @itemx __UINTMAX_TYPE__
2120 These macros are defined to the correct underlying types for the
2121 @code{size_t}, @code{ptrdiff_t}, @code{wchar_t}, @code{wint_t},
2122 @code{intmax_t}, and @code{uintmax_t}
2123 typedefs, respectively.  They exist to make the standard header files
2124 @file{stddef.h} and @file{wchar.h} work correctly.  You should not use
2125 these macros directly; instead, include the appropriate headers and use
2126 the typedefs.
2127
2128 @item __CHAR_BIT__
2129 Defined to the number of bits used in the representation of the
2130 @code{char} data type.  It exists to make the standard header given
2131 numerical limits work correctly.  You should not use
2132 this macro directly; instead, include the appropriate headers.
2133
2134 @item __SCHAR_MAX__
2135 @itemx __WCHAR_MAX__
2136 @itemx __SHRT_MAX__
2137 @itemx __INT_MAX__
2138 @itemx __LONG_MAX__
2139 @itemx __LONG_LONG_MAX__
2140 @itemx __INTMAX_MAX__
2141 Defined to the maximum value of the @code{signed char}, @code{wchar_t},
2142 @code{signed short},
2143 @code{signed int}, @code{signed long}, @code{signed long long}, and
2144 @code{intmax_t} types
2145 respectively.  They exist to make the standard header given numerical limits
2146 work correctly.  You should not use these macros directly; instead, include
2147 the appropriate headers.
2148
2149 @item __SIZEOF_INT__
2150 @itemx __SIZEOF_LONG__
2151 @itemx __SIZEOF_LONG_LONG__
2152 @itemx __SIZEOF_SHORT__
2153 @itemx __SIZEOF_POINTER__
2154 @itemx __SIZEOF_FLOAT__
2155 @itemx __SIZEOF_DOUBLE__
2156 @itemx __SIZEOF_LONG_DOUBLE__
2157 @itemx __SIZEOF_SIZE_T__
2158 @itemx __SIZEOF_WCHAR_T__
2159 @itemx __SIZEOF_WINT_T__
2160 @itemx __SIZEOF_PTRDIFF_T__
2161 Defined to the number of bytes of the C standard data types: @code{int},
2162 @code{long}, @code{long long}, @code{short}, @code{void *}, @code{float},
2163 @code{double}, @code{long double}, @code{size_t}, @code{wchar_t}, @code{wint_t}
2164 and @code{ptrdiff_t}.
2165
2166 @item __DEPRECATED
2167 This macro is defined, with value 1, when compiling a C++ source file
2168 with warnings about deprecated constructs enabled.  These warnings are
2169 enabled by default, but can be disabled with @option{-Wno-deprecated}.
2170
2171 @item __EXCEPTIONS
2172 This macro is defined, with value 1, when compiling a C++ source file
2173 with exceptions enabled.  If @option{-fno-exceptions} is used when
2174 compiling the file, then this macro is not defined.
2175
2176 @item __GXX_RTTI
2177 This macro is defined, with value 1, when compiling a C++ source file
2178 with runtime type identification enabled.  If @option{-fno-rtti} is
2179 used when compiling the file, then this macro is not defined.
2180
2181 @item __USING_SJLJ_EXCEPTIONS__
2182 This macro is defined, with value 1, if the compiler uses the old
2183 mechanism based on @code{setjmp} and @code{longjmp} for exception
2184 handling.
2185
2186 @item __GXX_EXPERIMENTAL_CXX0X__
2187 This macro is defined when compiling a C++ source file with the option
2188 @option{-std=c++0x} or @option{-std=gnu++0x}. It indicates that some
2189 features likely to be included in C++0x are available. Note that these
2190 features are experimental, and may change or be removed in future
2191 versions of GCC.
2192
2193 @item __GXX_WEAK__
2194 This macro is defined when compiling a C++ source file.  It has the
2195 value 1 if the compiler will use weak symbols, COMDAT sections, or
2196 other similar techniques to collapse symbols with ``vague linkage''
2197 that are defined in multiple translation units.  If the compiler will
2198 not collapse such symbols, this macro is defined with value 0.  In
2199 general, user code should not need to make use of this macro; the
2200 purpose of this macro is to ease implementation of the C++ runtime
2201 library provided with G++.
2202
2203 @item __NEXT_RUNTIME__
2204 This macro is defined, with value 1, if (and only if) the NeXT runtime
2205 (as in @option{-fnext-runtime}) is in use for Objective-C@.  If the GNU
2206 runtime is used, this macro is not defined, so that you can use this
2207 macro to determine which runtime (NeXT or GNU) is being used.
2208
2209 @item __LP64__
2210 @itemx _LP64
2211 These macros are defined, with value 1, if (and only if) the compilation
2212 is for a target where @code{long int} and pointer both use 64-bits and
2213 @code{int} uses 32-bit.
2214
2215 @item __SSP__
2216 This macro is defined, with value 1, when @option{-fstack-protector} is in
2217 use.
2218
2219 @item __SSP_ALL__
2220 This macro is defined, with value 2, when @option{-fstack-protector-all} is
2221 in use.
2222
2223 @item __TIMESTAMP__
2224 This macro expands to a string constant that describes the date and time
2225 of the last modification of the current source file. The string constant
2226 contains abbreviated day of the week, month, day of the month, time in
2227 hh:mm:ss form, year and looks like @code{@w{"Sun Sep 16 01:03:52 1973"}}.
2228 If the day of the month is less than 10, it is padded with a space on the left.
2229
2230 If GCC cannot determine the current date, it will emit a warning message
2231 (once per compilation) and @code{__TIMESTAMP__} will expand to
2232 @code{@w{"??? ??? ?? ??:??:?? ????"}}.
2233
2234 @item __GCC_HAVE_SYNC_COMPARE_AND_SWAP_1
2235 @itemx __GCC_HAVE_SYNC_COMPARE_AND_SWAP_2
2236 @itemx __GCC_HAVE_SYNC_COMPARE_AND_SWAP_4
2237 @itemx __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8
2238 @itemx __GCC_HAVE_SYNC_COMPARE_AND_SWAP_16
2239 These macros are defined when the target processor supports atomic compare
2240 and swap operations on operands 1, 2, 4, 8 or 16 bytes in length, respectively.
2241
2242 @item __GCC_HAVE_DWARF2_CFI_ASM
2243 This macro is defined when the compiler is emitting Dwarf2 CFI directives
2244 to the assembler.  When this is defined, it is possible to emit those same
2245 directives in inline assembly.
2246 @end table
2247
2248 @node System-specific Predefined Macros
2249 @subsection System-specific Predefined Macros
2250
2251 @cindex system-specific predefined macros
2252 @cindex predefined macros, system-specific
2253 @cindex reserved namespace
2254
2255 The C preprocessor normally predefines several macros that indicate what
2256 type of system and machine is in use.  They are obviously different on
2257 each target supported by GCC@.  This manual, being for all systems and
2258 machines, cannot tell you what their names are, but you can use
2259 @command{cpp -dM} to see them all.  @xref{Invocation}.  All system-specific
2260 predefined macros expand to the constant 1, so you can test them with
2261 either @samp{#ifdef} or @samp{#if}.
2262
2263 The C standard requires that all system-specific macros be part of the
2264 @dfn{reserved namespace}.  All names which begin with two underscores,
2265 or an underscore and a capital letter, are reserved for the compiler and
2266 library to use as they wish.  However, historically system-specific
2267 macros have had names with no special prefix; for instance, it is common
2268 to find @code{unix} defined on Unix systems.  For all such macros, GCC
2269 provides a parallel macro with two underscores added at the beginning
2270 and the end.  If @code{unix} is defined, @code{__unix__} will be defined
2271 too.  There will never be more than two underscores; the parallel of
2272 @code{_mips} is @code{__mips__}.
2273
2274 When the @option{-ansi} option, or any @option{-std} option that
2275 requests strict conformance, is given to the compiler, all the
2276 system-specific predefined macros outside the reserved namespace are
2277 suppressed.  The parallel macros, inside the reserved namespace, remain
2278 defined.
2279
2280 We are slowly phasing out all predefined macros which are outside the
2281 reserved namespace.  You should never use them in new programs, and we
2282 encourage you to correct older code to use the parallel macros whenever
2283 you find it.  We don't recommend you use the system-specific macros that
2284 are in the reserved namespace, either.  It is better in the long run to
2285 check specifically for features you need, using a tool such as
2286 @command{autoconf}.
2287
2288 @node C++ Named Operators
2289 @subsection C++ Named Operators
2290 @cindex named operators
2291 @cindex C++ named operators
2292 @cindex iso646.h
2293
2294 In C++, there are eleven keywords which are simply alternate spellings
2295 of operators normally written with punctuation.  These keywords are
2296 treated as such even in the preprocessor.  They function as operators in
2297 @samp{#if}, and they cannot be defined as macros or poisoned.  In C, you
2298 can request that those keywords take their C++ meaning by including
2299 @file{iso646.h}.  That header defines each one as a normal object-like
2300 macro expanding to the appropriate punctuator.
2301
2302 These are the named operators and their corresponding punctuators:
2303
2304 @multitable {Named Operator} {Punctuator}
2305 @item Named Operator @tab Punctuator
2306 @item @code{and}    @tab @code{&&}
2307 @item @code{and_eq} @tab @code{&=}
2308 @item @code{bitand} @tab @code{&}
2309 @item @code{bitor}  @tab @code{|}
2310 @item @code{compl}  @tab @code{~}
2311 @item @code{not}    @tab @code{!}
2312 @item @code{not_eq} @tab @code{!=}
2313 @item @code{or}     @tab @code{||}
2314 @item @code{or_eq}  @tab @code{|=}
2315 @item @code{xor}    @tab @code{^}
2316 @item @code{xor_eq} @tab @code{^=}
2317 @end multitable
2318
2319 @node Undefining and Redefining Macros
2320 @section Undefining and Redefining Macros
2321 @cindex undefining macros
2322 @cindex redefining macros
2323 @findex #undef
2324
2325 If a macro ceases to be useful, it may be @dfn{undefined} with the
2326 @samp{#undef} directive.  @samp{#undef} takes a single argument, the
2327 name of the macro to undefine.  You use the bare macro name, even if the
2328 macro is function-like.  It is an error if anything appears on the line
2329 after the macro name.  @samp{#undef} has no effect if the name is not a
2330 macro.
2331
2332 @smallexample
2333 #define FOO 4
2334 x = FOO;        @expansion{} x = 4;
2335 #undef FOO
2336 x = FOO;        @expansion{} x = FOO;
2337 @end smallexample
2338
2339 Once a macro has been undefined, that identifier may be @dfn{redefined}
2340 as a macro by a subsequent @samp{#define} directive.  The new definition
2341 need not have any resemblance to the old definition.
2342
2343 However, if an identifier which is currently a macro is redefined, then
2344 the new definition must be @dfn{effectively the same} as the old one.
2345 Two macro definitions are effectively the same if:
2346 @itemize @bullet
2347 @item Both are the same type of macro (object- or function-like).
2348 @item All the tokens of the replacement list are the same.
2349 @item If there are any parameters, they are the same.
2350 @item Whitespace appears in the same places in both.  It need not be
2351 exactly the same amount of whitespace, though.  Remember that comments
2352 count as whitespace.
2353 @end itemize
2354
2355 @noindent
2356 These definitions are effectively the same:
2357 @smallexample
2358 #define FOUR (2 + 2)
2359 #define FOUR         (2    +    2)
2360 #define FOUR (2 /* @r{two} */ + 2)
2361 @end smallexample
2362 @noindent
2363 but these are not:
2364 @smallexample
2365 #define FOUR (2 + 2)
2366 #define FOUR ( 2+2 )
2367 #define FOUR (2 * 2)
2368 #define FOUR(score,and,seven,years,ago) (2 + 2)
2369 @end smallexample
2370
2371 If a macro is redefined with a definition that is not effectively the
2372 same as the old one, the preprocessor issues a warning and changes the
2373 macro to use the new definition.  If the new definition is effectively
2374 the same, the redefinition is silently ignored.  This allows, for
2375 instance, two different headers to define a common macro.  The
2376 preprocessor will only complain if the definitions do not match.
2377
2378 @node Directives Within Macro Arguments
2379 @section Directives Within Macro Arguments
2380 @cindex macro arguments and directives
2381
2382 Occasionally it is convenient to use preprocessor directives within
2383 the arguments of a macro.  The C and C++ standards declare that
2384 behavior in these cases is undefined.
2385
2386 Versions of CPP prior to 3.2 would reject such constructs with an
2387 error message.  This was the only syntactic difference between normal
2388 functions and function-like macros, so it seemed attractive to remove
2389 this limitation, and people would often be surprised that they could
2390 not use macros in this way.  Moreover, sometimes people would use
2391 conditional compilation in the argument list to a normal library
2392 function like @samp{printf}, only to find that after a library upgrade
2393 @samp{printf} had changed to be a function-like macro, and their code
2394 would no longer compile.  So from version 3.2 we changed CPP to
2395 successfully process arbitrary directives within macro arguments in
2396 exactly the same way as it would have processed the directive were the
2397 function-like macro invocation not present.
2398
2399 If, within a macro invocation, that macro is redefined, then the new
2400 definition takes effect in time for argument pre-expansion, but the
2401 original definition is still used for argument replacement.  Here is a
2402 pathological example:
2403
2404 @smallexample
2405 #define f(x) x x
2406 f (1
2407 #undef f
2408 #define f 2
2409 f)
2410 @end smallexample
2411
2412 @noindent
2413 which expands to
2414
2415 @smallexample
2416 1 2 1 2
2417 @end smallexample
2418
2419 @noindent
2420 with the semantics described above.
2421
2422 @node Macro Pitfalls
2423 @section Macro Pitfalls
2424 @cindex problems with macros
2425 @cindex pitfalls of macros
2426
2427 In this section we describe some special rules that apply to macros and
2428 macro expansion, and point out certain cases in which the rules have
2429 counter-intuitive consequences that you must watch out for.
2430
2431 @menu
2432 * Misnesting::
2433 * Operator Precedence Problems::
2434 * Swallowing the Semicolon::
2435 * Duplication of Side Effects::
2436 * Self-Referential Macros::
2437 * Argument Prescan::
2438 * Newlines in Arguments::
2439 @end menu
2440
2441 @node Misnesting
2442 @subsection Misnesting
2443
2444 When a macro is called with arguments, the arguments are substituted
2445 into the macro body and the result is checked, together with the rest of
2446 the input file, for more macro calls.  It is possible to piece together
2447 a macro call coming partially from the macro body and partially from the
2448 arguments.  For example,
2449
2450 @smallexample
2451 #define twice(x) (2*(x))
2452 #define call_with_1(x) x(1)
2453 call_with_1 (twice)
2454      @expansion{} twice(1)
2455      @expansion{} (2*(1))
2456 @end smallexample
2457
2458 Macro definitions do not have to have balanced parentheses.  By writing
2459 an unbalanced open parenthesis in a macro body, it is possible to create
2460 a macro call that begins inside the macro body but ends outside of it.
2461 For example,
2462
2463 @smallexample
2464 #define strange(file) fprintf (file, "%s %d",
2465 @dots{}
2466 strange(stderr) p, 35)
2467      @expansion{} fprintf (stderr, "%s %d", p, 35)
2468 @end smallexample
2469
2470 The ability to piece together a macro call can be useful, but the use of
2471 unbalanced open parentheses in a macro body is just confusing, and
2472 should be avoided.
2473
2474 @node Operator Precedence Problems
2475 @subsection Operator Precedence Problems
2476 @cindex parentheses in macro bodies
2477
2478 You may have noticed that in most of the macro definition examples shown
2479 above, each occurrence of a macro argument name had parentheses around
2480 it.  In addition, another pair of parentheses usually surround the
2481 entire macro definition.  Here is why it is best to write macros that
2482 way.
2483
2484 Suppose you define a macro as follows,
2485
2486 @smallexample
2487 #define ceil_div(x, y) (x + y - 1) / y
2488 @end smallexample
2489
2490 @noindent
2491 whose purpose is to divide, rounding up.  (One use for this operation is
2492 to compute how many @code{int} objects are needed to hold a certain
2493 number of @code{char} objects.)  Then suppose it is used as follows:
2494
2495 @smallexample
2496 a = ceil_div (b & c, sizeof (int));
2497      @expansion{} a = (b & c + sizeof (int) - 1) / sizeof (int);
2498 @end smallexample
2499
2500 @noindent
2501 This does not do what is intended.  The operator-precedence rules of
2502 C make it equivalent to this:
2503
2504 @smallexample
2505 a = (b & (c + sizeof (int) - 1)) / sizeof (int);
2506 @end smallexample
2507
2508 @noindent
2509 What we want is this:
2510
2511 @smallexample
2512 a = ((b & c) + sizeof (int) - 1)) / sizeof (int);
2513 @end smallexample
2514
2515 @noindent
2516 Defining the macro as
2517
2518 @smallexample
2519 #define ceil_div(x, y) ((x) + (y) - 1) / (y)
2520 @end smallexample
2521
2522 @noindent
2523 provides the desired result.
2524
2525 Unintended grouping can result in another way.  Consider @code{sizeof
2526 ceil_div(1, 2)}.  That has the appearance of a C expression that would
2527 compute the size of the type of @code{ceil_div (1, 2)}, but in fact it
2528 means something very different.  Here is what it expands to:
2529
2530 @smallexample
2531 sizeof ((1) + (2) - 1) / (2)
2532 @end smallexample
2533
2534 @noindent
2535 This would take the size of an integer and divide it by two.  The
2536 precedence rules have put the division outside the @code{sizeof} when it
2537 was intended to be inside.
2538
2539 Parentheses around the entire macro definition prevent such problems.
2540 Here, then, is the recommended way to define @code{ceil_div}:
2541
2542 @smallexample
2543 #define ceil_div(x, y) (((x) + (y) - 1) / (y))
2544 @end smallexample
2545
2546 @node Swallowing the Semicolon
2547 @subsection Swallowing the Semicolon
2548 @cindex semicolons (after macro calls)
2549
2550 Often it is desirable to define a macro that expands into a compound
2551 statement.  Consider, for example, the following macro, that advances a
2552 pointer (the argument @code{p} says where to find it) across whitespace
2553 characters:
2554
2555 @smallexample
2556 #define SKIP_SPACES(p, limit)  \
2557 @{ char *lim = (limit);         \
2558   while (p < lim) @{            \
2559     if (*p++ != ' ') @{         \
2560       p--; break; @}@}@}
2561 @end smallexample
2562
2563 @noindent
2564 Here backslash-newline is used to split the macro definition, which must
2565 be a single logical line, so that it resembles the way such code would
2566 be laid out if not part of a macro definition.
2567
2568 A call to this macro might be @code{SKIP_SPACES (p, lim)}.  Strictly
2569 speaking, the call expands to a compound statement, which is a complete
2570 statement with no need for a semicolon to end it.  However, since it
2571 looks like a function call, it minimizes confusion if you can use it
2572 like a function call, writing a semicolon afterward, as in
2573 @code{SKIP_SPACES (p, lim);}
2574
2575 This can cause trouble before @code{else} statements, because the
2576 semicolon is actually a null statement.  Suppose you write
2577
2578 @smallexample
2579 if (*p != 0)
2580   SKIP_SPACES (p, lim);
2581 else @dots{}
2582 @end smallexample
2583
2584 @noindent
2585 The presence of two statements---the compound statement and a null
2586 statement---in between the @code{if} condition and the @code{else}
2587 makes invalid C code.
2588
2589 The definition of the macro @code{SKIP_SPACES} can be altered to solve
2590 this problem, using a @code{do @dots{} while} statement.  Here is how:
2591
2592 @smallexample
2593 #define SKIP_SPACES(p, limit)     \
2594 do @{ char *lim = (limit);         \
2595      while (p < lim) @{            \
2596        if (*p++ != ' ') @{         \
2597          p--; break; @}@}@}          \
2598 while (0)
2599 @end smallexample
2600
2601 Now @code{SKIP_SPACES (p, lim);} expands into
2602
2603 @smallexample
2604 do @{@dots{}@} while (0);
2605 @end smallexample
2606
2607 @noindent
2608 which is one statement.  The loop executes exactly once; most compilers
2609 generate no extra code for it.
2610
2611 @node Duplication of Side Effects
2612 @subsection Duplication of Side Effects
2613
2614 @cindex side effects (in macro arguments)
2615 @cindex unsafe macros
2616 Many C programs define a macro @code{min}, for ``minimum'', like this:
2617
2618 @smallexample
2619 #define min(X, Y)  ((X) < (Y) ? (X) : (Y))
2620 @end smallexample
2621
2622 When you use this macro with an argument containing a side effect,
2623 as shown here,
2624
2625 @smallexample
2626 next = min (x + y, foo (z));
2627 @end smallexample
2628
2629 @noindent
2630 it expands as follows:
2631
2632 @smallexample
2633 next = ((x + y) < (foo (z)) ? (x + y) : (foo (z)));
2634 @end smallexample
2635
2636 @noindent
2637 where @code{x + y} has been substituted for @code{X} and @code{foo (z)}
2638 for @code{Y}.
2639
2640 The function @code{foo} is used only once in the statement as it appears
2641 in the program, but the expression @code{foo (z)} has been substituted
2642 twice into the macro expansion.  As a result, @code{foo} might be called
2643 two times when the statement is executed.  If it has side effects or if
2644 it takes a long time to compute, the results might not be what you
2645 intended.  We say that @code{min} is an @dfn{unsafe} macro.
2646
2647 The best solution to this problem is to define @code{min} in a way that
2648 computes the value of @code{foo (z)} only once.  The C language offers
2649 no standard way to do this, but it can be done with GNU extensions as
2650 follows:
2651
2652 @smallexample
2653 #define min(X, Y)                \
2654 (@{ typeof (X) x_ = (X);          \
2655    typeof (Y) y_ = (Y);          \
2656    (x_ < y_) ? x_ : y_; @})
2657 @end smallexample
2658
2659 The @samp{(@{ @dots{} @})} notation produces a compound statement that
2660 acts as an expression.  Its value is the value of its last statement.
2661 This permits us to define local variables and assign each argument to
2662 one.  The local variables have underscores after their names to reduce
2663 the risk of conflict with an identifier of wider scope (it is impossible
2664 to avoid this entirely).  Now each argument is evaluated exactly once.
2665
2666 If you do not wish to use GNU C extensions, the only solution is to be
2667 careful when @emph{using} the macro @code{min}.  For example, you can
2668 calculate the value of @code{foo (z)}, save it in a variable, and use
2669 that variable in @code{min}:
2670
2671 @smallexample
2672 @group
2673 #define min(X, Y)  ((X) < (Y) ? (X) : (Y))
2674 @dots{}
2675 @{
2676   int tem = foo (z);
2677   next = min (x + y, tem);
2678 @}
2679 @end group
2680 @end smallexample
2681
2682 @noindent
2683 (where we assume that @code{foo} returns type @code{int}).
2684
2685 @node Self-Referential Macros
2686 @subsection Self-Referential Macros
2687 @cindex self-reference
2688
2689 A @dfn{self-referential} macro is one whose name appears in its
2690 definition.  Recall that all macro definitions are rescanned for more
2691 macros to replace.  If the self-reference were considered a use of the
2692 macro, it would produce an infinitely large expansion.  To prevent this,
2693 the self-reference is not considered a macro call.  It is passed into
2694 the preprocessor output unchanged.  Con