libcpp/include/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995-2015 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 3, 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; see the file COPYING3.  If not see
  17 <http://www.gnu.org/licenses/>.
  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 LIBCPP_CPPLIB_H
  23 #define LIBCPP_CPPLIB_H
  24
  25 #include <sys/types.h>
  26 #include "symtab.h"
  27 #include "line-map.h"
  28
  29 typedef struct cpp_reader cpp_reader;
  30 typedef struct cpp_buffer cpp_buffer;
  31 typedef struct cpp_options cpp_options;
  32 typedef struct cpp_token cpp_token;
  33 typedef struct cpp_string cpp_string;
  34 typedef struct cpp_hashnode cpp_hashnode;
  35 typedef struct cpp_macro cpp_macro;
  36 typedef struct cpp_callbacks cpp_callbacks;
  37 typedef struct cpp_dir cpp_dir;
  38
  39 struct answer;
  40 struct _cpp_file;
  41
  42 /* The first three groups, apart from '=', can appear in preprocessor
  43    expressions (+= and -= are used to indicate unary + and - resp.).
  44    This allows a lookup table to be implemented in _cpp_parse_expr.
  45
  46    The first group, to CPP_LAST_EQ, can be immediately followed by an
  47    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  48    the same order as their counterparts without the '=', like ">>".
  49
  50    See the cpp_operator table optab in expr.c if you change the order or
  51    add or remove anything in the first group.  */
  52
  53 #define TTYPE_TABLE                                                     \
  54   OP(EQ,                "=")                                            \
  55   OP(NOT,               "!")                                            \
  56   OP(GREATER,           ">")    /* compare */                           \
  57   OP(LESS,              "<")                                            \
  58   OP(PLUS,              "+")    /* math */                              \
  59   OP(MINUS,             "-")                                            \
  60   OP(MULT,              "*")                                            \
  61   OP(DIV,               "/")                                            \
  62   OP(MOD,               "%")                                            \
  63   OP(AND,               "&")    /* bit ops */                           \
  64   OP(OR,                "|")                                            \
  65   OP(XOR,               "^")                                            \
  66   OP(RSHIFT,            ">>")                                           \
  67   OP(LSHIFT,            "<<")                                           \
  68                                                                         \
  69   OP(COMPL,             "~")                                            \
  70   OP(AND_AND,           "&&")   /* logical */                           \
  71   OP(OR_OR,             "||")                                           \
  72   OP(QUERY,             "?")                                            \
  73   OP(COLON,             ":")                                            \
  74   OP(COMMA,             ",")    /* grouping */                          \
  75   OP(OPEN_PAREN,        "(")                                            \
  76   OP(CLOSE_PAREN,       ")")                                            \
  77   TK(EOF,               NONE)                                           \
  78   OP(EQ_EQ,             "==")   /* compare */                           \
  79   OP(NOT_EQ,            "!=")                                           \
  80   OP(GREATER_EQ,        ">=")                                           \
  81   OP(LESS_EQ,           "<=")                                           \
  82                                                                         \
  83   /* These two are unary + / - in preprocessor expressions.  */         \
  84   OP(PLUS_EQ,           "+=")   /* math */                              \
  85   OP(MINUS_EQ,          "-=")                                           \
  86                                                                         \
  87   OP(MULT_EQ,           "*=")                                           \
  88   OP(DIV_EQ,            "/=")                                           \
  89   OP(MOD_EQ,            "%=")                                           \
  90   OP(AND_EQ,            "&=")   /* bit ops */                           \
  91   OP(OR_EQ,             "|=")                                           \
  92   OP(XOR_EQ,            "^=")                                           \
  93   OP(RSHIFT_EQ,         ">>=")                                          \
  94   OP(LSHIFT_EQ,         "<<=")                                          \
  95   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */           \
  96   OP(HASH,              "#")    /* digraphs */                          \
  97   OP(PASTE,             "##")                                           \
  98   OP(OPEN_SQUARE,       "[")                                            \
  99   OP(CLOSE_SQUARE,      "]")                                            \
 100   OP(OPEN_BRACE,        "{")                                            \
 101   OP(CLOSE_BRACE,       "}")                                            \
 102   /* The remainder of the punctuation.  Order is not significant.  */   \
 103   OP(SEMICOLON,         ";")    /* structure */                         \
 104   OP(ELLIPSIS,          "...")                                          \
 105   OP(PLUS_PLUS,         "++")   /* increment */                         \
 106   OP(MINUS_MINUS,       "--")                                           \
 107   OP(DEREF,             "->")   /* accessors */                         \
 108   OP(DOT,               ".")                                            \
 109   OP(SCOPE,             "::")                                           \
 110   OP(DEREF_STAR,        "->*")                                          \
 111   OP(DOT_STAR,          ".*")                                           \
 112   OP(ATSIGN,            "@")  /* used in Objective-C */                 \
 113                                                                         \
 114   TK(NAME,              IDENT)   /* word */                             \
 115   TK(AT_NAME,           IDENT)   /* @word - Objective-C */              \
 116   TK(NUMBER,            LITERAL) /* 34_be+ta  */                        \
 117                                                                         \
 118   TK(CHAR,              LITERAL) /* 'char' */                           \
 119   TK(WCHAR,             LITERAL) /* L'char' */                          \
 120   TK(CHAR16,            LITERAL) /* u'char' */                          \
 121   TK(CHAR32,            LITERAL) /* U'char' */                          \
 122   TK(OTHER,             LITERAL) /* stray punctuation */                \
 123                                                                         \
 124   TK(STRING,            LITERAL) /* "string" */                         \
 125   TK(WSTRING,           LITERAL) /* L"string" */                        \
 126   TK(STRING16,          LITERAL) /* u"string" */                        \
 127   TK(STRING32,          LITERAL) /* U"string" */                        \
 128   TK(UTF8STRING,        LITERAL) /* u8"string" */                       \
 129   TK(OBJC_STRING,       LITERAL) /* @"string" - Objective-C */          \
 130   TK(HEADER_NAME,       LITERAL) /* <stdio.h> in #include */            \
 131                                                                         \
 132   TK(CHAR_USERDEF,      LITERAL) /* 'char'_suffix - C++-0x */           \
 133   TK(WCHAR_USERDEF,     LITERAL) /* L'char'_suffix - C++-0x */          \
 134   TK(CHAR16_USERDEF,    LITERAL) /* u'char'_suffix - C++-0x */          \
 135   TK(CHAR32_USERDEF,    LITERAL) /* U'char'_suffix - C++-0x */          \
 136   TK(STRING_USERDEF,    LITERAL) /* "string"_suffix - C++-0x */         \
 137   TK(WSTRING_USERDEF,   LITERAL) /* L"string"_suffix - C++-0x */        \
 138   TK(STRING16_USERDEF,  LITERAL) /* u"string"_suffix - C++-0x */        \
 139   TK(STRING32_USERDEF,  LITERAL) /* U"string"_suffix - C++-0x */        \
 140   TK(UTF8STRING_USERDEF,LITERAL) /* u8"string"_suffix - C++-0x */       \
 141                                                                         \
 142   TK(COMMENT,           LITERAL) /* Only if output comments.  */        \
 143                                  /* SPELL_LITERAL happens to DTRT.  */  \
 144   TK(MACRO_ARG,         NONE)    /* Macro argument.  */                 \
 145   TK(PRAGMA,            NONE)    /* Only for deferred pragmas.  */      \
 146   TK(PRAGMA_EOL,        NONE)    /* End-of-line for deferred pragmas.  */ \
 147   TK(PADDING,           NONE)    /* Whitespace for -E.  */
 148
 149 #define OP(e, s) CPP_ ## e,
 150 #define TK(e, s) CPP_ ## e,
 151 enum cpp_ttype
 152 {
 153   TTYPE_TABLE
 154   N_TTYPES,
 155
 156   /* A token type for keywords, as opposed to ordinary identifiers.  */
 157   CPP_KEYWORD,
 158
 159   /* Positions in the table.  */
 160   CPP_LAST_EQ        = CPP_LSHIFT,
 161   CPP_FIRST_DIGRAPH  = CPP_HASH,
 162   CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
 163   CPP_LAST_CPP_OP    = CPP_LESS_EQ
 164 };
 165 #undef OP
 166 #undef TK
 167
 168 /* C language kind, used when calling cpp_create_reader.  */
 169 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_GNUC11,
 170              CLK_STDC89, CLK_STDC94, CLK_STDC99, CLK_STDC11,
 171              CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX11, CLK_CXX11,
 172              CLK_GNUCXX14, CLK_CXX14, CLK_GNUCXX1Z, CLK_CXX1Z, CLK_ASM};
 173
 174 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
 175 struct GTY(()) cpp_string {
 176   unsigned int len;
 177   const unsigned char *text;
 178 };
 179
 180 /* Flags for the cpp_token structure.  */
 181 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 182 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 183 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 184 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 185 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
 186 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 187 #define BOL             (1 << 6) /* Token at beginning of line.  */
 188 #define PURE_ZERO       (1 << 7) /* Single 0 digit, used by the C++ frontend,
 189                                     set in c-lex.c.  */
 190 #define SP_DIGRAPH      (1 << 8) /* # or ## token was a digraph.  */
 191 #define SP_PREV_WHITE   (1 << 9) /* If whitespace before a ##
 192                                     operator, or before this token
 193                                     after a # operator.  */
 194
 195 /* Specify which field, if any, of the cpp_token union is used.  */
 196
 197 enum cpp_token_fld_kind {
 198   CPP_TOKEN_FLD_NODE,
 199   CPP_TOKEN_FLD_SOURCE,
 200   CPP_TOKEN_FLD_STR,
 201   CPP_TOKEN_FLD_ARG_NO,
 202   CPP_TOKEN_FLD_TOKEN_NO,
 203   CPP_TOKEN_FLD_PRAGMA,
 204   CPP_TOKEN_FLD_NONE
 205 };
 206
 207 /* A macro argument in the cpp_token union.  */
 208 struct GTY(()) cpp_macro_arg {
 209   /* Argument number.  */
 210   unsigned int arg_no;
 211   /* The original spelling of the macro argument token.  */
 212   cpp_hashnode *
 213     GTY ((nested_ptr (union tree_node,
 214                 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
 215                         "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
 216        spelling;
 217 };
 218
 219 /* An identifier in the cpp_token union.  */
 220 struct GTY(()) cpp_identifier {
 221   /* The canonical (UTF-8) spelling of the identifier.  */
 222   cpp_hashnode *
 223     GTY ((nested_ptr (union tree_node,
 224                 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
 225                         "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
 226        node;
 227   /* The original spelling of the identifier.  */
 228   cpp_hashnode *
 229     GTY ((nested_ptr (union tree_node,
 230                 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
 231                         "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
 232        spelling;
 233 };
 234
 235 /* A preprocessing token.  This has been carefully packed and should
 236    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 237 struct GTY(()) cpp_token {
 238   source_location src_loc;      /* Location of first char of token.  */
 239   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 240   unsigned short flags;         /* flags - see above */
 241
 242   union cpp_token_u
 243   {
 244     /* An identifier.  */
 245     struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node;
 246
 247     /* Inherit padding from this token.  */
 248     cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
 249
 250     /* A string, or number.  */
 251     struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
 252
 253     /* Argument no. (and original spelling) for a CPP_MACRO_ARG.  */
 254     struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg;
 255
 256     /* Original token no. for a CPP_PASTE (from a sequence of
 257        consecutive paste tokens in a macro expansion).  */
 258     unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no;
 259
 260     /* Caller-supplied identifier for a CPP_PRAGMA.  */
 261     unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
 262   } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
 263 };
 264
 265 /* Say which field is in use.  */
 266 extern enum cpp_token_fld_kind cpp_token_val_index (const cpp_token *tok);
 267
 268 /* A type wide enough to hold any multibyte source character.
 269    cpplib's character constant interpreter requires an unsigned type.
 270    Also, a typedef for the signed equivalent.
 271    The width of this type is capped at 32 bits; there do exist targets
 272    where wchar_t is 64 bits, but only in a non-default mode, and there
 273    would be no meaningful interpretation for a wchar_t value greater
 274    than 2^32 anyway -- the widest wide-character encoding around is
 275    ISO 10646, which stops at 2^31.  */
 276 #if CHAR_BIT * SIZEOF_INT >= 32
 277 # define CPPCHAR_SIGNED_T int
 278 #elif CHAR_BIT * SIZEOF_LONG >= 32
 279 # define CPPCHAR_SIGNED_T long
 280 #else
 281 # error "Cannot find a least-32-bit signed integer type"
 282 #endif
 283 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
 284 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
 285
 286 /* Style of header dependencies to generate.  */
 287 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
 288
 289 /* The possible normalization levels, from most restrictive to least.  */
 290 enum cpp_normalize_level {
 291   /* In NFKC.  */
 292   normalized_KC = 0,
 293   /* In NFC.  */
 294   normalized_C,
 295   /* In NFC, except for subsequences where being in NFC would make
 296      the identifier invalid.  */
 297   normalized_identifier_C,
 298   /* Not normalized at all.  */
 299   normalized_none
 300 };
 301
 302 /* This structure is nested inside struct cpp_reader, and
 303    carries all the options visible to the command line.  */
 304 struct cpp_options
 305 {
 306   /* Characters between tab stops.  */
 307   unsigned int tabstop;
 308
 309   /* The language we're preprocessing.  */
 310   enum c_lang lang;
 311
 312   /* Nonzero means use extra default include directories for C++.  */
 313   unsigned char cplusplus;
 314
 315   /* Nonzero means handle cplusplus style comments.  */
 316   unsigned char cplusplus_comments;
 317
 318   /* Nonzero means define __OBJC__, treat @ as a special token, use
 319      the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
 320      "#import".  */
 321   unsigned char objc;
 322
 323   /* Nonzero means don't copy comments into the output file.  */
 324   unsigned char discard_comments;
 325
 326   /* Nonzero means don't copy comments into the output file during
 327      macro expansion.  */
 328   unsigned char discard_comments_in_macro_exp;
 329
 330   /* Nonzero means process the ISO trigraph sequences.  */
 331   unsigned char trigraphs;
 332
 333   /* Nonzero means process the ISO digraph sequences.  */
 334   unsigned char digraphs;
 335
 336   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 337   unsigned char extended_numbers;
 338
 339   /* Nonzero means process u/U prefix literals (UTF-16/32).  */
 340   unsigned char uliterals;
 341
 342   /* Nonzero means process r/R raw strings.  If this is set, uliterals
 343      must be set as well.  */
 344   unsigned char rliterals;
 345
 346   /* Nonzero means print names of header files (-H).  */
 347   unsigned char print_include_names;
 348
 349   /* Nonzero means complain about deprecated features.  */
 350   unsigned char cpp_warn_deprecated;
 351
 352   /* Nonzero means warn if slash-star appears in a comment.  */
 353   unsigned char warn_comments;
 354
 355   /* Nonzero means to warn about __DATA__, __TIME__ and __TIMESTAMP__ usage.   */
 356   unsigned char warn_date_time;
 357
 358   /* Nonzero means warn if a user-supplied include directory does not
 359      exist.  */
 360   unsigned char warn_missing_include_dirs;
 361
 362   /* Nonzero means warn if there are any trigraphs.  */
 363   unsigned char warn_trigraphs;
 364
 365   /* Nonzero means warn about multicharacter charconsts.  */
 366   unsigned char warn_multichar;
 367
 368   /* Nonzero means warn about various incompatibilities with
 369      traditional C.  */
 370   unsigned char cpp_warn_traditional;
 371
 372   /* Nonzero means warn about long long numeric constants.  */
 373   unsigned char cpp_warn_long_long;
 374
 375   /* Nonzero means warn about text after an #endif (or #else).  */
 376   unsigned char warn_endif_labels;
 377
 378   /* Nonzero means warn about implicit sign changes owing to integer
 379      promotions.  */
 380   unsigned char warn_num_sign_change;
 381
 382   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
 383      Presumably the usage is protected by the appropriate #ifdef.  */
 384   unsigned char warn_variadic_macros;
 385
 386   /* Nonzero means warn about builtin macros that are redefined or
 387      explicitly undefined.  */
 388   unsigned char warn_builtin_macro_redefined;
 389
 390   /* Nonzero means we should look for header.gcc files that remap file
 391      names.  */
 392   unsigned char remap;
 393
 394   /* Zero means dollar signs are punctuation.  */
 395   unsigned char dollars_in_ident;
 396
 397   /* Nonzero means UCNs are accepted in identifiers.  */
 398   unsigned char extended_identifiers;
 399
 400   /* True if we should warn about dollars in identifiers or numbers
 401      for this translation unit.  */
 402   unsigned char warn_dollars;
 403
 404   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 405   unsigned char warn_undef;
 406
 407   /* Nonzero means warn of unused macros from the main file.  */
 408   unsigned char warn_unused_macros;
 409
 410   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 411   unsigned char c99;
 412
 413   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 414   unsigned char std;
 415
 416   /* Nonzero means give all the error messages the ANSI standard requires.  */
 417   unsigned char cpp_pedantic;
 418
 419   /* Nonzero means we're looking at already preprocessed code, so don't
 420      bother trying to do macro expansion and whatnot.  */
 421   unsigned char preprocessed;
 422
 423   /* Nonzero means we are going to emit debugging logs during
 424      preprocessing.  */
 425   unsigned char debug;
 426
 427   /* Nonzero means we are tracking locations of tokens involved in
 428      macro expansion. 1 Means we track the location in degraded mode
 429      where we do not track locations of tokens resulting from the
 430      expansion of arguments of function-like macro.  2 Means we do
 431      track all macro expansions. This last option is the one that
 432      consumes the highest amount of memory.  */
 433   unsigned char track_macro_expansion;
 434
 435   /* Nonzero means handle C++ alternate operator names.  */
 436   unsigned char operator_names;
 437
 438   /* Nonzero means warn about use of C++ alternate operator names.  */
 439   unsigned char warn_cxx_operator_names;
 440
 441   /* True for traditional preprocessing.  */
 442   unsigned char traditional;
 443
 444   /* Nonzero for C++ 2011 Standard user-defined literals.  */
 445   unsigned char user_literals;
 446
 447   /* Nonzero means warn when a string or character literal is followed by a
 448      ud-suffix which does not beging with an underscore.  */
 449   unsigned char warn_literal_suffix;
 450
 451   /* Nonzero means interpret imaginary, fixed-point, or other gnu extension
 452      literal number suffixes as user-defined literal number suffixes.  */
 453   unsigned char ext_numeric_literals;
 454
 455   /* Nonzero means extended identifiers allow the characters specified
 456      in C11 and C++11.  */
 457   unsigned char c11_identifiers;
 458
 459   /* Nonzero for C++ 2014 Standard binary constants.  */
 460   unsigned char binary_constants;
 461
 462   /* Nonzero for C++ 2014 Standard digit separators.  */
 463   unsigned char digit_separators;
 464
 465   /* Holds the name of the target (execution) character set.  */
 466   const char *narrow_charset;
 467
 468   /* Holds the name of the target wide character set.  */
 469   const char *wide_charset;
 470
 471   /* Holds the name of the input character set.  */
 472   const char *input_charset;
 473
 474   /* The minimum permitted level of normalization before a warning
 475      is generated.  See enum cpp_normalize_level.  */
 476   int warn_normalize;
 477
 478   /* True to warn about precompiled header files we couldn't use.  */
 479   bool warn_invalid_pch;
 480
 481   /* True if dependencies should be restored from a precompiled header.  */
 482   bool restore_pch_deps;
 483
 484   /* True if warn about differences between C90 and C99.  */
 485   signed char cpp_warn_c90_c99_compat;
 486
 487   /* True if warn about differences between C++98 and C++11.  */
 488   bool cpp_warn_cxx11_compat;
 489
 490   /* Dependency generation.  */
 491   struct
 492   {
 493     /* Style of header dependencies to generate.  */
 494     enum cpp_deps_style style;
 495
 496     /* Assume missing files are generated files.  */
 497     bool missing_files;
 498
 499     /* Generate phony targets for each dependency apart from the first
 500        one.  */
 501     bool phony_targets;
 502
 503     /* If true, no dependency is generated on the main file.  */
 504     bool ignore_main_file;
 505
 506     /* If true, intend to use the preprocessor output (e.g., for compilation)
 507        in addition to the dependency info.  */
 508     bool need_preprocessor_output;
 509   } deps;
 510
 511   /* Target-specific features set by the front end or client.  */
 512
 513   /* Precision for target CPP arithmetic, target characters, target
 514      ints and target wide characters, respectively.  */
 515   size_t precision, char_precision, int_precision, wchar_precision;
 516
 517   /* True means chars (wide chars) are unsigned.  */
 518   bool unsigned_char, unsigned_wchar;
 519
 520   /* True if the most significant byte in a word has the lowest
 521      address in memory.  */
 522   bool bytes_big_endian;
 523
 524   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 525   unsigned char stdc_0_in_system_headers;
 526
 527   /* True disables tokenization outside of preprocessing directives. */
 528   bool directives_only;
 529
 530   /* True enables canonicalization of system header file paths. */
 531   bool canonical_system_headers;
 532 };
 533
 534 /* Callback for header lookup for HEADER, which is the name of a
 535    source file.  It is used as a method of last resort to find headers
 536    that are not otherwise found during the normal include processing.
 537    The return value is the malloced name of a header to try and open,
 538    if any, or NULL otherwise.  This callback is called only if the
 539    header is otherwise unfound.  */
 540 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
 541
 542 /* Call backs to cpplib client.  */
 543 struct cpp_callbacks
 544 {
 545   /* Called when a new line of preprocessed output is started.  */
 546   void (*line_change) (cpp_reader *, const cpp_token *, int);
 547
 548   /* Called when switching to/from a new file.
 549      The line_map is for the new file.  It is NULL if there is no new file.
 550      (In C this happens when done with <built-in>+<command line> and also
 551      when done with a main file.)  This can be used for resource cleanup.  */
 552   void (*file_change) (cpp_reader *, const struct line_map *);
 553
 554   void (*dir_change) (cpp_reader *, const char *);
 555   void (*include) (cpp_reader *, source_location, const unsigned char *,
 556                    const char *, int, const cpp_token **);
 557   void (*define) (cpp_reader *, source_location, cpp_hashnode *);
 558   void (*undef) (cpp_reader *, source_location, cpp_hashnode *);
 559   void (*ident) (cpp_reader *, source_location, const cpp_string *);
 560   void (*def_pragma) (cpp_reader *, source_location);
 561   int (*valid_pch) (cpp_reader *, const char *, int);
 562   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 563   missing_header_cb missing_header;
 564
 565   /* Context-sensitive macro support.  Returns macro (if any) that should
 566      be expanded.  */
 567   cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
 568
 569   /* Called to emit a diagnostic.  This callback receives the
 570      translated message.  */
 571   bool (*error) (cpp_reader *, int, int, source_location, unsigned int,
 572                  const char *, va_list *)
 573        ATTRIBUTE_FPTR_PRINTF(6,0);
 574
 575   /* Callbacks for when a macro is expanded, or tested (whether
 576      defined or not at the time) in #ifdef, #ifndef or "defined".  */
 577   void (*used_define) (cpp_reader *, source_location, cpp_hashnode *);
 578   void (*used_undef) (cpp_reader *, source_location, cpp_hashnode *);
 579   /* Called before #define and #undef or other macro definition
 580      changes are processed.  */
 581   void (*before_define) (cpp_reader *);
 582   /* Called whenever a macro is expanded or tested.
 583      Second argument is the location of the start of the current expansion.  */
 584   void (*used) (cpp_reader *, source_location, cpp_hashnode *);
 585
 586   /* Callback to identify whether an attribute exists.  */
 587   int (*has_attribute) (cpp_reader *);
 588
 589   /* Callback that can change a user builtin into normal macro.  */
 590   bool (*user_builtin_macro) (cpp_reader *, cpp_hashnode *);
 591 };
 592
 593 #ifdef VMS
 594 #define INO_T_CPP ino_t ino[3]
 595 #else
 596 #define INO_T_CPP ino_t ino
 597 #endif
 598
 599 /* Chain of directories to look for include files in.  */
 600 struct cpp_dir
 601 {
 602   /* NULL-terminated singly-linked list.  */
 603   struct cpp_dir *next;
 604
 605   /* NAME of the directory, NUL-terminated.  */
 606   char *name;
 607   unsigned int len;
 608
 609   /* One if a system header, two if a system header that has extern
 610      "C" guards for C++.  */
 611   unsigned char sysp;
 612
 613   /* Is this a user-supplied directory? */
 614   bool user_supplied_p;
 615
 616   /* The canonicalized NAME as determined by lrealpath.  This field
 617      is only used by hosts that lack reliable inode numbers.  */
 618   char *canonical_name;
 619
 620   /* Mapping of file names for this directory for MS-DOS and related
 621      platforms.  A NULL-terminated array of (from, to) pairs.  */
 622   const char **name_map;
 623
 624   /* Routine to construct pathname, given the search path name and the
 625      HEADER we are trying to find, return a constructed pathname to
 626      try and open.  If this is NULL, the constructed pathname is as
 627      constructed by append_file_to_dir.  */
 628   char *(*construct) (const char *header, cpp_dir *dir);
 629
 630   /* The C front end uses these to recognize duplicated
 631      directories in the search path.  */
 632   INO_T_CPP;
 633   dev_t dev;
 634 };
 635
 636 /* The structure of a node in the hash table.  The hash table has
 637    entries for all identifiers: either macros defined by #define
 638    commands (type NT_MACRO), assertions created with #assert
 639    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 640    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 641    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 642    identifier that behaves like an operator such as "xor".
 643    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 644    diagnostic may be required for this node.  Currently this only
 645    applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat
 646    warnings about NODE_OPERATOR.  */
 647
 648 /* Hash node flags.  */
 649 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 650 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 651 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 652 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 653 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 654 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 655 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 656 #define NODE_USED       (1 << 7)        /* Dumped with -dU.  */
 657 #define NODE_CONDITIONAL (1 << 8)       /* Conditional macro */
 658 #define NODE_WARN_OPERATOR (1 << 9)     /* Warn about C++ named operator.  */
 659
 660 /* Different flavors of hash node.  */
 661 enum node_type
 662 {
 663   NT_VOID = 0,     /* No definition yet.  */
 664   NT_MACRO,        /* A macro of some form.  */
 665   NT_ASSERTION     /* Predicate for #assert.  */
 666 };
 667
 668 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 669    handle it with the builtin code for efficiency reasons.  */
 670 enum cpp_builtin_type
 671 {
 672   BT_SPECLINE = 0,              /* `__LINE__' */
 673   BT_DATE,                      /* `__DATE__' */
 674   BT_FILE,                      /* `__FILE__' */
 675   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 676   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 677   BT_TIME,                      /* `__TIME__' */
 678   BT_STDC,                      /* `__STDC__' */
 679   BT_PRAGMA,                    /* `_Pragma' operator */
 680   BT_TIMESTAMP,                 /* `__TIMESTAMP__' */
 681   BT_COUNTER,                   /* `__COUNTER__' */
 682   BT_HAS_ATTRIBUTE,             /* `__has_attribute__(x)' */
 683   BT_FIRST_USER,                /* User defined builtin macros.  */
 684   BT_LAST_USER = BT_FIRST_USER + 31
 685 };
 686
 687 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 688 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 689 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 690 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 691
 692 /* Specify which field, if any, of the union is used.  */
 693
 694 enum {
 695   NTV_MACRO,
 696   NTV_ANSWER,
 697   NTV_BUILTIN,
 698   NTV_ARGUMENT,
 699   NTV_NONE
 700 };
 701
 702 #define CPP_HASHNODE_VALUE_IDX(HNODE)                           \
 703   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT                \
 704    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN)     \
 705                                ? NTV_BUILTIN : NTV_MACRO)       \
 706    : HNODE.type == NT_ASSERTION ? NTV_ANSWER                    \
 707    : NTV_NONE)
 708
 709 /* The common part of an identifier node shared amongst all 3 C front
 710    ends.  Also used to store CPP identifiers, which are a superset of
 711    identifiers in the grammatical sense.  */
 712
 713 union GTY(()) _cpp_hashnode_value {
 714   /* If a macro.  */
 715   cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
 716   /* Answers to an assertion.  */
 717   struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
 718   /* Code for a builtin macro.  */
 719   enum cpp_builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
 720   /* Macro argument index.  */
 721   unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
 722 };
 723
 724 struct GTY(()) cpp_hashnode {
 725   struct ht_identifier ident;
 726   unsigned int is_directive : 1;
 727   unsigned int directive_index : 7;     /* If is_directive,
 728                                            then index into directive table.
 729                                            Otherwise, a NODE_OPERATOR.  */
 730   unsigned char rid_code;               /* Rid code - for front ends.  */
 731   ENUM_BITFIELD(node_type) type : 6;    /* CPP node type.  */
 732   unsigned int flags : 10;              /* CPP flags.  */
 733
 734   union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
 735 };
 736
 737 /* Call this first to get a handle to pass to other functions.
 738
 739    If you want cpplib to manage its own hashtable, pass in a NULL
 740    pointer.  Otherwise you should pass in an initialized hash table
 741    that cpplib will share; this technique is used by the C front
 742    ends.  */
 743 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
 744                                       struct line_maps *);
 745
 746 /* Reset the cpp_reader's line_map.  This is only used after reading a
 747    PCH file.  */
 748 extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
 749
 750 /* Call this to change the selected language standard (e.g. because of
 751    command line options).  */
 752 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 753
 754 /* Set the include paths.  */
 755 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 756
 757 /* Call these to get pointers to the options, callback, and deps
 758    structures for a given reader.  These pointers are good until you
 759    call cpp_finish on that reader.  You can either edit the callbacks
 760    through the pointer returned from cpp_get_callbacks, or set them
 761    with cpp_set_callbacks.  */
 762 extern cpp_options *cpp_get_options (cpp_reader *);
 763 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 764 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 765 extern struct deps *cpp_get_deps (cpp_reader *);
 766
 767 /* This function reads the file, but does not start preprocessing.  It
 768    returns the name of the original file; this is the same as the
 769    input file, except for preprocessed input.  This will generate at
 770    least one file change callback, and possibly a line change callback
 771    too.  If there was an error opening the file, it returns NULL.  */
 772 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 773
 774 /* Set up built-ins with special behavior.  Use cpp_init_builtins()
 775    instead unless your know what you are doing.  */
 776 extern void cpp_init_special_builtins (cpp_reader *);
 777
 778 /* Set up built-ins like __FILE__.  */
 779 extern void cpp_init_builtins (cpp_reader *, int);
 780
 781 /* This is called after options have been parsed, and partially
 782    processed.  */
 783 extern void cpp_post_options (cpp_reader *);
 784
 785 /* Set up translation to the target character set.  */
 786 extern void cpp_init_iconv (cpp_reader *);
 787
 788 /* Call this to finish preprocessing.  If you requested dependency
 789    generation, pass an open stream to write the information to,
 790    otherwise NULL.  It is your responsibility to close the stream.  */
 791 extern void cpp_finish (cpp_reader *, FILE *deps_stream);
 792
 793 /* Call this to release the handle at the end of preprocessing.  Any
 794    use of the handle after this function returns is invalid.  */
 795 extern void cpp_destroy (cpp_reader *);
 796
 797 extern unsigned int cpp_token_len (const cpp_token *);
 798 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 799 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 800                                        unsigned char *, bool);
 801 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 802                                  void (*) (cpp_reader *), bool);
 803 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
 804                                           const char *, unsigned, bool, bool);
 805 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 806                             const cpp_token *);
 807 extern const cpp_token *cpp_get_token (cpp_reader *);
 808 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
 809                                                      source_location *);
 810 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 811                                                   cpp_hashnode *);
 812 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 813 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
 814
 815 /* Evaluate a CPP_*CHAR* token.  */
 816 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 817                                           unsigned int *, int *);
 818 /* Evaluate a vector of CPP_*STRING* tokens.  */
 819 extern bool cpp_interpret_string (cpp_reader *,
 820                                   const cpp_string *, size_t,
 821                                   cpp_string *, enum cpp_ttype);
 822 extern bool cpp_interpret_string_notranslate (cpp_reader *,
 823                                               const cpp_string *, size_t,
 824                                               cpp_string *, enum cpp_ttype);
 825
 826 /* Convert a host character constant to the execution character set.  */
 827 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
 828
 829 /* Used to register macros and assertions, perhaps from the command line.
 830    The text is the same as the command line argument.  */
 831 extern void cpp_define (cpp_reader *, const char *);
 832 extern void cpp_define_formatted (cpp_reader *pfile,
 833                                   const char *fmt, ...) ATTRIBUTE_PRINTF_2;
 834 extern void cpp_assert (cpp_reader *, const char *);
 835 extern void cpp_undef (cpp_reader *, const char *);
 836 extern void cpp_unassert (cpp_reader *, const char *);
 837
 838 /* Undefine all macros and assertions.  */
 839 extern void cpp_undef_all (cpp_reader *);
 840
 841 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 842                                     size_t, int);
 843 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 844
 845 /* A preprocessing number.  Code assumes that any unused high bits of
 846    the double integer are set to zero.  */
 847
 848 /* This type has to be equal to unsigned HOST_WIDE_INT, see
 849    gcc/c-family/c-lex.c.  */
 850 typedef uint64_t cpp_num_part;
 851 typedef struct cpp_num cpp_num;
 852 struct cpp_num
 853 {
 854   cpp_num_part high;
 855   cpp_num_part low;
 856   bool unsignedp;  /* True if value should be treated as unsigned.  */
 857   bool overflow;   /* True if the most recent calculation overflowed.  */
 858 };
 859
 860 /* cpplib provides two interfaces for interpretation of preprocessing
 861    numbers.
 862
 863    cpp_classify_number categorizes numeric constants according to
 864    their field (integer, floating point, or invalid), radix (decimal,
 865    octal, hexadecimal), and type suffixes.  */
 866
 867 #define CPP_N_CATEGORY  0x000F
 868 #define CPP_N_INVALID   0x0000
 869 #define CPP_N_INTEGER   0x0001
 870 #define CPP_N_FLOATING  0x0002
 871
 872 #define CPP_N_WIDTH     0x00F0
 873 #define CPP_N_SMALL     0x0010  /* int, float, shrot _Fract/Accum  */
 874 #define CPP_N_MEDIUM    0x0020  /* long, double, long _Fract/_Accum.  */
 875 #define CPP_N_LARGE     0x0040  /* long long, long double,
 876                                    long long _Fract/Accum.  */
 877
 878 #define CPP_N_WIDTH_MD  0xF0000 /* machine defined.  */
 879 #define CPP_N_MD_W      0x10000
 880 #define CPP_N_MD_Q      0x20000
 881
 882 #define CPP_N_RADIX     0x0F00
 883 #define CPP_N_DECIMAL   0x0100
 884 #define CPP_N_HEX       0x0200
 885 #define CPP_N_OCTAL     0x0400
 886 #define CPP_N_BINARY    0x0800
 887
 888 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 889 #define CPP_N_IMAGINARY 0x2000
 890 #define CPP_N_DFLOAT    0x4000
 891 #define CPP_N_DEFAULT   0x8000
 892
 893 #define CPP_N_FRACT     0x100000 /* Fract types.  */
 894 #define CPP_N_ACCUM     0x200000 /* Accum types.  */
 895
 896 #define CPP_N_USERDEF   0x1000000 /* C++0x user-defined literal.  */
 897
 898 /* Classify a CPP_NUMBER token.  The return value is a combination of
 899    the flags from the above sets.  */
 900 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *,
 901                                      const char **, source_location);
 902
 903 /* Return the classification flags for a float suffix.  */
 904 extern unsigned int cpp_interpret_float_suffix (cpp_reader *, const char *,
 905                                                 size_t);
 906
 907 /* Return the classification flags for an int suffix.  */
 908 extern unsigned int cpp_interpret_int_suffix (cpp_reader *, const char *,
 909                                               size_t);
 910
 911 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 912 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 913                                       unsigned int);
 914
 915 /* Sign extend a number, with PRECISION significant bits and all
 916    others assumed clear, to fill out a cpp_num structure.  */
 917 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 918
 919 /* Diagnostic levels.  To get a diagnostic without associating a
 920    position in the translation unit with it, use cpp_error_with_line
 921    with a line number of zero.  */
 922
 923 enum {
 924   /* Warning, an error with -Werror.  */
 925   CPP_DL_WARNING = 0,
 926   /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
 927   CPP_DL_WARNING_SYSHDR,
 928   /* Warning, an error with -pedantic-errors or -Werror.  */
 929   CPP_DL_PEDWARN,
 930   /* An error.  */
 931   CPP_DL_ERROR,
 932   /* An internal consistency check failed.  Prints "internal error: ",
 933      otherwise the same as CPP_DL_ERROR.  */
 934   CPP_DL_ICE,
 935   /* An informative note following a warning.  */
 936   CPP_DL_NOTE,
 937   /* A fatal error.  */
 938   CPP_DL_FATAL
 939 };
 940
 941 /* Warning reason codes. Use a reason code of zero for unclassified warnings
 942    and errors that are not warnings.  */
 943 enum {
 944   CPP_W_NONE = 0,
 945   CPP_W_DEPRECATED,
 946   CPP_W_COMMENTS,
 947   CPP_W_MISSING_INCLUDE_DIRS,
 948   CPP_W_TRIGRAPHS,
 949   CPP_W_MULTICHAR,
 950   CPP_W_TRADITIONAL,
 951   CPP_W_LONG_LONG,
 952   CPP_W_ENDIF_LABELS,
 953   CPP_W_NUM_SIGN_CHANGE,
 954   CPP_W_VARIADIC_MACROS,
 955   CPP_W_BUILTIN_MACRO_REDEFINED,
 956   CPP_W_DOLLARS,
 957   CPP_W_UNDEF,
 958   CPP_W_UNUSED_MACROS,
 959   CPP_W_CXX_OPERATOR_NAMES,
 960   CPP_W_NORMALIZE,
 961   CPP_W_INVALID_PCH,
 962   CPP_W_WARNING_DIRECTIVE,
 963   CPP_W_LITERAL_SUFFIX,
 964   CPP_W_DATE_TIME,
 965   CPP_W_PEDANTIC,
 966   CPP_W_C90_C99_COMPAT,
 967   CPP_W_CXX11_COMPAT
 968 };
 969
 970 /* Output a diagnostic of some kind.  */
 971 extern bool cpp_error (cpp_reader *, int, const char *msgid, ...)
 972   ATTRIBUTE_PRINTF_3;
 973 extern bool cpp_warning (cpp_reader *, int, const char *msgid, ...)
 974   ATTRIBUTE_PRINTF_3;
 975 extern bool cpp_pedwarning (cpp_reader *, int, const char *msgid, ...)
 976   ATTRIBUTE_PRINTF_3;
 977 extern bool cpp_warning_syshdr (cpp_reader *, int, const char *msgid, ...)
 978   ATTRIBUTE_PRINTF_3;
 979
 980 /* Output a diagnostic with "MSGID: " preceding the
 981    error string of errno.  No location is printed.  */
 982 extern bool cpp_errno (cpp_reader *, int, const char *msgid);
 983
 984 /* Same as cpp_error, except additionally specifies a position as a
 985    (translation unit) physical line and physical column.  If the line is
 986    zero, then no location is printed.  */
 987 extern bool cpp_error_with_line (cpp_reader *, int, source_location,
 988                                  unsigned, const char *msgid, ...)
 989   ATTRIBUTE_PRINTF_5;
 990 extern bool cpp_warning_with_line (cpp_reader *, int, source_location,
 991                                    unsigned, const char *msgid, ...)
 992   ATTRIBUTE_PRINTF_5;
 993 extern bool cpp_pedwarning_with_line (cpp_reader *, int, source_location,
 994                                       unsigned, const char *msgid, ...)
 995   ATTRIBUTE_PRINTF_5;
 996 extern bool cpp_warning_with_line_syshdr (cpp_reader *, int, source_location,
 997                                           unsigned, const char *msgid, ...)
 998   ATTRIBUTE_PRINTF_5;
 999
1000 /* In lex.c */
1001 extern int cpp_ideq (const cpp_token *, const char *);
1002 extern void cpp_output_line (cpp_reader *, FILE *);
1003 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
1004                                                  const unsigned char *);
1005 extern void cpp_output_token (const cpp_token *, FILE *);
1006 extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
1007 /* Returns the value of an escape sequence, truncated to the correct
1008    target precision.  PSTR points to the input pointer, which is just
1009    after the backslash.  LIMIT is how much text we have.  WIDE is true
1010    if the escape sequence is part of a wide character constant or
1011    string literal.  Handles all relevant diagnostics.  */
1012 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
1013                                    const unsigned char *limit, int wide);
1014
1015 /* Structure used to hold a comment block at a given location in the
1016    source code.  */
1017
1018 typedef struct
1019 {
1020   /* Text of the comment including the terminators.  */
1021   char *comment;
1022
1023   /* source location for the given comment.  */
1024   source_location sloc;
1025 } cpp_comment;
1026
1027 /* Structure holding all comments for a given cpp_reader.  */
1028
1029 typedef struct
1030 {
1031   /* table of comment entries.  */
1032   cpp_comment *entries;
1033
1034   /* number of actual entries entered in the table.  */
1035   int count;
1036
1037   /* number of entries allocated currently.  */
1038   int allocated;
1039 } cpp_comment_table;
1040
1041 /* Returns the table of comments encountered by the preprocessor. This
1042    table is only populated when pfile->state.save_comments is true. */
1043 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
1044
1045 /* In hash.c */
1046
1047 /* Lookup an identifier in the hashtable.  Puts the identifier in the
1048    table if it is not already there.  */
1049 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
1050                                  unsigned int);
1051
1052 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
1053 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
1054
1055 /* In macro.c */
1056 extern void cpp_scan_nooutput (cpp_reader *);
1057 extern int  cpp_sys_macro_p (cpp_reader *);
1058 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
1059                                         unsigned int);
1060
1061 /* In files.c */
1062 extern bool cpp_included (cpp_reader *, const char *);
1063 extern bool cpp_included_before (cpp_reader *, const char *, source_location);
1064 extern void cpp_make_system_header (cpp_reader *, int, int);
1065 extern bool cpp_push_include (cpp_reader *, const char *);
1066 extern bool cpp_push_default_include (cpp_reader *, const char *);
1067 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
1068 extern const char *cpp_get_path (struct _cpp_file *);
1069 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
1070 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
1071 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
1072 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
1073 extern void cpp_clear_file_cache (cpp_reader *);
1074
1075 /* In pch.c */
1076 struct save_macro_data;
1077 extern int cpp_save_state (cpp_reader *, FILE *);
1078 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
1079 extern int cpp_write_pch_state (cpp_reader *, FILE *);
1080 extern int cpp_valid_state (cpp_reader *, const char *, int);
1081 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
1082 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
1083                            struct save_macro_data *);
1084
1085 /* In lex.c */
1086 extern void cpp_force_token_locations (cpp_reader *, source_location *);
1087 extern void cpp_stop_forcing_token_locations (cpp_reader *);
1088
1089 /* In expr.c */
1090 extern enum cpp_ttype cpp_userdef_string_remove_type
1091   (enum cpp_ttype type);
1092 extern enum cpp_ttype cpp_userdef_string_add_type
1093   (enum cpp_ttype type);
1094 extern enum cpp_ttype cpp_userdef_char_remove_type
1095   (enum cpp_ttype type);
1096 extern enum cpp_ttype cpp_userdef_char_add_type
1097   (enum cpp_ttype type);
1098 extern bool cpp_userdef_string_p
1099   (enum cpp_ttype type);
1100 extern bool cpp_userdef_char_p
1101   (enum cpp_ttype type);
1102 extern const char * cpp_get_userdef_suffix
1103   (const cpp_token *);
1104
1105 #endif /* ! LIBCPP_CPPLIB_H */