libcpp/include/cpplib.h

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