git.gag.com Git - debian/cc1111/blob - support/cpp/libcpp/include/cpplib.h

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