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 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
 253    efficiency, and partly to limit runaway recursion.  */
 254 #define CPP_STACK_MAX 200
 255
 256 /* Values for opts.dump_macros.
 257   dump_only means inhibit output of the preprocessed text
 258              and instead output the definitions of all user-defined
 259              macros in a form suitable for use as input to cpp.
 260    dump_names means pass #define and the macro name through to output.
 261    dump_definitions means pass the whole definition (plus #define) through
 262 */
 263 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 264
 265 /* This structure is nested inside struct cpp_reader, and
 266    carries all the options visible to the command line.  */
 267 struct cpp_options
 268 {
 269   /* Name of input and output files.  */
 270   const char *in_fname;
 271   const char *out_fname;
 272
 273   /* Characters between tab stops.  */
 274   unsigned int tabstop;
 275
 276   /* Pending options - -D, -U, -A, -I, -ixxx. */
 277   struct cpp_pending *pending;
 278
 279   /* File name which deps are being written to.  This is 0 if deps are
 280      being written to stdout.  */
 281   const char *deps_file;
 282
 283   /* Target-name to write with the dependency information.  */
 284   char *deps_target;
 285
 286   /* Search paths for include files.  */
 287   struct file_name_list *quote_include;  /* First dir to search for "file" */
 288   struct file_name_list *bracket_include;/* First dir to search for <file> */
 289
 290   /* Map between header names and file names, used only on DOS where
 291      file names are limited in length.  */
 292   struct file_name_map_list *map_list;
 293
 294   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 295      in the standard include file directories.  */
 296   const char *include_prefix;
 297   unsigned int include_prefix_len;
 298
 299   /* -fleading_underscore sets this to "_".  */
 300   const char *user_label_prefix;
 301
 302   /* The language we're preprocessing.  */
 303   enum c_lang lang;
 304
 305   /* Non-0 means -v, so print the full set of include dirs.  */
 306   unsigned char verbose;
 307
 308   /* Nonzero means use extra default include directories for C++.  */
 309   unsigned char cplusplus;
 310
 311   /* Nonzero means handle cplusplus style comments */
 312   unsigned char cplusplus_comments;
 313
 314   /* Nonzero means handle #import, for objective C.  */
 315   unsigned char objc;
 316
 317   /* Nonzero means don't copy comments into the output file.  */
 318   unsigned char discard_comments;
 319
 320   /* Nonzero means process the ISO trigraph sequences.  */
 321   unsigned char trigraphs;
 322
 323   /* Nonzero means process the ISO digraph sequences.  */
 324   unsigned char digraphs;
 325
 326   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 327   unsigned char extended_numbers;
 328
 329   /* Nonzero means print the names of included files rather than the
 330      preprocessed output.  1 means just the #include "...", 2 means
 331      #include <...> as well.  */
 332   unsigned char print_deps;
 333
 334   /* Nonzero if missing .h files in -M output are assumed to be
 335      generated files and not errors.  */
 336   unsigned char print_deps_missing_files;
 337
 338   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 339   unsigned char print_deps_append;
 340
 341   /* Nonzero means print names of header files (-H).  */
 342   unsigned char print_include_names;
 343
 344   /* Nonzero means cpp_pedwarn causes a hard error.  */
 345   unsigned char pedantic_errors;
 346
 347   /* Nonzero means don't print warning messages.  */
 348   unsigned char inhibit_warnings;
 349
 350   /* Nonzero means don't suppress warnings from system headers.  */
 351   unsigned char warn_system_headers;
 352
 353   /* Nonzero means don't print error messages.  Has no option to
 354      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 355   unsigned char inhibit_errors;
 356
 357   /* Nonzero means warn if slash-star appears in a comment.  */
 358   unsigned char warn_comments;
 359
 360   /* Nonzero means warn if there are any trigraphs.  */
 361   unsigned char warn_trigraphs;
 362
 363   /* Nonzero means warn if #import is used.  */
 364   unsigned char warn_import;
 365
 366   /* Nonzero means warn about various incompatibilities with
 367      traditional C.  */
 368   unsigned char warn_traditional;
 369
 370   /* Nonzero means turn warnings into errors.  */
 371   unsigned char warnings_are_errors;
 372
 373   /* Nonzero causes output not to be done, but directives such as
 374      #define that have side effects are still obeyed.  */
 375   unsigned char no_output;
 376
 377   /* Nonzero means we should look for header.gcc files that remap file
 378      names.  */
 379   unsigned char remap;
 380
 381   /* Nonzero means don't output line number information.  */
 382   unsigned char no_line_commands;
 383
 384   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 385      the source-file directory.  */
 386   unsigned char ignore_srcdir;
 387
 388   /* Zero means dollar signs are punctuation. */
 389   unsigned char dollars_in_ident;
 390
 391   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 392   unsigned char warn_undef;
 393
 394   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 395   unsigned char c99;
 396
 397   /* Nonzero means give all the error messages the ANSI standard requires.  */
 398   unsigned char pedantic;
 399
 400   /* Nonzero means we're looking at already preprocessed code, so don't
 401      bother trying to do macro expansion and whatnot.  */
 402   unsigned char preprocessed;
 403
 404   /* Nonzero disables all the standard directories for headers.  */
 405   unsigned char no_standard_includes;
 406
 407   /* Nonzero disables the C++-specific standard directories for headers.  */
 408   unsigned char no_standard_cplusplus_includes;
 409
 410   /* Nonzero means dump macros in some fashion - see above.  */
 411   unsigned char dump_macros;
 412
 413   /* Nonzero means pass all #define and #undef directives which we
 414      actually process through to the output stream.  This feature is
 415      used primarily to allow cc1 to record the #defines and #undefs
 416      for the sake of debuggers which understand about preprocessor
 417      macros, but it may also be useful with -E to figure out how
 418      symbols are defined, and where they are defined.  */
 419   unsigned char debug_output;
 420
 421   /* Nonzero means pass #include lines through to the output.  */
 422   unsigned char dump_includes;
 423
 424   /* Print column number in error messages.  */
 425   unsigned char show_column;
 426 };
 427
 428 struct lexer_state
 429 {
 430   /* Nonzero if first token on line is CPP_HASH.  */
 431   unsigned char in_directive;
 432
 433   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 434   unsigned char angled_headers;
 435
 436   /* Nonzero to save comments.  Turned off if discard_comments, and in
 437      all directives apart from #define.  */
 438   unsigned char save_comments;
 439
 440   /* If nonzero the next token is at the beginning of the line.  */
 441   unsigned char next_bol;
 442
 443   /* Nonzero if we're mid-comment.  */
 444   unsigned char lexing_comment;
 445
 446   /* Nonzero if lexing __VA_ARGS__ is valid.  */
 447   unsigned char va_args_ok;
 448
 449   /* Nonzero if lexing poisoned identifiers is valid.  */
 450   unsigned char poisoned_ok;
 451
 452   /* Nonzero to prevent macro expansion.  */
 453   unsigned char prevent_expansion;
 454
 455   /* Nonzero when parsing arguments to a function-like macro.  */
 456   unsigned char parsing_args;
 457 };
 458
 459 /* Special nodes - identifiers with predefined significance.  */
 460 struct spec_nodes
 461 {
 462   cpp_hashnode *n_L;                    /* L"str" */
 463   cpp_hashnode *n_defined;              /* defined operator */
 464   cpp_hashnode *n__Pragma;              /* _Pragma operator */
 465   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 466   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 467   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 468 };
 469
 470 /* This structure is passed to the call back when changing file.  */
 471 enum cpp_fc_reason {FC_ENTER = 0, FC_LEAVE, FC_RENAME};
 472
 473 struct cpp_file_loc
 474 {
 475   const char *filename;
 476   unsigned int lineno;
 477 };
 478
 479 typedef struct cpp_file_change cpp_file_change;
 480 struct cpp_file_change
 481 {
 482   struct cpp_file_loc from;     /* Line of #include or #line.  */
 483   struct cpp_file_loc to;       /* Line after #include or #line, or start.  */
 484   enum cpp_fc_reason reason;    /* Reason for change.  */
 485   unsigned char sysp;           /* Nonzero if system header.  */
 486   unsigned char externc;        /* Nonzero if wrapper needed.  */
 487 };
 488
 489 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 490    Applying cpp_get_token repeatedly yields a stream of pre-processor
 491    tokens.  Usually, there is only one cpp_reader object active.  */
 492
 493 struct cpp_reader
 494 {
 495   /* Top of buffer stack.  */
 496   cpp_buffer *buffer;
 497
 498   /* Lexer state.  */
 499   struct lexer_state state;
 500
 501   /* The position of the last lexed token, last lexed directive, and
 502      last macro invocation.  */
 503   cpp_lexer_pos lexer_pos;
 504   cpp_lexer_pos macro_pos;
 505   cpp_lexer_pos directive_pos;
 506
 507   /* Memory pools.  */
 508   cpp_pool ident_pool;          /* For all identifiers, and permanent
 509                                    numbers and strings.  */
 510   cpp_pool temp_string_pool;    /* For temporary numbers and strings.   */
 511   cpp_pool macro_pool;          /* For macro definitions.  Permanent.  */
 512   cpp_pool argument_pool;       /* For macro arguments.  Temporary.   */
 513   cpp_pool* string_pool;        /* Either temp_string_pool or ident_pool.   */
 514
 515   /* Context stack.  */
 516   struct cpp_context base_context;
 517   struct cpp_context *context;
 518
 519   /* If in_directive, the directive if known.  */
 520   const struct directive *directive;
 521
 522   /* Multiple inlcude optimisation.  */
 523   enum mi_state mi_state;
 524   enum mi_ind mi_if_not_defined;
 525   unsigned int mi_lexed;
 526   const cpp_hashnode *mi_cmacro;
 527   const cpp_hashnode *mi_ind_cmacro;
 528
 529   /* Token lookahead.  */
 530   struct cpp_lookahead *la_read;        /* Read from this lookahead.  */
 531   struct cpp_lookahead *la_write;       /* Write to this lookahead.  */
 532   struct cpp_lookahead *la_unused;      /* Free store.  */
 533   struct cpp_lookahead *la_saved;       /* Backup when entering directive.  */
 534
 535   /* Error counter for exit code.  */
 536   unsigned int errors;
 537
 538   /* Line and column where a newline was first seen in a string
 539      constant (multi-line strings).  */
 540   cpp_lexer_pos mlstring_pos;
 541
 542   /* Buffer to hold macro definition string.  */
 543   unsigned char *macro_buffer;
 544   unsigned int macro_buffer_len;
 545
 546   /* Current depth in #include directives that use <...>.  */
 547   unsigned int system_include_depth;
 548
 549   /* Current depth of buffer stack.  */
 550   unsigned int buffer_stack_depth;
 551
 552   /* Current depth in #include directives.  */
 553   unsigned int include_depth;
 554
 555   /* Hash table of macros and assertions.  See cpphash.c.  */
 556   struct htab *hashtab;
 557
 558   /* Tree of other included files.  See cppfiles.c.  */
 559   struct splay_tree_s *all_include_files;
 560
 561   /* Chain of `actual directory' file_name_list entries, for ""
 562      inclusion.  */
 563   struct file_name_list *actual_dirs;
 564
 565   /* Current maximum length of directory names in the search path
 566      for include files.  (Altered as we get more of them.)  */
 567   unsigned int max_include_len;
 568
 569   /* Date and time tokens.  Calculated together if either is requested.  */
 570   cpp_token date;
 571   cpp_token time;
 572
 573   /* Buffer of -M output.  */
 574   struct deps *deps;
 575
 576   /* Obstack holding all macro hash nodes.  This never shrinks.
 577      See cpphash.c */
 578   struct obstack *hash_ob;
 579
 580   /* Obstack holding buffer and conditional structures.  This is a
 581      real stack.  See cpplib.c */
 582   struct obstack *buffer_ob;
 583
 584   /* Pragma table - dynamic, because a library user can add to the
 585      list of recognized pragmas.  */
 586   struct pragma_entry *pragmas;
 587
 588   /* Call backs.  */
 589   struct {
 590     void (*change_file) PARAMS ((cpp_reader *, const cpp_file_change *));
 591     void (*include) PARAMS ((cpp_reader *, const unsigned char *,
 592                              const cpp_token *));
 593     void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
 594     void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
 595     void (*poison) PARAMS ((cpp_reader *));
 596     void (*ident) PARAMS ((cpp_reader *, const cpp_string *));
 597     void (*def_pragma) PARAMS ((cpp_reader *));
 598   } cb;
 599
 600   /* User visible options.  */
 601   struct cpp_options opts;
 602
 603   /* Special nodes - identifiers with predefined significance to the
 604      preprocessor.  */
 605   struct spec_nodes spec_nodes;
 606
 607   /* Nonzero means we have printed (while error reporting) a list of
 608      containing files that matches the current status.  */
 609   unsigned char input_stack_listing_current;
 610
 611   /* We're printed a warning recommending against using #import.  */
 612   unsigned char import_warning;
 613
 614   /* True after cpp_start_read completes.  Used to inhibit some
 615      warnings while parsing the command line.  */
 616   unsigned char done_initializing;
 617
 618   /* True if we are skipping a failed conditional group.  */
 619   unsigned char skipping;
 620 };
 621
 622 #define CPP_FATAL_LIMIT 1000
 623 /* True if we have seen a "fatal" error. */
 624 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 625
 626 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 627 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 628 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
 629 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
 630 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
 631
 632 /* Name under which this program was invoked.  */
 633 extern const char *progname;
 634
 635 /* The structure of a node in the hash table.  The hash table has
 636    entries for all identifiers: either macros defined by #define
 637    commands (type NT_MACRO), assertions created with #assert
 638    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 639    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 640    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 641    identifier that behaves like an operator such as "xor".
 642    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 643    diagnostic may be required for this node.  Currently this only
 644    applies to __VA_ARGS__ and poisoned identifiers.  */
 645
 646 /* Hash node flags.  */
 647 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 648 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 649 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 650 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 651
 652 /* Different flavors of hash node.  */
 653 enum node_type
 654 {
 655   NT_VOID = 0,     /* No definition yet.  */
 656   NT_MACRO,        /* A macro of some form.  */
 657   NT_ASSERTION     /* Predicate for #assert.  */
 658 };
 659
 660 /* Different flavors of builtin macro.  */
 661 enum builtin_type
 662 {
 663   BT_SPECLINE = 0,              /* `__LINE__' */
 664   BT_DATE,                      /* `__DATE__' */
 665   BT_FILE,                      /* `__FILE__' */
 666   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 667   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 668   BT_TIME,                      /* `__TIME__' */
 669   BT_STDC                       /* `__STDC__' */
 670 };
 671
 672 /* There is a slot in the hashnode for use by front ends when integrated
 673    with cpplib.  It holds a tree (see tree.h) but we mustn't drag that
 674    header into every user of cpplib.h.  cpplib does not do anything with
 675    this slot except clear it when a new node is created.  */
 676 union tree_node;
 677
 678 struct cpp_hashnode
 679 {
 680   const unsigned char *name;            /* Null-terminated name.  */
 681   unsigned int hash;                    /* Cached hash value.  */
 682   unsigned short length;                /* Length of name excluding null.  */
 683   unsigned short arg_index;             /* Macro argument index.  */
 684   unsigned char directive_index;        /* Index into directive table.  */
 685   ENUM_BITFIELD(node_type) type : 8;    /* Node type.  */
 686   unsigned char flags;                  /* Node flags.  */
 687
 688   union
 689   {
 690     cpp_macro *macro;                   /* If a macro.  */
 691     struct answer *answers;             /* Answers to an assertion.  */
 692     enum cpp_ttype operator;            /* Code for a named operator.  */
 693     enum builtin_type builtin;          /* Code for a builtin macro.  */
 694   } value;
 695
 696   union tree_node *fe_value;            /* Front end value.  */
 697 };
 698
 699 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 700 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 701 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 702                                                  const cpp_token *));
 703 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 704                                                unsigned char *));
 705 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 706 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 707 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 708                                          const char *, const char *,
 709                                          void (*) PARAMS ((cpp_reader *))));
 710 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
 711
 712 extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
 713 extern void cpp_finish PARAMS ((cpp_reader *));
 714 extern void cpp_cleanup PARAMS ((cpp_reader *));
 715 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 716                                     const cpp_token *));
 717 extern enum cpp_ttype cpp_can_paste PARAMS ((cpp_reader *, const cpp_token *,
 718                                              const cpp_token *, int *));
 719 extern void cpp_get_token PARAMS ((cpp_reader *, cpp_token *));
 720 extern const cpp_lexer_pos *cpp_get_line PARAMS ((cpp_reader *));
 721 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 722                                                   const cpp_hashnode *));
 723
 724 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 725 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 726 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 727 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 728
 729 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 730                                             const unsigned char *, long));
 731 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 732 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 733
 734 /* N.B. The error-message-printer prototypes have not been nicely
 735    formatted because exgettext needs to see 'msgid' on the same line
 736    as the name of the function in order to work properly.  Only the
 737    string argument gets a name in an effort to keep the lines from
 738    getting ridiculously oversized.  */
 739
 740 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 741   ATTRIBUTE_PRINTF_2;
 742 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 743   ATTRIBUTE_PRINTF_2;
 744 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 745   ATTRIBUTE_PRINTF_2;
 746 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 747   ATTRIBUTE_PRINTF_2;
 748 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 749   ATTRIBUTE_PRINTF_2;
 750 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 751   ATTRIBUTE_PRINTF_2;
 752 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 753   ATTRIBUTE_PRINTF_4;
 754 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 755   ATTRIBUTE_PRINTF_4;
 756 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 757   ATTRIBUTE_PRINTF_4;
 758 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 759   ATTRIBUTE_PRINTF_5;
 760 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 761 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 762
 763 /* In cpplex.c */
 764 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 765                                                  const char *));
 766 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 767 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 768 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 769
 770 /* In cpphash.c */
 771 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 772                                                  const unsigned char *, size_t));
 773 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 774                                                  int (*) PARAMS ((cpp_reader *,
 775                                                                   cpp_hashnode *,
 776                                                                   void *)),
 777                                                  void *));
 778
 779 /* In cppmacro.c */
 780 extern void cpp_scan_buffer_nooutput    PARAMS ((cpp_reader *, int));
 781 extern void cpp_start_lookahead         PARAMS ((cpp_reader *));
 782 extern void cpp_stop_lookahead          PARAMS ((cpp_reader *, int));
 783
 784 /* In cppfiles.c */
 785 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 786 extern int cpp_read_file PARAMS ((cpp_reader *, const char *));
 787 extern void cpp_make_system_header PARAMS ((cpp_reader *, cpp_buffer *, int));
 788
 789 /* These are inline functions instead of macros so we can get type
 790    checking.  */
 791 typedef unsigned char U_CHAR;
 792 #define U (const U_CHAR *)  /* Intended use: U"string" */
 793
 794 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 795 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 796                                          size_t));
 797 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 798 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 799 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 800 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 801
 802 static inline int
 803 ustrcmp (s1, s2)
 804      const U_CHAR *s1, *s2;
 805 {
 806   return strcmp ((const char *)s1, (const char *)s2);
 807 }
 808
 809 static inline int
 810 ustrncmp (s1, s2, n)
 811      const U_CHAR *s1, *s2;
 812      size_t n;
 813 {
 814   return strncmp ((const char *)s1, (const char *)s2, n);
 815 }
 816
 817 static inline size_t
 818 ustrlen (s1)
 819      const U_CHAR *s1;
 820 {
 821   return strlen ((const char *)s1);
 822 }
 823
 824 static inline U_CHAR *
 825 uxstrdup (s1)
 826      const U_CHAR *s1;
 827 {
 828   return (U_CHAR *) xstrdup ((const char *)s1);
 829 }
 830
 831 static inline U_CHAR *
 832 ustrchr (s1, c)
 833      const U_CHAR *s1;
 834      int c;
 835 {
 836   return (U_CHAR *) strchr ((const char *)s1, c);
 837 }
 838
 839 static inline int
 840 ufputs (s, f)
 841      const U_CHAR *s;
 842      FILE *f;
 843 {
 844   return fputs ((const char *)s, f);
 845 }
 846
 847 #ifdef __cplusplus
 848 }
 849 #endif
 850 #endif /* __GCC_CPPLIB__ */