gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   3    Free Software Foundation, Inc.
   4    Written by Per Bothner, 1994-95.
   5
   6 This program is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20  In other words, you are welcome to use, share and improve this program.
  21  You are forbidden to forbid anyone else to use, share and improve
  22  what you give them.   Help stamp out software-hoarding!  */
  23 #ifndef GCC_CPPLIB_H
  24 #define GCC_CPPLIB_H
  25
  26 #include <sys/types.h>
  27 #include "hashtable.h"
  28 #include "line-map.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 typedef struct cpp_reader cpp_reader;
  35 typedef struct cpp_buffer cpp_buffer;
  36 typedef struct cpp_options cpp_options;
  37 typedef struct cpp_token cpp_token;
  38 typedef struct cpp_string cpp_string;
  39 typedef struct cpp_hashnode cpp_hashnode;
  40 typedef struct cpp_macro cpp_macro;
  41 typedef struct cpp_callbacks cpp_callbacks;
  42
  43 struct answer;
  44 struct file_name_map_list;
  45
  46 /* The first three groups, apart from '=', can appear in preprocessor
  47    expressions (+= and -= are used to indicate unary + and - resp.).
  48    This allows a lookup table to be implemented in _cpp_parse_expr.
  49
  50    The first group, to CPP_LAST_EQ, can be immediately followed by an
  51    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  52    the same order as their counterparts without the '=', like ">>".  */
  53
  54 /* Positions in the table.  */
  55 #define CPP_LAST_EQ CPP_MAX
  56 #define CPP_FIRST_DIGRAPH CPP_HASH
  57 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  58 #define CPP_LAST_CPP_OP CPP_LESS_EQ
  59
  60 #define TTYPE_TABLE                             \
  61   OP(CPP_EQ = 0,        "=")                    \
  62   OP(CPP_NOT,           "!")                    \
  63   OP(CPP_GREATER,       ">")    /* compare */   \
  64   OP(CPP_LESS,          "<")                    \
  65   OP(CPP_PLUS,          "+")    /* math */      \
  66   OP(CPP_MINUS,         "-")                    \
  67   OP(CPP_MULT,          "*")                    \
  68   OP(CPP_DIV,           "/")                    \
  69   OP(CPP_MOD,           "%")                    \
  70   OP(CPP_AND,           "&")    /* bit ops */   \
  71   OP(CPP_OR,            "|")                    \
  72   OP(CPP_XOR,           "^")                    \
  73   OP(CPP_RSHIFT,        ">>")                   \
  74   OP(CPP_LSHIFT,        "<<")                   \
  75   OP(CPP_MIN,           "<?")   /* extension */ \
  76   OP(CPP_MAX,           ">?")                   \
  77 \
  78   OP(CPP_COMPL,         "~")                    \
  79   OP(CPP_AND_AND,       "&&")   /* logical */   \
  80   OP(CPP_OR_OR,         "||")                   \
  81   OP(CPP_QUERY,         "?")                    \
  82   OP(CPP_COLON,         ":")                    \
  83   OP(CPP_COMMA,         ",")    /* grouping */  \
  84   OP(CPP_OPEN_PAREN,    "(")                    \
  85   OP(CPP_CLOSE_PAREN,   ")")                    \
  86   TK(CPP_EOF,           SPELL_NONE)             \
  87   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  88   OP(CPP_NOT_EQ,        "!=")                   \
  89   OP(CPP_GREATER_EQ,    ">=")                   \
  90   OP(CPP_LESS_EQ,       "<=")                   \
  91 \
  92   /* These two are unary + / - in preprocessor expressions.  */ \
  93   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  94   OP(CPP_MINUS_EQ,      "-=")                   \
  95 \
  96   OP(CPP_MULT_EQ,       "*=")                   \
  97   OP(CPP_DIV_EQ,        "/=")                   \
  98   OP(CPP_MOD_EQ,        "%=")                   \
  99   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 100   OP(CPP_OR_EQ,         "|=")                   \
 101   OP(CPP_XOR_EQ,        "^=")                   \
 102   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 103   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 104   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 105   OP(CPP_MAX_EQ,        ">?=")                  \
 106   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 107   OP(CPP_HASH,          "#")    /* digraphs */  \
 108   OP(CPP_PASTE,         "##")                   \
 109   OP(CPP_OPEN_SQUARE,   "[")                    \
 110   OP(CPP_CLOSE_SQUARE,  "]")                    \
 111   OP(CPP_OPEN_BRACE,    "{")                    \
 112   OP(CPP_CLOSE_BRACE,   "}")                    \
 113   /* The remainder of the punctuation.  Order is not significant.  */   \
 114   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 115   OP(CPP_ELLIPSIS,      "...")                  \
 116   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 117   OP(CPP_MINUS_MINUS,   "--")                   \
 118   OP(CPP_DEREF,         "->")   /* accessors */ \
 119   OP(CPP_DOT,           ".")                    \
 120   OP(CPP_SCOPE,         "::")                   \
 121   OP(CPP_DEREF_STAR,    "->*")                  \
 122   OP(CPP_DOT_STAR,      ".*")                   \
 123   OP(CPP_ATSIGN,        "@")  /* used in Objective-C */ \
 124 \
 125   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 126   TK(CPP_NUMBER,        SPELL_NUMBER)   /* 34_be+ta  */                 \
 127 \
 128   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 129   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 130   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 131 \
 132   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 133   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 134   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 135 \
 136   TK(CPP_COMMENT,       SPELL_NUMBER)   /* Only if output comments.  */ \
 137                                         /* SPELL_NUMBER happens to DTRT.  */ \
 138   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 139   TK(CPP_PADDING,       SPELL_NONE)     /* Whitespace for cpp0.  */
 140
 141 #define OP(e, s) e,
 142 #define TK(e, s) e,
 143 enum cpp_ttype
 144 {
 145   TTYPE_TABLE
 146   N_TTYPES
 147 };
 148 #undef OP
 149 #undef TK
 150
 151 /* C language kind, used when calling cpp_reader_init.  */
 152 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
 153              CLK_GNUCXX, CLK_CXX98, CLK_ASM};
 154
 155 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
 156 struct cpp_string
 157 {
 158   unsigned int len;
 159   const unsigned char *text;
 160 };
 161
 162 /* Flags for the cpp_token structure.  */
 163 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 164 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 165 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 166 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 167 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
 168 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 169 #define BOL             (1 << 6) /* Token at beginning of line.  */
 170
 171 /* A preprocessing token.  This has been carefully packed and should
 172    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 173 struct cpp_token
 174 {
 175   unsigned int line;            /* Logical line of first char of token.  */
 176   unsigned short col;           /* Column of first char of token.  */
 177   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 178   unsigned char flags;          /* flags - see above */
 179
 180   union
 181   {
 182     cpp_hashnode *node;         /* An identifier.  */
 183     const cpp_token *source;    /* Inherit padding from this token.  */
 184     struct cpp_string str;      /* A string, or number.  */
 185     unsigned int arg_no;        /* Argument no. for a CPP_MACRO_ARG.  */
 186     unsigned char c;            /* Character represented by CPP_OTHER.  */
 187   } val;
 188 };
 189
 190 /* A type wide enough to hold any multibyte source character.
 191    cpplib's character constant interpreter requires an unsigned type.
 192    Also, a typedef for the signed equivalent.  */
 193 #ifndef MAX_WCHAR_TYPE_SIZE
 194 # define MAX_WCHAR_TYPE_SIZE WCHAR_TYPE_SIZE
 195 #endif
 196 #if CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
 197 # define CPPCHAR_SIGNED_T int
 198 #else
 199 # if CHAR_BIT * SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG
 200 #  define CPPCHAR_SIGNED_T long
 201 # else
 202 #  define CPPCHAR_SIGNED_T long long
 203 # endif
 204 #endif
 205 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
 206 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
 207
 208 /* Values for opts.dump_macros.
 209   dump_only means inhibit output of the preprocessed text
 210              and instead output the definitions of all user-defined
 211              macros in a form suitable for use as input to cpp.
 212    dump_names means pass #define and the macro name through to output.
 213    dump_definitions means pass the whole definition (plus #define) through
 214 */
 215 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 216
 217 /* This structure is nested inside struct cpp_reader, and
 218    carries all the options visible to the command line.  */
 219 struct cpp_options
 220 {
 221   /* Characters between tab stops.  */
 222   unsigned int tabstop;
 223
 224   /* Pending options - -D, -U, -A, -I, -ixxx.  */
 225   struct cpp_pending *pending;
 226
 227   /* Search paths for include files.  */
 228   struct search_path *quote_include;    /* "" */
 229   struct search_path *bracket_include;  /* <> */
 230
 231   /* Map between header names and file names, used only on DOS where
 232      file names are limited in length.  */
 233   struct file_name_map_list *map_list;
 234
 235   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 236      in the standard include file directories.  */
 237   const char *include_prefix;
 238   unsigned int include_prefix_len;
 239
 240   /* Directory prefix for system include directories in the standard search
 241      path.  */
 242   const char *sysroot;
 243
 244   /* The language we're preprocessing.  */
 245   enum c_lang lang;
 246
 247   /* Non-0 means -v, so print the full set of include dirs.  */
 248   unsigned char verbose;
 249
 250   /* Nonzero means use extra default include directories for C++.  */
 251   unsigned char cplusplus;
 252
 253   /* Nonzero means handle cplusplus style comments */
 254   unsigned char cplusplus_comments;
 255
 256   /* Nonzero means define __OBJC__, treat @ as a special token, and
 257      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 258   unsigned char objc;
 259
 260   /* Nonzero means don't copy comments into the output file.  */
 261   unsigned char discard_comments;
 262
 263   /* Nonzero means don't copy comments into the output file during
 264      macro expansion.  */
 265   unsigned char discard_comments_in_macro_exp;
 266
 267   /* Nonzero means process the ISO trigraph sequences.  */
 268   unsigned char trigraphs;
 269
 270   /* Nonzero means process the ISO digraph sequences.  */
 271   unsigned char digraphs;
 272
 273   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 274   unsigned char extended_numbers;
 275
 276   /* Nonzero means print names of header files (-H).  */
 277   unsigned char print_include_names;
 278
 279   /* Nonzero means cpp_pedwarn causes a hard error.  */
 280   unsigned char pedantic_errors;
 281
 282   /* Nonzero means don't print warning messages.  */
 283   unsigned char inhibit_warnings;
 284
 285   /* Nonzero means complain about deprecated features.  */
 286   unsigned char warn_deprecated;
 287
 288   /* Nonzero means don't suppress warnings from system headers.  */
 289   unsigned char warn_system_headers;
 290
 291   /* Nonzero means don't print error messages.  Has no option to
 292      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 293   unsigned char inhibit_errors;
 294
 295   /* Nonzero means warn if slash-star appears in a comment.  */
 296   unsigned char warn_comments;
 297
 298   /* Nonzero means warn if there are any trigraphs.  */
 299   unsigned char warn_trigraphs;
 300
 301   /* Nonzero means warn if #import is used.  */
 302   unsigned char warn_import;
 303
 304   /* Nonzero means warn about multicharacter charconsts.  */
 305   unsigned char warn_multichar;
 306
 307   /* Nonzero means warn about various incompatibilities with
 308      traditional C.  */
 309   unsigned char warn_traditional;
 310
 311   /* Nonzero means warn about long long numeric constants.  */
 312   unsigned char warn_long_long;
 313
 314   /* Nonzero means warn about text after an #endif (or #else).  */
 315   unsigned char warn_endif_labels;
 316
 317   /* Nonzero means warn about implicit sign changes owing to integer
 318      promotions.  */
 319   unsigned char warn_num_sign_change;
 320
 321   /* Nonzero means turn warnings into errors.  */
 322   unsigned char warnings_are_errors;
 323
 324   /* Nonzero causes output not to be done, but directives such as
 325      #define that have side effects are still obeyed.  */
 326   unsigned char no_output;
 327
 328   /* Nonzero means we should look for header.gcc files that remap file
 329      names.  */
 330   unsigned char remap;
 331
 332   /* Nonzero means don't output line number information.  */
 333   unsigned char no_line_commands;
 334
 335   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 336      the source-file directory.  */
 337   unsigned char ignore_srcdir;
 338
 339   /* Zero means dollar signs are punctuation.  */
 340   unsigned char dollars_in_ident;
 341
 342   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 343   unsigned char warn_undef;
 344
 345   /* Nonzero means warn of unused macros from the main file.  */
 346   unsigned char warn_unused_macros;
 347
 348   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 349   unsigned char c99;
 350
 351   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 352   unsigned char std;
 353
 354   /* Nonzero means give all the error messages the ANSI standard requires.  */
 355   unsigned char pedantic;
 356
 357   /* Nonzero means we're looking at already preprocessed code, so don't
 358      bother trying to do macro expansion and whatnot.  */
 359   unsigned char preprocessed;
 360
 361   /* Nonzero disables all the standard directories for headers.  */
 362   unsigned char no_standard_includes;
 363
 364   /* Nonzero disables the C++-specific standard directories for headers.  */
 365   unsigned char no_standard_cplusplus_includes;
 366
 367   /* Nonzero means dump macros in some fashion - see above.  */
 368   unsigned char dump_macros;
 369
 370   /* Nonzero means pass #include lines through to the output.  */
 371   unsigned char dump_includes;
 372
 373   /* Print column number in error messages.  */
 374   unsigned char show_column;
 375
 376   /* Nonzero means handle C++ alternate operator names.  */
 377   unsigned char operator_names;
 378
 379   /* True for traditional preprocessing.  */
 380   unsigned char traditional;
 381
 382   /* Dependency generation.  */
 383   struct
 384   {
 385     /* Style of header dependencies to generate.  */
 386     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 387
 388     /* Assume missing files are generated files.  */
 389     bool missing_files;
 390
 391     /* Generate phony targets for each dependency apart from the first
 392        one.  */
 393     bool phony_targets;
 394
 395     /* If true, no dependency is generated on the main file.  */
 396     bool ignore_main_file;
 397   } deps;
 398
 399   /* Target-specific features set by the front end or client.  */
 400
 401   /* Precision for target CPP arithmetic, target characters, target
 402      ints and target wide characters, respectively.  */
 403   size_t precision, char_precision, int_precision, wchar_precision;
 404
 405   /* True means chars (wide chars) are unsigned.  */
 406   bool unsigned_char, unsigned_wchar;
 407
 408   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 409   unsigned char stdc_0_in_system_headers;
 410
 411   /* True to warn about precompiled header files we couldn't use.  */
 412   bool warn_invalid_pch;
 413
 414   /* True if dependencies should be restored from a precompiled header.  */
 415   bool restore_pch_deps;
 416 };
 417
 418 /* Call backs.  */
 419 struct cpp_callbacks
 420 {
 421   /* Called when a new line of preprocessed output is started.  */
 422   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
 423   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
 424   void (*include) PARAMS ((cpp_reader *, unsigned int,
 425                            const unsigned char *, const cpp_token *));
 426   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 427   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 428   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
 429   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
 430   /* Called when the client has a chance to properly register
 431      built-ins with cpp_define() and cpp_assert().  */
 432   void (*register_builtins) PARAMS ((cpp_reader *));
 433   int (*valid_pch) PARAMS ((cpp_reader *, const char *, int));
 434   void (*read_pch) PARAMS ((cpp_reader *, const char *, int, const char *));
 435 };
 436
 437 /* Name under which this program was invoked.  */
 438 extern const char *progname;
 439
 440 /* The structure of a node in the hash table.  The hash table has
 441    entries for all identifiers: either macros defined by #define
 442    commands (type NT_MACRO), assertions created with #assert
 443    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 444    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 445    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 446    identifier that behaves like an operator such as "xor".
 447    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 448    diagnostic may be required for this node.  Currently this only
 449    applies to __VA_ARGS__ and poisoned identifiers.  */
 450
 451 /* Hash node flags.  */
 452 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 453 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 454 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 455 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 456 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 457 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 458 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing. */
 459
 460 /* Different flavors of hash node.  */
 461 enum node_type
 462 {
 463   NT_VOID = 0,     /* No definition yet.  */
 464   NT_MACRO,        /* A macro of some form.  */
 465   NT_ASSERTION     /* Predicate for #assert.  */
 466 };
 467
 468 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 469    handle it with the builtin code for efficiency reasons.  */
 470 enum builtin_type
 471 {
 472   BT_SPECLINE = 0,              /* `__LINE__' */
 473   BT_DATE,                      /* `__DATE__' */
 474   BT_FILE,                      /* `__FILE__' */
 475   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 476   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 477   BT_TIME,                      /* `__TIME__' */
 478   BT_STDC,                      /* `__STDC__' */
 479   BT_PRAGMA                     /* `_Pragma' operator */
 480 };
 481
 482 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 483 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 484 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 485 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 486
 487 /* The common part of an identifier node shared amongst all 3 C front
 488    ends.  Also used to store CPP identifiers, which are a superset of
 489    identifiers in the grammatical sense.  */
 490 struct cpp_hashnode GTY(())
 491 {
 492   struct ht_identifier ident;
 493   unsigned int is_directive : 1;
 494   unsigned int directive_index : 7;     /* If is_directive,
 495                                            then index into directive table.
 496                                            Otherwise, a NODE_OPERATOR. */
 497   unsigned char rid_code;               /* Rid code - for front ends.  */
 498   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 499   unsigned char flags;                  /* CPP flags.  */
 500
 501   union _cpp_hashnode_value
 502   {
 503     /* If a macro.  */
 504     cpp_macro * GTY((skip (""))) macro;
 505     /* Answers to an assertion.  */
 506     struct answer * GTY ((skip (""))) answers;
 507     /* Code for a builtin macro.  */
 508     enum builtin_type GTY ((tag ("1"))) builtin;
 509     /* Macro argument index.  */
 510     unsigned short GTY ((tag ("0"))) arg_index;
 511   } GTY ((desc ("0"))) value;
 512 };
 513
 514 /* Call this first to get a handle to pass to other functions.  */
 515 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 516
 517 /* Call this to change the selected language standard (e.g. because of
 518    command line options).  */
 519 extern void cpp_set_lang PARAMS ((cpp_reader *, enum c_lang));
 520
 521 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 522    called any number of times before cpp_read_main_file().  If no
 523    targets have been added before cpp_read_main_file(), then the
 524    default target is used.  */
 525 extern void cpp_add_dependency_target PARAMS ((cpp_reader *,
 526                                                const char * target,
 527                                                int quote));
 528
 529 /* Call these to get pointers to the options and callback structures
 530    for a given reader.  These pointers are good until you call
 531    cpp_finish on that reader.  You can either edit the callbacks
 532    through the pointer returned from cpp_get_callbacks, or set them
 533    with cpp_set_callbacks.  */
 534 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
 535 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
 536 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
 537 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
 538
 539 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
 540    return value is the number of arguments used.  If
 541    cpp_handle_options returns without using all arguments, it couldn't
 542    understand the next switch.  Options processing is not completed
 543    until you call cpp_finish_options.  */
 544 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 545 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 546
 547 /* This function reads the file, but does not start preprocessing.  It
 548    returns the name of the original file; this is the same as the
 549    input file, except for preprocessed input.  This will generate at
 550    least one file change callback, and possibly a line change callback
 551    too.  If there was an error opening the file, it returns NULL.
 552
 553    If you want cpplib to manage its own hashtable, pass in a NULL
 554    pointer.  Otherwise you should pass in an initialized hash table
 555    that cpplib will share; this technique is used by the C front
 556    ends.  */
 557 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
 558                                                struct ht *));
 559
 560 /* Deferred handling of command line options that can generate debug
 561    callbacks, such as -D and -imacros.  Call this after
 562    cpp_read_main_file.  The front ends need this separation so they
 563    can initialize debug output with the original file name, returned
 564    from cpp_read_main_file, before they get debug callbacks.  */
 565 extern void cpp_finish_options PARAMS ((cpp_reader *));
 566
 567 /* Call this to finish preprocessing.  If you requested dependency
 568    generation, pass an open stream to write the information to,
 569    otherwise NULL.  It is your responsibility to close the stream.
 570
 571    Returns cpp_errors (pfile).  */
 572 extern int cpp_finish PARAMS ((cpp_reader *, FILE *deps_stream));
 573
 574 /* Call this to release the handle at the end of preprocessing.  Any
 575    use of the handle after this function returns is invalid.  Returns
 576    cpp_errors (pfile).  */
 577 extern void cpp_destroy PARAMS ((cpp_reader *));
 578
 579 /* Error count.  */
 580 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
 581
 582 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 583 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 584                                                  const cpp_token *));
 585 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 586                                                unsigned char *));
 587 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 588                                          const char *, const char *,
 589                                          void (*) PARAMS ((cpp_reader *))));
 590
 591 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 592                                     const cpp_token *));
 593 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
 594 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 595                                                   const cpp_hashnode *));
 596 extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
 597
 598 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 599 extern cppchar_t
 600 cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
 601                                  unsigned int *, int *));
 602
 603 /* Used to register builtins during the register_builtins callback.
 604    The text is the same as the command line argument.  */
 605 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 606 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 607 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 608 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 609
 610 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 611                                             const unsigned char *, size_t,
 612                                             int, int));
 613 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 614
 615 /* A preprocessing number.  Code assumes that any unused high bits of
 616    the double integer are set to zero.  */
 617 typedef unsigned HOST_WIDE_INT cpp_num_part;
 618 typedef struct cpp_num cpp_num;
 619 struct cpp_num
 620 {
 621   cpp_num_part high;
 622   cpp_num_part low;
 623   bool unsignedp;  /* True if value should be treated as unsigned.  */
 624   bool overflow;   /* True if the most recent calculation overflowed.  */
 625 };
 626
 627 /* cpplib provides two interfaces for interpretation of preprocessing
 628    numbers.
 629
 630    cpp_classify_number categorizes numeric constants according to
 631    their field (integer, floating point, or invalid), radix (decimal,
 632    octal, hexadecimal), and type suffixes.  */
 633
 634 #define CPP_N_CATEGORY  0x000F
 635 #define CPP_N_INVALID   0x0000
 636 #define CPP_N_INTEGER   0x0001
 637 #define CPP_N_FLOATING  0x0002
 638
 639 #define CPP_N_WIDTH     0x00F0
 640 #define CPP_N_SMALL     0x0010  /* int, float.  */
 641 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 642 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 643
 644 #define CPP_N_RADIX     0x0F00
 645 #define CPP_N_DECIMAL   0x0100
 646 #define CPP_N_HEX       0x0200
 647 #define CPP_N_OCTAL     0x0400
 648
 649 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 650 #define CPP_N_IMAGINARY 0x2000
 651
 652 /* Classify a CPP_NUMBER token.  The return value is a combination of
 653    the flags from the above sets.  */
 654 extern unsigned cpp_classify_number PARAMS ((cpp_reader *, const cpp_token *));
 655
 656 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 657 extern cpp_num cpp_interpret_integer PARAMS ((cpp_reader *, const cpp_token *,
 658                                               unsigned int type));
 659
 660 /* Sign extend a number, with PRECISION significant bits and all
 661    others assumed clear, to fill out a cpp_num structure.  */
 662 cpp_num cpp_num_sign_extend PARAMS ((cpp_num, size_t));
 663
 664 /* Diagnostic levels.  To get a diagnostic without associating a
 665    position in the translation unit with it, use cpp_error_with_line
 666    with a line number of zero.  */
 667
 668 /* Warning, an error with -Werror.  */
 669 #define DL_WARNING              0x00
 670 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
 671 #define DL_WARNING_SYSHDR       0x01
 672 /* Warning, an error with -pedantic-errors or -Werror.  */
 673 #define DL_PEDWARN              0x02
 674 /* An error.  */
 675 #define DL_ERROR                0x03
 676 /* An internal consistency check failed.  Prints "internal error: ",
 677    otherwise the same as DL_ERROR.  */
 678 #define DL_ICE                  0x04
 679 /* Extracts a diagnostic level from an int.  */
 680 #define DL_EXTRACT(l)           (l & 0xf)
 681 /* Nonzero if a diagnostic level is one of the warnings.  */
 682 #define DL_WARNING_P(l)         (DL_EXTRACT (l) >= DL_WARNING \
 683                                  && DL_EXTRACT (l) <= DL_PEDWARN)
 684
 685 /* N.B. The error-message-printer prototypes have not been nicely
 686    formatted because exgettext needs to see 'msgid' on the same line
 687    as the name of the function in order to work properly.  Only the
 688    string argument gets a name in an effort to keep the lines from
 689    getting ridiculously oversized.  */
 690
 691 /* Output a diagnostic of some kind.  */
 692 extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
 693   ATTRIBUTE_PRINTF_3;
 694
 695 /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
 696    error string of errno.  No location is printed.  */
 697 extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
 698
 699 /* Same as cpp_error, except additionally specifies a position as a
 700    (translation unit) physical line and physical column.  If the line is
 701    zero, then no location is printed.  */
 702 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
 703   ATTRIBUTE_PRINTF_5;
 704
 705 /* In cpplex.c */
 706 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 707                                                  const char *));
 708 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 709 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 710 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 711 /* Returns the value of an escape sequence, truncated to the correct
 712    target precision.  PSTR points to the input pointer, which is just
 713    after the backslash.  LIMIT is how much text we have.  WIDE is true
 714    if the escape sequence is part of a wide character constant or
 715    string literal.  Handles all relevant diagnostics.  */
 716 extern cppchar_t cpp_parse_escape       PARAMS ((cpp_reader *,
 717                                                  const unsigned char ** pstr,
 718                                                  const unsigned char *limit,
 719                                                  int wide));
 720
 721 /* In cpphash.c */
 722
 723 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 724    table if it is not already there.  */
 725 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 726                                                  const unsigned char *,
 727                                                  unsigned int));
 728
 729 typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
 730 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 731                                                  cpp_cb, void *));
 732
 733 /* In cppmacro.c */
 734 extern void cpp_scan_nooutput           PARAMS ((cpp_reader *));
 735 extern int  cpp_sys_macro_p             PARAMS ((cpp_reader *));
 736 extern unsigned char *cpp_quote_string  PARAMS ((unsigned char *,
 737                                                  const unsigned char *,
 738                                                  unsigned int));
 739
 740 /* In cppfiles.c */
 741 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 742 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
 743
 744 /* In cpppch.c */
 745 struct save_macro_data;
 746 extern int cpp_save_state PARAMS ((cpp_reader *, FILE *));
 747 extern int cpp_write_pch_deps PARAMS ((cpp_reader *, FILE *));
 748 extern int cpp_write_pch_state PARAMS ((cpp_reader *, FILE *));
 749 extern int cpp_valid_state PARAMS ((cpp_reader *, const char *, int));
 750 extern void cpp_prepare_state PARAMS ((cpp_reader *,
 751                                        struct save_macro_data **));
 752 extern int cpp_read_state PARAMS ((cpp_reader *, const char *, FILE *,
 753                                    struct save_macro_data *));
 754
 755 /* In cppmain.c */
 756 extern void cpp_preprocess_file PARAMS ((cpp_reader *, const char *, FILE *));
 757
 758 #ifdef __cplusplus
 759 }
 760 #endif
 761
 762 #endif /* ! GCC_CPPLIB_H */