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, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /* The possible normalization levels, from most restrictive to least.  */
 240 enum cpp_normalize_level {
 241   /* In NFKC.  */
 242   normalized_KC = 0,
 243   /* In NFC.  */
 244   normalized_C,
 245   /* In NFC, except for subsequences where being in NFC would make
 246      the identifier invalid.  */
 247   normalized_identifier_C,
 248   /* Not normalized at all.  */
 249   normalized_none
 250 };
 251
 252 /* This structure is nested inside struct cpp_reader, and
 253    carries all the options visible to the command line.  */
 254 struct cpp_options
 255 {
 256   /* Characters between tab stops.  */
 257   unsigned int tabstop;
 258
 259   /* The language we're preprocessing.  */
 260   enum c_lang lang;
 261
 262   /* Nonzero means use extra default include directories for C++.  */
 263   unsigned char cplusplus;
 264
 265   /* Nonzero means handle cplusplus style comments.  */
 266   unsigned char cplusplus_comments;
 267
 268   /* Nonzero means define __OBJC__, treat @ as a special token, and
 269      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 270   unsigned char objc;
 271
 272   /* Nonzero means don't copy comments into the output file.  */
 273   unsigned char discard_comments;
 274
 275   /* Nonzero means don't copy comments into the output file during
 276      macro expansion.  */
 277   unsigned char discard_comments_in_macro_exp;
 278
 279   /* Nonzero means process the ISO trigraph sequences.  */
 280   unsigned char trigraphs;
 281
 282   /* Nonzero means process the ISO digraph sequences.  */
 283   unsigned char digraphs;
 284
 285   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 286   unsigned char extended_numbers;
 287
 288   /* Nonzero means print names of header files (-H).  */
 289   unsigned char print_include_names;
 290
 291   /* Nonzero means cpp_pedwarn causes a hard error.  */
 292   unsigned char pedantic_errors;
 293
 294   /* Nonzero means don't print warning messages.  */
 295   unsigned char inhibit_warnings;
 296
 297   /* Nonzero means complain about deprecated features.  */
 298   unsigned char warn_deprecated;
 299
 300   /* Nonzero means don't suppress warnings from system headers.  */
 301   unsigned char warn_system_headers;
 302
 303   /* Nonzero means don't print error messages.  Has no option to
 304      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 305   unsigned char inhibit_errors;
 306
 307   /* Nonzero means warn if slash-star appears in a comment.  */
 308   unsigned char warn_comments;
 309
 310   /* Nonzero means warn if a user-supplied include directory does not
 311      exist.  */
 312   unsigned char warn_missing_include_dirs;
 313
 314   /* Nonzero means warn if there are any trigraphs.  */
 315   unsigned char warn_trigraphs;
 316
 317   /* Nonzero means warn about multicharacter charconsts.  */
 318   unsigned char warn_multichar;
 319
 320   /* Nonzero means warn about various incompatibilities with
 321      traditional C.  */
 322   unsigned char warn_traditional;
 323
 324   /* Nonzero means warn about long long numeric constants.  */
 325   unsigned char warn_long_long;
 326
 327   /* Nonzero means warn about text after an #endif (or #else).  */
 328   unsigned char warn_endif_labels;
 329
 330   /* Nonzero means warn about implicit sign changes owing to integer
 331      promotions.  */
 332   unsigned char warn_num_sign_change;
 333
 334   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
 335      Presumably the usage is protected by the appropriate #ifdef.  */
 336   unsigned char warn_variadic_macros;
 337
 338   /* Nonzero means turn warnings into errors.  */
 339   unsigned char warnings_are_errors;
 340
 341   /* Nonzero means we should look for header.gcc files that remap file
 342      names.  */
 343   unsigned char remap;
 344
 345   /* Zero means dollar signs are punctuation.  */
 346   unsigned char dollars_in_ident;
 347
 348   /* True if we should warn about dollars in identifiers or numbers
 349      for this translation unit.  */
 350   unsigned char warn_dollars;
 351
 352   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 353   unsigned char warn_undef;
 354
 355   /* Nonzero means warn of unused macros from the main file.  */
 356   unsigned char warn_unused_macros;
 357
 358   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 359   unsigned char c99;
 360
 361   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 362   unsigned char std;
 363
 364   /* Nonzero means give all the error messages the ANSI standard requires.  */
 365   unsigned char pedantic;
 366
 367   /* Nonzero means we're looking at already preprocessed code, so don't
 368      bother trying to do macro expansion and whatnot.  */
 369   unsigned char preprocessed;
 370
 371   /* Print column number in error messages.  */
 372   unsigned char show_column;
 373
 374   /* Nonzero means handle C++ alternate operator names.  */
 375   unsigned char operator_names;
 376
 377   /* True for traditional preprocessing.  */
 378   unsigned char traditional;
 379
 380   /* Holds the name of the target (execution) character set.  */
 381   const char *narrow_charset;
 382
 383   /* Holds the name of the target wide character set.  */
 384   const char *wide_charset;
 385
 386   /* Holds the name of the input character set.  */
 387   const char *input_charset;
 388
 389   /* The minimum permitted level of normalization before a warning
 390      is generated.  */
 391   enum cpp_normalize_level warn_normalize;
 392
 393   /* True to warn about precompiled header files we couldn't use.  */
 394   bool warn_invalid_pch;
 395
 396   /* True if dependencies should be restored from a precompiled header.  */
 397   bool restore_pch_deps;
 398
 399   /* Dependency generation.  */
 400   struct
 401   {
 402     /* Style of header dependencies to generate.  */
 403     enum cpp_deps_style style;
 404
 405     /* Assume missing files are generated files.  */
 406     bool missing_files;
 407
 408     /* Generate phony targets for each dependency apart from the first
 409        one.  */
 410     bool phony_targets;
 411
 412     /* If true, no dependency is generated on the main file.  */
 413     bool ignore_main_file;
 414   } deps;
 415
 416   /* Target-specific features set by the front end or client.  */
 417
 418   /* Precision for target CPP arithmetic, target characters, target
 419      ints and target wide characters, respectively.  */
 420   size_t precision, char_precision, int_precision, wchar_precision;
 421
 422   /* True means chars (wide chars) are unsigned.  */
 423   bool unsigned_char, unsigned_wchar;
 424
 425   /* True if the most significant byte in a word has the lowest
 426      address in memory.  */
 427   bool bytes_big_endian;
 428
 429   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 430   unsigned char stdc_0_in_system_headers;
 431
 432   /* True means return pragmas as tokens rather than processing
 433      them directly. */
 434   bool defer_pragmas;
 435 };
 436
 437 /* Callback for header lookup for HEADER, which is the name of a
 438    source file.  It is used as a method of last resort to find headers
 439    that are not otherwise found during the normal include processing.
 440    The return value is the malloced name of a header to try and open,
 441    if any, or NULL otherwise.  This callback is called only if the
 442    header is otherwise unfound.  */
 443 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
 444
 445 /* Call backs to cpplib client.  */
 446 struct cpp_callbacks
 447 {
 448   /* Called when a new line of preprocessed output is started.  */
 449   void (*line_change) (cpp_reader *, const cpp_token *, int);
 450
 451   /* Called when switching to/from a new file.
 452      The line_map is for the new file.  It is NULL if there is no new file.
 453      (In C this happens when done with <built-in>+<command line> and also
 454      when done with a main file.)  This can be used for resource cleanup.  */
 455   void (*file_change) (cpp_reader *, const struct line_map *);
 456
 457   void (*dir_change) (cpp_reader *, const char *);
 458   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 459                    const char *, int);
 460   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 461   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 462   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 463   void (*def_pragma) (cpp_reader *, unsigned int);
 464   int (*valid_pch) (cpp_reader *, const char *, int);
 465   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 466   missing_header_cb missing_header;
 467 };
 468
 469 /* Chain of directories to look for include files in.  */
 470 struct cpp_dir
 471 {
 472   /* NULL-terminated singly-linked list.  */
 473   struct cpp_dir *next;
 474
 475   /* NAME of the directory, NUL-terminated.  */
 476   char *name;
 477   unsigned int len;
 478
 479   /* One if a system header, two if a system header that has extern
 480      "C" guards for C++.  */
 481   unsigned char sysp;
 482
 483   /* Mapping of file names for this directory for MS-DOS and related
 484      platforms.  A NULL-terminated array of (from, to) pairs.  */
 485   const char **name_map;
 486
 487   /* Routine to construct pathname, given the search path name and the
 488      HEADER we are trying to find, return a constructed pathname to
 489      try and open.  If this is NULL, the constructed pathname is as
 490      constructed by append_file_to_dir.  */
 491   char *(*construct) (const char *header, cpp_dir *dir);
 492
 493   /* The C front end uses these to recognize duplicated
 494      directories in the search path.  */
 495   ino_t ino;
 496   dev_t dev;
 497
 498   /* Is this a user-supplied directory? */
 499   bool user_supplied_p;
 500 };
 501
 502 /* Name under which this program was invoked.  */
 503 extern const char *progname;
 504
 505 /* The structure of a node in the hash table.  The hash table has
 506    entries for all identifiers: either macros defined by #define
 507    commands (type NT_MACRO), assertions created with #assert
 508    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 509    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 510    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 511    identifier that behaves like an operator such as "xor".
 512    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 513    diagnostic may be required for this node.  Currently this only
 514    applies to __VA_ARGS__ and poisoned identifiers.  */
 515
 516 /* Hash node flags.  */
 517 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 518 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 519 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 520 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 521 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 522 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 523 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 524
 525 /* Different flavors of hash node.  */
 526 enum node_type
 527 {
 528   NT_VOID = 0,     /* No definition yet.  */
 529   NT_MACRO,        /* A macro of some form.  */
 530   NT_ASSERTION     /* Predicate for #assert.  */
 531 };
 532
 533 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 534    handle it with the builtin code for efficiency reasons.  */
 535 enum builtin_type
 536 {
 537   BT_SPECLINE = 0,              /* `__LINE__' */
 538   BT_DATE,                      /* `__DATE__' */
 539   BT_FILE,                      /* `__FILE__' */
 540   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 541   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 542   BT_TIME,                      /* `__TIME__' */
 543   BT_STDC,                      /* `__STDC__' */
 544   BT_PRAGMA                     /* `_Pragma' operator */
 545 };
 546
 547 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 548 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 549 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 550 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 551
 552 /* Specify which field, if any, of the union is used.  */
 553
 554 enum {
 555   NTV_MACRO,
 556   NTV_ANSWER,
 557   NTV_BUILTIN,
 558   NTV_ARGUMENT,
 559   NTV_NONE
 560 };
 561
 562 #define CPP_HASHNODE_VALUE_IDX(HNODE)                           \
 563   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT                \
 564    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN)     \
 565                                ? NTV_BUILTIN : NTV_MACRO)       \
 566    : HNODE.type == NT_ASSERTION ? NTV_ANSWER                    \
 567    : NTV_NONE)
 568
 569 /* The common part of an identifier node shared amongst all 3 C front
 570    ends.  Also used to store CPP identifiers, which are a superset of
 571    identifiers in the grammatical sense.  */
 572
 573 union _cpp_hashnode_value GTY(())
 574 {
 575   /* If a macro.  */
 576   cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
 577   /* Answers to an assertion.  */
 578   struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
 579   /* Code for a builtin macro.  */
 580   enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
 581   /* Macro argument index.  */
 582   unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
 583 };
 584
 585 struct cpp_hashnode GTY(())
 586 {
 587   struct ht_identifier ident;
 588   unsigned int is_directive : 1;
 589   unsigned int directive_index : 7;     /* If is_directive,
 590                                            then index into directive table.
 591                                            Otherwise, a NODE_OPERATOR.  */
 592   unsigned char rid_code;               /* Rid code - for front ends.  */
 593   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 594   unsigned char flags;                  /* CPP flags.  */
 595
 596   union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
 597 };
 598
 599 /* Call this first to get a handle to pass to other functions.
 600
 601    If you want cpplib to manage its own hashtable, pass in a NULL
 602    pointer.  Otherwise you should pass in an initialized hash table
 603    that cpplib will share; this technique is used by the C front
 604    ends.  */
 605 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
 606                                       struct line_maps *);
 607
 608 /* Call this to change the selected language standard (e.g. because of
 609    command line options).  */
 610 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 611
 612 /* Set the include paths.  */
 613 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 614
 615 /* Call these to get pointers to the options, callback, and deps
 616    structures for a given reader.  These pointers are good until you
 617    call cpp_finish on that reader.  You can either edit the callbacks
 618    through the pointer returned from cpp_get_callbacks, or set them
 619    with cpp_set_callbacks.  */
 620 extern cpp_options *cpp_get_options (cpp_reader *);
 621 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 622 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 623 extern struct deps *cpp_get_deps (cpp_reader *);
 624
 625 /* This function reads the file, but does not start preprocessing.  It
 626    returns the name of the original file; this is the same as the
 627    input file, except for preprocessed input.  This will generate at
 628    least one file change callback, and possibly a line change callback
 629    too.  If there was an error opening the file, it returns NULL.  */
 630 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 631
 632 /* Set up built-ins like __FILE__.  */
 633 extern void cpp_init_builtins (cpp_reader *, int);
 634
 635 /* This is called after options have been parsed, and partially
 636    processed.  */
 637 extern void cpp_post_options (cpp_reader *);
 638
 639 /* Set up translation to the target character set.  */
 640 extern void cpp_init_iconv (cpp_reader *);
 641
 642 /* Call this to finish preprocessing.  If you requested dependency
 643    generation, pass an open stream to write the information to,
 644    otherwise NULL.  It is your responsibility to close the stream.
 645
 646    Returns cpp_errors (pfile).  */
 647 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
 648
 649 /* Call this to release the handle at the end of preprocessing.  Any
 650    use of the handle after this function returns is invalid.  Returns
 651    cpp_errors (pfile).  */
 652 extern void cpp_destroy (cpp_reader *);
 653
 654 /* Error count.  */
 655 extern unsigned int cpp_errors (cpp_reader *);
 656
 657 extern unsigned int cpp_token_len (const cpp_token *);
 658 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 659 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 660                                        unsigned char *, bool);
 661 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 662                                  void (*) (cpp_reader *), bool);
 663 extern void cpp_handle_deferred_pragma (cpp_reader *, const cpp_string *);
 664 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 665                             const cpp_token *);
 666 extern const cpp_token *cpp_get_token (cpp_reader *);
 667 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 668                                                   const cpp_hashnode *);
 669 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 670
 671 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 672 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 673                                           unsigned int *, int *);
 674 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
 675 extern bool cpp_interpret_string (cpp_reader *,
 676                                   const cpp_string *, size_t,
 677                                   cpp_string *, bool);
 678 extern bool cpp_interpret_string_notranslate (cpp_reader *,
 679                                               const cpp_string *, size_t,
 680                                               cpp_string *, bool);
 681
 682 /* Convert a host character constant to the execution character set.  */
 683 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
 684
 685 /* Used to register macros and assertions, perhaps from the command line.
 686    The text is the same as the command line argument.  */
 687 extern void cpp_define (cpp_reader *, const char *);
 688 extern void cpp_assert (cpp_reader *, const char *);
 689 extern void cpp_undef (cpp_reader *, const char *);
 690 extern void cpp_unassert (cpp_reader *, const char *);
 691
 692 /* Undefine all macros and assertions.  */
 693 extern void cpp_undef_all (cpp_reader *);
 694
 695 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 696                                     size_t, int);
 697 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 698
 699 /* A preprocessing number.  Code assumes that any unused high bits of
 700    the double integer are set to zero.  */
 701 typedef unsigned HOST_WIDE_INT cpp_num_part;
 702 typedef struct cpp_num cpp_num;
 703 struct cpp_num
 704 {
 705   cpp_num_part high;
 706   cpp_num_part low;
 707   bool unsignedp;  /* True if value should be treated as unsigned.  */
 708   bool overflow;   /* True if the most recent calculation overflowed.  */
 709 };
 710
 711 /* cpplib provides two interfaces for interpretation of preprocessing
 712    numbers.
 713
 714    cpp_classify_number categorizes numeric constants according to
 715    their field (integer, floating point, or invalid), radix (decimal,
 716    octal, hexadecimal), and type suffixes.  */
 717
 718 #define CPP_N_CATEGORY  0x000F
 719 #define CPP_N_INVALID   0x0000
 720 #define CPP_N_INTEGER   0x0001
 721 #define CPP_N_FLOATING  0x0002
 722
 723 #define CPP_N_WIDTH     0x00F0
 724 #define CPP_N_SMALL     0x0010  /* int, float.  */
 725 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 726 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 727
 728 #define CPP_N_RADIX     0x0F00
 729 #define CPP_N_DECIMAL   0x0100
 730 #define CPP_N_HEX       0x0200
 731 #define CPP_N_OCTAL     0x0400
 732
 733 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 734 #define CPP_N_IMAGINARY 0x2000
 735
 736 /* Classify a CPP_NUMBER token.  The return value is a combination of
 737    the flags from the above sets.  */
 738 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 739
 740 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 741 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 742                                       unsigned int type);
 743
 744 /* Sign extend a number, with PRECISION significant bits and all
 745    others assumed clear, to fill out a cpp_num structure.  */
 746 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 747
 748 /* Diagnostic levels.  To get a diagnostic without associating a
 749    position in the translation unit with it, use cpp_error_with_line
 750    with a line number of zero.  */
 751
 752 /* Warning, an error with -Werror.  */
 753 #define CPP_DL_WARNING          0x00
 754 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
 755 #define CPP_DL_WARNING_SYSHDR   0x01
 756 /* Warning, an error with -pedantic-errors or -Werror.  */
 757 #define CPP_DL_PEDWARN          0x02
 758 /* An error.  */
 759 #define CPP_DL_ERROR            0x03
 760 /* An internal consistency check failed.  Prints "internal error: ",
 761    otherwise the same as CPP_DL_ERROR.  */
 762 #define CPP_DL_ICE              0x04
 763 /* Extracts a diagnostic level from an int.  */
 764 #define CPP_DL_EXTRACT(l)       (l & 0xf)
 765 /* Nonzero if a diagnostic level is one of the warnings.  */
 766 #define CPP_DL_WARNING_P(l)     (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
 767                                  && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
 768
 769 /* Output a diagnostic of some kind.  */
 770 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
 771   ATTRIBUTE_PRINTF_3;
 772
 773 /* Output a diagnostic with "MSGID: " preceding the
 774    error string of errno.  No location is printed.  */
 775 extern void cpp_errno (cpp_reader *, int, const char *msgid);
 776
 777 /* Same as cpp_error, except additionally specifies a position as a
 778    (translation unit) physical line and physical column.  If the line is
 779    zero, then no location is printed.  */
 780 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
 781                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
 782
 783 /* In cpplex.c */
 784 extern int cpp_ideq (const cpp_token *, const char *);
 785 extern void cpp_output_line (cpp_reader *, FILE *);
 786 extern void cpp_output_token (const cpp_token *, FILE *);
 787 extern const char *cpp_type2name (enum cpp_ttype);
 788 /* Returns the value of an escape sequence, truncated to the correct
 789    target precision.  PSTR points to the input pointer, which is just
 790    after the backslash.  LIMIT is how much text we have.  WIDE is true
 791    if the escape sequence is part of a wide character constant or
 792    string literal.  Handles all relevant diagnostics.  */
 793 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 794                                    const unsigned char *limit, int wide);
 795
 796 /* In cpphash.c */
 797
 798 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 799    table if it is not already there.  */
 800 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
 801                                  unsigned int);
 802
 803 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 804 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 805
 806 /* In cppmacro.c */
 807 extern void cpp_scan_nooutput (cpp_reader *);
 808 extern int  cpp_sys_macro_p (cpp_reader *);
 809 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 810                                         unsigned int);
 811
 812 /* In cppfiles.c */
 813 extern bool cpp_included (cpp_reader *, const char *);
 814 extern void cpp_make_system_header (cpp_reader *, int, int);
 815 extern bool cpp_push_include (cpp_reader *, const char *);
 816 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 817 extern const char *cpp_get_path (struct _cpp_file *);
 818 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
 819 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
 820 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
 821 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
 822
 823 /* In cpppch.c */
 824 struct save_macro_data;
 825 extern int cpp_save_state (cpp_reader *, FILE *);
 826 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 827 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 828 extern int cpp_valid_state (cpp_reader *, const char *, int);
 829 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 830 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 831                            struct save_macro_data *);
 832
 833 #ifdef __cplusplus
 834 }
 835 #endif
 836
 837 #endif /* ! LIBCPP_CPPLIB_H */