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