osprey-gcc/libcpp/include/cpplib.h

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

---