Open64: osprey/kg++fe/gnu/cpplib.h Source File

00001 /*
00002  * Copyright 2003, 2004, 2005, 2006 PathScale, Inc.  All Rights Reserved.
00003  */
00004 
00005 /* Definitions for CPP library.
00006    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
00007    Free Software Foundation, Inc.
00008    Written by Per Bothner, 1994-95.
00009 
00010 This program is free software; you can redistribute it and/or modify it
00011 under the terms of the GNU General Public License as published by the
00012 Free Software Foundation; either version 2, or (at your option) any
00013 later version.
00014 
00015 This program is distributed in the hope that it will be useful,
00016 but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 GNU General Public License for more details.
00019 
00020 You should have received a copy of the GNU General Public License
00021 along with this program; if not, write to the Free Software
00022 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00023 
00024  In other words, you are welcome to use, share and improve this program.
00025  You are forbidden to forbid anyone else to use, share and improve
00026  what you give them.   Help stamp out software-hoarding!  */
00027 #ifndef GCC_CPPLIB_H
00028 #define GCC_CPPLIB_H
00029 
00030 #include <sys/types.h>
00031 #include "hashtable.h"
00032 #include "line-map.h"
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 /* For complex reasons, cpp_reader is also typedefed in c-pragma.h.  */
00039 #ifndef GCC_C_PRAGMA_H
00040 typedef struct cpp_reader cpp_reader;
00041 #endif
00042 typedef struct cpp_buffer cpp_buffer;
00043 typedef struct cpp_options cpp_options;
00044 typedef struct cpp_token cpp_token;
00045 typedef struct cpp_string cpp_string;
00046 typedef struct cpp_hashnode cpp_hashnode;
00047 typedef struct cpp_macro cpp_macro;
00048 typedef struct cpp_callbacks cpp_callbacks;
00049 
00050 struct answer;
00051 struct file_name_map_list;
00052 
00053 /* The first three groups, apart from '=', can appear in preprocessor
00054    expressions (+= and -= are used to indicate unary + and - resp.).
00055    This allows a lookup table to be implemented in _cpp_parse_expr.
00056 
00057    The first group, to CPP_LAST_EQ, can be immediately followed by an
00058    '='.  The lexer needs operators ending in '=', like ">>=", to be in
00059    the same order as their counterparts without the '=', like ">>".  */
00060 
00061 /* Positions in the table.  */
00062 #define CPP_LAST_EQ CPP_MAX
00063 #define CPP_FIRST_DIGRAPH CPP_HASH
00064 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
00065 #define CPP_LAST_CPP_OP CPP_LESS_EQ
00066 
00067 #define TTYPE_TABLE       \
00068   OP(CPP_EQ = 0,  "=")      \
00069   OP(CPP_NOT,   "!")      \
00070   OP(CPP_GREATER, ">")  /* compare */ \
00071   OP(CPP_LESS,    "<")      \
00072   OP(CPP_PLUS,    "+")  /* math */  \
00073   OP(CPP_MINUS,   "-")      \
00074   OP(CPP_MULT,    "*")      \
00075   OP(CPP_DIV,   "/")      \
00076   OP(CPP_MOD,   "%")      \
00077   OP(CPP_AND,   "&")  /* bit ops */ \
00078   OP(CPP_OR,    "|")      \
00079   OP(CPP_XOR,   "^")      \
00080   OP(CPP_RSHIFT,  ">>")     \
00081   OP(CPP_LSHIFT,  "<<")     \
00082   OP(CPP_MIN,   "<?") /* extension */ \
00083   OP(CPP_MAX,   ">?")     \
00084 \
00085   OP(CPP_COMPL,   "~")      \
00086   OP(CPP_AND_AND, "&&") /* logical */ \
00087   OP(CPP_OR_OR,   "||")     \
00088   OP(CPP_QUERY,   "?")      \
00089   OP(CPP_COLON,   ":")      \
00090   OP(CPP_COMMA,   ",")  /* grouping */  \
00091   OP(CPP_OPEN_PAREN,  "(")      \
00092   OP(CPP_CLOSE_PAREN, ")")      \
00093   TK(CPP_EOF,   SPELL_NONE)   \
00094   OP(CPP_EQ_EQ,   "==") /* compare */ \
00095   OP(CPP_NOT_EQ,  "!=")     \
00096   OP(CPP_GREATER_EQ,  ">=")     \
00097   OP(CPP_LESS_EQ, "<=")     \
00098 \
00099   /* These two are unary + / - in preprocessor expressions.  */ \
00100   OP(CPP_PLUS_EQ, "+=") /* math */  \
00101   OP(CPP_MINUS_EQ,  "-=")     \
00102 \
00103   OP(CPP_MULT_EQ, "*=")     \
00104   OP(CPP_DIV_EQ,  "/=")     \
00105   OP(CPP_MOD_EQ,  "%=")     \
00106   OP(CPP_AND_EQ,  "&=") /* bit ops */ \
00107   OP(CPP_OR_EQ,   "|=")     \
00108   OP(CPP_XOR_EQ,  "^=")     \
00109   OP(CPP_RSHIFT_EQ, ">>=")      \
00110   OP(CPP_LSHIFT_EQ, "<<=")      \
00111   OP(CPP_MIN_EQ,  "<?=")  /* extension */ \
00112   OP(CPP_MAX_EQ,  ">?=")      \
00113   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */ \
00114   OP(CPP_HASH,    "#")  /* digraphs */  \
00115   OP(CPP_PASTE,   "##")     \
00116   OP(CPP_OPEN_SQUARE, "[")      \
00117   OP(CPP_CLOSE_SQUARE,  "]")      \
00118   OP(CPP_OPEN_BRACE,  "{")      \
00119   OP(CPP_CLOSE_BRACE, "}")      \
00120   /* The remainder of the punctuation.  Order is not significant.  */ \
00121   OP(CPP_SEMICOLON, ";")  /* structure */ \
00122   OP(CPP_ELLIPSIS,  "...")      \
00123   OP(CPP_PLUS_PLUS, "++") /* increment */ \
00124   OP(CPP_MINUS_MINUS, "--")     \
00125   OP(CPP_DEREF,   "->") /* accessors */ \
00126   OP(CPP_DOT,   ".")      \
00127   OP(CPP_SCOPE,   "::")     \
00128   OP(CPP_DEREF_STAR,  "->*")      \
00129   OP(CPP_DOT_STAR,  ".*")     \
00130   OP(CPP_ATSIGN,  "@")  /* used in Objective-C */ \
\
  TK(CPP_NAME,    SPELL_IDENT)  /* word */      \
  TK(CPP_NUMBER,  SPELL_NUMBER) /* 34_be+ta  */     \
\
  TK(CPP_CHAR,    SPELL_STRING) /* 'char' */      \
  TK(CPP_WCHAR,   SPELL_STRING) /* L'char' */     \
  TK(CPP_OTHER,   SPELL_CHAR) /* stray punctuation */   \
\
  TK(CPP_STRING,  SPELL_STRING) /* "string" */      \
00131   TK(CPP_WSTRING, SPELL_STRING) /* L"string" */     \
00132   TK(CPP_HEADER_NAME, SPELL_STRING) /* <stdio.h> in #include */ \
00133 \
00134   TK(CPP_COMMENT, SPELL_NUMBER) /* Only if output comments.  */ \
00135                                         /* SPELL_NUMBER happens to DTRT.  */ \
00136   TK(CPP_MACRO_ARG, SPELL_NONE) /* Macro argument.  */    \
00137   TK(CPP_PADDING, SPELL_NONE) /* Whitespace for cpp0.  */
00138 
00139 #define OP(e, s) e,
00140 #define TK(e, s) e,
00141 enum cpp_ttype
00142 {
00143   TTYPE_TABLE
00144   N_TTYPES
00145 };
00146 #undef OP
00147 #undef TK
00148 
00149 /* C language kind, used when calling cpp_reader_init.  */
00150 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
00151        CLK_GNUCXX, CLK_CXX98, CLK_ASM};
00152 
00153 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
00154 struct cpp_string
00155 {
00156   unsigned int len;
00157   const unsigned char *text;
00158 };
00159 
00160 /* Flags for the cpp_token structure.  */
00161 #define PREV_WHITE  (1 << 0) /* If whitespace before this token.  */
00162 #define DIGRAPH   (1 << 1) /* If it was a digraph.  */
00163 #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified.  */
00164 #define PASTE_LEFT  (1 << 3) /* If on LHS of a ## operator.  */
00165 #define NAMED_OP  (1 << 4) /* C++ named operators.  */
00166 #define NO_EXPAND (1 << 5) /* Do not macro-expand this token.  */
00167 #define BOL   (1 << 6) /* Token at beginning of line.  */
00168 
00169 /* A preprocessing token.  This has been carefully packed and should
00170    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
00171 struct cpp_token
00172 {
00173   unsigned int line;    /* Logical line of first char of token.  */
00174   unsigned short col;   /* Column of first char of token.  */
00175   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
00176   unsigned char flags;    /* flags - see above */
00177 
00178   union
00179   {
00180     cpp_hashnode *node;   /* An identifier.  */
00181     const cpp_token *source;  /* Inherit padding from this token.  */
00182     struct cpp_string str;  /* A string, or number.  */
00183     unsigned int arg_no;  /* Argument no. for a CPP_MACRO_ARG.  */
00184     unsigned char c;    /* Character represented by CPP_OTHER.  */
00185   } val;
00186 };
00187 
00188 /* A type wide enough to hold any multibyte source character.
00189    cpplib's character constant interpreter requires an unsigned type.
00190    Also, a typedef for the signed equivalent.  */
00191 #ifndef MAX_WCHAR_TYPE_SIZE
00192 # define MAX_WCHAR_TYPE_SIZE WCHAR_TYPE_SIZE
00193 #endif
00194 #if CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
00195 # define CPPCHAR_SIGNED_T int
00196 #else
00197 # if CHAR_BIT * SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG
00198 #  define CPPCHAR_SIGNED_T long
00199 # else
00200 #  define CPPCHAR_SIGNED_T long long
00201 # endif
00202 #endif
00203 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
00204 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
00205 
00206 /* Values for opts.dump_macros.
00207   dump_only means inhibit output of the preprocessed text
00208              and instead output the definitions of all user-defined
00209              macros in a form suitable for use as input to cpp.
00210    dump_names means pass #define and the macro name through to output.
00211    dump_definitions means pass the whole definition (plus #define) through
00212 */
00213 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
00214 
00215 /* This structure is nested inside struct cpp_reader, and
00216    carries all the options visible to the command line.  */
00217 struct cpp_options
00218 {
00219   /* Characters between tab stops.  */
00220   unsigned int tabstop;
00221 
00222   /* Pending options - -D, -U, -A, -I, -ixxx.  */
00223   struct cpp_pending *pending;
00224 
00225   /* Search paths for include files.  */
00226   struct search_path *quote_include;  /* "" */
00227   struct search_path *bracket_include;  /* <> */
00228 
00229   /* Map between header names and file names, used only on DOS where
00230      file names are limited in length.  */
00231   struct file_name_map_list *map_list;
00232 
00233   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
00234      in the standard include file directories.  */
00235   const char *include_prefix;
00236   unsigned int include_prefix_len;
00237 
00238   /* The language we're preprocessing.  */
00239   enum c_lang lang;
00240 
00241   /* Non-0 means -v, so print the full set of include dirs.  */
00242   unsigned char verbose;
00243 
00244   /* Nonzero means use extra default include directories for C++.  */
00245   unsigned char cplusplus;
00246 
00247   /* Nonzero means handle cplusplus style comments */
00248   unsigned char cplusplus_comments;
00249 
00250   /* Nonzero means define __OBJC__, treat @ as a special token, and
00251      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
00252   unsigned char objc;
00253 
00254   /* Nonzero means don't copy comments into the output file.  */
00255   unsigned char discard_comments;
00256 
00257   /* Nonzero means don't copy comments into the output file during
00258      macro expansion.  */
00259   unsigned char discard_comments_in_macro_exp;
00260 
00261   /* Nonzero means process the ISO trigraph sequences.  */
00262   unsigned char trigraphs;
00263 
00264   /* Nonzero means process the ISO digraph sequences.  */
00265   unsigned char digraphs;
00266 
00267   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
00268   unsigned char extended_numbers;
00269 
00270   /* Nonzero means print names of header files (-H).  */
00271   unsigned char print_include_names;
00272 
00273   /* Nonzero means cpp_pedwarn causes a hard error.  */
00274   unsigned char pedantic_errors;
00275 
00276   /* Nonzero means don't print warning messages.  */
00277   unsigned char inhibit_warnings;
00278 
00279   /* Nonzero means complain about deprecated features.  */
00280   unsigned char warn_deprecated;
00281 
00282   /* Nonzero means don't suppress warnings from system headers.  */
00283   unsigned char warn_system_headers;
00284 
00285   /* Nonzero means don't print error messages.  Has no option to
00286      select it, but can be set by a user of cpplib (e.g. fix-header).  */
00287   unsigned char inhibit_errors;
00288 
00289   /* Nonzero means warn if slash-star appears in a comment.  */
00290   unsigned char warn_comments;
00291 
00292   /* Nonzero means warn if there are any trigraphs.  */
00293   unsigned char warn_trigraphs;
00294 
00295   /* Nonzero means warn if #import is used.  */
00296   unsigned char warn_import;
00297 
00298   /* Nonzero means warn about multicharacter charconsts.  */
00299   unsigned char warn_multichar;
00300 
00301   /* Nonzero means warn about various incompatibilities with
00302      traditional C.  */
00303   unsigned char warn_traditional;
00304 
00305   /* Nonzero means warn about long long numeric constants.  */
00306   unsigned char warn_long_long;
00307 
00308   /* Nonzero means warn about text after an #endif (or #else).  */
00309   unsigned char warn_endif_labels;
00310 
00311   /* Nonzero means warn about implicit sign changes owing to integer
00312      promotions.  */
00313   unsigned char warn_num_sign_change;
00314 
00315   /* Nonzero means turn warnings into errors.  */
00316   unsigned char warnings_are_errors;
00317 
00318   /* Nonzero causes output not to be done, but directives such as
00319      #define that have side effects are still obeyed.  */
00320   unsigned char no_output;
00321 
00322   /* Nonzero means we should look for header.gcc files that remap file
00323      names.  */
00324   unsigned char remap;
00325 
00326   /* Nonzero means don't output line number information.  */
00327   unsigned char no_line_commands;
00328 
00329   /* Nonzero means -I- has been seen, so don't look for #include "foo"
00330      the source-file directory.  */
00331   unsigned char ignore_srcdir;
00332 
00333   /* Zero means dollar signs are punctuation.  */
00334   unsigned char dollars_in_ident;
00335 
00336   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
00337   unsigned char warn_undef;
00338 
00339   /* Nonzero means warn of unused macros from the main file.  */
00340   unsigned char warn_unused_macros;
00341 
00342   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
00343   unsigned char c99;
00344 
00345   /* Nonzero if we are conforming to a specific C or C++ standard.  */
00346   unsigned char std;
00347 
00348   /* Nonzero means give all the error messages the ANSI standard requires.  */
00349   unsigned char pedantic;
00350 
00351   /* Nonzero means we're looking at already preprocessed code, so don't
00352      bother trying to do macro expansion and whatnot.  */
00353   unsigned char preprocessed;
00354 
00355   /* Nonzero disables all the standard directories for headers.  */
00356   unsigned char no_standard_includes;
00357 
00358   /* Nonzero disables the C++-specific standard directories for headers.  */
00359   unsigned char no_standard_cplusplus_includes;
00360 
00361   /* Nonzero means dump macros in some fashion - see above.  */
00362   unsigned char dump_macros;
00363 
00364   /* Nonzero means pass #include lines through to the output.  */
00365   unsigned char dump_includes;
00366 
00367   /* Print column number in error messages.  */
00368   unsigned char show_column;
00369 
00370   /* Nonzero means handle C++ alternate operator names.  */
00371   unsigned char operator_names;
00372 
00373   /* True for traditional preprocessing.  */
00374   unsigned char traditional;
00375 
00376   /* Dependency generation.  */
00377   struct
00378   {
00379     /* Style of header dependencies to generate.  */
00380     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
00381 
00382     /* Assume missing files are generated files.  */
00383     bool missing_files;
00384 
00385     /* Generate phony targets for each dependency apart from the first
00386        one.  */
00387     bool phony_targets;
00388 
00389     /* If true, no dependency is generated on the main file.  */
00390     bool ignore_main_file;
00391   } deps;
00392 
00393   /* Target-specific features set by the front end or client.  */
00394 
00395   /* Precision for target CPP arithmetic, target characters, target
00396      ints and target wide characters, respectively.  */
00397   size_t precision, char_precision, int_precision, wchar_precision;
00398 
00399   /* True means chars (wide chars) are unsigned.  */
00400   bool unsigned_char, unsigned_wchar;
00401 
00402   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
00403   unsigned char stdc_0_in_system_headers;
00404 };
00405 
00406 /* Call backs.  */
00407 struct cpp_callbacks
00408 {
00409   /* Called when a new line of preprocessed output is started.  */
00410   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
00411   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
00412   void (*include) PARAMS ((cpp_reader *, unsigned int,
00413          const unsigned char *, const cpp_token *));
00414   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
00415   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
00416   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
00417   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
00418   /* Called when the client has a chance to properly register
00419      built-ins with cpp_define() and cpp_assert().  */
00420   void (*register_builtins) PARAMS ((cpp_reader *));
00421 };
00422 
00423 /* Name under which this program was invoked.  */
00424 extern const char *progname;
00425 
00426 /* The structure of a node in the hash table.  The hash table has
00427    entries for all identifiers: either macros defined by #define
00428    commands (type NT_MACRO), assertions created with #assert
00429    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
00430    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
00431    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
00432    identifier that behaves like an operator such as "xor".
00433    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
00434    diagnostic may be required for this node.  Currently this only
00435    applies to __VA_ARGS__ and poisoned identifiers.  */
00436 
00437 /* Hash node flags.  */
00438 #define NODE_OPERATOR (1 << 0)  /* C++ named operator.  */
00439 #define NODE_POISONED (1 << 1)  /* Poisoned identifier.  */
00440 #define NODE_BUILTIN  (1 << 2)  /* Builtin macro.  */
00441 #define NODE_DIAGNOSTIC (1 << 3)  /* Possible diagnostic when lexed.  */
00442 #define NODE_WARN (1 << 4)  /* Warn if redefined or undefined.  */
00443 #define NODE_DISABLED (1 << 5)  /* A disabled macro.  */
00444 
00445 /* Different flavors of hash node.  */
00446 enum node_type
00447 {
00448   NT_VOID = 0,     /* No definition yet.  */
00449   NT_MACRO,    /* A macro of some form.  */
00450   NT_ASSERTION     /* Predicate for #assert.  */
00451 };
00452 
00453 /* Different flavors of builtin macro.  _Pragma is an operator, but we
00454    handle it with the builtin code for efficiency reasons.  */
00455 enum builtin_type
00456 {
00457   BT_SPECLINE = 0,    /* `__LINE__' */
00458   BT_DATE,      /* `__DATE__' */
00459   BT_FILE,      /* `__FILE__' */
00460   BT_BASE_FILE,     /* `__BASE_FILE__' */
00461   BT_INCLUDE_LEVEL,   /* `__INCLUDE_LEVEL__' */
00462   BT_TIME,      /* `__TIME__' */
00463   BT_STDC,      /* `__STDC__' */
00464   BT_PRAGMA     /* `_Pragma' operator */
00465 };
00466 
00467 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
00468 #define HT_NODE(NODE)   ((ht_identifier *) (NODE))
00469 #define NODE_LEN(NODE)    HT_LEN (&(NODE)->ident)
00470 #define NODE_NAME(NODE)   HT_STR (&(NODE)->ident)
00471 
00472 /* The common part of an identifier node shared amongst all 3 C front
00473    ends.  Also used to store CPP identifiers, which are a superset of
00474    identifiers in the grammatical sense.  */
00475 struct cpp_hashnode
00476 {
00477   struct ht_identifier ident;
00478   unsigned short arg_index;   /* Macro argument index.  */
00479   unsigned char directive_index;  /* Index into directive table.  */
00480   unsigned char rid_code;   /* Rid code - for front ends.  */
00481   ENUM_BITFIELD(node_type) type : 8;  /* CPP node type.  */
00482   unsigned char flags;      /* CPP flags.  */
00483 
00484   union
00485   {
00486     cpp_macro *macro;     /* If a macro.  */
00487     struct answer *answers;   /* Answers to an assertion.  */
00488 #ifdef SGI_MONGOOSE
00489     enum cpp_ttype operator_code;       /* Code for a named operator.  */
00490 #else
00491     enum cpp_ttype operator;    /* Code for a named operator.  */
00492 #endif /* SGI_MONGOOSE */
00493     enum builtin_type builtin;    /* Code for a builtin macro.  */
00494   } value;
00495 };
00496 
00497 /* Call this first to get a handle to pass to other functions.  */
00498 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
00499 
00500 /* Call this to change the selected language standard (e.g. because of
00501    command line options).  */
00502 extern void cpp_set_lang PARAMS ((cpp_reader *, enum c_lang));
00503 
00504 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
00505    called any number of times before cpp_read_main_file().  If no
00506    targets have been added before cpp_read_main_file(), then the
00507    default target is used.  */
00508 extern void cpp_add_dependency_target PARAMS ((cpp_reader *,
00509                  const char * target,
00510                  int quote));
00511 
00512 /* Call these to get pointers to the options and callback structures
00513    for a given reader.  These pointers are good until you call
00514    cpp_finish on that reader.  You can either edit the callbacks
00515    through the pointer returned from cpp_get_callbacks, or set them
00516    with cpp_set_callbacks.  */
00517 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
00518 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
00519 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
00520 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
00521 
00522 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
00523    return value is the number of arguments used.  If
00524    cpp_handle_options returns without using all arguments, it couldn't
00525    understand the next switch.  Options processing is not completed
00526    until you call cpp_finish_options.  */
00527 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
00528 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
00529 
00530 /* This function reads the file, but does not start preprocessing.  It
00531    returns the name of the original file; this is the same as the
00532    input file, except for preprocessed input.  This will generate at
00533    least one file change callback, and possibly a line change callback
00534    too.  If there was an error opening the file, it returns NULL.
00535 
00536    If you want cpplib to manage its own hashtable, pass in a NULL
00537    pointer.  Otherise you should pass in an initialized hash table
00538    that cpplib will share; this technique is used by the C front
00539    ends.  */
00540 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
00541                  struct ht *));
00542 
00543 /* Deferred handling of command line options that can generate debug
00544    callbacks, such as -D and -imacros.  Call this after
00545    cpp_read_main_file.  The front ends need this separation so they
00546    can initialize debug output with the original file name, returned
00547    from cpp_read_main_file, before they get debug callbacks.  */
00548 extern void cpp_finish_options PARAMS ((cpp_reader *));
00549 
00550 /* Call this to finish preprocessing.  If you requested dependency
00551    generation, pass an open stream to write the information to,
00552    otherwise NULL.  It is your responsibility to close the stream.
00553 
00554    Returns cpp_errors (pfile).  */
00555 extern int cpp_finish PARAMS ((cpp_reader *, FILE *deps_stream));
00556 
00557 /* Call this to release the handle at the end of preprocessing.  Any
00558    use of the handle after this function returns is invalid.  Returns
00559    cpp_errors (pfile).  */
00560 extern void cpp_destroy PARAMS ((cpp_reader *));
00561 
00562 /* Error count.  */
00563 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
00564 
00565 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
00566 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
00567              const cpp_token *));
00568 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
00569                  unsigned char *));
00570 extern void cpp_register_pragma PARAMS ((cpp_reader *,
00571            const char *, const char *,
00572            void (*) PARAMS ((cpp_reader *))));
00573 
00574 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
00575             const cpp_token *));
00576 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
00577 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
00578               const cpp_hashnode *));
00579 extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
00580 
00581 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
00582 extern cppchar_t
00583 cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
00584          unsigned int *, int *));
00585 
00586 /* Used to register builtins during the register_builtins callback.
00587    The text is the same as the command line argument.  */
00588 extern void cpp_define PARAMS ((cpp_reader *, const char *));
00589 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
00590 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
00591 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
00592 
00593 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
00594               const unsigned char *, size_t,
00595               int, int));
00596 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
00597 
00598 /* A preprocessing number.  Code assumes that any unused high bits of
00599    the double integer are set to zero.  */
00600 typedef unsigned HOST_WIDE_INT cpp_num_part;
00601 typedef struct cpp_num cpp_num;
00602 struct cpp_num
00603 {
00604   cpp_num_part high;
00605   cpp_num_part low;
00606   bool unsignedp;  /* True if value should be treated as unsigned.  */
00607   bool overflow;   /* True if the most recent calculation overflowed.  */
00608 };
00609 
00610 /* cpplib provides two interfaces for interpretation of preprocessing
00611    numbers.
00612 
00613    cpp_classify_number categorizes numeric constants according to
00614    their field (integer, floating point, or invalid), radix (decimal,
00615    octal, hexadecimal), and type suffixes.  */
00616 
00617 #define CPP_N_CATEGORY  0x000F
00618 #define CPP_N_INVALID 0x0000
00619 #define CPP_N_INTEGER 0x0001
00620 #define CPP_N_FLOATING  0x0002
00621 
00622 #define CPP_N_WIDTH 0x00F0
00623 #define CPP_N_SMALL 0x0010  /* int, float.  */
00624 #define CPP_N_MEDIUM  0x0020  /* long, double.  */
00625 #define CPP_N_LARGE 0x0040  /* long long, long double.  */
00626 
00627 #define CPP_N_RADIX 0x0F00
00628 #define CPP_N_DECIMAL 0x0100
00629 #define CPP_N_HEX 0x0200
00630 #define CPP_N_OCTAL 0x0400
00631 
00632 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
00633 #define CPP_N_IMAGINARY 0x2000
00634 
00635 /* Classify a CPP_NUMBER token.  The return value is a combination of
00636    the flags from the above sets.  */
00637 extern unsigned cpp_classify_number PARAMS ((cpp_reader *, const cpp_token *));
00638 
00639 /* Evaluate a token classified as category CPP_N_INTEGER.  */
00640 extern cpp_num cpp_interpret_integer PARAMS ((cpp_reader *, const cpp_token *,
00641                 unsigned int type));
00642 
00643 /* Sign extend a number, with PRECISION significant bits and all
00644    others assumed clear, to fill out a cpp_num structure.  */
00645 cpp_num cpp_num_sign_extend PARAMS ((cpp_num, size_t));
00646 
00647 /* Diagnostic levels.  To get a dianostic without associating a
00648    position in the translation unit with it, use cpp_error_with_line
00649    with a line number of zero.  */
00650 
00651 /* Warning, an error with -Werror.  */
00652 #define DL_WARNING    0x00
00653 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
00654 #define DL_WARNING_SYSHDR 0x01
00655 /* Warning, an error with -pedantic-errors or -Werror.  */
00656 #define DL_PEDWARN    0x02
00657 /* An error.  */
00658 #define DL_ERROR    0x03
00659 /* An internal consistency check failed.  Prints "internal error: ",
00660    otherwise the same as DL_ERROR.  */
00661 #define DL_ICE      0x04
00662 /* Extracts a diagnostic level from an int.  */
00663 #define DL_EXTRACT(l)   (l & 0xf)
00664 /* Nonzero if a diagnostic level is one of the warnings.  */
00665 #define DL_WARNING_P(l)   (DL_EXTRACT (l) >= DL_WARNING \
00666          && DL_EXTRACT (l) <= DL_PEDWARN)
00667 
00668 /* N.B. The error-message-printer prototypes have not been nicely
00669    formatted because exgettext needs to see 'msgid' on the same line
00670    as the name of the function in order to work properly.  Only the
00671    string argument gets a name in an effort to keep the lines from
00672    getting ridiculously oversized.  */
00673 
00674 /* Output a diagnostic of some kind.  */
00675 extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
00676   ATTRIBUTE_PRINTF_3;
00677 
00678 /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
00679    error string of errno.  No location is printed.  */
00680 extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
00681 
00682 /* Same as cpp_error, except additionally specifies a position as a
00683    (translation unit) physical line and physical column.  If the line is
00684    zero, then no location is printed.  */
00685 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
00686   ATTRIBUTE_PRINTF_5;
00687 
00688 /* In cpplex.c */
00689 extern int cpp_ideq     PARAMS ((const cpp_token *,
00690              const char *));
00691 extern void cpp_output_line   PARAMS ((cpp_reader *, FILE *));
00692 extern void cpp_output_token    PARAMS ((const cpp_token *, FILE *));
00693 extern const char *cpp_type2name  PARAMS ((enum cpp_ttype));
00694 /* Returns the value of an escape sequence, truncated to the correct
00695    target precision.  PSTR points to the input pointer, which is just
00696    after the backslash.  LIMIT is how much text we have.  WIDE is true
00697    if the escape sequence is part of a wide character constant or
00698    string literal.  Handles all relevant diagnostics.  */
00699 extern cppchar_t cpp_parse_escape PARAMS ((cpp_reader *,
00700              const unsigned char ** pstr,
00701              const unsigned char *limit,
00702              int wide));
00703 
00704 /* In cpphash.c */
00705 
00706 /* Lookup an identifier in the hashtable.  Puts the identifier in the
00707    table if it is not already there.  */
00708 extern cpp_hashnode *cpp_lookup   PARAMS ((cpp_reader *,
00709              const unsigned char *,
00710              unsigned int));
00711 
00712 typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
00713 extern void cpp_forall_identifiers  PARAMS ((cpp_reader *,
00714              cpp_cb, void *));
00715 
00716 /* In cppmacro.c */
00717 extern void cpp_scan_nooutput   PARAMS ((cpp_reader *));
00718 extern int  cpp_sys_macro_p   PARAMS ((cpp_reader *));
00719 extern unsigned char *cpp_quote_string  PARAMS ((unsigned char *,
00720              const unsigned char *,
00721              unsigned int));
00722 
00723 /* In cppfiles.c */
00724 extern int cpp_included PARAMS ((cpp_reader *, const char *));
00725 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
00726 
00727 /* In cppmain.c */
00728 extern void cpp_preprocess_file PARAMS ((cpp_reader *, const char *, FILE *));
00729 
00730 #ifdef __cplusplus
00731 }
00732 #endif
00733 
00734 #endif /* ! GCC_CPPLIB_H */
00735