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