Open64: osprey-gcc-4.2.0/libcpp/include/cpplib.h Source File

00001 /* Definitions for CPP library.
00002    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
00003    2004, 2005
00004    Free Software Foundation, Inc.
00005    Written by Per Bothner, 1994-95.
00006 
00007 This program is free software; you can redistribute it and/or modify it
00008 under the terms of the GNU General Public License as published by the
00009 Free Software Foundation; either version 2, or (at your option) any
00010 later version.
00011 
00012 This program is distributed in the hope that it will be useful,
00013 but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 GNU General Public License for more details.
00016 
00017 You should have received a copy of the GNU General Public License
00018 along with this program; if not, write to the Free Software
00019 Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00020 
00021  In other words, you are welcome to use, share and improve this program.
00022  You are forbidden to forbid anyone else to use, share and improve
00023  what you give them.   Help stamp out software-hoarding!  */
00024 #ifndef LIBCPP_CPPLIB_H
00025 #define LIBCPP_CPPLIB_H
00026 
00027 #include <sys/types.h>
00028 #include "symtab.h"
00029 #include "line-map.h"
00030 
00031 #ifdef __cplusplus
00032 extern "C" {
00033 #endif
00034 
00035 typedef struct cpp_reader cpp_reader;
00036 typedef struct cpp_buffer cpp_buffer;
00037 typedef struct cpp_options cpp_options;
00038 typedef struct cpp_token cpp_token;
00039 typedef struct cpp_string cpp_string;
00040 typedef struct cpp_hashnode cpp_hashnode;
00041 typedef struct cpp_macro cpp_macro;
00042 typedef struct cpp_callbacks cpp_callbacks;
00043 typedef struct cpp_dir cpp_dir;
00044 
00045 struct answer;
00046 struct _cpp_file;
00047 
00048 /* The first three groups, apart from '=', can appear in preprocessor
00049    expressions (+= and -= are used to indicate unary + and - resp.).
00050    This allows a lookup table to be implemented in _cpp_parse_expr.
00051 
00052    The first group, to CPP_LAST_EQ, can be immediately followed by an
00053    '='.  The lexer needs operators ending in '=', like ">>=", to be in
00054    the same order as their counterparts without the '=', like ">>".
00055 
00056    See the cpp_operator table optab in expr.c if you change the order or
00057    add or remove anything in the first group.  */
00058 
00059 #define TTYPE_TABLE             \
00060   OP(EQ,    "=")            \
00061   OP(NOT,   "!")            \
00062   OP(GREATER,   ">")  /* compare */       \
00063   OP(LESS,    "<")            \
00064   OP(PLUS,    "+")  /* math */        \
00065   OP(MINUS,   "-")            \
00066   OP(MULT,    "*")            \
00067   OP(DIV,   "/")            \
00068   OP(MOD,   "%")            \
00069   OP(AND,   "&")  /* bit ops */       \
00070   OP(OR,    "|")            \
00071   OP(XOR,   "^")            \
00072   OP(RSHIFT,    ">>")           \
00073   OP(LSHIFT,    "<<")           \
00074                   \
00075   OP(COMPL,   "~")            \
00076   OP(AND_AND,   "&&") /* logical */       \
00077   OP(OR_OR,   "||")           \
00078   OP(QUERY,   "?")            \
00079   OP(COLON,   ":")            \
00080   OP(COMMA,   ",")  /* grouping */        \
00081   OP(OPEN_PAREN,  "(")            \
00082   OP(CLOSE_PAREN, ")")            \
00083   TK(EOF,   NONE)           \
00084   OP(EQ_EQ,   "==") /* compare */       \
00085   OP(NOT_EQ,    "!=")           \
00086   OP(GREATER_EQ,  ">=")           \
00087   OP(LESS_EQ,   "<=")           \
00088                   \
00089   /* These two are unary + / - in preprocessor expressions.  */   \
00090   OP(PLUS_EQ,   "+=") /* math */        \
00091   OP(MINUS_EQ,    "-=")           \
00092                   \
00093   OP(MULT_EQ,   "*=")           \
00094   OP(DIV_EQ,    "/=")           \
00095   OP(MOD_EQ,    "%=")           \
00096   OP(AND_EQ,    "&=") /* bit ops */       \
00097   OP(OR_EQ,   "|=")           \
00098   OP(XOR_EQ,    "^=")           \
00099   OP(RSHIFT_EQ,   ">>=")            \
00100   OP(LSHIFT_EQ,   "<<=")            \
00101   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
00102   OP(HASH,    "#")  /* digraphs */        \
00103   OP(PASTE,   "##")           \
00104   OP(OPEN_SQUARE, "[")            \
00105   OP(CLOSE_SQUARE,  "]")            \
00106   OP(OPEN_BRACE,  "{")            \
00107   OP(CLOSE_BRACE, "}")            \
00108   /* The remainder of the punctuation.  Order is not significant.  */ \
00109   OP(SEMICOLON,   ";")  /* structure */       \
00110   OP(ELLIPSIS,    "...")            \
00111   OP(PLUS_PLUS,   "++") /* increment */       \
00112   OP(MINUS_MINUS, "--")           \
00113   OP(DEREF,   "->") /* accessors */       \
00114   OP(DOT,   ".")            \
00115   OP(SCOPE,   "::")           \
00116   OP(DEREF_STAR,  "->*")            \
00117   OP(DOT_STAR,    ".*")           \
00118   OP(ATSIGN,    "@")  /* used in Objective-C */     \
                  \
  TK(NAME,    IDENT)   /* word */       \
  TK(AT_NAME,   IDENT)   /* @word - Objective-C */    \
  TK(NUMBER,    LITERAL) /* 34_be+ta  */      \
                  \
  TK(CHAR,    LITERAL) /* 'char' */       \
  TK(WCHAR,   LITERAL) /* L'char' */        \
  TK(OTHER,   LITERAL) /* stray punctuation */    \
                  \
  TK(STRING,    LITERAL) /* "string" */       \
00119   TK(WSTRING,   LITERAL) /* L"string" */      \
00120   TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */    \
00121   TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */    \
00122                   \
00123   TK(COMMENT,   LITERAL) /* Only if output comments.  */  \
00124          /* SPELL_LITERAL happens to DTRT.  */  \
00125   TK(MACRO_ARG,   NONE)  /* Macro argument.  */     \
00126   TK(PRAGMA,    NONE)  /* Only for deferred pragmas.  */  \
00127   TK(PRAGMA_EOL,  NONE)  /* End-of-line for deferred pragmas.  */ \
00128   TK(PADDING,   NONE)  /* Whitespace for -E.  */
00129 
00130 #define OP(e, s) CPP_ ## e,
00131 #define TK(e, s) CPP_ ## e,
00132 enum cpp_ttype
00133 {
00134   TTYPE_TABLE
00135   N_TTYPES,
00136 
00137   /* Positions in the table.  */
00138   CPP_LAST_EQ        = CPP_LSHIFT,
00139   CPP_FIRST_DIGRAPH  = CPP_HASH,
00140   CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
00141   CPP_LAST_CPP_OP    = CPP_LESS_EQ
00142 };
00143 #undef OP
00144 #undef TK
00145 
00146 /* C language kind, used when calling cpp_create_reader.  */
00147 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
00148        CLK_GNUCXX, CLK_CXX98, CLK_ASM};
00149 
00150 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
00151 struct cpp_string GTY(())
00152 {
00153   unsigned int len;
00154   const unsigned char *text;
00155 };
00156 
00157 /* Flags for the cpp_token structure.  */
00158 #define PREV_WHITE  (1 << 0) /* If whitespace before this token.  */
00159 #define DIGRAPH   (1 << 1) /* If it was a digraph.  */
00160 #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified.  */
00161 #define PASTE_LEFT  (1 << 3) /* If on LHS of a ## operator.  */
00162 #define NAMED_OP  (1 << 4) /* C++ named operators.  */
00163 #define NO_EXPAND (1 << 5) /* Do not macro-expand this token.  */
00164 #define BOL   (1 << 6) /* Token at beginning of line.  */
00165 #define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend,
00166             set in c-lex.c.  */
00167 
00168 /* Specify which field, if any, of the cpp_token union is used.  */
00169 
00170 enum cpp_token_fld_kind {
00171   CPP_TOKEN_FLD_NODE,
00172   CPP_TOKEN_FLD_SOURCE,
00173   CPP_TOKEN_FLD_STR,
00174   CPP_TOKEN_FLD_ARG_NO,
00175   CPP_TOKEN_FLD_PRAGMA,
00176   CPP_TOKEN_FLD_NONE
00177 };
00178 
00179 /* A preprocessing token.  This has been carefully packed and should
00180    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
00181 struct cpp_token GTY(())
00182 {
00183   source_location src_loc;  /* Location of first char of token.  */
00184   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
00185   unsigned char flags;    /* flags - see above */
00186 
00187   union cpp_token_u
00188   {
00189     /* An identifier.  */
00190     cpp_hashnode *
00191       GTY ((nested_ptr (union tree_node,
00192     "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
00193       "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"),
00194       tag ("CPP_TOKEN_FLD_NODE")))
00195    node;
00196    
00197     /* Inherit padding from this token.  */
00198     cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
00199 
00200     /* A string, or number.  */
00201     struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
00202 
00203     /* Argument no. for a CPP_MACRO_ARG.  */
00204     unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no;
00205 
00206     /* Caller-supplied identifier for a CPP_PRAGMA.  */
00207     unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
00208   } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
00209 };
00210 
00211 /* Say which field is in use.  */
00212 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
00213 
00214 /* A type wide enough to hold any multibyte source character.
00215    cpplib's character constant interpreter requires an unsigned type.
00216    Also, a typedef for the signed equivalent.
00217    The width of this type is capped at 32 bits; there do exist targets
00218    where wchar_t is 64 bits, but only in a non-default mode, and there
00219    would be no meaningful interpretation for a wchar_t value greater
00220    than 2^32 anyway -- the widest wide-character encoding around is
00221    ISO 10646, which stops at 2^31.  */
00222 #if CHAR_BIT * SIZEOF_INT >= 32
00223 # define CPPCHAR_SIGNED_T int
00224 #elif CHAR_BIT * SIZEOF_LONG >= 32
00225 # define CPPCHAR_SIGNED_T long
00226 #else
00227 # error "Cannot find a least-32-bit signed integer type"
00228 #endif
00229 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
00230 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
00231 
00232 /* Style of header dependencies to generate.  */
00233 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
00234 
00235 /* The possible normalization levels, from most restrictive to least.  */
00236 enum cpp_normalize_level {
00237   /* In NFKC.  */
00238   normalized_KC = 0,
00239   /* In NFC.  */
00240   normalized_C,
00241   /* In NFC, except for subsequences where being in NFC would make
00242      the identifier invalid.  */
00243   normalized_identifier_C,
00244   /* Not normalized at all.  */
00245   normalized_none
00246 };
00247 
00248 /* This structure is nested inside struct cpp_reader, and
00249    carries all the options visible to the command line.  */
00250 struct cpp_options
00251 {
00252   /* Characters between tab stops.  */
00253   unsigned int tabstop;
00254 
00255   /* The language we're preprocessing.  */
00256   enum c_lang lang;
00257 
00258   /* Nonzero means use extra default include directories for C++.  */
00259   unsigned char cplusplus;
00260 
00261   /* Nonzero means handle cplusplus style comments.  */
00262   unsigned char cplusplus_comments;
00263 
00264   /* Nonzero means define __OBJC__, treat @ as a special token, and
00265      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
00266   unsigned char objc;
00267 
00268   /* Nonzero means don't copy comments into the output file.  */
00269   unsigned char discard_comments;
00270 
00271   /* Nonzero means don't copy comments into the output file during
00272      macro expansion.  */
00273   unsigned char discard_comments_in_macro_exp;
00274 
00275   /* Nonzero means process the ISO trigraph sequences.  */
00276   unsigned char trigraphs;
00277 
00278   /* Nonzero means process the ISO digraph sequences.  */
00279   unsigned char digraphs;
00280 
00281   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
00282   unsigned char extended_numbers;
00283 
00284   /* Nonzero means print names of header files (-H).  */
00285   unsigned char print_include_names;
00286 
00287   /* Nonzero means cpp_pedwarn causes a hard error.  */
00288   unsigned char pedantic_errors;
00289 
00290   /* Nonzero means don't print warning messages.  */
00291   unsigned char inhibit_warnings;
00292 
00293   /* Nonzero means complain about deprecated features.  */
00294   unsigned char warn_deprecated;
00295 
00296   /* Nonzero means don't suppress warnings from system headers.  */
00297   unsigned char warn_system_headers;
00298 
00299   /* Nonzero means don't print error messages.  Has no option to
00300      select it, but can be set by a user of cpplib (e.g. fix-header).  */
00301   unsigned char inhibit_errors;
00302 
00303   /* Nonzero means warn if slash-star appears in a comment.  */
00304   unsigned char warn_comments;
00305 
00306   /* Nonzero means warn if a user-supplied include directory does not
00307      exist.  */
00308   unsigned char warn_missing_include_dirs;
00309 
00310   /* Nonzero means warn if there are any trigraphs.  */
00311   unsigned char warn_trigraphs;
00312 
00313   /* Nonzero means warn about multicharacter charconsts.  */
00314   unsigned char warn_multichar;
00315 
00316   /* Nonzero means warn about various incompatibilities with
00317      traditional C.  */
00318   unsigned char warn_traditional;
00319 
00320   /* Nonzero means warn about long long numeric constants.  */
00321   unsigned char warn_long_long;
00322 
00323   /* Nonzero means warn about text after an #endif (or #else).  */
00324   unsigned char warn_endif_labels;
00325 
00326   /* Nonzero means warn about implicit sign changes owing to integer
00327      promotions.  */
00328   unsigned char warn_num_sign_change;
00329 
00330   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
00331      Presumably the usage is protected by the appropriate #ifdef.  */
00332   unsigned char warn_variadic_macros;
00333 
00334   /* Nonzero means turn warnings into errors.  */
00335   unsigned char warnings_are_errors;
00336 
00337   /* Nonzero means we should look for header.gcc files that remap file
00338      names.  */
00339   unsigned char remap;
00340 
00341   /* Zero means dollar signs are punctuation.  */
00342   unsigned char dollars_in_ident;
00343 
00344   /* Nonzero means UCNs are accepted in identifiers.  */
00345   unsigned char extended_identifiers;
00346 
00347   /* True if we should warn about dollars in identifiers or numbers
00348      for this translation unit.  */
00349   unsigned char warn_dollars;
00350 
00351   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
00352   unsigned char warn_undef;
00353 
00354   /* Nonzero means warn of unused macros from the main file.  */
00355   unsigned char warn_unused_macros;
00356 
00357   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
00358   unsigned char c99;
00359 
00360   /* Nonzero if we are conforming to a specific C or C++ standard.  */
00361   unsigned char std;
00362 
00363   /* Nonzero means give all the error messages the ANSI standard requires.  */
00364   unsigned char pedantic;
00365 
00366   /* Nonzero means we're looking at already preprocessed code, so don't
00367      bother trying to do macro expansion and whatnot.  */
00368   unsigned char preprocessed;
00369 
00370   /* Print column number in error messages.  */
00371   unsigned char show_column;
00372 
00373   /* Nonzero means handle C++ alternate operator names.  */
00374   unsigned char operator_names;
00375 
00376   /* True for traditional preprocessing.  */
00377   unsigned char traditional;
00378 
00379   /* Holds the name of the target (execution) character set.  */
00380   const char *narrow_charset;
00381 
00382   /* Holds the name of the target wide character set.  */
00383   const char *wide_charset;
00384 
00385   /* Holds the name of the input character set.  */
00386   const char *input_charset;
00387 
00388   /* The minimum permitted level of normalization before a warning
00389      is generated.  */
00390   enum cpp_normalize_level warn_normalize;
00391 
00392   /* True to warn about precompiled header files we couldn't use.  */
00393   bool warn_invalid_pch;
00394 
00395   /* True if dependencies should be restored from a precompiled header.  */
00396   bool restore_pch_deps;
00397 
00398   /* Dependency generation.  */
00399   struct
00400   {
00401     /* Style of header dependencies to generate.  */
00402     enum cpp_deps_style style;
00403 
00404     /* Assume missing files are generated files.  */
00405     bool missing_files;
00406 
00407     /* Generate phony targets for each dependency apart from the first
00408        one.  */
00409     bool phony_targets;
00410 
00411     /* If true, no dependency is generated on the main file.  */
00412     bool ignore_main_file;
00413   } deps;
00414 
00415   /* Target-specific features set by the front end or client.  */
00416 
00417   /* Precision for target CPP arithmetic, target characters, target
00418      ints and target wide characters, respectively.  */
00419   size_t precision, char_precision, int_precision, wchar_precision;
00420 
00421   /* True means chars (wide chars) are unsigned.  */
00422   bool unsigned_char, unsigned_wchar;
00423 
00424   /* True if the most significant byte in a word has the lowest
00425      address in memory.  */
00426   bool bytes_big_endian;
00427 
00428   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
00429   unsigned char stdc_0_in_system_headers;
00430 
00431   /* True means error callback should be used for diagnostics.  */
00432   bool client_diagnostic;
00433 };
00434 
00435 /* Callback for header lookup for HEADER, which is the name of a
00436    source file.  It is used as a method of last resort to find headers
00437    that are not otherwise found during the normal include processing.
00438    The return value is the malloced name of a header to try and open,
00439    if any, or NULL otherwise.  This callback is called only if the
00440    header is otherwise unfound.  */
00441 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
00442 
00443 /* Call backs to cpplib client.  */
00444 struct cpp_callbacks
00445 {
00446   /* Called when a new line of preprocessed output is started.  */
00447   void (*line_change) (cpp_reader *, const cpp_token *, int);
00448 
00449   /* Called when switching to/from a new file.
00450      The line_map is for the new file.  It is NULL if there is no new file.
00451      (In C this happens when done with <built-in>+<command line> and also
00452      when done with a main file.)  This can be used for resource cleanup.  */
00453   void (*file_change) (cpp_reader *, const struct line_map *);
00454 
00455   void (*dir_change) (cpp_reader *, const char *);
00456   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
00457        const char *, int, const cpp_token **);
00458   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
00459   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
00460   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
00461   void (*def_pragma) (cpp_reader *, unsigned int);
00462   int (*valid_pch) (cpp_reader *, const char *, int);
00463   void (*read_pch) (cpp_reader *, const char *, int, const char *);
00464   missing_header_cb missing_header;
00465 
00466   /* Called to emit a diagnostic if client_diagnostic option is true.
00467      This callback receives the translated message.  */
00468   void (*error) (cpp_reader *, int, const char *, va_list *)
00469        ATTRIBUTE_FPTR_PRINTF(3,0);
00470 };
00471 
00472 /* Chain of directories to look for include files in.  */
00473 struct cpp_dir
00474 {
00475   /* NULL-terminated singly-linked list.  */
00476   struct cpp_dir *next;
00477 
00478   /* NAME of the directory, NUL-terminated.  */
00479   char *name;
00480   unsigned int len;
00481 
00482   /* One if a system header, two if a system header that has extern
00483      "C" guards for C++.  */
00484   unsigned char sysp;
00485 
00486   /* Mapping of file names for this directory for MS-DOS and related
00487      platforms.  A NULL-terminated array of (from, to) pairs.  */
00488   const char **name_map;
00489 
00490   /* Routine to construct pathname, given the search path name and the
00491      HEADER we are trying to find, return a constructed pathname to
00492      try and open.  If this is NULL, the constructed pathname is as
00493      constructed by append_file_to_dir.  */
00494   char *(*construct) (const char *header, cpp_dir *dir);
00495 
00496   /* The C front end uses these to recognize duplicated
00497      directories in the search path.  */
00498   ino_t ino;
00499   dev_t dev;
00500 
00501   /* Is this a user-supplied directory? */
00502   bool user_supplied_p;
00503 };
00504 
00505 /* Name under which this program was invoked.  */
00506 extern const char *progname;
00507 
00508 /* The structure of a node in the hash table.  The hash table has
00509    entries for all identifiers: either macros defined by #define
00510    commands (type NT_MACRO), assertions created with #assert
00511    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
00512    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
00513    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
00514    identifier that behaves like an operator such as "xor".
00515    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
00516    diagnostic may be required for this node.  Currently this only
00517    applies to __VA_ARGS__ and poisoned identifiers.  */
00518 
00519 /* Hash node flags.  */
00520 #define NODE_OPERATOR (1 << 0)  /* C++ named operator.  */
00521 #define NODE_POISONED (1 << 1)  /* Poisoned identifier.  */
00522 #define NODE_BUILTIN  (1 << 2)  /* Builtin macro.  */
00523 #define NODE_DIAGNOSTIC (1 << 3)  /* Possible diagnostic when lexed.  */
00524 #define NODE_WARN (1 << 4)  /* Warn if redefined or undefined.  */
00525 #define NODE_DISABLED (1 << 5)  /* A disabled macro.  */
00526 #define NODE_MACRO_ARG  (1 << 6)  /* Used during #define processing.  */
00527 
00528 /* Different flavors of hash node.  */
00529 enum node_type
00530 {
00531   NT_VOID = 0,     /* No definition yet.  */
00532   NT_MACRO,    /* A macro of some form.  */
00533   NT_ASSERTION     /* Predicate for #assert.  */
00534 };
00535 
00536 /* Different flavors of builtin macro.  _Pragma is an operator, but we
00537    handle it with the builtin code for efficiency reasons.  */
00538 enum builtin_type
00539 {
00540   BT_SPECLINE = 0,    /* `__LINE__' */
00541   BT_DATE,      /* `__DATE__' */
00542   BT_FILE,      /* `__FILE__' */
00543   BT_BASE_FILE,     /* `__BASE_FILE__' */
00544   BT_INCLUDE_LEVEL,   /* `__INCLUDE_LEVEL__' */
00545   BT_TIME,      /* `__TIME__' */
00546   BT_STDC,      /* `__STDC__' */
00547   BT_PRAGMA,      /* `_Pragma' operator */
00548   BT_TIMESTAMP      /* `__TIMESTAMP__' */
00549 };
00550 
00551 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
00552 #define HT_NODE(NODE)   ((ht_identifier *) (NODE))
00553 #define NODE_LEN(NODE)    HT_LEN (&(NODE)->ident)
00554 #define NODE_NAME(NODE)   HT_STR (&(NODE)->ident)
00555 
00556 /* Specify which field, if any, of the union is used.  */
00557 
00558 enum {
00559   NTV_MACRO,
00560   NTV_ANSWER,
00561   NTV_BUILTIN,
00562   NTV_ARGUMENT,
00563   NTV_NONE
00564 };
00565 
00566 #define CPP_HASHNODE_VALUE_IDX(HNODE)       \
00567   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT    \
00568    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN)   \
00569              ? NTV_BUILTIN : NTV_MACRO) \
00570    : HNODE.type == NT_ASSERTION ? NTV_ANSWER      \
00571    : NTV_NONE)
00572 
00573 /* The common part of an identifier node shared amongst all 3 C front
00574    ends.  Also used to store CPP identifiers, which are a superset of
00575    identifiers in the grammatical sense.  */
00576 
00577 union _cpp_hashnode_value GTY(())
00578 {
00579   /* If a macro.  */
00580   cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
00581   /* Answers to an assertion.  */
00582   struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
00583   /* Code for a builtin macro.  */
00584   enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
00585   /* Macro argument index.  */
00586   unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
00587 };
00588 
00589 struct cpp_hashnode GTY(())
00590 {
00591   struct ht_identifier ident;
00592   unsigned int is_directive : 1;
00593   unsigned int directive_index : 7; /* If is_directive,
00594              then index into directive table.
00595              Otherwise, a NODE_OPERATOR.  */
00596   unsigned char rid_code;   /* Rid code - for front ends.  */
00597   ENUM_BITFIELD(node_type) type : 8;  /* CPP node type.  */
00598   unsigned char flags;      /* CPP flags.  */
00599 
00600   union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
00601 };
00602 
00603 /* Call this first to get a handle to pass to other functions.
00604 
00605    If you want cpplib to manage its own hashtable, pass in a NULL
00606    pointer.  Otherwise you should pass in an initialized hash table
00607    that cpplib will share; this technique is used by the C front
00608    ends.  */
00609 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
00610               struct line_maps *);
00611 
00612 /* Call this to change the selected language standard (e.g. because of
00613    command line options).  */
00614 extern void cpp_set_lang (cpp_reader *, enum c_lang);
00615 
00616 /* Set the include paths.  */
00617 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
00618 
00619 /* Call these to get pointers to the options, callback, and deps
00620    structures for a given reader.  These pointers are good until you
00621    call cpp_finish on that reader.  You can either edit the callbacks
00622    through the pointer returned from cpp_get_callbacks, or set them
00623    with cpp_set_callbacks.  */
00624 extern cpp_options *cpp_get_options (cpp_reader *);
00625 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
00626 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
00627 extern struct deps *cpp_get_deps (cpp_reader *);
00628 
00629 /* This function reads the file, but does not start preprocessing.  It
00630    returns the name of the original file; this is the same as the
00631    input file, except for preprocessed input.  This will generate at
00632    least one file change callback, and possibly a line change callback
00633    too.  If there was an error opening the file, it returns NULL.  */
00634 extern const char *cpp_read_main_file (cpp_reader *, const char *);
00635 
00636 /* Set up built-ins like __FILE__.  */
00637 extern void cpp_init_builtins (cpp_reader *, int);
00638 
00639 /* This is called after options have been parsed, and partially
00640    processed.  */
00641 extern void cpp_post_options (cpp_reader *);
00642 
00643 /* Set up translation to the target character set.  */
00644 extern void cpp_init_iconv (cpp_reader *);
00645 
00646 /* Call this to finish preprocessing.  If you requested dependency
00647    generation, pass an open stream to write the information to,
00648    otherwise NULL.  It is your responsibility to close the stream.
00649 
00650    Returns cpp_errors (pfile).  */
00651 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
00652 
00653 /* Call this to release the handle at the end of preprocessing.  Any
00654    use of the handle after this function returns is invalid.  Returns
00655    cpp_errors (pfile).  */
00656 extern void cpp_destroy (cpp_reader *);
00657 
00658 /* Error count.  */
00659 extern unsigned int cpp_errors (cpp_reader *);
00660 
00661 extern unsigned int cpp_token_len (const cpp_token *);
00662 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
00663 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
00664                unsigned char *, bool);
00665 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
00666          void (*) (cpp_reader *), bool);
00667 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
00668             const char *, unsigned, bool, bool);
00669 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
00670           const cpp_token *);
00671 extern const cpp_token *cpp_get_token (cpp_reader *);
00672 extern const unsigned char *cpp_macro_definition (cpp_reader *,
00673               const cpp_hashnode *);
00674 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
00675 
00676 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
00677 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
00678             unsigned int *, int *);
00679 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
00680 extern bool cpp_interpret_string (cpp_reader *,
00681           const cpp_string *, size_t,
00682           cpp_string *, bool);
00683 extern bool cpp_interpret_string_notranslate (cpp_reader *,
00684                 const cpp_string *, size_t,
00685                 cpp_string *, bool);
00686 
00687 /* Convert a host character constant to the execution character set.  */
00688 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
00689 
00690 /* Used to register macros and assertions, perhaps from the command line.
00691    The text is the same as the command line argument.  */
00692 extern void cpp_define (cpp_reader *, const char *);
00693 extern void cpp_assert (cpp_reader *, const char *);
00694 extern void cpp_undef (cpp_reader *, const char *);
00695 extern void cpp_unassert (cpp_reader *, const char *);
00696 
00697 /* Undefine all macros and assertions.  */
00698 extern void cpp_undef_all (cpp_reader *);
00699 
00700 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
00701             size_t, int);
00702 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
00703 
00704 /* A preprocessing number.  Code assumes that any unused high bits of
00705    the double integer are set to zero.  */
00706 typedef unsigned HOST_WIDE_INT cpp_num_part;
00707 typedef struct cpp_num cpp_num;
00708 struct cpp_num
00709 {
00710   cpp_num_part high;
00711   cpp_num_part low;
00712   bool unsignedp;  /* True if value should be treated as unsigned.  */
00713   bool overflow;   /* True if the most recent calculation overflowed.  */
00714 };
00715 
00716 /* cpplib provides two interfaces for interpretation of preprocessing
00717    numbers.
00718 
00719    cpp_classify_number categorizes numeric constants according to
00720    their field (integer, floating point, or invalid), radix (decimal,
00721    octal, hexadecimal), and type suffixes.  */
00722 
00723 #define CPP_N_CATEGORY  0x000F
00724 #define CPP_N_INVALID 0x0000
00725 #define CPP_N_INTEGER 0x0001
00726 #define CPP_N_FLOATING  0x0002
00727 
00728 #define CPP_N_WIDTH 0x00F0
00729 #define CPP_N_SMALL 0x0010  /* int, float.  */
00730 #define CPP_N_MEDIUM  0x0020  /* long, double.  */
00731 #define CPP_N_LARGE 0x0040  /* long long, long double.  */
00732 
00733 #define CPP_N_RADIX 0x0F00
00734 #define CPP_N_DECIMAL 0x0100
00735 #define CPP_N_HEX 0x0200
00736 #define CPP_N_OCTAL 0x0400
00737 
00738 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
00739 #define CPP_N_IMAGINARY 0x2000
00740 #define CPP_N_DFLOAT  0x4000
00741 
00742 /* Classify a CPP_NUMBER token.  The return value is a combination of
00743    the flags from the above sets.  */
00744 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
00745 
00746 /* Evaluate a token classified as category CPP_N_INTEGER.  */
00747 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
00748               unsigned int type);
00749 
00750 /* Sign extend a number, with PRECISION significant bits and all
00751    others assumed clear, to fill out a cpp_num structure.  */
00752 cpp_num cpp_num_sign_extend (cpp_num, size_t);
00753 
00754 /* Diagnostic levels.  To get a diagnostic without associating a
00755    position in the translation unit with it, use cpp_error_with_line
00756    with a line number of zero.  */
00757 
00758 /* Warning, an error with -Werror.  */
00759 #define CPP_DL_WARNING    0x00
00760 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
00761 #define CPP_DL_WARNING_SYSHDR 0x01
00762 /* Warning, an error with -pedantic-errors or -Werror.  */
00763 #define CPP_DL_PEDWARN    0x02
00764 /* An error.  */
00765 #define CPP_DL_ERROR    0x03
00766 /* An internal consistency check failed.  Prints "internal error: ",
00767    otherwise the same as CPP_DL_ERROR.  */
00768 #define CPP_DL_ICE    0x04
00769 /* Extracts a diagnostic level from an int.  */
00770 #define CPP_DL_EXTRACT(l) (l & 0xf)
00771 /* Nonzero if a diagnostic level is one of the warnings.  */
00772 #define CPP_DL_WARNING_P(l) (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
00773          && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
00774 
00775 /* Output a diagnostic of some kind.  */
00776 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
00777   ATTRIBUTE_PRINTF_3;
00778 
00779 /* Output a diagnostic with "MSGID: " preceding the
00780    error string of errno.  No location is printed.  */
00781 extern void cpp_errno (cpp_reader *, int, const char *msgid);
00782 
00783 /* Same as cpp_error, except additionally specifies a position as a
00784    (translation unit) physical line and physical column.  If the line is
00785    zero, then no location is printed.  */
00786 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
00787          const char *msgid, ...) ATTRIBUTE_PRINTF_5;
00788 
00789 /* In cpplex.c */
00790 extern int cpp_ideq (const cpp_token *, const char *);
00791 extern void cpp_output_line (cpp_reader *, FILE *);
00792 extern void cpp_output_token (const cpp_token *, FILE *);
00793 extern const char *cpp_type2name (enum cpp_ttype);
00794 /* Returns the value of an escape sequence, truncated to the correct
00795    target precision.  PSTR points to the input pointer, which is just
00796    after the backslash.  LIMIT is how much text we have.  WIDE is true
00797    if the escape sequence is part of a wide character constant or
00798    string literal.  Handles all relevant diagnostics.  */
00799 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
00800            const unsigned char *limit, int wide);
00801 
00802 /* In cpphash.c */
00803 
00804 /* Lookup an identifier in the hashtable.  Puts the identifier in the
00805    table if it is not already there.  */
00806 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
00807          unsigned int);
00808 
00809 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
00810 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
00811 
00812 /* In cppmacro.c */
00813 extern void cpp_scan_nooutput (cpp_reader *);
00814 extern int  cpp_sys_macro_p (cpp_reader *);
00815 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
00816           unsigned int);
00817 
00818 /* In cppfiles.c */
00819 extern bool cpp_included (cpp_reader *, const char *);
00820 extern void cpp_make_system_header (cpp_reader *, int, int);
00821 extern bool cpp_push_include (cpp_reader *, const char *);
00822 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
00823 extern const char *cpp_get_path (struct _cpp_file *);
00824 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
00825 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
00826 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
00827 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
00828 
00829 /* In cpppch.c */
00830 struct save_macro_data;
00831 extern int cpp_save_state (cpp_reader *, FILE *);
00832 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
00833 extern int cpp_write_pch_state (cpp_reader *, FILE *);
00834 extern int cpp_valid_state (cpp_reader *, const char *, int);
00835 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
00836 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
00837          struct save_macro_data *);
00838 
00839 #ifdef __cplusplus
00840 }
00841 #endif
00842 
00843 #endif /* ! LIBCPP_CPPLIB_H */
00844