libcpp/include/cpplib.h

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