libcpp/include/cpplib.h

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