gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 96-99, 2000 Free Software Foundation, Inc.
   3    Written by Per Bothner, 1994-95.
   4
   5 This program is free software; you can redistribute it and/or modify it
   6 under the terms of the GNU General Public License as published by the
   7 Free Software Foundation; either version 2, or (at your option) any
   8 later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19  In other words, you are welcome to use, share and improve this program.
  20  You are forbidden to forbid anyone else to use, share and improve
  21  what you give them.   Help stamp out software-hoarding!  */
  22 #ifndef __GCC_CPPLIB__
  23 #define __GCC_CPPLIB__
  24
  25 #include <sys/types.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /* For complex reasons, cpp_reader is also typedefed in c-pragma.h.  */
  32 #ifndef _C_PRAGMA_H
  33 typedef struct cpp_reader cpp_reader;
  34 #endif
  35 typedef struct cpp_buffer cpp_buffer;
  36 typedef struct cpp_options cpp_options;
  37 typedef struct cpp_token cpp_token;
  38 typedef struct cpp_string cpp_string;
  39 typedef struct cpp_hashnode cpp_hashnode;
  40 typedef struct cpp_pool cpp_pool;
  41 typedef struct cpp_macro cpp_macro;
  42 typedef struct cpp_lexer_pos cpp_lexer_pos;
  43 typedef struct cpp_lookahead cpp_lookahead;
  44
  45 struct directive;               /* These are deliberately incomplete.  */
  46 struct answer;
  47 struct cpp_macro;
  48 struct macro_args;
  49 struct cpp_chunk;
  50 struct file_name_map_list;
  51 struct htab;
  52
  53 /* The first two groups, apart from '=', can appear in preprocessor
  54    expressions.  This allows a lookup table to be implemented in
  55    _cpp_parse_expr.
  56
  57    The first group, to CPP_LAST_EQ, can be immediately followed by an
  58    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  59    the same order as their counterparts without the '=', like ">>".  */
  60
  61 /* Positions in the table.  */
  62 #define CPP_LAST_EQ CPP_MAX
  63 #define CPP_FIRST_DIGRAPH CPP_HASH
  64 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  65
  66 #define TTYPE_TABLE                             \
  67   OP(CPP_EQ = 0,        "=")                    \
  68   OP(CPP_NOT,           "!")                    \
  69   OP(CPP_GREATER,       ">")    /* compare */   \
  70   OP(CPP_LESS,          "<")                    \
  71   OP(CPP_PLUS,          "+")    /* math */      \
  72   OP(CPP_MINUS,         "-")                    \
  73   OP(CPP_MULT,          "*")                    \
  74   OP(CPP_DIV,           "/")                    \
  75   OP(CPP_MOD,           "%")                    \
  76   OP(CPP_AND,           "&")    /* bit ops */   \
  77   OP(CPP_OR,            "|")                    \
  78   OP(CPP_XOR,           "^")                    \
  79   OP(CPP_RSHIFT,        ">>")                   \
  80   OP(CPP_LSHIFT,        "<<")                   \
  81   OP(CPP_MIN,           "<?")   /* extension */ \
  82   OP(CPP_MAX,           ">?")                   \
  83 \
  84   OP(CPP_COMPL,         "~")                    \
  85   OP(CPP_AND_AND,       "&&")   /* logical */   \
  86   OP(CPP_OR_OR,         "||")                   \
  87   OP(CPP_QUERY,         "?")                    \
  88   OP(CPP_COLON,         ":")                    \
  89   OP(CPP_COMMA,         ",")    /* grouping */  \
  90   OP(CPP_OPEN_PAREN,    "(")                    \
  91   OP(CPP_CLOSE_PAREN,   ")")                    \
  92   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  93   OP(CPP_NOT_EQ,        "!=")                   \
  94   OP(CPP_GREATER_EQ,    ">=")                   \
  95   OP(CPP_LESS_EQ,       "<=")                   \
  96 \
  97   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  98   OP(CPP_MINUS_EQ,      "-=")                   \
  99   OP(CPP_MULT_EQ,       "*=")                   \
 100   OP(CPP_DIV_EQ,        "/=")                   \
 101   OP(CPP_MOD_EQ,        "%=")                   \
 102   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 103   OP(CPP_OR_EQ,         "|=")                   \
 104   OP(CPP_XOR_EQ,        "^=")                   \
 105   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 106   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 107   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 108   OP(CPP_MAX_EQ,        ">?=")                  \
 109   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 110   OP(CPP_HASH,          "#")    /* digraphs */  \
 111   OP(CPP_PASTE,         "##")                   \
 112   OP(CPP_OPEN_SQUARE,   "[")                    \
 113   OP(CPP_CLOSE_SQUARE,  "]")                    \
 114   OP(CPP_OPEN_BRACE,    "{")                    \
 115   OP(CPP_CLOSE_BRACE,   "}")                    \
 116   /* The remainder of the punctuation.  Order is not significant.  */   \
 117   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 118   OP(CPP_ELLIPSIS,      "...")                  \
 119   OP(CPP_BACKSLASH,     "\\")                   \
 120   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 121   OP(CPP_MINUS_MINUS,   "--")                   \
 122   OP(CPP_DEREF,         "->")   /* accessors */ \
 123   OP(CPP_DOT,           ".")                    \
 124   OP(CPP_SCOPE,         "::")                   \
 125   OP(CPP_DEREF_STAR,    "->*")                  \
 126   OP(CPP_DOT_STAR,      ".*")                   \
 127 \
 128   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 129   TK(CPP_INT,           SPELL_STRING)   /* 23 */                        \
 130   TK(CPP_FLOAT,         SPELL_STRING)   /* 3.14159 */                   \
 131   TK(CPP_NUMBER,        SPELL_STRING)   /* 34_be+ta  */                 \
 132 \
 133   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 134   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 135   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 136 \
 137   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 138   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 139   TK(CPP_OSTRING,       SPELL_STRING)   /* @"string" - Objective C */   \
 140   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 141 \
 142   TK(CPP_COMMENT,       SPELL_STRING)   /* Only if output comments.  */ \
 143   TK(CPP_DHASH,         SPELL_NONE)     /* The # of a directive.  */    \
 144   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 145   TK(CPP_PLACEMARKER,   SPELL_NONE)     /* Placemarker token.  */       \
 146   OP(CPP_EOF,           "EOL")          /* End of line or file.  */
 147
 148 #define OP(e, s) e,
 149 #define TK(e, s) e,
 150 enum cpp_ttype
 151 {
 152   TTYPE_TABLE
 153   N_TTYPES
 154 };
 155 #undef OP
 156 #undef TK
 157
 158 /* Multiple-include optimisation.  */
 159 enum mi_state {MI_FAILED = 0, MI_OUTSIDE};
 160 enum mi_ind {MI_IND_NONE = 0, MI_IND_NOT};
 161
 162 /* Payload of a NUMBER, FLOAT, STRING, or COMMENT token.  */
 163 struct cpp_string
 164 {
 165   unsigned int len;
 166   const unsigned char *text;
 167 };
 168
 169 /* Flags for the cpp_token structure.  */
 170 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 171 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 172 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 173 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 174 #define NAMED_OP        (1 << 4) /* C++ named operators, also "defined".  */
 175 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 176 #define VARARGS_FIRST   STRINGIFY_ARG /* First token of varargs expansion.  */
 177
 178 /* A preprocessing token.  This has been carefully packed and should
 179    occupy 12 bytes on 32-bit hosts and 16 bytes on 64-bit hosts.  */
 180 struct cpp_token
 181 {
 182   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 183   unsigned char flags;          /* flags - see above */
 184
 185   union
 186   {
 187     HOST_WIDEST_INT integer;    /* an integer */
 188     struct cpp_hashnode *node;  /* an identifier */
 189     struct cpp_string str;      /* a string, or number */
 190     unsigned int aux;           /* argument no. for a CPP_MACRO_ARG, or
 191                                    character represented by CPP_OTHER.  */
 192   } val;
 193 };
 194
 195 /* The position of a token in the current file.  */
 196 struct cpp_lexer_pos
 197 {
 198   unsigned int line;
 199   unsigned int output_line;
 200   unsigned short col;
 201 };
 202
 203 typedef struct cpp_token_with_pos cpp_token_with_pos;
 204 struct cpp_token_with_pos
 205 {
 206   cpp_token token;
 207   cpp_lexer_pos pos;
 208 };
 209
 210 /* Token lookahead.  */
 211 struct cpp_lookahead
 212 {
 213   struct cpp_lookahead *next;
 214   cpp_token_with_pos *tokens;
 215   cpp_lexer_pos pos;
 216   unsigned int cur, count, cap;
 217 };
 218
 219 /* Memory pools.  */
 220 struct cpp_pool
 221 {
 222   struct cpp_chunk *cur, *locked;
 223   unsigned char *pos;           /* Current position.  */
 224   unsigned int align;
 225   unsigned int locks;
 226 };
 227
 228 typedef struct toklist toklist;
 229 struct toklist
 230 {
 231   cpp_token *first;
 232   cpp_token *limit;
 233 };
 234
 235 typedef struct cpp_context cpp_context;
 236 struct cpp_context
 237 {
 238   /* Doubly-linked list.  */
 239   cpp_context *next, *prev;
 240
 241   /* Contexts other than the base context are contiguous tokens.
 242      e.g. macro expansions, expanded argument tokens.  */
 243   struct toklist list;
 244
 245   /* For a macro context, these are the macro and its arguments.  */
 246   cpp_macro *macro;
 247 };
 248
 249 /* A standalone character.  We may want to make it unsigned for the
 250    same reason we use unsigned char - to avoid signedness issues.  */
 251 typedef int cppchar_t;
 252
 253 struct cpp_buffer
 254 {
 255   const unsigned char *cur;      /* current position */
 256   const unsigned char *rlimit; /* end of valid data */
 257   const unsigned char *line_base; /* start of current line */
 258   cppchar_t read_ahead;         /* read ahead character */
 259   cppchar_t extra_char;         /* extra read-ahead for long tokens.  */
 260
 261   struct cpp_reader *pfile;     /* Owns this buffer.  */
 262   struct cpp_buffer *prev;
 263
 264   const unsigned char *buf;      /* entire buffer */
 265
 266   /* Filename specified with #line command.  */
 267   const char *nominal_fname;
 268
 269   /* Actual directory of this file, used only for "" includes */
 270   struct file_name_list *actual_dir;
 271
 272   /* Pointer into the include table.  Used for include_next and
 273      to record control macros. */
 274   struct include_file *inc;
 275
 276   /* Value of if_stack at start of this file.
 277      Used to prohibit unmatched #endif (etc) in an include file.  */
 278   struct if_stack *if_stack;
 279
 280   /* Token column position adjustment owing to tabs in whitespace.  */
 281   unsigned int col_adjust;
 282
 283   /* Line number at line_base (above). */
 284   unsigned int lineno;
 285
 286   /* True if we have already warned about C++ comments in this file.
 287      The warning happens only for C89 extended mode with -pedantic on,
 288      or for -Wtraditional, and only once per file (otherwise it would
 289      be far too noisy).  */
 290   unsigned char warned_cplusplus_comments;
 291
 292   /* True if we don't process trigraphs and escaped newlines.  True
 293      for preprocessed input, command line directives, and _Pragma
 294      buffers.  */
 295   unsigned char from_stage3;
 296 };
 297
 298 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
 299    efficiency, and partly to limit runaway recursion.  */
 300 #define CPP_STACK_MAX 200
 301
 302 /* Values for opts.dump_macros.
 303   dump_only means inhibit output of the preprocessed text
 304              and instead output the definitions of all user-defined
 305              macros in a form suitable for use as input to cpp.
 306    dump_names means pass #define and the macro name through to output.
 307    dump_definitions means pass the whole definition (plus #define) through
 308 */
 309 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 310
 311 /* This structure is nested inside struct cpp_reader, and
 312    carries all the options visible to the command line.  */
 313 struct cpp_options
 314 {
 315   /* Name of input and output files.  */
 316   const char *in_fname;
 317   const char *out_fname;
 318
 319   /* Characters between tab stops.  */
 320   unsigned int tabstop;
 321
 322   /* Pending options - -D, -U, -A, -I, -ixxx. */
 323   struct cpp_pending *pending;
 324
 325   /* File name which deps are being written to.  This is 0 if deps are
 326      being written to stdout.  */
 327   const char *deps_file;
 328
 329   /* Target-name to write with the dependency information.  */
 330   char *deps_target;
 331
 332   /* Search paths for include files.  */
 333   struct file_name_list *quote_include;  /* First dir to search for "file" */
 334   struct file_name_list *bracket_include;/* First dir to search for <file> */
 335
 336   /* Map between header names and file names, used only on DOS where
 337      file names are limited in length.  */
 338   struct file_name_map_list *map_list;
 339
 340   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 341      in the standard include file directories.  */
 342   const char *include_prefix;
 343   unsigned int include_prefix_len;
 344
 345   /* -fleading_underscore sets this to "_".  */
 346   const char *user_label_prefix;
 347
 348   /* Non-0 means -v, so print the full set of include dirs.  */
 349   unsigned char verbose;
 350
 351   /* Nonzero means use extra default include directories for C++.  */
 352   unsigned char cplusplus;
 353
 354   /* Nonzero means handle cplusplus style comments */
 355   unsigned char cplusplus_comments;
 356
 357   /* Nonzero means handle #import, for objective C.  */
 358   unsigned char objc;
 359
 360   /* Nonzero means this is an assembly file, so ignore unrecognized
 361      directives and the "# 33" form of #line, both of which are
 362      probably comments.  Also, permit unbalanced ' strings (again,
 363      likely to be in comments).  */
 364   unsigned char lang_asm;
 365
 366   /* Nonzero means don't copy comments into the output file.  */
 367   unsigned char discard_comments;
 368
 369   /* Nonzero means process the ISO trigraph sequences.  */
 370   unsigned char trigraphs;
 371
 372   /* Nonzero means process the ISO digraph sequences.  */
 373   unsigned char digraphs;
 374
 375   /* Nonzero means print the names of included files rather than the
 376      preprocessed output.  1 means just the #include "...", 2 means
 377      #include <...> as well.  */
 378   unsigned char print_deps;
 379
 380   /* Nonzero if missing .h files in -M output are assumed to be
 381      generated files and not errors.  */
 382   unsigned char print_deps_missing_files;
 383
 384   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 385   unsigned char print_deps_append;
 386
 387   /* Nonzero means print names of header files (-H).  */
 388   unsigned char print_include_names;
 389
 390   /* Nonzero means cpp_pedwarn causes a hard error.  */
 391   unsigned char pedantic_errors;
 392
 393   /* Nonzero means don't print warning messages.  */
 394   unsigned char inhibit_warnings;
 395
 396   /* Nonzero means don't suppress warnings from system headers.  */
 397   unsigned char warn_system_headers;
 398
 399   /* Nonzero means don't print error messages.  Has no option to
 400      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 401   unsigned char inhibit_errors;
 402
 403   /* Nonzero means warn if slash-star appears in a comment.  */
 404   unsigned char warn_comments;
 405
 406   /* Nonzero means warn if there are any trigraphs.  */
 407   unsigned char warn_trigraphs;
 408
 409   /* Nonzero means warn if #import is used.  */
 410   unsigned char warn_import;
 411
 412   /* Nonzero means warn about various incompatibilities with
 413      traditional C.  */
 414   unsigned char warn_traditional;
 415
 416   /* Nonzero means warn if ## is applied to two tokens that cannot be
 417      pasted together.  */
 418   unsigned char warn_paste;
 419
 420   /* Nonzero means turn warnings into errors.  */
 421   unsigned char warnings_are_errors;
 422
 423   /* Nonzero causes output not to be done, but directives such as
 424      #define that have side effects are still obeyed.  */
 425   unsigned char no_output;
 426
 427   /* Nonzero means we should look for header.gcc files that remap file
 428      names.  */
 429   unsigned char remap;
 430
 431   /* Nonzero means don't output line number information.  */
 432   unsigned char no_line_commands;
 433
 434   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 435      the source-file directory.  */
 436   unsigned char ignore_srcdir;
 437
 438   /* Zero means dollar signs are punctuation. */
 439   unsigned char dollars_in_ident;
 440
 441   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 442   unsigned char warn_undef;
 443
 444   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 445   unsigned char c89;
 446
 447   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 448   unsigned char c99;
 449
 450   /* Nonzero means give all the error messages the ANSI standard requires.  */
 451   unsigned char pedantic;
 452
 453   /* Nonzero means we're looking at already preprocessed code, so don't
 454      bother trying to do macro expansion and whatnot.  */
 455   unsigned char preprocessed;
 456
 457   /* Nonzero disables all the standard directories for headers.  */
 458   unsigned char no_standard_includes;
 459
 460   /* Nonzero disables the C++-specific standard directories for headers.  */
 461   unsigned char no_standard_cplusplus_includes;
 462
 463   /* Nonzero means dump macros in some fashion - see above.  */
 464   unsigned char dump_macros;
 465
 466   /* Nonzero means pass all #define and #undef directives which we
 467      actually process through to the output stream.  This feature is
 468      used primarily to allow cc1 to record the #defines and #undefs
 469      for the sake of debuggers which understand about preprocessor
 470      macros, but it may also be useful with -E to figure out how
 471      symbols are defined, and where they are defined.  */
 472   unsigned char debug_output;
 473
 474   /* Nonzero means pass #include lines through to the output.  */
 475   unsigned char dump_includes;
 476
 477   /* Print column number in error messages.  */
 478   unsigned char show_column;
 479 };
 480
 481 struct lexer_state
 482 {
 483   /* Nonzero if first token on line is CPP_HASH.  */
 484   unsigned char in_directive;
 485
 486   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 487   unsigned char angled_headers;
 488
 489   /* Nonzero to save comments.  Turned off if discard_comments, and in
 490      all directives apart from #define.  */
 491   unsigned char save_comments;
 492
 493   /* If nonzero the lexer skips newlines.  Internal to the lexer.  */
 494   unsigned char skip_newlines;
 495
 496   /* Nonzero if we're mid-comment.  */
 497   unsigned char lexing_comment;
 498
 499   /* Nonzero if lexing __VA_ARGS__ is valid.  */
 500   unsigned char va_args_ok;
 501
 502   /* Nonzero if lexing poisoned identifiers is valid.  */
 503   unsigned char poisoned_ok;
 504
 505   /* Nonzero to prevent macro expansion.  */
 506   unsigned char prevent_expansion;
 507
 508   /* Nonzero when parsing arguments to a function-like macro.  */
 509   unsigned char parsing_args;
 510 };
 511
 512 /* Special nodes - identifiers with predefined significance.  */
 513 struct spec_nodes
 514 {
 515   cpp_hashnode *n_L;                    /* L"str" */
 516   cpp_hashnode *n_defined;              /* defined operator */
 517   cpp_hashnode *n__Pragma;              /* _Pragma operator */
 518   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 519   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 520   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 521 };
 522
 523 /* a cpp_reader encapsulates the "state" of a pre-processor run.
 524    Applying cpp_get_token repeatedly yields a stream of pre-processor
 525    tokens.  Usually, there is only one cpp_reader object active.  */
 526
 527 struct cpp_reader
 528 {
 529   /* Top of buffer stack.  */
 530   cpp_buffer *buffer;
 531
 532   /* Lexer state.  */
 533   struct lexer_state state;
 534
 535   /* The position of the last lexed token, last lexed directive, and
 536      last macro invocation.  */
 537   cpp_lexer_pos lexer_pos;
 538   cpp_lexer_pos macro_pos;
 539   cpp_lexer_pos directive_pos;
 540
 541   /* Memory pools.  */
 542   cpp_pool ident_pool;          /* For all identifiers, and permanent
 543                                    numbers and strings.  */
 544   cpp_pool temp_string_pool;    /* For temporary numbers and strings.   */
 545   cpp_pool macro_pool;          /* For macro definitions.  Permanent.  */
 546   cpp_pool argument_pool;       /* For macro arguments.  Temporary.   */
 547   cpp_pool* string_pool;        /* Either temp_string_pool or ident_pool.   */
 548
 549   /* Context stack.  */
 550   struct cpp_context base_context;
 551   struct cpp_context *context;
 552
 553   /* If in_directive, the directive if known.  */
 554   const struct directive *directive;
 555
 556   /* Multiple inlcude optimisation.  */
 557   enum mi_state mi_state;
 558   enum mi_ind mi_if_not_defined;
 559   unsigned int mi_lexed;
 560   const cpp_hashnode *mi_cmacro;
 561   const cpp_hashnode *mi_ind_cmacro;
 562
 563   /* Token lookahead.  */
 564   struct cpp_lookahead *la_read;        /* Read from this lookahead.  */
 565   struct cpp_lookahead *la_write;       /* Write to this lookahead.  */
 566   struct cpp_lookahead *la_unused;      /* Free store.  */
 567
 568   /* Error counter for exit code.  */
 569   unsigned int errors;
 570
 571   /* Line and column where a newline was first seen in a string
 572      constant (multi-line strings).  */
 573   cpp_lexer_pos mlstring_pos;
 574
 575   /* Buffer to hold macro definition string.  */
 576   unsigned char *macro_buffer;
 577   unsigned int macro_buffer_len;
 578
 579   /* Current depth in #include directives that use <...>.  */
 580   unsigned int system_include_depth;
 581
 582   /* Current depth of buffer stack.  */
 583   unsigned int buffer_stack_depth;
 584
 585   /* Current depth in #include directives.  */
 586   unsigned int include_depth;
 587
 588   /* Hash table of macros and assertions.  See cpphash.c.  */
 589   struct htab *hashtab;
 590
 591   /* Tree of other included files.  See cppfiles.c.  */
 592   struct splay_tree_s *all_include_files;
 593
 594   /* Chain of `actual directory' file_name_list entries, for ""
 595      inclusion.  */
 596   struct file_name_list *actual_dirs;
 597
 598   /* Current maximum length of directory names in the search path
 599      for include files.  (Altered as we get more of them.)  */
 600   unsigned int max_include_len;
 601
 602   /* Date and time tokens.  Calculated together if either is requested.  */
 603   cpp_token date;
 604   cpp_token time;
 605
 606   /* Buffer of -M output.  */
 607   struct deps *deps;
 608
 609   /* Obstack holding all macro hash nodes.  This never shrinks.
 610      See cpphash.c */
 611   struct obstack *hash_ob;
 612
 613   /* Obstack holding buffer and conditional structures.  This is a
 614      real stack.  See cpplib.c */
 615   struct obstack *buffer_ob;
 616
 617   /* Pragma table - dynamic, because a library user can add to the
 618      list of recognized pragmas.  */
 619   struct pragma_entry *pragmas;
 620
 621   /* Call backs.  */
 622   struct {
 623     void (*enter_file) PARAMS ((cpp_reader *));
 624     void (*leave_file) PARAMS ((cpp_reader *));
 625     void (*rename_file) PARAMS ((cpp_reader *));
 626     void (*include) PARAMS ((cpp_reader *, const unsigned char *,
 627                              const cpp_token *));
 628     void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
 629     void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
 630     void (*poison) PARAMS ((cpp_reader *));
 631     void (*ident) PARAMS ((cpp_reader *, const cpp_string *));
 632     void (*def_pragma) PARAMS ((cpp_reader *));
 633   } cb;
 634
 635   /* User visible options.  */
 636   struct cpp_options opts;
 637
 638   /* Special nodes - identifiers with predefined significance to the
 639      preprocessor.  */
 640   struct spec_nodes spec_nodes;
 641
 642   /* Nonzero means we have printed (while error reporting) a list of
 643      containing files that matches the current status.  */
 644   unsigned char input_stack_listing_current;
 645
 646   /* We're printed a warning recommending against using #import.  */
 647   unsigned char import_warning;
 648
 649   /* True after cpp_start_read completes.  Used to inhibit some
 650      warnings while parsing the command line.  */
 651   unsigned char done_initializing;
 652
 653   /* True if we are skipping a failed conditional group.  */
 654   unsigned char skipping;
 655 };
 656
 657 #define CPP_FATAL_LIMIT 1000
 658 /* True if we have seen a "fatal" error. */
 659 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 660
 661 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 662 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 663 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
 664 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
 665 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
 666
 667 /* Name under which this program was invoked.  */
 668 extern const char *progname;
 669
 670 /* The structure of a node in the hash table.  The hash table has
 671    entries for all identifiers: either macros defined by #define
 672    commands (type NT_MACRO), assertions created with #assert
 673    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 674    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 675    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 676    identifier that behaves like an operator such as "xor".
 677    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 678    diagnostic may be required for this node.  Currently this only
 679    applies to __VA_ARGS__ and poisoned identifiers.  */
 680
 681 /* Hash node flags.  */
 682 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 683 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 684 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 685 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 686
 687 /* Different flavors of hash node.  */
 688 enum node_type
 689 {
 690   NT_VOID = 0,     /* No definition yet.  */
 691   NT_MACRO,        /* A macro of some form.  */
 692   NT_ASSERTION     /* Predicate for #assert.  */
 693 };
 694
 695 /* Different flavors of builtin macro.  */
 696 enum builtin_type
 697 {
 698   BT_SPECLINE = 0,              /* `__LINE__' */
 699   BT_DATE,                      /* `__DATE__' */
 700   BT_FILE,                      /* `__FILE__' */
 701   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 702   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 703   BT_TIME,                      /* `__TIME__' */
 704   BT_STDC                       /* `__STDC__' */
 705 };
 706
 707 /* There is a slot in the hashnode for use by front ends when integrated
 708    with cpplib.  It holds a tree (see tree.h) but we mustn't drag that
 709    header into every user of cpplib.h.  cpplib does not do anything with
 710    this slot except clear it when a new node is created.  */
 711 union tree_node;
 712
 713 struct cpp_hashnode
 714 {
 715   const unsigned char *name;            /* null-terminated name */
 716   unsigned int hash;                    /* cached hash value */
 717   unsigned short length;                /* length of name excluding null */
 718   unsigned short arg_index;             /* macro argument index */
 719   unsigned char directive_index;        /* index into directive table.  */
 720   ENUM_BITFIELD(node_type) type : 8;    /* node type.  */
 721   unsigned char flags;                  /* node flags.  */
 722
 723   union
 724   {
 725     cpp_macro *macro;                   /* a macro.  */
 726     struct answer *answers;             /* answers to an assertion.  */
 727     enum cpp_ttype operator;            /* code for a named operator.  */
 728     enum builtin_type builtin;          /* code for a builtin macro.  */
 729   } value;
 730
 731   union tree_node *fe_value;            /* front end value */
 732 };
 733
 734 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 735 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *, const cpp_token *));
 736 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 737                                                unsigned char *));
 738 extern void cpp_init PARAMS ((void));
 739 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 740 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 741 extern void cpp_reader_init PARAMS ((cpp_reader *));
 742
 743 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 744                                          const char *, const char *,
 745                                          void (*) PARAMS ((cpp_reader *))));
 746 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
 747
 748 extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
 749 extern void cpp_finish PARAMS ((cpp_reader *));
 750 extern void cpp_cleanup PARAMS ((cpp_reader *));
 751 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 752                                     const cpp_token *));
 753 extern enum cpp_ttype cpp_can_paste PARAMS ((cpp_reader *, const cpp_token *,
 754                                              const cpp_token *, int *));
 755 extern void cpp_get_token PARAMS ((cpp_reader *, cpp_token *));
 756 extern const cpp_lexer_pos *cpp_get_line PARAMS ((cpp_reader *));
 757 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 758                                                   const cpp_hashnode *));
 759
 760 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 761 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 762 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 763 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 764
 765 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 766                                             const unsigned char *, long));
 767 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 768 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 769
 770 /* N.B. The error-message-printer prototypes have not been nicely
 771    formatted because exgettext needs to see 'msgid' on the same line
 772    as the name of the function in order to work properly.  Only the
 773    string argument gets a name in an effort to keep the lines from
 774    getting ridiculously oversized.  */
 775
 776 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 777   ATTRIBUTE_PRINTF_2;
 778 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 779   ATTRIBUTE_PRINTF_2;
 780 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 781   ATTRIBUTE_PRINTF_2;
 782 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 783   ATTRIBUTE_PRINTF_2;
 784 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 785   ATTRIBUTE_PRINTF_2;
 786 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 787   ATTRIBUTE_PRINTF_2;
 788 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 789   ATTRIBUTE_PRINTF_4;
 790 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 791   ATTRIBUTE_PRINTF_4;
 792 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 793   ATTRIBUTE_PRINTF_4;
 794 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 795   ATTRIBUTE_PRINTF_5;
 796 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 797 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 798
 799 /* In cpplex.c */
 800 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 801                                                  const char *));
 802 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 803 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 804 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 805
 806 /* In cpphash.c */
 807 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 808                                                  const unsigned char *, size_t));
 809 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 810                                                  int (*) PARAMS ((cpp_reader *,
 811                                                                   cpp_hashnode *,
 812                                                                   void *)),
 813                                                  void *));
 814
 815 /* In cppmacro.c */
 816 extern void cpp_scan_buffer_nooutput    PARAMS ((cpp_reader *));
 817 extern void cpp_start_lookahead         PARAMS ((cpp_reader *));
 818 extern void cpp_stop_lookahead          PARAMS ((cpp_reader *, int));
 819
 820 /* In cppfiles.c */
 821 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 822 extern int cpp_read_file PARAMS ((cpp_reader *, const char *));
 823 extern void cpp_make_system_header PARAMS ((cpp_reader *, cpp_buffer *, int));
 824 extern const char *cpp_syshdr_flags PARAMS ((cpp_reader *, cpp_buffer *));
 825
 826 /* These are inline functions instead of macros so we can get type
 827    checking.  */
 828 typedef unsigned char U_CHAR;
 829 #define U (const U_CHAR *)  /* Intended use: U"string" */
 830
 831 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 832 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 833                                          size_t));
 834 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 835 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 836 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 837 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 838
 839 static inline int
 840 ustrcmp (s1, s2)
 841      const U_CHAR *s1, *s2;
 842 {
 843   return strcmp ((const char *)s1, (const char *)s2);
 844 }
 845
 846 static inline int
 847 ustrncmp (s1, s2, n)
 848      const U_CHAR *s1, *s2;
 849      size_t n;
 850 {
 851   return strncmp ((const char *)s1, (const char *)s2, n);
 852 }
 853
 854 static inline size_t
 855 ustrlen (s1)
 856      const U_CHAR *s1;
 857 {
 858   return strlen ((const char *)s1);
 859 }
 860
 861 static inline U_CHAR *
 862 uxstrdup (s1)
 863      const U_CHAR *s1;
 864 {
 865   return (U_CHAR *) xstrdup ((const char *)s1);
 866 }
 867
 868 static inline U_CHAR *
 869 ustrchr (s1, c)
 870      const U_CHAR *s1;
 871      int c;
 872 {
 873   return (U_CHAR *) strchr ((const char *)s1, c);
 874 }
 875
 876 static inline int
 877 ufputs (s, f)
 878      const U_CHAR *s;
 879      FILE *f;
 880 {
 881   return fputs ((const char *)s, f);
 882 }
 883
 884 #ifdef __cplusplus
 885 }
 886 #endif
 887 #endif /* __GCC_CPPLIB__ */