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 #define SP_DIGRAPH      (1 << 8) /* # or ## token was a digraph.  */
 182 #define SP_PREV_WHITE   (1 << 9) /* If whitespace before a ##
 183                                     operator, or before this token
 184                                     after a # operator.  */
 185
 186 /* Specify which field, if any, of the cpp_token union is used.  */
 187
 188 enum cpp_token_fld_kind {
 189   CPP_TOKEN_FLD_NODE,
 190   CPP_TOKEN_FLD_SOURCE,
 191   CPP_TOKEN_FLD_STR,
 192   CPP_TOKEN_FLD_ARG_NO,
 193   CPP_TOKEN_FLD_PRAGMA,
 194   CPP_TOKEN_FLD_NONE
 195 };
 196
 197 /* A preprocessing token.  This has been carefully packed and should
 198    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 199 struct cpp_token GTY(())
 200 {
 201   source_location src_loc;      /* Location of first char of token.  */
 202   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 203   unsigned short flags;         /* flags - see above */
 204
 205   union cpp_token_u
 206   {
 207     /* An identifier.  */
 208     cpp_hashnode *
 209       GTY ((nested_ptr (union tree_node,
 210                 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
 211                         "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"),
 212             tag ("CPP_TOKEN_FLD_NODE")))
 213          node;
 214
 215     /* Inherit padding from this token.  */
 216     cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
 217
 218     /* A string, or number.  */
 219     struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
 220
 221     /* Argument no. for a CPP_MACRO_ARG.  */
 222     unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no;
 223
 224     /* Caller-supplied identifier for a CPP_PRAGMA.  */
 225     unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
 226   } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
 227 };
 228
 229 /* Say which field is in use.  */
 230 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
 231
 232 /* A type wide enough to hold any multibyte source character.
 233    cpplib's character constant interpreter requires an unsigned type.
 234    Also, a typedef for the signed equivalent.
 235    The width of this type is capped at 32 bits; there do exist targets
 236    where wchar_t is 64 bits, but only in a non-default mode, and there
 237    would be no meaningful interpretation for a wchar_t value greater
 238    than 2^32 anyway -- the widest wide-character encoding around is
 239    ISO 10646, which stops at 2^31.  */
 240 #if CHAR_BIT * SIZEOF_INT >= 32
 241 # define CPPCHAR_SIGNED_T int
 242 #elif CHAR_BIT * SIZEOF_LONG >= 32
 243 # define CPPCHAR_SIGNED_T long
 244 #else
 245 # error "Cannot find a least-32-bit signed integer type"
 246 #endif
 247 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
 248 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
 249
 250 /* Style of header dependencies to generate.  */
 251 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
 252
 253 /* The possible normalization levels, from most restrictive to least.  */
 254 enum cpp_normalize_level {
 255   /* In NFKC.  */
 256   normalized_KC = 0,
 257   /* In NFC.  */
 258   normalized_C,
 259   /* In NFC, except for subsequences where being in NFC would make
 260      the identifier invalid.  */
 261   normalized_identifier_C,
 262   /* Not normalized at all.  */
 263   normalized_none
 264 };
 265
 266 /* This structure is nested inside struct cpp_reader, and
 267    carries all the options visible to the command line.  */
 268 struct cpp_options
 269 {
 270   /* Characters between tab stops.  */
 271   unsigned int tabstop;
 272
 273   /* The language we're preprocessing.  */
 274   enum c_lang lang;
 275
 276   /* Nonzero means use extra default include directories for C++.  */
 277   unsigned char cplusplus;
 278
 279   /* Nonzero means handle cplusplus style comments.  */
 280   unsigned char cplusplus_comments;
 281
 282   /* Nonzero means define __OBJC__, treat @ as a special token, use
 283      the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
 284      "#import".  */
 285   unsigned char objc;
 286
 287   /* Nonzero means don't copy comments into the output file.  */
 288   unsigned char discard_comments;
 289
 290   /* Nonzero means don't copy comments into the output file during
 291      macro expansion.  */
 292   unsigned char discard_comments_in_macro_exp;
 293
 294   /* Nonzero means process the ISO trigraph sequences.  */
 295   unsigned char trigraphs;
 296
 297   /* Nonzero means process the ISO digraph sequences.  */
 298   unsigned char digraphs;
 299
 300   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 301   unsigned char extended_numbers;
 302
 303   /* Nonzero means process u/U prefix literals (UTF-16/32).  */
 304   unsigned char uliterals;
 305
 306   /* Nonzero means print names of header files (-H).  */
 307   unsigned char print_include_names;
 308
 309   /* Nonzero means complain about deprecated features.  */
 310   unsigned char warn_deprecated;
 311
 312   /* Nonzero means warn if slash-star appears in a comment.  */
 313   unsigned char warn_comments;
 314
 315   /* Nonzero means warn if a user-supplied include directory does not
 316      exist.  */
 317   unsigned char warn_missing_include_dirs;
 318
 319   /* Nonzero means warn if there are any trigraphs.  */
 320   unsigned char warn_trigraphs;
 321
 322   /* Nonzero means warn about multicharacter charconsts.  */
 323   unsigned char warn_multichar;
 324
 325   /* Nonzero means warn about various incompatibilities with
 326      traditional C.  */
 327   unsigned char warn_traditional;
 328
 329   /* Nonzero means warn about long long numeric constants.  */
 330   unsigned char warn_long_long;
 331
 332   /* Nonzero means warn about text after an #endif (or #else).  */
 333   unsigned char warn_endif_labels;
 334
 335   /* Nonzero means warn about implicit sign changes owing to integer
 336      promotions.  */
 337   unsigned char warn_num_sign_change;
 338
 339   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
 340      Presumably the usage is protected by the appropriate #ifdef.  */
 341   unsigned char warn_variadic_macros;
 342
 343   /* Nonzero means warn about builtin macros that are redefined or
 344      explicitly undefined.  */
 345   unsigned char warn_builtin_macro_redefined;
 346
 347   /* Nonzero means we should look for header.gcc files that remap file
 348      names.  */
 349   unsigned char remap;
 350
 351   /* Zero means dollar signs are punctuation.  */
 352   unsigned char dollars_in_ident;
 353
 354   /* Nonzero means UCNs are accepted in identifiers.  */
 355   unsigned char extended_identifiers;
 356
 357   /* True if we should warn about dollars in identifiers or numbers
 358      for this translation unit.  */
 359   unsigned char warn_dollars;
 360
 361   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 362   unsigned char warn_undef;
 363
 364   /* Nonzero means warn of unused macros from the main file.  */
 365   unsigned char warn_unused_macros;
 366
 367   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 368   unsigned char c99;
 369
 370   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 371   unsigned char std;
 372
 373   /* Nonzero means give all the error messages the ANSI standard requires.  */
 374   unsigned char pedantic;
 375
 376   /* Nonzero means we're looking at already preprocessed code, so don't
 377      bother trying to do macro expansion and whatnot.  */
 378   unsigned char preprocessed;
 379
 380   /* Print column number in error messages.  */
 381   unsigned char show_column;
 382
 383   /* Nonzero means handle C++ alternate operator names.  */
 384   unsigned char operator_names;
 385
 386   /* True for traditional preprocessing.  */
 387   unsigned char traditional;
 388
 389   /* Holds the name of the target (execution) character set.  */
 390   const char *narrow_charset;
 391
 392   /* Holds the name of the target wide character set.  */
 393   const char *wide_charset;
 394
 395   /* Holds the name of the input character set.  */
 396   const char *input_charset;
 397
 398   /* The minimum permitted level of normalization before a warning
 399      is generated.  */
 400   enum cpp_normalize_level warn_normalize;
 401
 402   /* True to warn about precompiled header files we couldn't use.  */
 403   bool warn_invalid_pch;
 404
 405   /* True if dependencies should be restored from a precompiled header.  */
 406   bool restore_pch_deps;
 407
 408   /* Dependency generation.  */
 409   struct
 410   {
 411     /* Style of header dependencies to generate.  */
 412     enum cpp_deps_style style;
 413
 414     /* Assume missing files are generated files.  */
 415     bool missing_files;
 416
 417     /* Generate phony targets for each dependency apart from the first
 418        one.  */
 419     bool phony_targets;
 420
 421     /* If true, no dependency is generated on the main file.  */
 422     bool ignore_main_file;
 423   } deps;
 424
 425   /* Target-specific features set by the front end or client.  */
 426
 427   /* Precision for target CPP arithmetic, target characters, target
 428      ints and target wide characters, respectively.  */
 429   size_t precision, char_precision, int_precision, wchar_precision;
 430
 431   /* True means chars (wide chars) are unsigned.  */
 432   bool unsigned_char, unsigned_wchar;
 433
 434   /* True if the most significant byte in a word has the lowest
 435      address in memory.  */
 436   bool bytes_big_endian;
 437
 438   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 439   unsigned char stdc_0_in_system_headers;
 440
 441   /* True disables tokenization outside of preprocessing directives. */
 442   bool directives_only;
 443 };
 444
 445 /* Callback for header lookup for HEADER, which is the name of a
 446    source file.  It is used as a method of last resort to find headers
 447    that are not otherwise found during the normal include processing.
 448    The return value is the malloced name of a header to try and open,
 449    if any, or NULL otherwise.  This callback is called only if the
 450    header is otherwise unfound.  */
 451 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
 452
 453 /* Call backs to cpplib client.  */
 454 struct cpp_callbacks
 455 {
 456   /* Called when a new line of preprocessed output is started.  */
 457   void (*line_change) (cpp_reader *, const cpp_token *, int);
 458
 459   /* Called when switching to/from a new file.
 460      The line_map is for the new file.  It is NULL if there is no new file.
 461      (In C this happens when done with <built-in>+<command line> and also
 462      when done with a main file.)  This can be used for resource cleanup.  */
 463   void (*file_change) (cpp_reader *, const struct line_map *);
 464
 465   void (*dir_change) (cpp_reader *, const char *);
 466   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 467                    const char *, int, const cpp_token **);
 468   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 469   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 470   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 471   void (*def_pragma) (cpp_reader *, unsigned int);
 472   int (*valid_pch) (cpp_reader *, const char *, int);
 473   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 474   missing_header_cb missing_header;
 475
 476   /* Context-sensitive macro support.  Returns macro (if any) that should
 477      be expanded.  */
 478   cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
 479
 480   /* Called to emit a diagnostic.  This callback receives the
 481      translated message.  */
 482   bool (*error) (cpp_reader *, int, source_location, unsigned int,
 483                  const char *, va_list *)
 484        ATTRIBUTE_FPTR_PRINTF(5,0);
 485
 486   /* Callbacks for when a macro is expanded, or tested (whether
 487      defined or not at the time) in #ifdef, #ifndef or "defined".  */
 488   void (*used_define) (cpp_reader *, unsigned int, cpp_hashnode *);
 489   void (*used_undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 490   /* Called before #define and #undef or other macro definition
 491      changes are processed.  */
 492   void (*before_define) (cpp_reader *);
 493 };
 494
 495 /* Chain of directories to look for include files in.  */
 496 struct cpp_dir
 497 {
 498   /* NULL-terminated singly-linked list.  */
 499   struct cpp_dir *next;
 500
 501   /* NAME of the directory, NUL-terminated.  */
 502   char *name;
 503   unsigned int len;
 504
 505   /* One if a system header, two if a system header that has extern
 506      "C" guards for C++.  */
 507   unsigned char sysp;
 508
 509   /* Is this a user-supplied directory? */
 510   bool user_supplied_p;
 511
 512   /* The canonicalized NAME as determined by lrealpath.  This field
 513      is only used by hosts that lack reliable inode numbers.  */
 514   char *canonical_name;
 515
 516   /* Mapping of file names for this directory for MS-DOS and related
 517      platforms.  A NULL-terminated array of (from, to) pairs.  */
 518   const char **name_map;
 519
 520   /* Routine to construct pathname, given the search path name and the
 521      HEADER we are trying to find, return a constructed pathname to
 522      try and open.  If this is NULL, the constructed pathname is as
 523      constructed by append_file_to_dir.  */
 524   char *(*construct) (const char *header, cpp_dir *dir);
 525
 526   /* The C front end uses these to recognize duplicated
 527      directories in the search path.  */
 528   ino_t ino;
 529   dev_t dev;
 530 };
 531
 532 /* Name under which this program was invoked.  */
 533 extern const char *progname;
 534
 535 /* The structure of a node in the hash table.  The hash table has
 536    entries for all identifiers: either macros defined by #define
 537    commands (type NT_MACRO), assertions created with #assert
 538    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 539    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 540    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 541    identifier that behaves like an operator such as "xor".
 542    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 543    diagnostic may be required for this node.  Currently this only
 544    applies to __VA_ARGS__ and poisoned identifiers.  */
 545
 546 /* Hash node flags.  */
 547 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 548 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 549 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 550 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 551 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 552 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 553 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 554 #define NODE_USED       (1 << 7)        /* Dumped with -dU.  */
 555 #define NODE_CONDITIONAL (1 << 8)       /* Conditional macro */
 556
 557 /* Different flavors of hash node.  */
 558 enum node_type
 559 {
 560   NT_VOID = 0,     /* No definition yet.  */
 561   NT_MACRO,        /* A macro of some form.  */
 562   NT_ASSERTION     /* Predicate for #assert.  */
 563 };
 564
 565 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 566    handle it with the builtin code for efficiency reasons.  */
 567 enum builtin_type
 568 {
 569   BT_SPECLINE = 0,              /* `__LINE__' */
 570   BT_DATE,                      /* `__DATE__' */
 571   BT_FILE,                      /* `__FILE__' */
 572   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 573   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 574   BT_TIME,                      /* `__TIME__' */
 575   BT_STDC,                      /* `__STDC__' */
 576   BT_PRAGMA,                    /* `_Pragma' operator */
 577   BT_TIMESTAMP,                 /* `__TIMESTAMP__' */
 578   BT_COUNTER                    /* `__COUNTER__' */
 579 };
 580
 581 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 582 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 583 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 584 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 585
 586 /* Specify which field, if any, of the union is used.  */
 587
 588 enum {
 589   NTV_MACRO,
 590   NTV_ANSWER,
 591   NTV_BUILTIN,
 592   NTV_ARGUMENT,
 593   NTV_NONE
 594 };
 595
 596 #define CPP_HASHNODE_VALUE_IDX(HNODE)                           \
 597   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT                \
 598    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN)     \
 599                                ? NTV_BUILTIN : NTV_MACRO)       \
 600    : HNODE.type == NT_ASSERTION ? NTV_ANSWER                    \
 601    : NTV_NONE)
 602
 603 /* The common part of an identifier node shared amongst all 3 C front
 604    ends.  Also used to store CPP identifiers, which are a superset of
 605    identifiers in the grammatical sense.  */
 606
 607 union _cpp_hashnode_value GTY(())
 608 {
 609   /* If a macro.  */
 610   cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
 611   /* Answers to an assertion.  */
 612   struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
 613   /* Code for a builtin macro.  */
 614   enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
 615   /* Macro argument index.  */
 616   unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
 617 };
 618
 619 struct cpp_hashnode GTY(())
 620 {
 621   struct ht_identifier ident;
 622   unsigned int is_directive : 1;
 623   unsigned int directive_index : 7;     /* If is_directive,
 624                                            then index into directive table.
 625                                            Otherwise, a NODE_OPERATOR.  */
 626   unsigned char rid_code;               /* Rid code - for front ends.  */
 627   ENUM_BITFIELD(node_type) type : 7;    /* CPP node type.  */
 628   unsigned int flags : 9;               /* CPP flags.  */
 629
 630   union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
 631 };
 632
 633 /* Call this first to get a handle to pass to other functions.
 634
 635    If you want cpplib to manage its own hashtable, pass in a NULL
 636    pointer.  Otherwise you should pass in an initialized hash table
 637    that cpplib will share; this technique is used by the C front
 638    ends.  */
 639 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
 640                                       struct line_maps *);
 641
 642 /* Reset the cpp_reader's line_map.  This is only used after reading a
 643    PCH file.  */
 644 extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
 645
 646 /* Call this to change the selected language standard (e.g. because of
 647    command line options).  */
 648 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 649
 650 /* Set the include paths.  */
 651 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 652
 653 /* Call these to get pointers to the options, callback, and deps
 654    structures for a given reader.  These pointers are good until you
 655    call cpp_finish on that reader.  You can either edit the callbacks
 656    through the pointer returned from cpp_get_callbacks, or set them
 657    with cpp_set_callbacks.  */
 658 extern cpp_options *cpp_get_options (cpp_reader *);
 659 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 660 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 661 extern struct deps *cpp_get_deps (cpp_reader *);
 662
 663 /* This function reads the file, but does not start preprocessing.  It
 664    returns the name of the original file; this is the same as the
 665    input file, except for preprocessed input.  This will generate at
 666    least one file change callback, and possibly a line change callback
 667    too.  If there was an error opening the file, it returns NULL.  */
 668 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 669
 670 /* Set up built-ins with special behavior.  Use cpp_init_builtins()
 671    instead unless your know what you are doing.  */
 672 extern void cpp_init_special_builtins (cpp_reader *);
 673
 674 /* Set up built-ins like __FILE__.  */
 675 extern void cpp_init_builtins (cpp_reader *, int);
 676
 677 /* This is called after options have been parsed, and partially
 678    processed.  */
 679 extern void cpp_post_options (cpp_reader *);
 680
 681 /* Set up translation to the target character set.  */
 682 extern void cpp_init_iconv (cpp_reader *);
 683
 684 /* Call this to finish preprocessing.  If you requested dependency
 685    generation, pass an open stream to write the information to,
 686    otherwise NULL.  It is your responsibility to close the stream.  */
 687 extern void cpp_finish (cpp_reader *, FILE *deps_stream);
 688
 689 /* Call this to release the handle at the end of preprocessing.  Any
 690    use of the handle after this function returns is invalid.  */
 691 extern void cpp_destroy (cpp_reader *);
 692
 693 extern unsigned int cpp_token_len (const cpp_token *);
 694 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 695 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 696                                        unsigned char *, bool);
 697 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 698                                  void (*) (cpp_reader *), bool);
 699 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
 700                                           const char *, unsigned, bool, bool);
 701 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 702                             const cpp_token *);
 703 extern const cpp_token *cpp_get_token (cpp_reader *);
 704 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
 705                                                      source_location *);
 706 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 707                                                   const cpp_hashnode *);
 708 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 709 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
 710
 711 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 712 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 713                                           unsigned int *, int *);
 714 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
 715 extern bool cpp_interpret_string (cpp_reader *,
 716                                   const cpp_string *, size_t,
 717                                   cpp_string *, enum cpp_ttype);
 718 extern bool cpp_interpret_string_notranslate (cpp_reader *,
 719                                               const cpp_string *, size_t,
 720                                               cpp_string *, enum cpp_ttype);
 721
 722 /* Convert a host character constant to the execution character set.  */
 723 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
 724
 725 /* Used to register macros and assertions, perhaps from the command line.
 726    The text is the same as the command line argument.  */
 727 extern void cpp_define (cpp_reader *, const char *);
 728 extern void cpp_define_formatted (cpp_reader *pfile,
 729                                   const char *fmt, ...) ATTRIBUTE_PRINTF_2;
 730 extern void cpp_assert (cpp_reader *, const char *);
 731 extern void cpp_undef (cpp_reader *, const char *);
 732 extern void cpp_unassert (cpp_reader *, const char *);
 733
 734 extern cpp_macro *cpp_push_definition (cpp_reader *, const char *);
 735 extern void cpp_pop_definition (cpp_reader *, const char *, cpp_macro *);
 736
 737 /* Undefine all macros and assertions.  */
 738 extern void cpp_undef_all (cpp_reader *);
 739
 740 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 741                                     size_t, int);
 742 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 743
 744 /* A preprocessing number.  Code assumes that any unused high bits of
 745    the double integer are set to zero.  */
 746 typedef unsigned HOST_WIDE_INT cpp_num_part;
 747 typedef struct cpp_num cpp_num;
 748 struct cpp_num
 749 {
 750   cpp_num_part high;
 751   cpp_num_part low;
 752   bool unsignedp;  /* True if value should be treated as unsigned.  */
 753   bool overflow;   /* True if the most recent calculation overflowed.  */
 754 };
 755
 756 /* cpplib provides two interfaces for interpretation of preprocessing
 757    numbers.
 758
 759    cpp_classify_number categorizes numeric constants according to
 760    their field (integer, floating point, or invalid), radix (decimal,
 761    octal, hexadecimal), and type suffixes.  */
 762
 763 #define CPP_N_CATEGORY  0x000F
 764 #define CPP_N_INVALID   0x0000
 765 #define CPP_N_INTEGER   0x0001
 766 #define CPP_N_FLOATING  0x0002
 767
 768 #define CPP_N_WIDTH     0x00F0
 769 #define CPP_N_SMALL     0x0010  /* int, float, shrot _Fract/Accum  */
 770 #define CPP_N_MEDIUM    0x0020  /* long, double, long _Fract/_Accum.  */
 771 #define CPP_N_LARGE     0x0040  /* long long, long double,
 772                                    long long _Fract/Accum.  */
 773
 774 #define CPP_N_WIDTH_MD  0xF0000 /* machine defined.  */
 775 #define CPP_N_MD_W      0x10000
 776 #define CPP_N_MD_Q      0x20000
 777
 778 #define CPP_N_RADIX     0x0F00
 779 #define CPP_N_DECIMAL   0x0100
 780 #define CPP_N_HEX       0x0200
 781 #define CPP_N_OCTAL     0x0400
 782 #define CPP_N_BINARY    0x0800
 783
 784 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 785 #define CPP_N_IMAGINARY 0x2000
 786 #define CPP_N_DFLOAT    0x4000
 787 #define CPP_N_DEFAULT   0x8000
 788
 789 #define CPP_N_FRACT     0x100000 /* Fract types.  */
 790 #define CPP_N_ACCUM     0x200000 /* Accum types.  */
 791
 792 /* Classify a CPP_NUMBER token.  The return value is a combination of
 793    the flags from the above sets.  */
 794 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 795
 796 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 797 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 798                                       unsigned int type);
 799
 800 /* Sign extend a number, with PRECISION significant bits and all
 801    others assumed clear, to fill out a cpp_num structure.  */
 802 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 803
 804 /* Diagnostic levels.  To get a diagnostic without associating a
 805    position in the translation unit with it, use cpp_error_with_line
 806    with a line number of zero.  */
 807
 808 /* Warning, an error with -Werror.  */
 809 #define CPP_DL_WARNING          0x00
 810 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
 811 #define CPP_DL_WARNING_SYSHDR   0x01
 812 /* Warning, an error with -pedantic-errors or -Werror.  */
 813 #define CPP_DL_PEDWARN          0x02
 814 /* An error.  */
 815 #define CPP_DL_ERROR            0x03
 816 /* An internal consistency check failed.  Prints "internal error: ",
 817    otherwise the same as CPP_DL_ERROR.  */
 818 #define CPP_DL_ICE              0x04
 819 /* An informative note following a warning.  */
 820 #define CPP_DL_NOTE             0x05
 821 /* A fatal error.  */
 822 #define CPP_DL_FATAL            0x06
 823
 824 /* Output a diagnostic of some kind.  */
 825 extern bool cpp_error (cpp_reader *, int, const char *msgid, ...)
 826   ATTRIBUTE_PRINTF_3;
 827
 828 /* Output a diagnostic with "MSGID: " preceding the
 829    error string of errno.  No location is printed.  */
 830 extern bool cpp_errno (cpp_reader *, int, const char *msgid);
 831
 832 /* Same as cpp_error, except additionally specifies a position as a
 833    (translation unit) physical line and physical column.  If the line is
 834    zero, then no location is printed.  */
 835 extern bool cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
 836                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
 837
 838 /* In lex.c */
 839 extern int cpp_ideq (const cpp_token *, const char *);
 840 extern void cpp_output_line (cpp_reader *, FILE *);
 841 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
 842                                                  const unsigned char *);
 843 extern void cpp_output_token (const cpp_token *, FILE *);
 844 extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
 845 /* Returns the value of an escape sequence, truncated to the correct
 846    target precision.  PSTR points to the input pointer, which is just
 847    after the backslash.  LIMIT is how much text we have.  WIDE is true
 848    if the escape sequence is part of a wide character constant or
 849    string literal.  Handles all relevant diagnostics.  */
 850 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 851                                    const unsigned char *limit, int wide);
 852
 853 /* Structure used to hold a comment block at a given location in the
 854    source code.  */
 855
 856 typedef struct
 857 {
 858   /* Text of the comment including the terminators.  */
 859   char *comment;
 860
 861   /* source location for the given comment.  */
 862   source_location sloc;
 863 } cpp_comment;
 864
 865 /* Structure holding all comments for a given cpp_reader.  */
 866
 867 typedef struct
 868 {
 869   /* table of comment entries.  */
 870   cpp_comment *entries;
 871
 872   /* number of actual entries entered in the table.  */
 873   int count;
 874
 875   /* number of entries allocated currently.  */
 876   int allocated;
 877 } cpp_comment_table;
 878
 879 /* Returns the table of comments encountered by the preprocessor. This
 880    table is only populated when pfile->state.save_comments is true. */
 881 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
 882
 883 /* In hash.c */
 884
 885 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 886    table if it is not already there.  */
 887 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
 888                                  unsigned int);
 889
 890 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 891 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 892
 893 /* In macro.c */
 894 extern void cpp_scan_nooutput (cpp_reader *);
 895 extern int  cpp_sys_macro_p (cpp_reader *);
 896 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 897                                         unsigned int);
 898
 899 /* In files.c */
 900 extern bool cpp_included (cpp_reader *, const char *);
 901 extern bool cpp_included_before (cpp_reader *, const char *, source_location);
 902 extern void cpp_make_system_header (cpp_reader *, int, int);
 903 extern bool cpp_push_include (cpp_reader *, const char *);
 904 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 905 extern const char *cpp_get_path (struct _cpp_file *);
 906 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
 907 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
 908 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
 909 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
 910 extern void cpp_clear_file_cache (cpp_reader *);
 911
 912 /* In pch.c */
 913 struct save_macro_data;
 914 extern int cpp_save_state (cpp_reader *, FILE *);
 915 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 916 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 917 extern int cpp_valid_state (cpp_reader *, const char *, int);
 918 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 919 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 920                            struct save_macro_data *);
 921
 922 #ifdef __cplusplus
 923 }
 924 #endif
 925
 926 #endif /* ! LIBCPP_CPPLIB_H */