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