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