libcpp/include/cpplib.h

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