OSDN Git Service

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