contrib/gcc-4.4/libcpp/include/cpplib.h

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