OSDN Git Service

libcpp:
[pf3gnuchains/gcc-fork.git] / 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
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.1 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 Programming
54 @direntry
55 * Cpp: (cpp).                  The GNU C preprocessor.
56 @end direntry
57 @end ifinfo
58
59 @titlepage
60 @title The C Preprocessor
61 @subtitle for GCC version @value{version-GCC}
62 @author Richard M. Stallman
63 @author Zachary Weinberg
64 @page
65 @c There is a fill at the bottom of the page, so we need a filll to
66 @c override it.
67 @vskip 0pt plus 1filll
68 @insertcopying
69 @end titlepage
70 @contents
71 @page
72
73 @ifnottex
74 @node Top
75 @top
76 The C preprocessor implements the macro language used to transform C,
77 C++, and Objective-C programs before they are compiled.  It can also be
78 useful on its own.
79
80 @menu
81 * Overview::
82 * Header Files::
83 * Macros::
84 * Conditionals::
85 * Diagnostics::
86 * Line Control::
87 * Pragmas::
88 * Other Directives::
89 * Preprocessor Output::
90 * Traditional Mode::
91 * Implementation Details::
92 * Invocation::
93 * Environment Variables::
94 * GNU Free Documentation License::
95 * Index of Directives::
96 * Option Index::
97 * Concept Index::
98
99 @detailmenu
100  --- The Detailed Node Listing ---
101
102 Overview
103
104 * Character sets::
105 * Initial processing::
106 * Tokenization::
107 * The preprocessing language::
108
109 Header Files
110
111 * Include Syntax::
112 * Include Operation::
113 * Search Path::
114 * Once-Only Headers::
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 * Assertions::
173 * Obsolete once-only headers::
174
175 @end detailmenu
176 @end menu
177
178 @insertcopying
179 @end ifnottex
180
181 @node Overview
182 @chapter Overview
183 @c man begin DESCRIPTION
184 The C preprocessor, often known as @dfn{cpp}, is a @dfn{macro processor}
185 that is used automatically by the C compiler to transform your program
186 before compilation.  It is called a macro processor because it allows
187 you to define @dfn{macros}, which are brief abbreviations for longer
188 constructs.
189
190 The C preprocessor is intended to be used only with C, C++, and
191 Objective-C source code.  In the past, it has been abused as a general
192 text processor.  It will choke on input which does not obey C's lexical
193 rules.  For example, apostrophes will be interpreted as the beginning of
194 character constants, and cause errors.  Also, you cannot rely on it
195 preserving characteristics of the input which are not significant to
196 C-family languages.  If a Makefile is preprocessed, all the hard tabs
197 will be removed, and the Makefile will not work.
198
199 Having said that, you can often get away with using cpp on things which
200 are not C@.  Other Algol-ish programming languages are often safe
201 (Pascal, Ada, etc.) So is assembly, with caution.  @option{-traditional-cpp}
202 mode preserves more white space, and is otherwise more permissive.  Many
203 of the problems can be avoided by writing C or C++ style comments
204 instead of native language comments, and keeping macros simple.
205
206 Wherever possible, you should use a preprocessor geared to the language
207 you are writing in.  Modern versions of the GNU assembler have macro
208 facilities.  Most high level programming languages have their own
209 conditional compilation and inclusion mechanism.  If all else fails,
210 try a true general text processor, such as GNU M4.
211
212 C preprocessors vary in some details.  This manual discusses the GNU C
213 preprocessor, which provides a small superset of the features of ISO
214 Standard C@.  In its default mode, the GNU C preprocessor does not do a
215 few things required by the standard.  These are features which are
216 rarely, if ever, used, and may cause surprising changes to the meaning
217 of a program which does not expect them.  To get strict ISO Standard C,
218 you should use the @option{-std=c89} or @option{-std=c99} options, depending
219 on which version of the standard you want.  To get all the mandatory
220 diagnostics, you must also use @option{-pedantic}.  @xref{Invocation}.
221
222 This manual describes the behavior of the ISO preprocessor.  To
223 minimize gratuitous differences, where the ISO preprocessor's
224 behavior does not conflict with traditional semantics, the
225 traditional preprocessor should behave the same way.  The various
226 differences that do exist are detailed in the section @ref{Traditional
227 Mode}.
228
229 For clarity, unless noted otherwise, references to @samp{CPP} in this
230 manual refer to GNU CPP@.
231 @c man end
232
233 @menu
234 * Character sets::
235 * Initial processing::
236 * Tokenization::
237 * The preprocessing language::
238 @end menu
239
240 @node Character sets
241 @section Character sets
242
243 Source code character set processing in C and related languages is
244 rather complicated.  The C standard discusses two character sets, but
245 there are really at least four.
246
247 The files input to CPP might be in any character set at all.  CPP's
248 very first action, before it even looks for line boundaries, is to
249 convert the file into the character set it uses for internal
250 processing.  That set is what the C standard calls the @dfn{source}
251 character set.  It must be isomorphic with ISO 10646, also known as
252 Unicode.  CPP uses the UTF-8 encoding of Unicode.
253
254 At present, GNU CPP does not implement conversion from arbitrary file
255 encodings to the source character set.  Use of any encoding other than
256 plain ASCII or UTF-8, except in comments, will cause errors.  Use of
257 encodings that are not strict supersets of ASCII, such as Shift JIS,
258 may cause errors even if non-ASCII characters appear only in comments.
259 We plan to fix this in the near future.
260
261 All preprocessing work (the subject of the rest of this manual) is
262 carried out in the source character set.  If you request textual
263 output from the preprocessor with the @option{-E} option, it will be
264 in UTF-8.
265
266 After preprocessing is complete, string and character constants are
267 converted again, into the @dfn{execution} character set.  This
268 character set is under control of the user; the default is UTF-8,
269 matching the source character set.  Wide string and character
270 constants have their own character set, which is not called out
271 specifically in the standard.  Again, it is under control of the user.
272 The default is UTF-16 or UTF-32, whichever fits in the target's
273 @code{wchar_t} type, in the target machine's byte
274 order.@footnote{UTF-16 does not meet the requirements of the C
275 standard for a wide character set, but the choice of 16-bit
276 @code{wchar_t} is enshrined in some system ABIs so we cannot fix
277 this.}  Octal and hexadecimal escape sequences do not undergo
278 conversion; @t{'\x12'} has the value 0x12 regardless of the currently
279 selected execution character set.  All other escapes are replaced by
280 the character in the source character set that they represent, then
281 converted to the execution character set, just like unescaped
282 characters.
283
284 GCC does not permit the use of characters outside the ASCII range, nor
285 @samp{\u} and @samp{\U} escapes, in identifiers.  We hope this will
286 change eventually, but there are problems with the standard semantics
287 of such ``extended identifiers'' which must be resolved through the
288 ISO C and C++ committees first.
289
290 @node Initial processing
291 @section Initial processing
292
293 The preprocessor performs a series of textual transformations on its
294 input.  These happen before all other processing.  Conceptually, they
295 happen in a rigid order, and the entire file is run through each
296 transformation before the next one begins.  CPP actually does them
297 all at once, for performance reasons.  These transformations correspond
298 roughly to the first three ``phases of translation'' described in the C
299 standard.
300
301 @enumerate
302 @item
303 @cindex line endings
304 The input file is read into memory and broken into lines.
305
306 Different systems use different conventions to indicate the end of a
307 line.  GCC accepts the ASCII control sequences @kbd{LF}, @kbd{@w{CR
308 LF}} and @kbd{CR} as end-of-line markers.  These are the canonical
309 sequences used by Unix, DOS and VMS, and the classic Mac OS (before
310 OSX) respectively.  You may therefore safely copy source code written
311 on any of those systems to a different one and use it without
312 conversion.  (GCC may lose track of the current line number if a file
313 doesn't consistently use one convention, as sometimes happens when it
314 is edited on computers with different conventions that share a network
315 file system.)
316
317 If the last line of any input file lacks an end-of-line marker, the end
318 of the file is considered to implicitly supply one.  The C standard says
319 that this condition provokes undefined behavior, so GCC will emit a
320 warning message.
321
322 @item
323 @cindex trigraphs
324 @anchor{trigraphs}If trigraphs are enabled, they are replaced by their
325 corresponding single characters.  By default GCC ignores trigraphs,
326 but if you request a strictly conforming mode with the @option{-std}
327 option, or you specify the @option{-trigraphs} option, then it
328 converts them.
329
330 These are nine three-character sequences, all starting with @samp{??},
331 that are defined by ISO C to stand for single characters.  They permit
332 obsolete systems that lack some of C's punctuation to use C@.  For
333 example, @samp{??/} stands for @samp{\}, so @t{'??/n'} is a character
334 constant for a newline.
335
336 Trigraphs are not popular and many compilers implement them
337 incorrectly.  Portable code should not rely on trigraphs being either
338 converted or ignored.  With @option{-Wtrigraphs} GCC will warn you
339 when a trigraph may change the meaning of your program if it were
340 converted.  @xref{Wtrigraphs}.
341
342 In a string constant, you can prevent a sequence of question marks
343 from being confused with a trigraph by inserting a backslash between
344 the question marks, or by separating the string literal at the
345 trigraph and making use of string literal concatenation.  @t{"(??\?)"}
346 is the string @samp{(???)}, not @samp{(?]}.  Traditional C compilers
347 do not recognize these idioms.
348
349 The nine trigraphs and their replacements are
350
351 @smallexample
352 Trigraph:       ??(  ??)  ??<  ??>  ??=  ??/  ??'  ??!  ??-
353 Replacement:      [    ]    @{    @}    #    \    ^    |    ~
354 @end smallexample
355
356 @item
357 @cindex continued lines
358 @cindex backslash-newline
359 Continued lines are merged into one long line.
360
361 A continued line is a line which ends with a backslash, @samp{\}.  The
362 backslash is removed and the following line is joined with the current
363 one.  No space is inserted, so you may split a line anywhere, even in
364 the middle of a word.  (It is generally more readable to split lines
365 only at white space.)
366
367 The trailing backslash on a continued line is commonly referred to as a
368 @dfn{backslash-newline}.
369
370 If there is white space between a backslash and the end of a line, that
371 is still a continued line.  However, as this is usually the result of an
372 editing mistake, and many compilers will not accept it as a continued
373 line, GCC will warn you about it.
374
375 @item
376 @cindex comments
377 @cindex line comments
378 @cindex block comments
379 All comments are replaced with single spaces.
380
381 There are two kinds of comments.  @dfn{Block comments} begin with
382 @samp{/*} and continue until the next @samp{*/}.  Block comments do not
383 nest:
384
385 @smallexample
386 /* @r{this is} /* @r{one comment} */ @r{text outside comment}
387 @end smallexample
388
389 @dfn{Line comments} begin with @samp{//} and continue to the end of the
390 current line.  Line comments do not nest either, but it does not matter,
391 because they would end in the same place anyway.
392
393 @smallexample
394 // @r{this is} // @r{one comment}
395 @r{text outside comment}
396 @end smallexample
397 @end enumerate
398
399 It is safe to put line comments inside block comments, or vice versa.
400
401 @smallexample
402 @group
403 /* @r{block comment}
404    // @r{contains line comment}
405    @r{yet more comment}
406  */ @r{outside comment}
407
408 // @r{line comment} /* @r{contains block comment} */
409 @end group
410 @end smallexample
411
412 But beware of commenting out one end of a block comment with a line
413 comment.
414
415 @smallexample
416 @group
417  // @r{l.c.}  /* @r{block comment begins}
418     @r{oops! this isn't a comment anymore} */
419 @end group
420 @end smallexample
421
422 Comments are not recognized within string literals.
423 @t{@w{"/* blah */"}} is the string constant @samp{@w{/* blah */}}, not
424 an empty string.
425
426 Line comments are not in the 1989 edition of the C standard, but they
427 are recognized by GCC as an extension.  In C++ and in the 1999 edition
428 of the C standard, they are an official part of the language.
429
430 Since these transformations happen before all other processing, you can
431 split a line mechanically with backslash-newline anywhere.  You can
432 comment out the end of a line.  You can continue a line comment onto the
433 next line with backslash-newline.  You can even split @samp{/*},
434 @samp{*/}, and @samp{//} onto multiple lines with backslash-newline.
435 For example:
436
437 @smallexample
438 @group
439 /\
440 *
441 */ # /*
442 */ defi\
443 ne FO\
444 O 10\
445 20
446 @end group
447 @end smallexample
448
449 @noindent
450 is equivalent to @code{@w{#define FOO 1020}}.  All these tricks are
451 extremely confusing and should not be used in code intended to be
452 readable.
453
454 There is no way to prevent a backslash at the end of a line from being
455 interpreted as a backslash-newline.  This cannot affect any correct
456 program, however.
457
458 @node Tokenization
459 @section Tokenization
460
461 @cindex tokens
462 @cindex preprocessing tokens
463 After the textual transformations are finished, the input file is
464 converted into a sequence of @dfn{preprocessing tokens}.  These mostly
465 correspond to the syntactic tokens used by the C compiler, but there are
466 a few differences.  White space separates tokens; it is not itself a
467 token of any kind.  Tokens do not have to be separated by white space,
468 but it is often necessary to avoid ambiguities.
469
470 When faced with a sequence of characters that has more than one possible
471 tokenization, the preprocessor is greedy.  It always makes each token,
472 starting from the left, as big as possible before moving on to the next
473 token.  For instance, @code{a+++++b} is interpreted as
474 @code{@w{a ++ ++ + b}}, not as @code{@w{a ++ + ++ b}}, even though the
475 latter tokenization could be part of a valid C program and the former
476 could not.
477
478 Once the input file is broken into tokens, the token boundaries never
479 change, except when the @samp{##} preprocessing operator is used to paste
480 tokens together.  @xref{Concatenation}.  For example,
481
482 @smallexample
483 @group
484 #define foo() bar
485 foo()baz
486      @expansion{} bar baz
487 @emph{not}
488      @expansion{} barbaz
489 @end group
490 @end smallexample
491
492 The compiler does not re-tokenize the preprocessor's output.  Each
493 preprocessing token becomes one compiler token.
494
495 @cindex identifiers
496 Preprocessing tokens fall into five broad classes: identifiers,
497 preprocessing numbers, string literals, punctuators, and other.  An
498 @dfn{identifier} is the same as an identifier in C: any sequence of
499 letters, digits, or underscores, which begins with a letter or
500 underscore.  Keywords of C have no significance to the preprocessor;
501 they are ordinary identifiers.  You can define a macro whose name is a
502 keyword, for instance.  The only identifier which can be considered a
503 preprocessing keyword is @code{defined}.  @xref{Defined}.
504
505 This is mostly true of other languages which use the C preprocessor.
506 However, a few of the keywords of C++ are significant even in the
507 preprocessor.  @xref{C++ Named Operators}.
508
509 In the 1999 C standard, identifiers may contain letters which are not
510 part of the ``basic source character set'', at the implementation's
511 discretion (such as accented Latin letters, Greek letters, or Chinese
512 ideograms).  This may be done with an extended character set, or the
513 @samp{\u} and @samp{\U} escape sequences.  GCC does not presently
514 implement either feature in the preprocessor or the compiler.
515
516 As an extension, GCC treats @samp{$} as a letter.  This is for
517 compatibility with some systems, such as VMS, where @samp{$} is commonly
518 used in system-defined function and object names.  @samp{$} is not a
519 letter in strictly conforming mode, or if you specify the @option{-$}
520 option.  @xref{Invocation}.
521
522 @cindex numbers
523 @cindex preprocessing numbers
524 A @dfn{preprocessing number} has a rather bizarre definition.  The
525 category includes all the normal integer and floating point constants
526 one expects of C, but also a number of other things one might not
527 initially recognize as a number.  Formally, preprocessing numbers begin
528 with an optional period, a required decimal digit, and then continue
529 with any sequence of letters, digits, underscores, periods, and
530 exponents.  Exponents are the two-character sequences @samp{e+},
531 @samp{e-}, @samp{E+}, @samp{E-}, @samp{p+}, @samp{p-}, @samp{P+}, and
532 @samp{P-}.  (The exponents that begin with @samp{p} or @samp{P} are new
533 to C99.  They are used for hexadecimal floating-point constants.)
534
535 The purpose of this unusual definition is to isolate the preprocessor
536 from the full complexity of numeric constants.  It does not have to
537 distinguish between lexically valid and invalid floating-point numbers,
538 which is complicated.  The definition also permits you to split an
539 identifier at any position and get exactly two tokens, which can then be
540 pasted back together with the @samp{##} operator.
541
542 It's possible for preprocessing numbers to cause programs to be
543 misinterpreted.  For example, @code{0xE+12} is a preprocessing number
544 which does not translate to any valid numeric constant, therefore a
545 syntax error.  It does not mean @code{@w{0xE + 12}}, which is what you
546 might have intended.
547
548 @cindex string literals
549 @cindex string constants
550 @cindex character constants
551 @cindex header file names
552 @c the @: prevents makeinfo from turning '' into ".
553 @dfn{String literals} are string constants, character constants, and
554 header file names (the argument of @samp{#include}).@footnote{The C
555 standard uses the term @dfn{string literal} to refer only to what we are
556 calling @dfn{string constants}.}  String constants and character
557 constants are straightforward: @t{"@dots{}"} or @t{'@dots{}'}.  In
558 either case embedded quotes should be escaped with a backslash:
559 @t{'\'@:'} is the character constant for @samp{'}.  There is no limit on
560 the length of a character constant, but the value of a character
561 constant that contains more than one character is
562 implementation-defined.  @xref{Implementation Details}.
563
564 Header file names either look like string constants, @t{"@dots{}"}, or are
565 written with angle brackets instead, @t{<@dots{}>}.  In either case,
566 backslash is an ordinary character.  There is no way to escape the
567 closing quote or angle bracket.  The preprocessor looks for the header
568 file in different places depending on which form you use.  @xref{Include
569 Operation}.
570
571 No string literal may extend past the end of a line.  Older versions
572 of GCC accepted multi-line string constants.  You may use continued
573 lines instead, or string constant concatenation.  @xref{Differences
574 from previous versions}.
575
576 @cindex punctuators
577 @cindex digraphs
578 @cindex alternative tokens
579 @dfn{Punctuators} are all the usual bits of punctuation which are
580 meaningful to C and C++.  All but three of the punctuation characters in
581 ASCII are C punctuators.  The exceptions are @samp{@@}, @samp{$}, and
582 @samp{`}.  In addition, all the two- and three-character operators are
583 punctuators.  There are also six @dfn{digraphs}, which the C++ standard
584 calls @dfn{alternative tokens}, which are merely alternate ways to spell
585 other punctuators.  This is a second attempt to work around missing
586 punctuation in obsolete systems.  It has no negative side effects,
587 unlike trigraphs, but does not cover as much ground.  The digraphs and
588 their corresponding normal punctuators are:
589
590 @smallexample
591 Digraph:        <%  %>  <:  :>  %:  %:%:
592 Punctuator:      @{   @}   [   ]   #    ##
593 @end smallexample
594
595 @cindex other tokens
596 Any other single character is considered ``other''.  It is passed on to
597 the preprocessor's output unmolested.  The C compiler will almost
598 certainly reject source code containing ``other'' tokens.  In ASCII, the
599 only other characters are @samp{@@}, @samp{$}, @samp{`}, and control
600 characters other than NUL (all bits zero).  (Note that @samp{$} is
601 normally considered a letter.)  All characters with the high bit set
602 (numeric range 0x7F--0xFF) are also ``other'' in the present
603 implementation.  This will change when proper support for international
604 character sets is added to GCC@.
605
606 NUL is a special case because of the high probability that its
607 appearance is accidental, and because it may be invisible to the user
608 (many terminals do not display NUL at all).  Within comments, NULs are
609 silently ignored, just as any other character would be.  In running
610 text, NUL is considered white space.  For example, these two directives
611 have the same meaning.
612
613 @smallexample
614 #define X^@@1
615 #define X 1
616 @end smallexample
617
618 @noindent
619 (where @samp{^@@} is ASCII NUL)@.  Within string or character constants,
620 NULs are preserved.  In the latter two cases the preprocessor emits a
621 warning message.
622
623 @node The preprocessing language
624 @section The preprocessing language
625 @cindex directives
626 @cindex preprocessing directives
627 @cindex directive line
628 @cindex directive name
629
630 After tokenization, the stream of tokens may simply be passed straight
631 to the compiler's parser.  However, if it contains any operations in the
632 @dfn{preprocessing language}, it will be transformed first.  This stage
633 corresponds roughly to the standard's ``translation phase 4'' and is
634 what most people think of as the preprocessor's job.
635
636 The preprocessing language consists of @dfn{directives} to be executed
637 and @dfn{macros} to be expanded.  Its primary capabilities are:
638
639 @itemize @bullet
640 @item
641 Inclusion of header files.  These are files of declarations that can be
642 substituted into your program.
643
644 @item
645 Macro expansion.  You can define @dfn{macros}, which are abbreviations
646 for arbitrary fragments of C code.  The preprocessor will replace the
647 macros with their definitions throughout the program.  Some macros are
648 automatically defined for you.
649
650 @item
651 Conditional compilation.  You can include or exclude parts of the
652 program according to various conditions.
653
654 @item
655 Line control.  If you use a program to combine or rearrange source files
656 into an intermediate file which is then compiled, you can use line
657 control to inform the compiler where each source line originally came
658 from.
659
660 @item
661 Diagnostics.  You can detect problems at compile time and issue errors
662 or warnings.
663 @end itemize
664
665 There are a few more, less useful, features.
666
667 Except for expansion of predefined macros, all these operations are
668 triggered with @dfn{preprocessing directives}.  Preprocessing directives
669 are lines in your program that start with @samp{#}.  Whitespace is
670 allowed before and after the @samp{#}.  The @samp{#} is followed by an
671 identifier, the @dfn{directive name}.  It specifies the operation to
672 perform.  Directives are commonly referred to as @samp{#@var{name}}
673 where @var{name} is the directive name.  For example, @samp{#define} is
674 the directive that defines a macro.
675
676 The @samp{#} which begins a directive cannot come from a macro
677 expansion.  Also, the directive name is not macro expanded.  Thus, if
678 @code{foo} is defined as a macro expanding to @code{define}, that does
679 not make @samp{#foo} a valid preprocessing directive.
680
681 The set of valid directive names is fixed.  Programs cannot define new
682 preprocessing directives.
683
684 Some directives require arguments; these make up the rest of the
685 directive line and must be separated from the directive name by
686 whitespace.  For example, @samp{#define} must be followed by a macro
687 name and the intended expansion of the macro.
688
689 A preprocessing directive cannot cover more than one line.  The line
690 may, however, be continued with backslash-newline, or by a block comment
691 which extends past the end of the line.  In either case, when the
692 directive is processed, the continuations have already been merged with
693 the first line to make one long line.
694
695 @node Header Files
696 @chapter Header Files
697
698 @cindex header file
699 A header file is a file containing C declarations and macro definitions
700 (@pxref{Macros}) to be shared between several source files.  You request
701 the use of a header file in your program by @dfn{including} it, with the
702 C preprocessing directive @samp{#include}.
703
704 Header files serve two purposes.
705
706 @itemize @bullet
707 @item
708 @cindex system header files
709 System header files declare the interfaces to parts of the operating
710 system.  You include them in your program to supply the definitions and
711 declarations you need to invoke system calls and libraries.
712
713 @item
714 Your own header files contain declarations for interfaces between the
715 source files of your program.  Each time you have a group of related
716 declarations and macro definitions all or most of which are needed in
717 several different source files, it is a good idea to create a header
718 file for them.
719 @end itemize
720
721 Including a header file produces the same results as copying the header
722 file into each source file that needs it.  Such copying would be
723 time-consuming and error-prone.  With a header file, the related
724 declarations appear in only one place.  If they need to be changed, they
725 can be changed in one place, and programs that include the header file
726 will automatically use the new version when next recompiled.  The header
727 file eliminates the labor of finding and changing all the copies as well
728 as the risk that a failure to find one copy will result in
729 inconsistencies within a program.
730
731 In C, the usual convention is to give header files names that end with
732 @file{.h}.  It is most portable to use only letters, digits, dashes, and
733 underscores in header file names, and at most one dot.
734
735 @menu
736 * Include Syntax::
737 * Include Operation::
738 * Search Path::
739 * Once-Only Headers::
740 * Computed Includes::
741 * Wrapper Headers::
742 * System Headers::
743 @end menu
744
745 @node Include Syntax
746 @section Include Syntax
747
748 @findex #include
749 Both user and system header files are included using the preprocessing
750 directive @samp{#include}.  It has two variants:
751
752 @table @code
753 @item #include <@var{file}>
754 This variant is used for system header files.  It searches for a file
755 named @var{file} in a standard list of system directories.  You can prepend
756 directories to this list with the @option{-I} option (@pxref{Invocation}).
757
758 @item #include "@var{file}"
759 This variant is used for header files of your own program.  It
760 searches for a file named @var{file} first in the directory containing
761 the current file, then in the quote directories and then the same
762 directories used for @code{<@var{file}>}.  You can prepend directories
763 to the list of quote directories with the @option{-iquote} option.
764 @end table
765
766 The argument of @samp{#include}, whether delimited with quote marks or
767 angle brackets, behaves like a string constant in that comments are not
768 recognized, and macro names are not expanded.  Thus, @code{@w{#include
769 <x/*y>}} specifies inclusion of a system header file named @file{x/*y}.
770
771 However, if backslashes occur within @var{file}, they are considered
772 ordinary text characters, not escape characters.  None of the character
773 escape sequences appropriate to string constants in C are processed.
774 Thus, @code{@w{#include "x\n\\y"}} specifies a filename containing three
775 backslashes.  (Some systems interpret @samp{\} as a pathname separator.
776 All of these also interpret @samp{/} the same way.  It is most portable
777 to use only @samp{/}.)
778
779 It is an error if there is anything (other than comments) on the line
780 after the file name.
781
782 @node Include Operation
783 @section Include Operation
784
785 The @samp{#include} directive works by directing the C preprocessor to
786 scan the specified file as input before continuing with the rest of the
787 current file.  The output from the preprocessor contains the output
788 already generated, followed by the output resulting from the included
789 file, followed by the output that comes from the text after the
790 @samp{#include} directive.  For example, if you have a header file
791 @file{header.h} as follows,
792
793 @smallexample
794 char *test (void);
795 @end smallexample
796
797 @noindent
798 and a main program called @file{program.c} that uses the header file,
799 like this,
800
801 @smallexample
802 int x;
803 #include "header.h"
804
805 int
806 main (void)
807 @{
808   puts (test ());
809 @}
810 @end smallexample
811
812 @noindent
813 the compiler will see the same token stream as it would if
814 @file{program.c} read
815
816 @smallexample
817 int x;
818 char *test (void);
819
820 int
821 main (void)
822 @{
823   puts (test ());
824 @}
825 @end smallexample
826
827 Included files are not limited to declarations and macro definitions;
828 those are merely the typical uses.  Any fragment of a C program can be
829 included from another file.  The include file could even contain the
830 beginning of a statement that is concluded in the containing file, or
831 the end of a statement that was started in the including file.  However,
832 an included file must consist of complete tokens.  Comments and string
833 literals which have not been closed by the end of an included file are
834 invalid.  For error recovery, they are considered to end at the end of
835 the file.
836
837 To avoid confusion, it is best if header files contain only complete
838 syntactic units---function declarations or definitions, type
839 declarations, etc.
840
841 The line following the @samp{#include} directive is always treated as a
842 separate line by the C preprocessor, even if the included file lacks a
843 final newline.
844
845 @node Search Path
846 @section Search Path
847
848 GCC looks in several different places for headers.  On a normal Unix
849 system, if you do not instruct it otherwise, it will look for headers
850 requested with @code{@w{#include <@var{file}>}} in:
851
852 @smallexample
853 /usr/local/include
854 @var{libdir}/gcc/@var{target}/@var{version}/include
855 /usr/@var{target}/include
856 /usr/include
857 @end smallexample
858
859 For C++ programs, it will also look in @file{/usr/include/g++-v3},
860 first.  In the above, @var{target} is the canonical name of the system
861 GCC was configured to compile code for; often but not always the same as
862 the canonical name of the system it runs on.  @var{version} is the
863 version of GCC in use.
864
865 You can add to this list with the @option{-I@var{dir}} command line
866 option.  All the directories named by @option{-I} are searched, in
867 left-to-right order, @emph{before} the default directories.  The only
868 exception is when @file{dir} is already searched by default.  In
869 this case, the option is ignored and the search order for system
870 directories remains unchanged.
871
872 Duplicate directories are removed from the quote and bracket search
873 chains before the two chains are merged to make the final search chain.
874 Thus, it is possible for a directory to occur twice in the final search
875 chain if it was specified in both the quote and bracket chains.
876
877 You can prevent GCC from searching any of the default directories with
878 the @option{-nostdinc} option.  This is useful when you are compiling an
879 operating system kernel or some other program that does not use the
880 standard C library facilities, or the standard C library itself.
881 @option{-I} options are not ignored as described above when
882 @option{-nostdinc} is in effect.
883
884 GCC looks for headers requested with @code{@w{#include "@var{file}"}}
885 first in the directory containing the current file, then in the
886 directories as specified by @option{-iquote} options, then in the same
887 places it would have looked for a header requested with angle
888 brackets.  For example, if @file{/usr/include/sys/stat.h} contains
889 @code{@w{#include "types.h"}}, GCC looks for @file{types.h} first in
890 @file{/usr/include/sys}, then in its usual search path.
891
892 @samp{#line} (@pxref{Line Control}) does not change GCC's idea of the
893 directory containing the current file.
894
895 You may put @option{-I-} at any point in your list of @option{-I} options.
896 This has two effects.  First, directories appearing before the
897 @option{-I-} in the list are searched only for headers requested with
898 quote marks.  Directories after @option{-I-} are searched for all
899 headers.  Second, the directory containing the current file is not
900 searched for anything, unless it happens to be one of the directories
901 named by an @option{-I} switch.  @option{-I-} is deprecated, @option{-iquote}
902 should be used instead.
903
904 @option{-I. -I-} is not the same as no @option{-I} options at all, and does
905 not cause the same behavior for @samp{<>} includes that @samp{""}
906 includes get with no special options.  @option{-I.} searches the
907 compiler's current working directory for header files.  That may or may
908 not be the same as the directory containing the current file.
909
910 If you need to look for headers in a directory named @file{-}, write
911 @option{-I./-}.
912
913 There are several more ways to adjust the header search path.  They are
914 generally less useful.  @xref{Invocation}.
915
916 @node Once-Only Headers
917 @section Once-Only Headers
918 @cindex repeated inclusion
919 @cindex including just once
920 @cindex wrapper @code{#ifndef}
921
922 If a header file happens to be included twice, the compiler will process
923 its contents twice.  This is very likely to cause an error, e.g.@: when the
924 compiler sees the same structure definition twice.  Even if it does not,
925 it will certainly waste time.
926
927 The standard way to prevent this is to enclose the entire real contents
928 of the file in a conditional, like this:
929
930 @smallexample
931 @group
932 /* File foo.  */
933 #ifndef FILE_FOO_SEEN
934 #define FILE_FOO_SEEN
935
936 @var{the entire file}
937
938 #endif /* !FILE_FOO_SEEN */
939 @end group
940 @end smallexample
941
942 This construct is commonly known as a @dfn{wrapper #ifndef}.
943 When the header is included again, the conditional will be false,
944 because @code{FILE_FOO_SEEN} is defined.  The preprocessor will skip
945 over the entire contents of the file, and the compiler will not see it
946 twice.
947
948 CPP optimizes even further.  It remembers when a header file has a
949 wrapper @samp{#ifndef}.  If a subsequent @samp{#include} specifies that
950 header, and the macro in the @samp{#ifndef} is still defined, it does
951 not bother to rescan the file at all.
952
953 You can put comments outside the wrapper.  They will not interfere with
954 this optimization.
955
956 @cindex controlling macro
957 @cindex guard macro
958 The macro @code{FILE_FOO_SEEN} is called the @dfn{controlling macro} or
959 @dfn{guard macro}.  In a user header file, the macro name should not
960 begin with @samp{_}.  In a system header file, it should begin with
961 @samp{__} to avoid conflicts with user programs.  In any kind of header
962 file, the macro name should contain the name of the file and some
963 additional text, to avoid conflicts with other header files.
964
965 @node Computed Includes
966 @section Computed Includes
967 @cindex computed includes
968 @cindex macros in include
969
970 Sometimes it is necessary to select one of several different header
971 files to be included into your program.  They might specify
972 configuration parameters to be used on different sorts of operating
973 systems, for instance.  You could do this with a series of conditionals,
974
975 @smallexample
976 #if SYSTEM_1
977 # include "system_1.h"
978 #elif SYSTEM_2
979 # include "system_2.h"
980 #elif SYSTEM_3
981 @dots{}
982 #endif
983 @end smallexample
984
985 That rapidly becomes tedious.  Instead, the preprocessor offers the
986 ability to use a macro for the header name.  This is called a
987 @dfn{computed include}.  Instead of writing a header name as the direct
988 argument of @samp{#include}, you simply put a macro name there instead:
989
990 @smallexample
991 #define SYSTEM_H "system_1.h"
992 @dots{}
993 #include SYSTEM_H
994 @end smallexample
995
996 @noindent
997 @code{SYSTEM_H} will be expanded, and the preprocessor will look for
998 @file{system_1.h} as if the @samp{#include} had been written that way
999 originally.  @code{SYSTEM_H} could be defined by your Makefile with a
1000 @option{-D} option.
1001
1002 You must be careful when you define the macro.  @samp{#define} saves
1003 tokens, not text.  The preprocessor has no way of knowing that the macro
1004 will be used as the argument of @samp{#include}, so it generates
1005 ordinary tokens, not a header name.  This is unlikely to cause problems
1006 if you use double-quote includes, which are close enough to string
1007 constants.  If you use angle brackets, however, you may have trouble.
1008
1009 The syntax of a computed include is actually a bit more general than the
1010 above.  If the first non-whitespace character after @samp{#include} is
1011 not @samp{"} or @samp{<}, then the entire line is macro-expanded
1012 like running text would be.
1013
1014 If the line expands to a single string constant, the contents of that
1015 string constant are the file to be included.  CPP does not re-examine the
1016 string for embedded quotes, but neither does it process backslash
1017 escapes in the string.  Therefore
1018
1019 @smallexample
1020 #define HEADER "a\"b"
1021 #include HEADER
1022 @end smallexample
1023
1024 @noindent
1025 looks for a file named @file{a\"b}.  CPP searches for the file according
1026 to the rules for double-quoted includes.
1027
1028 If the line expands to a token stream beginning with a @samp{<} token
1029 and including a @samp{>} token, then the tokens between the @samp{<} and
1030 the first @samp{>} are combined to form the filename to be included.
1031 Any whitespace between tokens is reduced to a single space; then any
1032 space after the initial @samp{<} is retained, but a trailing space
1033 before the closing @samp{>} is ignored.  CPP searches for the file
1034 according to the rules for angle-bracket includes.
1035
1036 In either case, if there are any tokens on the line after the file name,
1037 an error occurs and the directive is not processed.  It is also an error
1038 if the result of expansion does not match either of the two expected
1039 forms.
1040
1041 These rules are implementation-defined behavior according to the C
1042 standard.  To minimize the risk of different compilers interpreting your
1043 computed includes differently, we recommend you use only a single
1044 object-like macro which expands to a string constant.  This will also
1045 minimize confusion for people reading your program.
1046
1047 @node Wrapper Headers
1048 @section Wrapper Headers
1049 @cindex wrapper headers
1050 @cindex overriding a header file
1051 @findex #include_next
1052
1053 Sometimes it is necessary to adjust the contents of a system-provided
1054 header file without editing it directly.  GCC's @command{fixincludes}
1055 operation does this, for example.  One way to do that would be to create
1056 a new header file with the same name and insert it in the search path
1057 before the original header.  That works fine as long as you're willing
1058 to replace the old header entirely.  But what if you want to refer to
1059 the old header from the new one?
1060
1061 You cannot simply include the old header with @samp{#include}.  That
1062 will start from the beginning, and find your new header again.  If your
1063 header is not protected from multiple inclusion (@pxref{Once-Only
1064 Headers}), it will recurse infinitely and cause a fatal error.
1065
1066 You could include the old header with an absolute pathname:
1067 @smallexample
1068 #include "/usr/include/old-header.h"
1069 @end smallexample
1070 @noindent
1071 This works, but is not clean; should the system headers ever move, you
1072 would have to edit the new headers to match.
1073
1074 There is no way to solve this problem within the C standard, but you can
1075 use the GNU extension @samp{#include_next}.  It means, ``Include the
1076 @emph{next} file with this name''.  This directive works like
1077 @samp{#include} except in searching for the specified file: it starts
1078 searching the list of header file directories @emph{after} the directory
1079 in which the current file was found.
1080
1081 Suppose you specify @option{-I /usr/local/include}, and the list of
1082 directories to search also includes @file{/usr/include}; and suppose
1083 both directories contain @file{signal.h}.  Ordinary @code{@w{#include
1084 <signal.h>}} finds the file under @file{/usr/local/include}.  If that
1085 file contains @code{@w{#include_next <signal.h>}}, it starts searching
1086 after that directory, and finds the file in @file{/usr/include}.
1087
1088 @samp{#include_next} does not distinguish between @code{<@var{file}>}
1089 and @code{"@var{file}"} inclusion, nor does it check that the file you
1090 specify has the same name as the current file.  It simply looks for the
1091 file named, starting with the directory in the search path after the one
1092 where the current file was found.
1093
1094 The use of @samp{#include_next} can lead to great confusion.  We
1095 recommend it be used only when there is no other alternative.  In
1096 particular, it should not be used in the headers belonging to a specific
1097 program; it should be used only to make global corrections along the
1098 lines of @command{fixincludes}.
1099
1100 @node System Headers
1101 @section System Headers
1102 @cindex system header files
1103
1104 The header files declaring interfaces to the operating system and
1105 runtime libraries often cannot be written in strictly conforming C@.
1106 Therefore, GCC gives code found in @dfn{system headers} special
1107 treatment.  All warnings, other than those generated by @samp{#warning}
1108 (@pxref{Diagnostics}), are suppressed while GCC is processing a system
1109 header.  Macros defined in a system header are immune to a few warnings
1110 wherever they are expanded.  This immunity is granted on an ad-hoc
1111 basis, when we find that a warning generates lots of false positives
1112 because of code in macros defined in system headers.
1113
1114 Normally, only the headers found in specific directories are considered
1115 system headers.  These directories are determined when GCC is compiled.
1116 There are, however, two ways to make normal headers into system headers.
1117
1118 The @option{-isystem} command line option adds its argument to the list of
1119 directories to search for headers, just like @option{-I}.  Any headers
1120 found in that directory will be considered system headers.
1121
1122 All directories named by @option{-isystem} are searched @emph{after} all
1123 directories named by @option{-I}, no matter what their order was on the
1124 command line.  If the same directory is named by both @option{-I} and
1125 @option{-isystem}, the @option{-I} option is ignored.  GCC provides an
1126 informative message when this occurs if @option{-v} is used.
1127
1128 @findex #pragma GCC system_header
1129 There is also a directive, @code{@w{#pragma GCC system_header}}, which
1130 tells GCC to consider the rest of the current include file a system
1131 header, no matter where it was found.  Code that comes before the
1132 @samp{#pragma} in the file will not be affected.  @code{@w{#pragma GCC
1133 system_header}} has no effect in the primary source file.
1134
1135 On very old systems, some of the pre-defined system header directories
1136 get even more special treatment.  GNU C++ considers code in headers
1137 found in those directories to be surrounded by an @code{@w{extern "C"}}
1138 block.  There is no way to request this behavior with a @samp{#pragma},
1139 or from the command line.
1140
1141 @node Macros
1142 @chapter Macros
1143
1144 A @dfn{macro} is a fragment of code which has been given a name.
1145 Whenever the name is used, it is replaced by the contents of the macro.
1146 There are two kinds of macros.  They differ mostly in what they look
1147 like when they are used.  @dfn{Object-like} macros resemble data objects
1148 when used, @dfn{function-like} macros resemble function calls.
1149
1150 You may define any valid identifier as a macro, even if it is a C
1151 keyword.  The preprocessor does not know anything about keywords.  This
1152 can be useful if you wish to hide a keyword such as @code{const} from an
1153 older compiler that does not understand it.  However, the preprocessor
1154 operator @code{defined} (@pxref{Defined}) can never be defined as a
1155 macro, and C++'s named operators (@pxref{C++ Named Operators}) cannot be
1156 macros when you are compiling C++.
1157
1158 @menu
1159 * Object-like Macros::
1160 * Function-like Macros::
1161 * Macro Arguments::
1162 * Stringification::
1163 * Concatenation::
1164 * Variadic Macros::
1165 * Predefined Macros::
1166 * Undefining and Redefining Macros::
1167 * Directives Within Macro Arguments::
1168 * Macro Pitfalls::
1169 @end menu
1170
1171 @node Object-like Macros
1172 @section Object-like Macros
1173 @cindex object-like macro
1174 @cindex symbolic constants
1175 @cindex manifest constants
1176
1177 An @dfn{object-like macro} is a simple identifier which will be replaced
1178 by a code fragment.  It is called object-like because it looks like a
1179 data object in code that uses it.  They are most commonly used to give
1180 symbolic names to numeric constants.
1181
1182 @findex #define
1183 You create macros with the @samp{#define} directive.  @samp{#define} is
1184 followed by the name of the macro and then the token sequence it should
1185 be an abbreviation for, which is variously referred to as the macro's
1186 @dfn{body}, @dfn{expansion} or @dfn{replacement list}.  For example,
1187
1188 @smallexample
1189 #define BUFFER_SIZE 1024
1190 @end smallexample
1191
1192 @noindent
1193 defines a macro named @code{BUFFER_SIZE} as an abbreviation for the
1194 token @code{1024}.  If somewhere after this @samp{#define} directive
1195 there comes a C statement of the form
1196
1197 @smallexample
1198 foo = (char *) malloc (BUFFER_SIZE);
1199 @end smallexample
1200
1201 @noindent
1202 then the C preprocessor will recognize and @dfn{expand} the macro
1203 @code{BUFFER_SIZE}.  The C compiler will see the same tokens as it would
1204 if you had written
1205
1206 @smallexample
1207 foo = (char *) malloc (1024);
1208 @end smallexample
1209
1210 By convention, macro names are written in uppercase.  Programs are
1211 easier to read when it is possible to tell at a glance which names are
1212 macros.
1213
1214 The macro's body ends at the end of the @samp{#define} line.  You may
1215 continue the definition onto multiple lines, if necessary, using
1216 backslash-newline.  When the macro is expanded, however, it will all
1217 come out on one line.  For example,
1218
1219 @smallexample
1220 #define NUMBERS 1, \
1221                 2, \
1222                 3
1223 int x[] = @{ NUMBERS @};
1224      @expansion{} int x[] = @{ 1, 2, 3 @};
1225 @end smallexample
1226
1227 @noindent
1228 The most common visible consequence of this is surprising line numbers
1229 in error messages.
1230
1231 There is no restriction on what can go in a macro body provided it
1232 decomposes into valid preprocessing tokens.  Parentheses need not
1233 balance, and the body need not resemble valid C code.  (If it does not,
1234 you may get error messages from the C compiler when you use the macro.)
1235
1236 The C preprocessor scans your program sequentially.  Macro definitions
1237 take effect at the place you write them.  Therefore, the following input
1238 to the C preprocessor
1239
1240 @smallexample
1241 foo = X;
1242 #define X 4
1243 bar = X;
1244 @end smallexample
1245
1246 @noindent
1247 produces
1248
1249 @smallexample
1250 foo = X;
1251 bar = 4;
1252 @end smallexample
1253
1254 When the preprocessor expands a macro name, the macro's expansion
1255 replaces the macro invocation, then the expansion is examined for more
1256 macros to expand.  For example,
1257
1258 @smallexample
1259 @group
1260 #define TABLESIZE BUFSIZE
1261 #define BUFSIZE 1024
1262 TABLESIZE
1263      @expansion{} BUFSIZE
1264      @expansion{} 1024
1265 @end group
1266 @end smallexample
1267
1268 @noindent
1269 @code{TABLESIZE} is expanded first to produce @code{BUFSIZE}, then that
1270 macro is expanded to produce the final result, @code{1024}.
1271
1272 Notice that @code{BUFSIZE} was not defined when @code{TABLESIZE} was
1273 defined.  The @samp{#define} for @code{TABLESIZE} uses exactly the
1274 expansion you specify---in this case, @code{BUFSIZE}---and does not
1275 check to see whether it too contains macro names.  Only when you
1276 @emph{use} @code{TABLESIZE} is the result of its expansion scanned for
1277 more macro names.
1278
1279 This makes a difference if you change the definition of @code{BUFSIZE}
1280 at some point in the source file.  @code{TABLESIZE}, defined as shown,
1281 will always expand using the definition of @code{BUFSIZE} that is
1282 currently in effect:
1283
1284 @smallexample
1285 #define BUFSIZE 1020
1286 #define TABLESIZE BUFSIZE
1287 #undef BUFSIZE
1288 #define BUFSIZE 37
1289 @end smallexample
1290
1291 @noindent
1292 Now @code{TABLESIZE} expands (in two stages) to @code{37}.
1293
1294 If the expansion of a macro contains its own name, either directly or
1295 via intermediate macros, it is not expanded again when the expansion is
1296 examined for more macros.  This prevents infinite recursion.
1297 @xref{Self-Referential Macros}, for the precise details.
1298
1299 @node Function-like Macros
1300 @section Function-like Macros
1301 @cindex function-like macros
1302
1303 You can also define macros whose use looks like a function call.  These
1304 are called @dfn{function-like macros}.  To define a function-like macro,
1305 you use the same @samp{#define} directive, but you put a pair of
1306 parentheses immediately after the macro name.  For example,
1307
1308 @smallexample
1309 #define lang_init()  c_init()
1310 lang_init()
1311      @expansion{} c_init()
1312 @end smallexample
1313
1314 A function-like macro is only expanded if its name appears with a pair
1315 of parentheses after it.  If you write just the name, it is left alone.
1316 This can be useful when you have a function and a macro of the same
1317 name, and you wish to use the function sometimes.
1318
1319 @smallexample
1320 extern void foo(void);
1321 #define foo() /* @r{optimized inline version} */
1322 @dots{}
1323   foo();
1324   funcptr = foo;
1325 @end smallexample
1326
1327 Here the call to @code{foo()} will use the macro, but the function
1328 pointer will get the address of the real function.  If the macro were to
1329 be expanded, it would cause a syntax error.
1330
1331 If you put spaces between the macro name and the parentheses in the
1332 macro definition, that does not define a function-like macro, it defines
1333 an object-like macro whose expansion happens to begin with a pair of
1334 parentheses.
1335
1336 @smallexample
1337 #define lang_init ()    c_init()
1338 lang_init()
1339      @expansion{} () c_init()()
1340 @end smallexample
1341
1342 The first two pairs of parentheses in this expansion come from the
1343 macro.  The third is the pair that was originally after the macro
1344 invocation.  Since @code{lang_init} is an object-like macro, it does not
1345 consume those parentheses.
1346
1347 @node Macro Arguments
1348 @section Macro Arguments
1349 @cindex arguments
1350 @cindex macros with arguments
1351 @cindex arguments in macro definitions
1352
1353 Function-like macros can take @dfn{arguments}, just like true functions.
1354 To define a macro that uses arguments, you insert @dfn{parameters}
1355 between the pair of parentheses in the macro definition that make the
1356 macro function-like.  The parameters must be valid C identifiers,
1357 separated by commas and optionally whitespace.
1358
1359 To invoke a macro that takes arguments, you write the name of the macro
1360 followed by a list of @dfn{actual arguments} in parentheses, separated
1361 by commas.  The invocation of the macro need not be restricted to a
1362 single logical line---it can cross as many lines in the source file as
1363 you wish.  The number of arguments you give must match the number of
1364 parameters in the macro definition.  When the macro is expanded, each
1365 use of a parameter in its body is replaced by the tokens of the
1366 corresponding argument.  (You need not use all of the parameters in the
1367 macro body.)
1368
1369 As an example, here is a macro that computes the minimum of two numeric
1370 values, as it is defined in many C programs, and some uses.
1371
1372 @smallexample
1373 #define min(X, Y)  ((X) < (Y) ? (X) : (Y))
1374   x = min(a, b);          @expansion{}  x = ((a) < (b) ? (a) : (b));
1375   y = min(1, 2);          @expansion{}  y = ((1) < (2) ? (1) : (2));
1376   z = min(a + 28, *p);    @expansion{}  z = ((a + 28) < (*p) ? (a + 28) : (*p));
1377 @end smallexample
1378
1379 @noindent
1380 (In this small example you can already see several of the dangers of
1381 macro arguments.  @xref{Macro Pitfalls}, for detailed explanations.)
1382
1383 Leading and trailing whitespace in each argument is dropped, and all
1384 whitespace between the tokens of an argument is reduced to a single
1385 space.  Parentheses within each argument must balance; a comma within
1386 such parentheses does not end the argument.  However, there is no
1387 requirement for square brackets or braces to balance, and they do not
1388 prevent a comma from separating arguments.  Thus,
1389
1390 @smallexample
1391 macro (array[x = y, x + 1])
1392 @end smallexample
1393
1394 @noindent
1395 passes two arguments to @code{macro}: @code{array[x = y} and @code{x +
1396 1]}.  If you want to supply @code{array[x = y, x + 1]} as an argument,
1397 you can write it as @code{array[(x = y, x + 1)]}, which is equivalent C
1398 code.
1399
1400 All arguments to a macro are completely macro-expanded before they are
1401 substituted into the macro body.  After substitution, the complete text
1402 is scanned again for macros to expand, including the arguments.  This rule
1403 may seem strange, but it is carefully designed so you need not worry
1404 about whether any function call is actually a macro invocation.  You can
1405 run into trouble if you try to be too clever, though.  @xref{Argument
1406 Prescan}, for detailed discussion.
1407
1408 For example, @code{min (min (a, b), c)} is first expanded to
1409
1410 @smallexample
1411   min (((a) < (b) ? (a) : (b)), (c))
1412 @end smallexample
1413
1414 @noindent
1415 and then to
1416
1417 @smallexample
1418 @group
1419 ((((a) < (b) ? (a) : (b))) < (c)
1420  ? (((a) < (b) ? (a) : (b)))
1421  : (c))
1422 @end group
1423 @end smallexample
1424
1425 @noindent
1426 (Line breaks shown here for clarity would not actually be generated.)
1427
1428 @cindex empty macro arguments
1429 You can leave macro arguments empty; this is not an error to the
1430 preprocessor (but many macros will then expand to invalid code).
1431 You cannot leave out arguments entirely; if a macro takes two arguments,
1432 there must be exactly one comma at the top level of its argument list.
1433 Here are some silly examples using @code{min}:
1434
1435 @smallexample
1436 min(, b)        @expansion{} ((   ) < (b) ? (   ) : (b))
1437 min(a, )        @expansion{} ((a  ) < ( ) ? (a  ) : ( ))
1438 min(,)          @expansion{} ((   ) < ( ) ? (   ) : ( ))
1439 min((,),)       @expansion{} (((,)) < ( ) ? ((,)) : ( ))
1440
1441 min()      @error{} macro "min" requires 2 arguments, but only 1 given
1442 min(,,)    @error{} macro "min" passed 3 arguments, but takes just 2
1443 @end smallexample
1444
1445 Whitespace is not a preprocessing token, so if a macro @code{foo} takes
1446 one argument, @code{@w{foo ()}} and @code{@w{foo ( )}} both supply it an
1447 empty argument.  Previous GNU preprocessor implementations and
1448 documentation were incorrect on this point, insisting that a
1449 function-like macro that takes a single argument be passed a space if an
1450 empty argument was required.
1451
1452 Macro parameters appearing inside string literals are not replaced by
1453 their corresponding actual arguments.
1454
1455 @smallexample
1456 #define foo(x) x, "x"
1457 foo(bar)        @expansion{} bar, "x"
1458 @end smallexample
1459
1460 @node Stringification
1461 @section Stringification
1462 @cindex stringification
1463 @cindex @samp{#} operator
1464
1465 Sometimes you may want to convert a macro argument into a string
1466 constant.  Parameters are not replaced inside string constants, but you
1467 can use the @samp{#} preprocessing operator instead.  When a macro
1468 parameter is used with a leading @samp{#}, the preprocessor replaces it
1469 with the literal text of the actual argument, converted to a string
1470 constant.  Unlike normal parameter replacement, the argument is not
1471 macro-expanded first.  This is called @dfn{stringification}.
1472
1473 There is no way to combine an argument with surrounding text and
1474 stringify it all together.  Instead, you can write a series of adjacent
1475 string constants and stringified arguments.  The preprocessor will
1476 replace the stringified arguments with string constants.  The C
1477 compiler will then combine all the adjacent string constants into one
1478 long string.
1479
1480 Here is an example of a macro definition that uses stringification:
1481
1482 @smallexample
1483 @group
1484 #define WARN_IF(EXP) \
1485 do @{ if (EXP) \
1486         fprintf (stderr, "Warning: " #EXP "\n"); @} \
1487 while (0)
1488 WARN_IF (x == 0);
1489      @expansion{} do @{ if (x == 0)
1490            fprintf (stderr, "Warning: " "x == 0" "\n"); @} while (0);
1491 @end group
1492 @end smallexample
1493
1494 @noindent
1495 The argument for @code{EXP} is substituted once, as-is, into the
1496 @code{if} statement, and once, stringified, into the argument to
1497 @code{fprintf}.  If @code{x} were a macro, it would be expanded in the
1498 @code{if} statement, but not in the string.
1499
1500 The @code{do} and @code{while (0)} are a kludge to make it possible to
1501 write @code{WARN_IF (@var{arg});}, which the resemblance of
1502 @code{WARN_IF} to a function would make C programmers want to do; see
1503 @ref{Swallowing the Semicolon}.
1504
1505 Stringification in C involves more than putting double-quote characters
1506 around the fragment.  The preprocessor backslash-escapes the quotes
1507 surrounding embedded string constants, and all backslashes within string and
1508 character constants, in order to get a valid C string constant with the
1509 proper contents.  Thus, stringifying @code{@w{p = "foo\n";}} results in
1510 @t{@w{"p = \"foo\\n\";"}}.  However, backslashes that are not inside string
1511 or character constants are not duplicated: @samp{\n} by itself
1512 stringifies to @t{"\n"}.
1513
1514 All leading and trailing whitespace in text being stringified is
1515 ignored.  Any sequence of whitespace in the middle of the text is
1516 converted to a single space in the stringified result.  Comments are
1517 replaced by whitespace long before stringification happens, so they
1518 never appear in stringified text.
1519
1520 There is no way to convert a macro argument into a character constant.
1521
1522 If you want to stringify the result of expansion of a macro argument,
1523 you have to use two levels of macros.
1524
1525 @smallexample
1526 #define xstr(s) str(s)
1527 #define str(s) #s
1528 #define foo 4
1529 str (foo)
1530      @expansion{} "foo"
1531 xstr (foo)
1532      @expansion{} xstr (4)
1533      @expansion{} str (4)
1534      @expansion{} "4"
1535 @end smallexample
1536
1537 @code{s} is stringified when it is used in @code{str}, so it is not
1538 macro-expanded first.  But @code{s} is an ordinary argument to
1539 @code{xstr}, so it is completely macro-expanded before @code{xstr}
1540 itself is expanded (@pxref{Argument Prescan}).  Therefore, by the time
1541 @code{str} gets to its argument, it has already been macro-expanded.
1542
1543 @node Concatenation
1544 @section Concatenation
1545 @cindex concatenation
1546 @cindex token pasting
1547 @cindex token concatenation
1548 @cindex @samp{##} operator
1549
1550 It is often useful to merge two tokens into one while expanding macros.
1551 This is called @dfn{token pasting} or @dfn{token concatenation}.  The
1552 @samp{##} preprocessing operator performs token pasting.  When a macro
1553 is expanded, the two tokens on either side of each @samp{##} operator
1554 are combined into a single token, which then replaces the @samp{##} and
1555 the two original tokens in the macro expansion.  Usually both will be
1556 identifiers, or one will be an identifier and the other a preprocessing
1557 number.  When pasted, they make a longer identifier.  This isn't the
1558 only valid case.  It is also possible to concatenate two numbers (or a
1559 number and a name, such as @code{1.5} and @code{e3}) into a number.
1560 Also, multi-character operators such as @code{+=} can be formed by
1561 token pasting.
1562
1563 However, two tokens that don't together form a valid token cannot be
1564 pasted together.  For example, you cannot concatenate @code{x} with
1565 @code{+} in either order.  If you try, the preprocessor issues a warning
1566 and emits the two tokens.  Whether it puts white space between the
1567 tokens is undefined.  It is common to find unnecessary uses of @samp{##}
1568 in complex macros.  If you get this warning, it is likely that you can
1569 simply remove the @samp{##}.
1570
1571 Both the tokens combined by @samp{##} could come from the macro body,
1572 but you could just as well write them as one token in the first place.
1573 Token pasting is most useful when one or both of the tokens comes from a
1574 macro argument.  If either of the tokens next to an @samp{##} is a
1575 parameter name, it is replaced by its actual argument before @samp{##}
1576 executes.  As with stringification, the actual argument is not
1577 macro-expanded first.  If the argument is empty, that @samp{##} has no
1578 effect.
1579
1580 Keep in mind that the C preprocessor converts comments to whitespace
1581 before macros are even considered.  Therefore, you cannot create a
1582 comment by concatenating @samp{/} and @samp{*}.  You can put as much
1583 whitespace between @samp{##} and its operands as you like, including
1584 comments, and you can put comments in arguments that will be
1585 concatenated.  However, it is an error if @samp{##} appears at either
1586 end of a macro body.
1587
1588 Consider a C program that interprets named commands.  There probably
1589 needs to be a table of commands, perhaps an array of structures declared
1590 as follows:
1591
1592 @smallexample
1593 @group
1594 struct command
1595 @{
1596   char *name;
1597   void (*function) (void);
1598 @};
1599 @end group
1600
1601 @group
1602 struct command commands[] =
1603 @{
1604   @{ "quit", quit_command @},
1605   @{ "help", help_command @},
1606   @dots{}
1607 @};
1608 @end group
1609 @end smallexample
1610
1611 It would be cleaner not to have to give each command name twice, once in
1612 the string constant and once in the function name.  A macro which takes the
1613 name of a command as an argument can make this unnecessary.  The string
1614 constant can be created with stringification, and the function name by
1615 concatenating the argument with @samp{_command}.  Here is how it is done:
1616
1617 @smallexample
1618 #define COMMAND(NAME)  @{ #NAME, NAME ## _command @}
1619
1620 struct command commands[] =
1621 @{
1622   COMMAND (quit),
1623   COMMAND (help),
1624   @dots{}
1625 @};
1626 @end smallexample
1627
1628 @node Variadic Macros
1629 @section Variadic Macros
1630 @cindex variable number of arguments
1631 @cindex macros with variable arguments
1632 @cindex variadic macros
1633
1634 A macro can be declared to accept a variable number of arguments much as
1635 a function can.  The syntax for defining the macro is similar to that of
1636 a function.  Here is an example:
1637
1638 @smallexample
1639 #define eprintf(@dots{}) fprintf (stderr, __VA_ARGS__)
1640 @end smallexample
1641
1642 This kind of macro is called @dfn{variadic}.  When the macro is invoked,
1643 all the tokens in its argument list after the last named argument (this
1644 macro has none), including any commas, become the @dfn{variable
1645 argument}.  This sequence of tokens replaces the identifier
1646 @code{@w{__VA_ARGS__}} in the macro body wherever it appears.  Thus, we
1647 have this expansion:
1648
1649 @smallexample
1650 eprintf ("%s:%d: ", input_file, lineno)
1651      @expansion{}  fprintf (stderr, "%s:%d: ", input_file, lineno)
1652 @end smallexample
1653
1654 The variable argument is completely macro-expanded before it is inserted
1655 into the macro expansion, just like an ordinary argument.  You may use
1656 the @samp{#} and @samp{##} operators to stringify the variable argument
1657 or to paste its leading or trailing token with another token.  (But see
1658 below for an important special case for @samp{##}.)
1659
1660 If your macro is complicated, you may want a more descriptive name for
1661 the variable argument than @code{@w{__VA_ARGS__}}.  CPP permits
1662 this, as an extension.  You may write an argument name immediately
1663 before the @samp{@dots{}}; that name is used for the variable argument.
1664 The @code{eprintf} macro above could be written
1665
1666 @smallexample
1667 #define eprintf(args@dots{}) fprintf (stderr, args)
1668 @end smallexample
1669
1670 @noindent
1671 using this extension.  You cannot use @code{@w{__VA_ARGS__}} and this
1672 extension in the same macro.
1673
1674 You can have named arguments as well as variable arguments in a variadic
1675 macro.  We could define @code{eprintf} like this, instead:
1676
1677 @smallexample
1678 #define eprintf(format, @dots{}) fprintf (stderr, format, __VA_ARGS__)
1679 @end smallexample
1680
1681 @noindent
1682 This formulation looks more descriptive, but unfortunately it is less
1683 flexible: you must now supply at least one argument after the format
1684 string.  In standard C, you cannot omit the comma separating the named
1685 argument from the variable arguments.  Furthermore, if you leave the
1686 variable argument empty, you will get a syntax error, because
1687 there will be an extra comma after the format string.
1688
1689 @smallexample
1690 eprintf("success!\n", );
1691      @expansion{} fprintf(stderr, "success!\n", );
1692 @end smallexample
1693
1694 GNU CPP has a pair of extensions which deal with this problem.  First,
1695 you are allowed to leave the variable argument out entirely:
1696
1697 @smallexample
1698 eprintf ("success!\n")
1699      @expansion{} fprintf(stderr, "success!\n", );
1700 @end smallexample
1701
1702 @noindent
1703 Second, the @samp{##} token paste operator has a special meaning when
1704 placed between a comma and a variable argument.  If you write
1705
1706 @smallexample
1707 #define eprintf(format, @dots{}) fprintf (stderr, format, ##__VA_ARGS__)
1708 @end smallexample
1709
1710 @noindent
1711 and the variable argument is left out when the @code{eprintf} macro is
1712 used, then the comma before the @samp{##} will be deleted.  This does
1713 @emph{not} happen if you pass an empty argument, nor does it happen if
1714 the token preceding @samp{##} is anything other than a comma.
1715
1716 @smallexample
1717 eprintf ("success!\n")
1718      @expansion{} fprintf(stderr, "success!\n");
1719 @end smallexample
1720
1721 @noindent
1722 The above explanation is ambiguous about the case where the only macro
1723 parameter is a variable arguments parameter, as it is meaningless to
1724 try to distinguish whether no argument at all is an empty argument or
1725 a missing argument.  In this case the C99 standard is clear that the
1726 comma must remain, however the existing GCC extension used to swallow
1727 the comma.  So CPP retains the comma when conforming to a specific C
1728 standard, and drops it otherwise.
1729
1730 C99 mandates that the only place the identifier @code{@w{__VA_ARGS__}}
1731 can appear is in the replacement list of a variadic macro.  It may not
1732 be used as a macro name, macro argument name, or within a different type
1733 of macro.  It may also be forbidden in open text; the standard is
1734 ambiguous.  We recommend you avoid using it except for its defined
1735 purpose.
1736
1737 Variadic macros are a new feature in C99.  GNU CPP has supported them
1738 for a long time, but only with a named variable argument
1739 (@samp{args@dots{}}, not @samp{@dots{}} and @code{@w{__VA_ARGS__}}).  If you are
1740 concerned with portability to previous versions of GCC, you should use
1741 only named variable arguments.  On the other hand, if you are concerned
1742 with portability to other conforming implementations of C99, you should
1743 use only @code{@w{__VA_ARGS__}}.
1744
1745 Previous versions of CPP implemented the comma-deletion extension
1746 much more generally.  We have restricted it in this release to minimize
1747 the differences from C99.  To get the same effect with both this and
1748 previous versions of GCC, the token preceding the special @samp{##} must
1749 be a comma, and there must be white space between that comma and
1750 whatever comes immediately before it:
1751
1752 @smallexample
1753 #define eprintf(format, args@dots{}) fprintf (stderr, format , ##args)
1754 @end smallexample
1755
1756 @noindent
1757 @xref{Differences from previous versions}, for the gory details.
1758
1759 @node Predefined Macros
1760 @section Predefined Macros
1761
1762 @cindex predefined macros
1763 Several object-like macros are predefined; you use them without
1764 supplying their definitions.  They fall into three classes: standard,
1765 common, and system-specific.
1766
1767 In C++, there is a fourth category, the named operators.  They act like
1768 predefined macros, but you cannot undefine them.
1769
1770 @menu
1771 * Standard Predefined Macros::
1772 * Common Predefined Macros::
1773 * System-specific Predefined Macros::
1774 * C++ Named Operators::
1775 @end menu
1776
1777 @node Standard Predefined Macros
1778 @subsection Standard Predefined Macros
1779 @cindex standard predefined macros.
1780
1781 The standard predefined macros are specified by the relevant
1782 language standards, so they are available with all compilers that
1783 implement those standards.  Older compilers may not provide all of
1784 them.  Their names all start with double underscores.
1785
1786 @table @code
1787 @item __FILE__
1788 This macro expands to the name of the current input file, in the form of
1789 a C string constant.  This is the path by which the preprocessor opened
1790 the file, not the short name specified in @samp{#include} or as the
1791 input file name argument.  For example,
1792 @code{"/usr/local/include/myheader.h"} is a possible expansion of this
1793 macro.
1794
1795 @item __LINE__
1796 This macro expands to the current input line number, in the form of a
1797 decimal integer constant.  While we call it a predefined macro, it's
1798 a pretty strange macro, since its ``definition'' changes with each
1799 new line of source code.
1800 @end table
1801
1802 @code{__FILE__} and @code{__LINE__} are useful in generating an error
1803 message to report an inconsistency detected by the program; the message
1804 can state the source line at which the inconsistency was detected.  For
1805 example,
1806
1807 @smallexample
1808 fprintf (stderr, "Internal error: "
1809                  "negative string length "
1810                  "%d at %s, line %d.",
1811          length, __FILE__, __LINE__);
1812 @end smallexample
1813
1814 An @samp{#include} directive changes the expansions of @code{__FILE__}
1815 and @code{__LINE__} to correspond to the included file.  At the end of
1816 that file, when processing resumes on the input file that contained
1817 the @samp{#include} directive, the expansions of @code{__FILE__} and
1818 @code{__LINE__} revert to the values they had before the
1819 @samp{#include} (but @code{__LINE__} is then incremented by one as
1820 processing moves to the line after the @samp{#include}).
1821
1822 A @samp{#line} directive changes @code{__LINE__}, and may change
1823 @code{__FILE__} as well.  @xref{Line Control}.
1824
1825 C99 introduces @code{__func__}, and GCC has provided @code{__FUNCTION__}
1826 for a long time.  Both of these are strings containing the name of the
1827 current function (there are slight semantic differences; see the GCC
1828 manual).  Neither of them is a macro; the preprocessor does not know the
1829 name of the current function.  They tend to be useful in conjunction
1830 with @code{__FILE__} and @code{__LINE__}, though.
1831
1832 @table @code
1833
1834 @item __DATE__
1835 This macro expands to a string constant that describes the date on which
1836 the preprocessor is being run.  The string constant contains eleven
1837 characters and looks like @code{@w{"Feb 12 1996"}}.  If the day of the
1838 month is less than 10, it is padded with a space on the left.
1839
1840 If GCC cannot determine the current date, it will emit a warning message
1841 (once per compilation) and @code{__DATE__} will expand to
1842 @code{@w{"??? ?? ????"}}.
1843
1844 @item __TIME__
1845 This macro expands to a string constant that describes the time at
1846 which the preprocessor is being run.  The string constant contains
1847 eight characters and looks like @code{"23:59:01"}.
1848
1849 If GCC cannot determine the current time, it will emit a warning message
1850 (once per compilation) and @code{__TIME__} will expand to
1851 @code{"??:??:??"}.
1852
1853 @item __STDC__
1854 In normal operation, this macro expands to the constant 1, to signify
1855 that this compiler conforms to ISO Standard C@.  If GNU CPP is used with
1856 a compiler other than GCC, this is not necessarily true; however, the
1857 preprocessor always conforms to the standard unless the
1858 @option{-traditional-cpp} option is used.
1859
1860 This macro is not defined if the @option{-traditional-cpp} option is used.
1861
1862 On some hosts, the system compiler uses a different convention, where
1863 @code{__STDC__} is normally 0, but is 1 if the user specifies strict
1864 conformance to the C Standard.  CPP follows the host convention when
1865 processing system header files, but when processing user files
1866 @code{__STDC__} is always 1.  This has been reported to cause problems;
1867 for instance, some versions of Solaris provide X Windows headers that
1868 expect @code{__STDC__} to be either undefined or 1.  @xref{Invocation}.
1869
1870 @item __STDC_VERSION__
1871 This macro expands to the C Standard's version number, a long integer
1872 constant of the form @code{@var{yyyy}@var{mm}L} where @var{yyyy} and
1873 @var{mm} are the year and month of the Standard version.  This signifies
1874 which version of the C Standard the compiler conforms to.  Like
1875 @code{__STDC__}, this is not necessarily accurate for the entire
1876 implementation, unless GNU CPP is being used with GCC@.
1877
1878 The value @code{199409L} signifies the 1989 C standard as amended in
1879 1994, which is the current default; the value @code{199901L} signifies
1880 the 1999 revision of the C standard.  Support for the 1999 revision is
1881 not yet complete.
1882
1883 This macro is not defined if the @option{-traditional-cpp} option is
1884 used, nor when compiling C++ or Objective-C@.
1885
1886 @item __STDC_HOSTED__
1887 This macro is defined, with value 1, if the compiler's target is a
1888 @dfn{hosted environment}.  A hosted environment has the complete
1889 facilities of the standard C library available.
1890
1891 @item __cplusplus
1892 This macro is defined when the C++ compiler is in use.  You can use
1893 @code{__cplusplus} to test whether a header is compiled by a C compiler
1894 or a C++ compiler.  This macro is similar to @code{__STDC_VERSION__}, in
1895 that it expands to a version number.  A fully conforming implementation
1896 of the 1998 C++ standard will define this macro to @code{199711L}.  The
1897 GNU C++ compiler is not yet fully conforming, so it uses @code{1}
1898 instead.  It is hoped to complete the implementation of standard C++
1899 in the near future.
1900
1901 @item __OBJC__
1902 This macro is defined, with value 1, when the Objective-C compiler is in
1903 use.  You can use @code{__OBJC__} to test whether a header is compiled
1904 by a C compiler or a Objective-C compiler.
1905
1906 @item __ASSEMBLER__
1907 This macro is defined with value 1 when preprocessing assembly
1908 language.
1909
1910 @end table
1911
1912 @node Common Predefined Macros
1913 @subsection Common Predefined Macros
1914 @cindex common predefined macros
1915
1916 The common predefined macros are GNU C extensions.  They are available
1917 with the same meanings regardless of the machine or operating system on
1918 which you are using GNU C@.  Their names all start with double
1919 underscores.
1920
1921 @table @code
1922
1923 @item __GNUC__
1924 @itemx __GNUC_MINOR__
1925 @itemx __GNUC_PATCHLEVEL__
1926 These macros are defined by all GNU compilers that use the C
1927 preprocessor: C, C++, and Objective-C@.  Their values are the major
1928 version, minor version, and patch level of the compiler, as integer
1929 constants.  For example, GCC 3.2.1 will define @code{__GNUC__} to 3,
1930 @code{__GNUC_MINOR__} to 2, and @code{__GNUC_PATCHLEVEL__} to 1.  These
1931 macros are also defined if you invoke the preprocessor directly.
1932
1933 @code{__GNUC_PATCHLEVEL__} is new to GCC 3.0; it is also present in the
1934 widely-used development snapshots leading up to 3.0 (which identify
1935 themselves as GCC 2.96 or 2.97, depending on which snapshot you have).
1936
1937 If all you need to know is whether or not your program is being compiled
1938 by GCC, or a non-GCC compiler that claims to accept the GNU C dialects,
1939 you can simply test @code{__GNUC__}.  If you need to write code
1940 which depends on a specific version, you must be more careful.  Each
1941 time the minor version is increased, the patch level is reset to zero;
1942 each time the major version is increased (which happens rarely), the
1943 minor version and patch level are reset.  If you wish to use the
1944 predefined macros directly in the conditional, you will need to write it
1945 like this:
1946
1947 @smallexample
1948 /* @r{Test for GCC > 3.2.0} */
1949 #if __GNUC__ > 3 || \
1950     (__GNUC__ == 3 && (__GNUC_MINOR__ > 2 || \
1951                        (__GNUC_MINOR__ == 2 && \
1952                         __GNUC_PATCHLEVEL__ > 0))
1953 @end smallexample
1954
1955 @noindent
1956 Another approach is to use the predefined macros to
1957 calculate a single number, then compare that against a threshold:
1958
1959 @smallexample
1960 #define GCC_VERSION (__GNUC__ * 10000 \
1961                      + __GNUC_MINOR__ * 100 \
1962                      + __GNUC_PATCHLEVEL__)
1963 @dots{}
1964 /* @r{Test for GCC > 3.2.0} */
1965 #if GCC_VERSION > 30200
1966 @end smallexample
1967
1968 @noindent
1969 Many people find this form easier to understand.
1970
1971 @item __GNUG__
1972 The GNU C++ compiler defines this.  Testing it is equivalent to
1973 testing @code{@w{(__GNUC__ && __cplusplus)}}.
1974
1975 @item __STRICT_ANSI__
1976 GCC defines this macro if and only if the @option{-ansi} switch, or a
1977 @option{-std} switch specifying strict conformance to some version of ISO C,
1978 was specified when GCC was invoked.  It is defined to @samp{1}.
1979 This macro exists primarily to direct GNU libc's header files to
1980 restrict their definitions to the minimal set found in the 1989 C
1981 standard.
1982
1983 @item __BASE_FILE__
1984 This macro expands to the name of the main input file, in the form
1985 of a C string constant.  This is the source file that was specified
1986 on the command line of the preprocessor or C compiler.
1987
1988 @item __INCLUDE_LEVEL__
1989 This macro expands to a decimal integer constant that represents the
1990 depth of nesting in include files.  The value of this macro is
1991 incremented on every @samp{#include} directive and decremented at the
1992 end of every included file.  It starts out at 0, it's value within the
1993 base file specified on the command line.
1994
1995 @item __ELF__
1996 This macro is defined if the target uses the ELF object format.
1997
1998 @item __VERSION__
1999 This macro expands to a string constant which describes the version of
2000 the compiler in use.  You should not rely on its contents having any
2001 particular form, but it can be counted on to contain at least the
2002 release number.
2003
2004 @item __OPTIMIZE__
2005 @itemx __OPTIMIZE_SIZE__
2006 @itemx __NO_INLINE__
2007 These macros describe the compilation mode.  @code{__OPTIMIZE__} is
2008 defined in all optimizing compilations.  @code{__OPTIMIZE_SIZE__} is
2009 defined if the compiler is optimizing for size, not speed.
2010 @code{__NO_INLINE__} is defined if no functions will be inlined into
2011 their callers (when not optimizing, or when inlining has been
2012 specifically disabled by @option{-fno-inline}).
2013
2014 These macros cause certain GNU header files to provide optimized
2015 definitions, using macros or inline functions, of system library
2016 functions.  You should not use these macros in any way unless you make
2017 sure that programs will execute with the same effect whether or not they
2018 are defined.  If they are defined, their value is 1.
2019
2020 @item __CHAR_UNSIGNED__
2021 GCC defines this macro if and only if the data type @code{char} is
2022 unsigned on the target machine.  It exists to cause the standard header
2023 file @file{limits.h} to work correctly.  You should not use this macro
2024 yourself; instead, refer to the standard macros defined in @file{limits.h}.
2025
2026 @item __WCHAR_UNSIGNED__
2027 Like @code{__CHAR_UNSIGNED__}, this macro is defined if and only if the
2028 data type @code{wchar_t} is unsigned and the front-end is in C++ mode.
2029
2030 @item __REGISTER_PREFIX__
2031 This macro expands to a single token (not a string constant) which is
2032 the prefix applied to CPU register names in assembly language for this
2033 target.  You can use it to write assembly that is usable in multiple
2034 environments.  For example, in the @code{m68k-aout} environment it
2035 expands to nothing, but in the @code{m68k-coff} environment it expands
2036 to a single @samp{%}.
2037
2038 @item __USER_LABEL_PREFIX__
2039 This macro expands to a single token which is the prefix applied to
2040 user labels (symbols visible to C code) in assembly.  For example, in
2041 the @code{m68k-aout} environment it expands to an @samp{_}, but in the
2042 @code{m68k-coff} environment it expands to nothing.
2043
2044 This macro will have the correct definition even if
2045 @option{-f(no-)underscores} is in use, but it will not be correct if
2046 target-specific options that adjust this prefix are used (e.g.@: the
2047 OSF/rose @option{-mno-underscores} option).
2048
2049 @item __SIZE_TYPE__
2050 @itemx __PTRDIFF_TYPE__
2051 @itemx __WCHAR_TYPE__
2052 @itemx __WINT_TYPE__
2053 @itemx __INTMAX_TYPE__
2054 @itemx __UINTMAX_TYPE__
2055 These macros are defined to the correct underlying types for the
2056 @code{size_t}, @code{ptrdiff_t}, @code{wchar_t}, @code{wint_t},
2057 @code{intmax_t}, and @code{uintmax_t}
2058 typedefs, respectively.  They exist to make the standard header files
2059 @file{stddef.h} and @file{wchar.h} work correctly.  You should not use
2060 these macros directly; instead, include the appropriate headers and use
2061 the typedefs.
2062
2063 @item __CHAR_BIT__
2064 Defined to the number of bits used in the representation of the
2065 @code{char} data type.  It exists to make the standard header given
2066 numerical limits work correctly.  You should not use
2067 this macro directly; instead, include the appropriate headers.
2068
2069 @item __SCHAR_MAX__
2070 @itemx __WCHAR_MAX__
2071 @itemx __SHRT_MAX__
2072 @itemx __INT_MAX__
2073 @itemx __LONG_MAX__
2074 @itemx __LONG_LONG_MAX__
2075 @itemx __INTMAX_MAX__
2076 Defined to the maximum value of the @code{signed char}, @code{wchar_t},
2077 @code{signed short},
2078 @code{signed int}, @code{signed long}, @code{signed long long}, and
2079 @code{intmax_t} types
2080 respectively.  They exist to make the standard header given numerical limits
2081 work correctly.  You should not use these macros directly; instead, include
2082 the appropriate headers.
2083
2084 @item __DEPRECATED
2085 This macro is defined, with value 1, when compiling a C++ source file
2086 with warnings about deprecated constructs enabled.  These warnings are
2087 enabled by default, but can be disabled with @option{-Wno-deprecated}.
2088
2089 @item __EXCEPTIONS
2090 This macro is defined, with value 1, when compiling a C++ source file
2091 with exceptions enabled.  If @option{-fno-exceptions} was used when
2092 compiling the file, then this macro will not be defined.
2093
2094 @item __USING_SJLJ_EXCEPTIONS__
2095 This macro is defined, with value 1, if the compiler uses the old
2096 mechanism based on @code{setjmp} and @code{longjmp} for exception
2097 handling.
2098
2099 @item __GXX_WEAK__
2100 This macro is defined when compiling a C++ source file.  It has the
2101 value 1 if the compiler will use weak symbols, COMDAT sections, or
2102 other similar techniques to collapse symbols with ``vague linkage''
2103 that are defined in multiple translation units.  If the compiler will
2104 not collapse such symbols, this macro is defined with value 0.  In
2105 general, user code should not need to make use of this macro; the
2106 purpose of this macro is to ease implementation of the C++ runtime
2107 library provided with G++.
2108
2109 @item __NEXT_RUNTIME__
2110 This macro is defined, with value 1, if (and only if) the NeXT runtime
2111 (as in @option{-fnext-runtime}) is in use for Objective-C@.  If the GNU
2112 runtime is used, this macro is not defined, so that you can use this
2113 macro to determine which runtime (NeXT or GNU) is being used.
2114
2115 @item __LP64__
2116 @itemx _LP64
2117 These macros are defined, with value 1, if (and only if) the compilation
2118 is for a target where @code{long int} and pointer both use 64-bits and
2119 @code{int} uses 32-bit.
2120 @end table
2121
2122 @node System-specific Predefined Macros
2123 @subsection System-specific Predefined Macros
2124
2125 @cindex system-specific predefined macros
2126 @cindex predefined macros, system-specific
2127 @cindex reserved namespace
2128
2129 The C preprocessor normally predefines several macros that indicate what
2130 type of system and machine is in use.  They are obviously different on
2131 each target supported by GCC@.  This manual, being for all systems and
2132 machines, cannot tell you what their names are, but you can use
2133 @command{cpp -dM} to see them all.  @xref{Invocation}.  All system-specific
2134 predefined macros expand to the constant 1, so you can test them with
2135 either @samp{#ifdef} or @samp{#if}.
2136
2137 The C standard requires that all system-specific macros be part of the
2138 @dfn{reserved namespace}.  All names which begin with two underscores,
2139 or an underscore and a capital letter, are reserved for the compiler and
2140 library to use as they wish.  However, historically system-specific
2141 macros have had names with no special prefix; for instance, it is common
2142 to find @code{unix} defined on Unix systems.  For all such macros, GCC
2143 provides a parallel macro with two underscores added at the beginning
2144 and the end.  If @code{unix} is defined, @code{__unix__} will be defined
2145 too.  There will never be more than two underscores; the parallel of
2146 @code{_mips} is @code{__mips__}.
2147
2148 When the @option{-ansi} option, or any @option{-std} option that
2149 requests strict conformance, is given to the compiler, all the
2150 system-specific predefined macros outside the reserved namespace are
2151 suppressed.  The parallel macros, inside the reserved namespace, remain
2152 defined.
2153
2154 We are slowly phasing out all predefined macros which are outside the
2155 reserved namespace.  You should never use them in new programs, and we
2156 encourage you to correct older code to use the parallel macros whenever
2157 you find it.  We don't recommend you use the system-specific macros that
2158 are in the reserved namespace, either.  It is better in the long run to
2159 check specifically for features you need, using a tool such as
2160 @command{autoconf}.
2161
2162 @node C++ Named Operators
2163 @subsection C++ Named Operators
2164 @cindex named operators
2165 @cindex C++ named operators
2166 @cindex iso646.h
2167
2168 In C++, there are eleven keywords which are simply alternate spellings
2169 of operators normally written with punctuation.  These keywords are
2170 treated as such even in the preprocessor.  They function as operators in
2171 @samp{#if}, and they cannot be defined as macros or poisoned.  In C, you
2172 can request that those keywords take their C++ meaning by including
2173 @file{iso646.h}.  That header defines each one as a normal object-like
2174 macro expanding to the appropriate punctuator.
2175
2176 These are the named operators and their corresponding punctuators:
2177
2178 @multitable {Named Operator} {Punctuator}
2179 @item Named Operator @tab Punctuator
2180 @item @code{and}    @tab @code{&&}
2181 @item @code{and_eq} @tab @code{&=}
2182 @item @code{bitand} @tab @code{&}
2183 @item @code{bitor}  @tab @code{|}
2184 @item @code{compl}  @tab @code{~}
2185 @item @code{not}    @tab @code{!}
2186 @item @code{not_eq} @tab @code{!=}
2187 @item @code{or}     @tab @code{||}
2188 @item @code{or_eq}  @tab @code{|=}
2189 @item @code{xor}    @tab @code{^}
2190 @item @code{xor_eq} @tab @code{^=}
2191 @end multitable
2192
2193 @node Undefining and Redefining Macros
2194 @section Undefining and Redefining Macros
2195 @cindex undefining macros
2196 @cindex redefining macros
2197 @findex #undef
2198
2199 If a macro ceases to be useful, it may be @dfn{undefined} with the
2200 @samp{#undef} directive.  @samp{#undef} takes a single argument, the
2201 name of the macro to undefine.  You use the bare macro name, even if the
2202 macro is function-like.  It is an error if anything appears on the line
2203 after the macro name.  @samp{#undef} has no effect if the name is not a
2204 macro.
2205
2206 @smallexample
2207 #define FOO 4
2208 x = FOO;        @expansion{} x = 4;
2209 #undef FOO
2210 x = FOO;        @expansion{} x = FOO;
2211 @end smallexample
2212
2213 Once a macro has been undefined, that identifier may be @dfn{redefined}
2214 as a macro by a subsequent @samp{#define} directive.  The new definition
2215 need not have any resemblance to the old definition.
2216
2217 However, if an identifier which is currently a macro is redefined, then
2218 the new definition must be @dfn{effectively the same} as the old one.
2219 Two macro definitions are effectively the same if:
2220 @itemize @bullet
2221 @item Both are the same type of macro (object- or function-like).
2222 @item All the tokens of the replacement list are the same.
2223 @item If there are any parameters, they are the same.
2224 @item Whitespace appears in the same places in both.  It need not be
2225 exactly the same amount of whitespace, though.  Remember that comments
2226 count as whitespace.
2227 @end itemize
2228
2229 @noindent
2230 These definitions are effectively the same:
2231 @smallexample
2232 #define FOUR (2 + 2)
2233 #define FOUR         (2    +    2)
2234 #define FOUR (2 /* @r{two} */ + 2)
2235 @end smallexample
2236 @noindent
2237 but these are not:
2238 @smallexample
2239 #define FOUR (2 + 2)
2240 #define FOUR ( 2+2 )
2241 #define FOUR (2 * 2)
2242 #define FOUR(score,and,seven,years,ago) (2 + 2)
2243 @end smallexample
2244
2245 If a macro is redefined with a definition that is not effectively the
2246 same as the old one, the preprocessor issues a warning and changes the
2247 macro to use the new definition.  If the new definition is effectively
2248 the same, the redefinition is silently ignored.  This allows, for
2249 instance, two different headers to define a common macro.  The
2250 preprocessor will only complain if the definitions do not match.
2251
2252 @node Directives Within Macro Arguments
2253 @section Directives Within Macro Arguments
2254 @cindex macro arguments and directives
2255
2256 Occasionally it is convenient to use preprocessor directives within
2257 the arguments of a macro.  The C and C++ standards declare that
2258 behavior in these cases is undefined.
2259
2260 Versions of CPP prior to 3.2 would reject such constructs with an
2261 error message.  This was the only syntactic difference between normal
2262 functions and function-like macros, so it seemed attractive to remove
2263 this limitation, and people would often be surprised that they could
2264 not use macros in this way.  Moreover, sometimes people would use
2265 conditional compilation in the argument list to a normal library
2266 function like @samp{printf}, only to find that after a library upgrade
2267 @samp{printf} had changed to be a function-like macro, and their code
2268 would no longer compile.  So from version 3.2 we changed CPP to
2269 successfully process arbitrary directives within macro arguments in
2270 exactly the same way as it would have processed the directive were the
2271 function-like macro invocation not present.
2272
2273 If, within a macro invocation, that macro is redefined, then the new
2274 definition takes effect in time for argument pre-expansion, but the
2275 original definition is still used for argument replacement.  Here is a
2276 pathological example:
2277
2278 @smallexample
2279 #define f(x) x x
2280 f (1
2281 #undef f
2282 #define f 2
2283 f)
2284 @end smallexample
2285
2286 @noindent
2287 which expands to
2288
2289 @smallexample
2290 1 2 1 2
2291 @end smallexample
2292
2293 @noindent
2294 with the semantics described above.
2295
2296 @node Macro Pitfalls
2297 @section Macro Pitfalls
2298 @cindex problems with macros
2299 @cindex pitfalls of macros
2300
2301 In this section we describe some special rules that apply to macros and
2302 macro expansion, and point out certain cases in which the rules have
2303 counter-intuitive consequences that you must watch out for.
2304
2305 @menu
2306 * Misnesting::
2307 * Operator Precedence Problems::
2308 * Swallowing the Semicolon::
2309 * Duplication of Side Effects::
2310 * Self-Referential Macros::
2311 * Argument Prescan::
2312 * Newlines in Arguments::
2313 @end menu
2314
2315 @node Misnesting
2316 @subsection Misnesting
2317
2318 When a macro is called with arguments, the arguments are substituted
2319 into the macro body and the result is checked, together with the rest of
2320 the input file, for more macro calls.  It is possible to piece together
2321 a macro call coming partially from the macro body and partially from the
2322 arguments.  For example,
2323
2324 @smallexample
2325 #define twice(x) (2*(x))
2326 #define call_with_1(x) x(1)
2327 call_with_1 (twice)
2328      @expansion{} twice(1)
2329      @expansion{} (2*(1))
2330 @end smallexample
2331
2332 Macro definitions do not have to have balanced parentheses.  By writing
2333 an unbalanced open parenthesis in a macro body, it is possible to create
2334 a macro call that begins inside the macro body but ends outside of it.
2335 For example,
2336
2337 @smallexample
2338 #define strange(file) fprintf (file, "%s %d",
2339 @dots{}
2340 strange(stderr) p, 35)
2341      @expansion{} fprintf (stderr, "%s %d", p, 35)
2342 @end smallexample
2343
2344 The ability to piece together a macro call can be useful, but the use of
2345 unbalanced open parentheses in a macro body is just confusing, and
2346 should be avoided.
2347
2348 @node Operator Precedence Problems
2349 @subsection Operator Precedence Problems
2350 @cindex parentheses in macro bodies
2351
2352 You may have noticed that in most of the macro definition examples shown
2353 above, each occurrence of a macro argument name had parentheses around
2354 it.  In addition, another pair of parentheses usually surround the
2355 entire macro definition.  Here is why it is best to write macros that
2356 way.
2357
2358 Suppose you define a macro as follows,
2359
2360 @smallexample
2361 #define ceil_div(x, y) (x + y - 1) / y
2362 @end smallexample
2363
2364 @noindent
2365 whose purpose is to divide, rounding up.  (One use for this operation is
2366 to compute how many @code{int} objects are needed to hold a certain
2367 number of @code{char} objects.)  Then suppose it is used as follows:
2368
2369 @smallexample
2370 a = ceil_div (b & c, sizeof (int));
2371      @expansion{} a = (b & c + sizeof (int) - 1) / sizeof (int);
2372 @end smallexample
2373
2374 @noindent
2375 This does not do what is intended.  The operator-precedence rules of
2376 C make it equivalent to this:
2377
2378 @smallexample
2379 a = (b & (c + sizeof (int) - 1)) / sizeof (int);
2380 @end smallexample
2381
2382 @noindent
2383 What we want is this:
2384
2385 @smallexample
2386 a = ((b & c) + sizeof (int) - 1)) / sizeof (int);
2387 @end smallexample
2388
2389 @noindent
2390 Defining the macro as
2391
2392 @smallexample
2393 #define ceil_div(x, y) ((x) + (y) - 1) / (y)
2394 @end smallexample
2395
2396 @noindent
2397 provides the desired result.
2398
2399 Unintended grouping can result in another way.  Consider @code{sizeof
2400 ceil_div(1, 2)}.  That has the appearance of a C expression that would
2401 compute the size of the type of @code{ceil_div (1, 2)}, but in fact it
2402 means something very different.  Here is what it expands to:
2403
2404 @smallexample
2405 sizeof ((1) + (2) - 1) / (2)
2406 @end smallexample
2407
2408 @noindent
2409 This would take the size of an integer and divide it by two.  The
2410 precedence rules have put the division outside the @code{sizeof} when it
2411 was intended to be inside.
2412
2413 Parentheses around the entire macro definition prevent such problems.
2414 Here, then, is the recommended way to define @code{ceil_div}:
2415
2416 @smallexample
2417 #define ceil_div(x, y) (((x) + (y) - 1) / (y))
2418 @end smallexample
2419
2420 @node Swallowing the Semicolon
2421 @subsection Swallowing the Semicolon
2422 @cindex semicolons (after macro calls)
2423
2424 Often it is desirable to define a macro that expands into a compound
2425 statement.  Consider, for example, the following macro, that advances a
2426 pointer (the argument @code{p} says where to find it) across whitespace
2427 characters:
2428
2429 @smallexample
2430 #define SKIP_SPACES(p, limit)  \
2431 @{ char *lim = (limit);         \
2432   while (p < lim) @{            \
2433     if (*p++ != ' ') @{         \
2434       p--; break; @}@}@}
2435 @end smallexample
2436
2437 @noindent
2438 Here backslash-newline is used to split the macro definition, which must
2439 be a single logical line, so that it resembles the way such code would
2440 be laid out if not part of a macro definition.
2441
2442 A call to this macro might be @code{SKIP_SPACES (p, lim)}.  Strictly
2443 speaking, the call expands to a compound statement, which is a complete
2444 statement with no need for a semicolon to end it.  However, since it
2445 looks like a function call, it minimizes confusion if you can use it
2446 like a function call, writing a semicolon afterward, as in
2447 @code{SKIP_SPACES (p, lim);}
2448
2449 This can cause trouble before @code{else} statements, because the
2450 semicolon is actually a null statement.  Suppose you write
2451
2452 @smallexample
2453 if (*p != 0)
2454   SKIP_SPACES (p, lim);
2455 else @dots{}
2456 @end smallexample
2457
2458 @noindent
2459 The presence of two statements---the compound statement and a null
2460 statement---in between the @code{if} condition and the @code{else}
2461 makes invalid C code.
2462
2463 The definition of the macro @code{SKIP_SPACES} can be altered to solve
2464 this problem, using a @code{do @dots{} while} statement.  Here is how:
2465
2466 @smallexample
2467 #define SKIP_SPACES(p, limit)     \
2468 do @{ char *lim = (limit);         \
2469      while (p < lim) @{            \
2470        if (*p++ != ' ') @{         \
2471          p--; break; @}@}@}          \
2472 while (0)
2473 @end smallexample
2474
2475 Now @code{SKIP_SPACES (p, lim);} expands into
2476
2477 @smallexample
2478 do @{@dots{}@} while (0);
2479 @end smallexample
2480
2481 @noindent
2482 which is one statement.  The loop executes exactly once; most compilers
2483 generate no extra code for it.
2484
2485 @node Duplication of Side Effects
2486 @subsection Duplication of Side Effects
2487
2488 @cindex side effects (in macro arguments)
2489 @cindex unsafe macros
2490 Many C programs define a macro @code{min}, for ``minimum'', like this:
2491
2492 @smallexample
2493 #define min(X, Y)  ((X) < (Y) ? (X) : (Y))
2494 @end smallexample
2495
2496 When you use this macro with an argument containing a side effect,
2497 as shown here,
2498
2499 @smallexample
2500 next = min (x + y, foo (z));
2501 @end smallexample
2502
2503 @noindent
2504 it expands as follows:
2505
2506 @smallexample
2507 next = ((x + y) < (foo (z)) ? (x + y) : (foo (z)));
2508 @end smallexample
2509
2510 @noindent
2511 where @code{x + y} has been substituted for @code{X} and @code{foo (z)}
2512 for @code{Y}.
2513
2514 The function @code{foo} is used only once in the statement as it appears
2515 in the program, but the expression @code{foo (z)} has been substituted
2516 twice into the macro expansion.  As a result, @code{foo} might be called
2517 two times when the statement is executed.  If it has side effects or if
2518 it takes a long time to compute, the results might not be what you
2519 intended.  We say that @code{min} is an @dfn{unsafe} macro.
2520
2521 The best solution to this problem is to define @code{min} in a way that
2522 computes the value of @code{foo (z)} only once.  The C language offers
2523 no standard way to do this, but it can be done with GNU extensions as
2524 follows:
2525
2526 @smallexample
2527 #define min(X, Y)                \
2528 (@{ typeof (X) x_ = (X);          \
2529    typeof (Y) y_ = (Y);          \
2530    (x_ < y_) ? x_ : y_; @})
2531 @end smallexample
2532
2533 The @samp{(@{ @dots{} @})} notation produces a compound statement that
2534 acts as an expression.  Its value is the value of its last statement.
2535 This permits us to define local variables and assign each argument to
2536 one.  The local variables have underscores after their names to reduce
2537 the risk of conflict with an identifier of wider scope (it is impossible
2538 to avoid this entirely).  Now each argument is evaluated exactly once.
2539
2540 If you do not wish to use GNU C extensions, the only solution is to be
2541 careful when @emph{using} the macro @code{min}.  For example, you can
2542 calculate the value of @code{foo (z)}, save it in a variable, and use
2543 that variable in @code{min}:
2544
2545 @smallexample
2546 @group
2547 #define min(X, Y)  ((X) < (Y) ? (X) : (Y))
2548 @dots{}
2549 @{
2550   int tem = foo (z);
2551   next = min (x + y, tem);
2552 @}
2553 @end group
2554 @end smallexample
2555
2556 @noindent
2557 (where we assume that @code{foo} returns type @code{int}).
2558
2559 @node Self-Referential Macros
2560 @subsection Self-Referential Macros
2561 @cindex self-reference
2562
2563 A @dfn{self-referential} macro is one whose name appears in its
2564 definition.  Recall that all macro definitions are rescanned for more
2565 macros to replace.  If the self-reference were considered a use of the
2566 macro, it would produce an infinitely large expansion.  To prevent this,
2567 the self-reference is not considered a macro call.  It is passed into
2568 the preprocessor output unchanged.  Consider an example:
2569
2570 @smallexample
2571 #define foo (4 + foo)
2572 @end smallexample
2573
2574 @noindent
2575 where @code{foo} is also a variable in your program.
2576
2577 Following the ordinary rules, each reference to @code{foo} will expand
2578 into @code{(4 + foo)}; then this will be rescanned and will expand into
2579 @code{(4 + (4 + foo))}; and so on until the computer runs out of memory.
2580
2581 The self-reference rule cuts this process short after one step, at
2582 @code{(4 + foo)}.  Therefore, this macro definition has the possibly
2583 useful effect of causing the program to add 4 to the value of @code{foo}
2584 wherever @code{foo} is referred to.
2585
2586 In most cases, it is a bad idea to take advantage of this feature.  A
2587 person reading the program who sees that @code{foo} is a variable will
2588 not expect that it is a macro as well.  The reader will come across the
2589 identifier @code{foo} in the program and think its value should be that
2590 of the variable @code{foo}, whereas in fact the value is four greater.
2591
2592 One common, useful use of self-reference is to create a macro which
2593 expands to itself.  If you write
2594
2595 @smallexample
2596 #define EPERM EPERM
2597 @end smallexample
2598
2599 @noindent
2600 then the macro @code{EPERM} expands to @code{EPERM}.  Effectively, it is
2601 left alone by the preprocessor whenever it's used in running text.  You
2602 can tell that it's a macro with @samp{#ifdef}.  You might do this if you
2603 want to define numeric constants with an @code{enum}, but have
2604 @samp{#ifdef} be true for each constant.
2605
2606 If a macro @code{x} expands to use a macro @code{y}, and the expansion of
2607 @code{y} refers to the macro @code{x}, that is an @dfn{indirect
2608 self-reference} of @code{x}.  @code{x} is not expanded in this case
2609 either.  Thus, if we have
2610
2611 @smallexample
2612 #define x (4 + y)
2613 #define y (2 * x)
2614 @end smallexample
2615
2616 @noindent
2617 then @code{x} and @code{y} expand as follows:
2618
2619 @smallexample
2620 @group
2621 x    @expansion{} (4 + y)
2622      @expansion{} (4 + (2 * x))
2623
2624 y    @expansion{} (2 * x)
2625      @expansion{} (2 * (4 + y))
2626 @end group
2627 @end smallexample
2628
2629 @noindent
2630 Each macro is expanded when it appears in the definition of the other
2631 macro, but not when it indirectly appears in its own definition.
2632
2633 @node Argument Prescan
2634 @subsection Argument Prescan
2635 @cindex expansion of arguments
2636 @cindex macro argument expansion
2637 @cindex prescan of macro arguments
2638
2639 Macro arguments are completely macro-expanded before they are
2640 substituted into a macro body, unless they are stringified or pasted
2641 with other tokens.  After substitution, the entire macro body, including
2642 the substituted arguments, is scanned again for macros to be expanded.
2643 The result is that the arguments are scanned @emph{twice} to expand
2644 macro calls in them.
2645
2646 Most of the time, this has no effect.  If the argument contained any
2647 macro calls, they are expanded during the first scan.  The result
2648 therefore contains no macro calls, so the second scan does not change
2649 it.  If the argument were substituted as given, with no prescan, the
2650 single remaining scan would find the same macro calls and produce the
2651 same results.
2652
2653 You might expect the double scan to change the results when a
2654 self-referential macro is used in an argument of another macro
2655 (@pxref{Self-Referential Macros}): the self-referential macro would be
2656 expanded once in the first scan, and a second time in the second scan.
2657 However, this is not what happens.  The self-references that do not
2658 expand in the first scan are marked so that they will not expand in the
2659 second scan either.
2660
2661 You might wonder, ``Why mention the prescan, if it makes no difference?
2662 And why not skip it and make the preprocessor faster?''  The answer is
2663 that the prescan does make a difference in three special cases:
2664
2665 @itemize @bullet
2666 @item
2667 Nested calls to a macro.
2668
2669 We say that @dfn{nested} calls to a macro occur when a macro's argument
2670 contains a call to that very macro.  For example, if @code{f} is a macro
2671 that expects one argument, @code{f (f (1))} is a nested pair of calls to
2672 @code{f}.  The desired expansion is made by expanding @code{f (1)} and
2673 substituting that into the definition of @code{f}.  The prescan causes
2674 the expected result to happen.  Without the prescan, @code{f (1)} itself
2675 would be substituted as an argument, and the inner use of @code{f} would
2676 appear during the main scan as an indirect self-reference and would not
2677 be expanded.
2678
2679 @item
2680 Macros that call other macros that stringify or concatenate.
2681
2682 If an argument is stringified or concatenated, the prescan does not
2683 occur.  If you @emph{want} to expand a macro, then stringify or
2684 concatenate its expansion, you can do that by causing one macro to call
2685 another macro that does the stringification or concatenation.  For
2686 instance, if you have
2687
2688 @smallexample
2689 #define AFTERX(x) X_ ## x
2690 #define XAFTERX(x) AFTERX(x)
2691 #define TABLESIZE 1024
2692 #define BUFSIZE TABLESIZE
2693 @end smallexample
2694
2695 then @code{AFTERX(BUFSIZE)} expands to @code{X_BUFSIZE}, and
2696 @code{XAFTERX(BUFSIZE)} expands to @code{X_1024}.  (Not to
2697 @code{X_TABLESIZE}.  Prescan always does a complete expansion.)
2698
2699 @item
2700 Macros used in arguments, whose expansions contain unshielded commas.
2701
2702 This can cause a macro expanded on the second scan to be called with the
2703 wrong number of arguments.  Here is an example:
2704
2705 @smallexample
2706 #define foo  a,b
2707 #define bar(x) lose(x)
2708 #define lose(x) (1 + (x))
2709 @end smallexample
2710
2711 We would like @code{bar(foo)} to turn into @code{(1 + (foo))}, which
2712 would then turn into @code{(1 + (a,b))}.  Instead, @code{bar(foo)}
2713 expands into @code{lose(a,b)}, and you get an error because @code{lose}
2714 requires a single argument.  In this case, the problem is easily solved
2715 by the same parentheses that ought to be used to prevent misnesting of
2716 arithmetic operations:
2717
2718 @smallexample
2719 #define foo (a,b)
2720 @exdent or
2721 #define bar(x) lose((x))
2722 @end smallexample
2723
2724 The extra pair of parentheses prevents the comma in @code{foo}'s
2725 definition from being interpreted as an argument separator.
2726
2727 @end itemize
2728
2729 @node Newlines in Arguments
2730 @subsection Newlines in Arguments
2731 @cindex newlines in macro arguments
2732
2733 The invocation of a function-like macro can extend over many logical
2734 lines.  However, in the present implementation, the entire expansion
2735 comes out on one line.  Thus line numbers emitted by the compiler or
2736 debugger refer to the line the invocation started on, which might be
2737 different to the line containing the argument causing the problem.
2738
2739 Here is an example illustrating this:
2740
2741 @smallexample
2742 #define ignore_second_arg(a,b,c) a; c
2743
2744 ignore_second_arg (foo (),
2745                    ignored (),
2746                    syntax error);
2747 @end smallexample
2748
2749 @noindent
2750 The syntax error triggered by the tokens @code{syntax error} results in
2751 an error message citing line three---the line of ignore_second_arg---
2752 even though the problematic code comes from line five.
2753
2754 We consider this a bug, and intend to fix it in the near future.
2755
2756 @node Conditionals
2757 @chapter Conditionals
2758 @cindex conditionals
2759
2760 A @dfn{conditional} is a directive that instructs the preprocessor to
2761 select whether or not to include a chunk of code in the final token
2762 stream passed to the compiler.  Preprocessor conditionals can test
2763 arithmetic expressions, or whether a name is defined as a macro, or both
2764 simultaneously using the special @code{defined} operator.
2765
2766 A conditional in the C preprocessor resembles in some ways an @code{if}
2767 statement in C, but it is important to understand the difference between
2768 them.  The condition in an @code{if} statement is tested during the
2769 execution of your program.  Its purpose is to allow your program to
2770 behave differently from run to run, depending on the data it is
2771 operating on.  The condition in a preprocessing conditional directive is
2772 tested when your program is compiled.  Its purpose is to allow different
2773 code to be included in the program depending on the situation at the
2774 time of compilation.
2775
2776 However, the distinction is becoming less clear.  Modern compilers often
2777 do test @code{if} statements when a program is compiled, if their
2778 conditions are known not to vary at run time, and eliminate code which
2779 can never be executed.  If you can count on your compiler to do this,
2780 you may find that your program is more readable if you use @code{if}
2781 statements with constant conditions (perhaps determined by macros).  Of
2782 course, you can only use this to exclude code, not type definitions or
2783 other preprocessing directives, and you can only do it if the code
2784 remains syntactically valid when it is not to be used.
2785
2786 GCC version 3 eliminates this kind of never-executed code even when
2787 not optimizing.  Older versions did it only when optimizing.
2788
2789 @menu
2790 * Conditional Uses::
2791 * Conditional Syntax::
2792 * Deleted Code::
2793 @end menu
2794
2795 @node Conditional Uses
2796 @section Conditional Uses
2797
2798 There are three general reasons to use a conditional.
2799
2800 @itemize @bullet
2801 @item
2802 A program may need to use different code depending on the machine or
2803 operating system it is to run on.  In some cases the code for one
2804 operating system may be erroneous on another operating system; for
2805 example, it might refer to data types or constants that do not exist on
2806 the other system.  When this happens, it is not enough to avoid
2807 executing the invalid code.  Its mere presence will cause the compiler
2808 to reject the program.  With a preprocessing conditional, the offending
2809 code can be effectively excised from the program when it is not valid.
2810
2811 @item
2812 You may want to be able to compile the same source file into two
2813 different programs.  One version might make frequent time-consuming
2814 consistency checks on its intermediate data, or print the values of
2815 those data for debugging, and the other not.
2816
2817 @item
2818 A conditional whose condition is always false is one way to exclude code
2819 from the program but keep it as a sort of comment for future reference.
2820 @end itemize
2821
2822 Simple programs that do not need system-specific logic or complex
2823 debugging hooks generally will not need to use preprocessing
2824 conditionals.
2825
2826 @node Conditional Syntax
2827 @section Conditional Syntax
2828
2829 @findex #if
2830 A conditional in the C preprocessor begins with a @dfn{conditional
2831 directive}: @samp{#if}, @samp{#ifdef} or @samp{#ifndef}.
2832
2833 @menu
2834 * Ifdef::
2835 * If::
2836 * Defined::
2837 * Else::
2838 * Elif::
2839 @end menu
2840
2841 @node Ifdef
2842 @subsection Ifdef
2843 @findex #ifdef
2844 @findex #endif
2845
2846 The simplest sort of conditional is
2847
2848 @smallexample
2849 @group
2850 #ifdef @var{MACRO}
2851
2852 @var{controlled text}
2853
2854 #endif /* @var{MACRO} */
2855 @end group
2856 @end smallexample
2857
2858 @cindex conditional group
2859 This block is called a @dfn{conditional group}.  @var{controlled text}
2860 will be included in the output of the preprocessor if and only if
2861 @var{MACRO} is defined.  We say that the conditional @dfn{succeeds} if
2862 @var{MACRO} is defined, @dfn{fails} if it is not.
2863
2864 The @var{controlled text} inside of a conditional can include
2865 preprocessing directives.  They are executed only if the conditional
2866 succeeds.  You can nest conditional groups inside other conditional
2867 groups, but they must be completely nested.  In other words,
2868 @samp{#endif} always matches the nearest @samp{#ifdef} (or
2869 @samp{#ifndef}, or @samp{#if}).  Also, you cannot start a conditional
2870 group in one file and end it in another.
2871
2872 Even if a conditional fails, the @var{controlled text} inside it is
2873 still run through initial transformations and tokenization.  Therefore,
2874 it must all be lexically valid C@.  Normally the only way this matters is
2875 that all comments and string literals inside a failing conditional group
2876 must still be properly ended.
2877
2878 The comment following the @samp{#endif} is not required, but it is a
2879 good practice if there is a lot of @var{controlled text}, because it
2880 helps people match the @samp{#endif} to the corresponding @samp{#ifdef}.
2881 Older programs sometimes put @var{MACRO} directly after the
2882 @samp{#endif} without enclosing it in a comment.  This is invalid code
2883 according to the C standard.  CPP accepts it with a warning.  It
2884 never affects which @samp{#ifndef} the @samp{#endif} matches.
2885
2886 @findex #ifndef
2887 Sometimes you wish to use some code if a macro is @emph{not} defined.
2888 You can do this by writing @samp{#ifndef} instead of @samp{#ifdef}.
2889 One common use of @samp{#ifndef} is to include code only the first
2890 time a header file is included.  @xref{Once-Only Headers}.
2891
2892 Macro definitions can vary between compilations for several reasons.
2893 Here are some samples.
2894
2895 @itemize @bullet
2896 @item
2897 Some macros are predefined on each kind of machine
2898 (@pxref{System-specific Predefined Macros}).  This allows you to provide
2899 code specially tuned for a particular machine.
2900
2901 @item
2902 System header files define more macros, associated with the features
2903 they implement.  You can test these macros with conditionals to avoid
2904 using a system feature on a machine where it is not implemented.
2905
2906 @item
2907 Macros can be defined or undefined with the @option{-D} and @option{-U}
2908 command line options when you compile the program.  You can arrange to
2909 compile the same source file into two different programs by choosing a
2910 macro name to specify which program you want, writing conditionals to
2911 test whether or how this macro is defined, and then controlling the
2912 state of the macro with command line options, perhaps set in the
2913 Makefile.  @xref{Invocation}.
2914
2915 @item
2916 Your program might have a special header file (often called
2917 @file{config.h}) that is adjusted when the program is compiled.  It can
2918 define or not define macros depending on the features of the system and
2919 the desired capabilities of the program.  The adjustment can be
2920 automated by a tool such as @command{autoconf}, or done by hand.
2921 @end itemize
2922
2923 @node If
2924 @subsection If
2925
2926 The @samp{#if} directive allows you to test the value of an arithmetic
2927 expression, rather than the mere existence of one macro.  Its syntax is
2928
2929 @smallexample
2930 @group
2931 #if @var{expression}
2932
2933 @var{controlled text}
2934
2935 #endif /* @var{expression} */
2936 @end group
2937 @end smallexample
2938
2939 @var{expression} is a C expression of integer type, subject to stringent
2940 restrictions.  It may contain
2941
2942 @itemize @bullet
2943 @item
2944 Integer constants.
2945
2946 @item
2947 Character constants, which are interpreted as they would be in normal
2948 code.
2949
2950 @item
2951 Arithmetic operators for addition, subtraction, multiplication,
2952 division, bitwise operations, shifts, comparisons, and logical
2953 operations (@code{&&} and @code{||}).  The latter two obey the usual
2954 short-circuiting rules of standard C@.
2955
2956 @item
2957 Macros.  All macros in the expression are expanded before actual
2958 computation of the expression's value begins.
2959
2960 @item
2961 Uses of the @code{defined} operator, which lets you check whether macros
2962 are defined in the middle of an @samp{#if}.
2963
2964 @item
2965 Identifiers that are not macros, which are all considered to be the
2966 number zero.  This allows you to write @code{@w{#if MACRO}} instead of
2967 @code{@w{#ifdef MACRO}}, if you know that MACRO, when defined, will
2968 always have a nonzero value.  Function-like macros used without their
2969 function call parentheses are also treated as zero.
2970
2971 In some contexts this shortcut is undesirable.  The @option{-Wundef}
2972 option causes GCC to warn whenever it encounters an identifier which is
2973 not a macro in an @samp{#if}.
2974 @end itemize
2975
2976 The preprocessor does not know anything about types in the language.
2977 Therefore, @code{sizeof} operators are not recognized in @samp{#if}, and
2978 neither are @code{enum} constants.  They will be taken as identifiers
2979 which are not macros, and replaced by zero.  In the case of
2980 @code{sizeof}, this is likely to cause the expression to be invalid.
2981
2982 The preprocessor calculates the value of @var{expression}.  It carries
2983 out all calculations in the widest integer type known to the compiler;
2984 on most machines supported by GCC this is 64 bits.  This is not the same
2985 rule as the compiler uses to calculate the value of a constant
2986 expression, and may give different results in some cases.  If the value
2987 comes out to be nonzero, the @samp{#if} succeeds and the @var{controlled
2988 text} is included; otherwise it is skipped.
2989
2990 @node Defined
2991 @subsection Defined
2992
2993 @cindex @code{defined}
2994 The special operator @code{defined} is used in @samp{#if} and
2995 @samp{#elif} expressions to test whether a certain name is defined as a
2996 macro.  @code{defined @var{name}} and @code{defined (@var{name})} are
2997 both expressions whose value is 1 if @var{name} is defined as a macro at
2998 the current point in the program, and 0 otherwise.  Thus,  @code{@w{#if
2999 defined MACRO}} is precisely equivalent to @code{@w{#ifdef MACRO}}.
3000
3001 @code{defined} is useful when you wish to test more than one macro for
3002 existence at once.  For example,
3003
3004 @smallexample
3005 #if defined (__vax__) || defined (__ns16000__)
3006 @end smallexample
3007
3008 @noindent
3009 would succeed if either of the names @code{__vax__} or
3010 @code{__ns16000__} is defined as a macro.
3011
3012 Conditionals written like this:
3013
3014 @smallexample
3015 #if defined BUFSIZE && BUFSIZE >= 1024
3016 @end smallexample
3017
3018 @noindent
3019 can generally be simplified to just @code{@w{#if BUFSIZE >= 1024}},
3020 since if @code{BUFSIZE} is not defined, it will be interpreted as having
3021 the value zero.
3022
3023 If the @code{defined} operator appears as a result of a macro expansion,
3024 the C standard says the behavior is undefined.  GNU cpp treats it as a
3025 genuine @code{defined} operator and evaluates it normally.  It will warn
3026 wherever your code uses this feature if you use the command-line option
3027 @option{-pedantic}, since other compilers may handle it differently.
3028
3029 @node Else
3030 @subsection Else
3031
3032 @findex #else
3033 The @samp{#else} directive can be added to a conditional to provide
3034 alternative text to be used if the condition fails.  This is what it
3035 looks like:
3036
3037 @smallexample
3038 @group
3039 #if @var{expression}
3040 @var{text-if-true}
3041 #else /* Not @var{expression} */
3042 @var{text-if-false}
3043 #endif /* Not @var{expression} */
3044 @end group
3045 @end smallexample
3046
3047 @noindent
3048 If @var{expression} is nonzero, the @var{text-if-true} is included and
3049 the @var{text-if-false} is skipped.  If @var{expression} is zero, the
3050 opposite happens.
3051
3052 You can use @samp{#else} with @samp{#ifdef} and @samp{#ifndef}, too.
3053
3054 @node Elif
3055 @subsection Elif
3056
3057 @findex #elif
3058 One common case of nested conditionals is used to check for more than two
3059 possible alternatives.  For example, you might have
3060
3061 @smallexample
3062 #if X == 1
3063 @dots{}
3064 #else /* X != 1 */
3065 #if X == 2
3066 @dots{}
3067 #else /* X != 2 */
3068 @dots{}
3069 #endif /* X != 2 */
3070 #endif /* X != 1 */
3071 @end smallexample
3072
3073 Another conditional directive, @samp{#elif}, allows this to be
3074 abbreviated as follows:
3075
3076 @smallexample
3077 #if X == 1
3078 @dots{}
3079 #elif X == 2
3080 @dots{}
3081 #else /* X != 2 and X != 1*/
3082 @dots{}
3083 #endif /* X != 2 and X != 1*/
3084 @end smallexample
3085
3086 @samp{#elif} stands for ``else if''.  Like @samp{#else}, it goes in the
3087 middle of a conditional group and subdivides it; it does not require a
3088 matching @samp{#endif} of its own.  Like @samp{#if}, the @samp{#elif}
3089 directive includes an expression to be tested.  The text following the
3090 @samp{#elif} is processed only if the original @samp{#if}-condition
3091 failed and the @samp{#elif} condition succeeds.
3092
3093 More than one @samp{#elif} can go in the same conditional group.  Then
3094 the text after each @samp{#elif} is processed only if the @samp{#elif}
3095 condition succeeds after the original @samp{#if} and all previous
3096 @samp{#elif} directives within it have failed.
3097
3098 @samp{#else} is allowed after any number of @samp{#elif} directives, but
3099 @samp{#elif} may not follow @samp{#else}.
3100
3101 @node Deleted Code
3102 @section Deleted Code
3103 @cindex commenting out code
3104
3105 If you replace or delete a part of the program but want to keep the old
3106 code around for future reference, you often cannot simply comment it
3107 out.  Block comments do not nest, so the first comment inside the old
3108 code will end the commenting-out.  The probable result is a flood of
3109 syntax errors.
3110
3111 One way to avoid this problem is to use an always-false conditional
3112 instead.  For instance, put @code{#if 0} before the deleted code and
3113 @code{#endif} after it.  This works even if the code being turned
3114 off contains conditionals, but they must be entire conditionals
3115 (balanced @samp{#if} and @samp{#endif}).
3116
3117 Some people use @code{#ifdef notdef} instead.  This is risky, because
3118 @code{notdef} might be accidentally defined as a macro, and then the
3119 conditional would succeed.  @code{#if 0} can be counted on to fail.
3120
3121 Do not use @code{#if 0} for comments which are not C code.  Use a real
3122 comment, instead.  The interior of @code{#if 0} must consist of complete
3123 tokens; in particular, single-quote characters must balance.  Comments
3124 often contain unbalanced single-quote characters (known in English as
3125 apostrophes).  These confuse @code{#if 0}.  They don't confuse
3126 @samp{/*}.
3127
3128 @node Diagnostics
3129 @chapter Diagnostics
3130 @cindex diagnostic
3131 @cindex reporting errors
3132 @cindex reporting warnings
3133
3134 @findex #error
3135 The directive @samp{#error} causes the preprocessor to report a fatal
3136 error.  The tokens forming the rest of the line following @samp{#error}
3137 are used as the error message.
3138
3139 You would use @samp{#error} inside of a conditional that detects a
3140 combination of parameters which you know the program does not properly
3141 support.  For example, if you know that the program will not run
3142 properly on a VAX, you might write
3143
3144 @smallexample
3145 @group
3146 #ifdef __vax__
3147 #error "Won't work on VAXen.  See comments at get_last_object."
3148 #endif
3149 @end group
3150 @end smallexample
3151
3152 If you have several configuration parameters that must be set up by
3153 the installation in a consistent way, you can use conditionals to detect
3154 an inconsistency and report it with @samp{#error}.  For example,
3155
3156 @smallexample
3157 #if !defined(UNALIGNED_INT_ASM_OP) && defined(DWARF2_DEBUGGING_INFO)
3158 #error "DWARF2_DEBUGGING_INFO requires UNALIGNED_INT_ASM_OP."
3159 #endif
3160 @end smallexample
3161
3162 @findex #warning
3163 The directive @samp{#warning} is like @samp{#error}, but causes the
3164 preprocessor to issue a warning and continue preprocessing.  The tokens
3165 following @samp{#warning} are used as the warning message.
3166
3167 You might use @samp{#warning} in obsolete header files, with a message
3168 directing the user to the header file which should be used instead.
3169
3170 Neither @samp{#error} nor @samp{#warning} macro-expands its argument.
3171 Internal whitespace sequences are each replaced with a single space.
3172 The line must consist of complete tokens.  It is wisest to make the
3173 argument of these directives be a single string constant; this avoids
3174 problems with apostrophes and the like.
3175
3176 @node Line Control
3177 @chapter Line Control
3178 @cindex line control
3179
3180 The C preprocessor informs the C compiler of the location in your source
3181 code where each token came from.  Presently, this is just the file name
3182 and line number.  All the tokens resulting from macro expansion are
3183 reported as having appeared on the line of the source file where the
3184 outermost macro was used.  We intend to be more accurate in the future.
3185
3186 If you write a program which generates source code, such as the
3187 @command{bison} parser generator, you may want to adjust the preprocessor's
3188 notion of the current file name and line number by hand.  Parts of the
3189 output from @command{bison} are generated from scratch, other parts come
3190 from a standard parser file.  The rest are copied verbatim from
3191 @command{bison}'s input.  You would like compiler error messages and
3192 symbolic debuggers to be able to refer to @code{bison}'s input file.
3193
3194 @findex #line
3195 @command{bison} or any such program can arrange this by writing
3196 @samp{#line} directives into the output file.  @samp{#line} is a
3197 directive that specifies the original line number and source file name
3198 for subsequent input in the current preprocessor input file.
3199 @samp{#line} has three variants:
3200
3201 @table @code
3202 @item #line @var{linenum}
3203 @var{linenum} is a non-negative decimal integer constant.  It specifies
3204 the line number which should be reported for the following line of
3205 input.  Subsequent lines are counted from @var{linenum}.
3206
3207 @item #line @var{linenum} @var{filename}
3208 @var{linenum} is the same as for the first form, and has the same
3209 effect.  In addition, @var{filename} is a string constant.  The
3210 following line and all subsequent lines are reported to come from the
3211 file it specifies, until something else happens to change that.
3212 @var{filename} is interpreted according to the normal rules for a string
3213 constant: backslash escapes are interpreted.  This is different from
3214 @samp{#include}.
3215
3216 Previous versions of CPP did not interpret escapes in @samp{#line};
3217 we have changed it because the standard requires they be interpreted,
3218 and most other compilers do.
3219
3220 @item #line @var{anything else}
3221 @var{anything else} is checked for macro calls, which are expanded.
3222 The result should match one of the above two forms.
3223 @end table
3224
3225 @samp{#line} directives alter the results of the @code{__FILE__} and
3226 @code{__LINE__} predefined macros from that point on.  @xref{Standard
3227 Predefined Macros}.  They do not have any effect on @samp{#include}'s
3228 idea of the directory containing the current file.  This is a change
3229 from GCC 2.95.  Previously, a file reading
3230
3231 @smallexample
3232 #line 1 "../src/gram.y"
3233 #include "gram.h"
3234 @end smallexample
3235
3236 would search for @file{gram.h} in @file{../src}, then the @option{-I}
3237 chain; the directory containing the physical source file would not be
3238 searched.  In GCC 3.0 and later, the @samp{#include} is not affected by
3239 the presence of a @samp{#line} referring to a different directory.
3240
3241 We made this change because the old behavior caused problems when
3242 generated source files were transported between machines.  For instance,
3243 it is common practice to ship generated parsers with a source release,
3244 so that people building the distribution do not need to have yacc or
3245 Bison installed.  These files frequently have @samp{#line} directives
3246 referring to the directory tree of the system where the distribution was
3247 created.  If GCC tries to search for headers in those directories, the
3248 build is likely to fail.
3249
3250 The new behavior can cause failures too, if the generated file is not
3251 in the same directory as its source and it attempts to include a header
3252 which would be visible searching from the directory containing the
3253 source file.  However, this problem is easily solved with an additional
3254 @option{-I} switch on the command line.  The failures caused by the old
3255 semantics could sometimes be corrected only by editing the generated
3256 files, which is difficult and error-prone.
3257
3258 @node Pragmas
3259 @chapter Pragmas
3260
3261 The @samp{#pragma} directive is the method specified by the C standard
3262 for providing additional information to the compiler, beyond what is
3263 conveyed in the language itself.  Three forms of this directive
3264 (commonly known as @dfn{pragmas}) are specified by the 1999 C standard.
3265 A C compiler is free to attach any meaning it likes to other pragmas.
3266
3267 GCC has historically preferred to use extensions to the syntax of the
3268 language, such as @code{__attribute__}, for this purpose.  However, GCC
3269 does define a few pragmas of its own.  These mostly have effects on the
3270 entire translation unit or source file.
3271
3272 In GCC version 3, all GNU-defined, supported pragmas have been given a
3273 @code{GCC} prefix.  This is in line with the @code{STDC} prefix on all
3274 pragmas defined by C99.  For backward compatibility, pragmas which were
3275 recognized by previous versions are still recognized without the
3276 @code{GCC} prefix, but that usage is deprecated.  Some older pragmas are
3277 deprecated in their entirety.  They are not recognized with the
3278 @code{GCC} prefix.  @xref{Obsolete Features}.
3279
3280 @cindex @code{_Pragma}
3281 C99 introduces the @code{@w{_Pragma}} operator.  This feature addresses a
3282 major problem with @samp{#pragma}: being a directive, it cannot be
3283 produced as the result of macro expansion.  @code{@w{_Pragma}} is an
3284 operator, much like @code{sizeof} or @code{defined}, and can be embedded
3285 in a macro.
3286
3287 Its syntax is @code{@w{_Pragma (@var{string-literal})}}, where
3288 @var{string-literal} can be either a normal or wide-character string
3289 literal.  It is destringized, by replacing all @samp{\\} with a single
3290 @samp{\} and all @samp{\"} with a @samp{"}.  The result is then
3291 processed as if it had appeared as the right hand side of a
3292 @samp{#pragma} directive.  For example,
3293
3294 @smallexample
3295 _Pragma ("GCC dependency \"parse.y\"")
3296 @end smallexample
3297
3298 @noindent
3299 has the same effect as @code{#pragma GCC dependency "parse.y"}.  The
3300 same effect could be achieved using macros, for example
3301
3302 @smallexample
3303 #define DO_PRAGMA(x) _Pragma (#x)
3304 DO_PRAGMA (GCC dependency "parse.y")
3305 @end smallexample
3306
3307 The standard is unclear on where a @code{_Pragma} operator can appear.
3308 The preprocessor does not accept it within a preprocessing conditional
3309 directive like @samp{#if}.  To be safe, you are probably best keeping it
3310 out of directives other than @samp{#define}, and putting it on a line of
3311 its own.
3312
3313 This manual documents the pragmas which are meaningful to the
3314 preprocessor itself.  Other pragmas are meaningful to the C or C++
3315 compilers.  They are documented in the GCC manual.
3316
3317 @ftable @code
3318 @item #pragma GCC dependency
3319 @code{#pragma GCC dependency} allows you to check the relative dates of
3320 the current file and another file.  If the other file is more recent than
3321 the current file, a warning is issued.  This is useful if the current
3322 file is derived from the other file, and should be regenerated.  The
3323 other file is searched for using the normal include search path.
3324 Optional trailing text can be used to give more information in the
3325 warning message.
3326
3327 @smallexample
3328 #pragma GCC dependency "parse.y"
3329 #pragma GCC dependency "/usr/include/time.h" rerun fixincludes
3330 @end smallexample
3331
3332 @item #pragma GCC poison
3333 Sometimes, there is an identifier that you want to remove completely
3334 from your program, and make sure that it never creeps back in.  To
3335 enforce this, you can @dfn{poison} the identifier with this pragma.
3336 @code{#pragma GCC poison} is followed by a list of identifiers to
3337 poison.  If any of those identifiers appears anywhere in the source
3338 after the directive, it is a hard error.  For example,
3339
3340 @smallexample
3341 #pragma GCC poison printf sprintf fprintf
3342 sprintf(some_string, "hello");
3343 @end smallexample
3344
3345 @noindent
3346 will produce an error.
3347
3348 If a poisoned identifier appears as part of the expansion of a macro
3349 which was defined before the identifier was poisoned, it will @emph{not}
3350 cause an error.  This lets you poison an identifier without worrying
3351 about system headers defining macros that use it.
3352
3353 For example,
3354
3355 @smallexample
3356 #define strrchr rindex
3357 #pragma GCC poison rindex
3358 strrchr(some_string, 'h');
3359 @end smallexample
3360
3361 @noindent
3362 will not produce an error.
3363
3364 @item #pragma GCC system_header
3365 This pragma takes no arguments.  It causes the rest of the code in the
3366 current file to be treated as if it came from a system header.
3367 @xref{System Headers}.
3368
3369 @end ftable
3370
3371 @node Other Directives
3372 @chapter Other Directives
3373
3374 @findex #ident
3375 @findex #sccs
3376 The @samp{#ident} directive takes one argument, a string constant.  On
3377 some systems, that string constant is copied into a special segment of
3378 the object file.  On other systems, the directive is ignored.  The
3379 @samp{#sccs} directive is a synonym for @samp{#ident}.
3380
3381 These directives are not part of the C standard, but they are not
3382 official GNU extensions either.  What historical information we have
3383 been able to find, suggests they originated with System V@.
3384
3385 @cindex null directive
3386 The @dfn{null directive} consists of a @samp{#} followed by a newline,
3387 with only whitespace (including comments) in between.  A null directive
3388 is understood as a preprocessing directive but has no effect on the
3389 preprocessor output.  The primary significance of the existence of the
3390 null directive is that an input line consisting of just a @samp{#} will
3391 produce no output, rather than a line of output containing just a
3392 @samp{#}.  Supposedly some old C programs contain such lines.
3393
3394 @node Preprocessor Output
3395 @chapter Preprocessor Output
3396
3397 When the C preprocessor is used with the C, C++, or Objective-C
3398 compilers, it is integrated into the compiler and communicates a stream
3399 of binary tokens directly to the compiler's parser.  However, it can
3400 also be used in the more conventional standalone mode, where it produces
3401 textual output.
3402 @c FIXME: Document the library interface.
3403
3404 @cindex output format
3405 The output from the C preprocessor looks much like the input, except
3406 that all preprocessing directive lines have been replaced with blank
3407 lines and all comments with spaces.  Long runs of blank lines are
3408 discarded.
3409
3410 The ISO standard specifies that it is implementation defined whether a
3411 preprocessor preserves whitespace between tokens, or replaces it with
3412 e.g.@: a single space.  In GNU CPP, whitespace between tokens is collapsed
3413 to become a single space, with the exception that the first token on a
3414 non-directive line is preceded with sufficient spaces that it appears in
3415 the same column in the preprocessed output that it appeared in the
3416 original source file.  This is so the output is easy to read.
3417 @xref{Differences from previous versions}.  CPP does not insert any
3418 whitespace where there was none in the original source, except where
3419 necessary to prevent an accidental token paste.
3420
3421 @cindex linemarkers
3422 Source file name and line number information is conveyed by lines
3423 of the form
3424
3425 @smallexample
3426 # @var{linenum} @var{filename} @var{flags}
3427 @end smallexample
3428
3429 @noindent
3430 These are called @dfn{linemarkers}.  They are inserted as needed into
3431 the output (but never within a string or character constant).  They mean
3432 that the following line originated in file @var{filename} at line
3433 @var{linenum}.  @var{filename} will never contain any non-printing
3434 characters; they are replaced with octal escape sequences.
3435
3436 After the file name comes zero or more flags, which are @samp{1},
3437 @samp{2}, @samp{3}, or @samp{4}.  If there are multiple flags, spaces
3438 separate them.  Here is what the flags mean:
3439
3440 @table @samp
3441 @item 1
3442 This indicates the start of a new file.
3443 @item 2
3444 This indicates returning to a file (after having included another file).
3445 @item 3
3446 This indicates that the following text comes from a system header file,
3447 so certain warnings should be suppressed.
3448 @item 4
3449 This indicates that the following text should be treated as being
3450 wrapped in an implicit @code{extern "C"} block.
3451 @c maybe cross reference NO_IMPLICIT_EXTERN_C
3452 @end table
3453
3454 As an extension, the preprocessor accepts linemarkers in non-assembler
3455 input files.  They are treated like the corresponding @samp{#line}
3456 directive, (@pxref{Line Control}), except that trailing flags are
3457 permitted, and are interpreted with the meanings described above.  If
3458 multiple flags are given, they must be in ascending order.
3459
3460 Some directives may be duplicated in the output of the preprocessor.
3461 These are @samp{#ident} (always), @samp{#pragma} (only if the
3462 preprocessor does not handle the pragma itself), and @samp{#define} and
3463 @samp{#undef} (with certain debugging options).  If this happens, the
3464 @samp{#} of the directive will always be in the first column, and there
3465 will be no space between the @samp{#} and the directive name.  If macro
3466 expansion happens to generate tokens which might be mistaken for a
3467 duplicated directive, a space will be inserted between the @samp{#} and
3468 the directive name.
3469
3470 @node Traditional Mode
3471 @chapter Traditional Mode
3472
3473 Traditional (pre-standard) C preprocessing is rather different from
3474 the preprocessing specified by the standard.  When GCC is given the
3475 @option{-traditional-cpp} option, it attempts to emulate a traditional
3476 preprocessor.
3477
3478 GCC versions 3.2 and later only support traditional mode semantics in
3479 the preprocessor, and not in the compiler front ends.  This chapter
3480 outlines the traditional preprocessor semantics we implemented.
3481
3482 The implementation does not correspond precisely to the behavior of
3483 earlier versions of GCC, nor to any true traditional preprocessor.
3484 After all, inconsistencies among traditional implementations were a
3485 major motivation for C standardization.  However, we intend that it
3486 should be compatible with true traditional preprocessors in all ways
3487 that actually matter.
3488
3489 @menu
3490 * Traditional lexical analysis::
3491 * Traditional macros::
3492 * Traditional miscellany::
3493 * Traditional warnings::
3494 @end menu
3495
3496 @node Traditional lexical analysis
3497 @section Traditional lexical analysis
3498
3499 The traditional preprocessor does not decompose its input into tokens
3500 the same way a standards-conforming preprocessor does.  The input is
3501 simply treated as a stream of text with minimal internal form.
3502
3503 This implementation does not treat trigraphs (@pxref{trigraphs})
3504 specially since they were an invention of the standards committee.  It
3505 handles arbitrarily-positioned escaped newlines properly and splices
3506 the lines as you would expect; many traditional preprocessors did not
3507 do this.
3508
3509 The form of horizontal whitespace in the input file is preserved in
3510 the output.  In particular, hard tabs remain hard tabs.  This can be
3511 useful if, for example, you are preprocessing a Makefile.
3512
3513 Traditional CPP only recognizes C-style block comments, and treats the
3514 @samp{/*} sequence as introducing a comment only if it lies outside
3515 quoted text.  Quoted text is introduced by the usual single and double
3516 quotes, and also by an initial @samp{<} in a @code{#include}
3517 directive.
3518
3519 Traditionally, comments are completely removed and are not replaced
3520 with a space.  Since a traditional compiler does its own tokenization
3521 of the output of the preprocessor, this means that comments can
3522 effectively be used as token paste operators.  However, comments
3523 behave like separators for text handled by the preprocessor itself,
3524 since it doesn't re-lex its input.  For example, in
3525
3526 @smallexample
3527 #if foo/**/bar
3528 @end smallexample
3529
3530 @noindent
3531 @samp{foo} and @samp{bar} are distinct identifiers and expanded
3532 separately if they happen to be macros.  In other words, this
3533 directive is equivalent to
3534
3535 @smallexample
3536 #if foo bar
3537 @end smallexample
3538
3539 @noindent
3540 rather than
3541
3542 @smallexample
3543 #if foobar
3544 @end smallexample
3545
3546 Generally speaking, in traditional mode an opening quote need not have
3547 a matching closing quote.  In particular, a macro may be defined with
3548 replacement text that contains an unmatched quote.  Of course, if you
3549 attempt to compile preprocessed output containing an unmatched quote
3550 you will get a syntax error.
3551
3552 However, all preprocessing directives other than @code{#define}
3553 require matching quotes.  For example:
3554
3555 @smallexample
3556 #define m This macro's fine and has an unmatched quote
3557 "/* This is not a comment.  */
3558 /* @r{This is a comment.  The following #include directive
3559    is ill-formed.}  */
3560 #include <stdio.h
3561 @end smallexample
3562
3563 Just as for the ISO preprocessor, what would be a closing quote can be
3564 escaped with a backslash to prevent the quoted text from closing.
3565
3566 @node Traditional macros
3567 @section Traditional macros
3568
3569 The major difference between traditional and ISO macros is that the
3570 former expand to text rather than to a token sequence.  CPP removes
3571 all leading and trailing horizontal whitespace from a macro's
3572 replacement text before storing it, but preserves the form of internal
3573 whitespace.
3574
3575 One consequence is that it is legitimate for the replacement text to
3576 contain an unmatched quote (@pxref{Traditional lexical analysis}).  An
3577 unclosed string or character constant continues into the text
3578 following the macro call.  Similarly, the text at the end of a macro's
3579 expansion can run together with the text after the macro invocation to
3580 produce a single token.
3581
3582 Normally comments are removed from the replacement text after the
3583 macro is expanded, but if the @option{-CC} option is passed on the
3584 command line comments are preserved.  (In fact, the current
3585 implementation removes comments even before saving the macro
3586 replacement text, but it careful to do it in such a way that the
3587 observed effect is identical even in the function-like macro case.)
3588
3589 The ISO stringification operator @samp{#} and token paste operator
3590 @samp{##} have no special meaning.  As explained later, an effect
3591 similar to these operators can be obtained in a different way.  Macro
3592 names that are embedded in quotes, either from the main file or after
3593 macro replacement, do not expand.
3594
3595 CPP replaces an unquoted object-like macro name with its replacement
3596 text, and then rescans it for further macros to replace.  Unlike
3597 standard macro expansion, traditional macro expansion has no provision
3598 to prevent recursion.  If an object-like macro appears unquoted in its
3599 replacement text, it will be replaced again during the rescan pass,
3600 and so on @emph{ad infinitum}.  GCC detects when it is expanding
3601 recursive macros, emits an error message, and continues after the
3602 offending macro invocation.
3603
3604 @smallexample
3605 #define PLUS +
3606 #define INC(x) PLUS+x
3607 INC(foo);
3608      @expansion{} ++foo;
3609 @end smallexample
3610
3611 Function-like macros are similar in form but quite different in
3612 behavior to their ISO counterparts.  Their arguments are contained
3613 within parentheses, are comma-separated, and can cross physical lines.
3614 Commas within nested parentheses are not treated as argument
3615 separators.  Similarly, a quote in an argument cannot be left
3616 unclosed; a following comma or parenthesis that comes before the
3617 closing quote is treated like any other character.  There is no
3618 facility for handling variadic macros.
3619
3620 This implementation removes all comments from macro arguments, unless
3621 the @option{-C} option is given.  The form of all other horizontal
3622 whitespace in arguments is preserved, including leading and trailing
3623 whitespace.  In particular
3624
3625 @smallexample
3626 f( )
3627 @end smallexample
3628
3629 @noindent
3630 is treated as an invocation of the macro @samp{f} with a single
3631 argument consisting of a single space.  If you want to invoke a
3632 function-like macro that takes no arguments, you must not leave any
3633 whitespace between the parentheses.
3634
3635 If a macro argument crosses a new line, the new line is replaced with
3636 a space when forming the argument.  If the previous line contained an
3637 unterminated quote, the following line inherits the quoted state.
3638
3639 Traditional preprocessors replace parameters in the replacement text
3640 with their arguments regardless of whether the parameters are within
3641 quotes or not.  This provides a way to stringize arguments.  For
3642 example
3643
3644 @smallexample
3645 #define str(x) "x"
3646 str(/* @r{A comment} */some text )
3647      @expansion{} "some text "
3648 @end smallexample
3649