libcpp/include/cpplib.h

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