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_LITERAL)  /* 34_be+ta  */                 \
 128 \
 129   TK(CPP_CHAR,          SPELL_LITERAL)  /* 'char' */                    \
 130   TK(CPP_WCHAR,         SPELL_LITERAL)  /* L'char' */                   \
 131   TK(CPP_OTHER,         SPELL_LITERAL)  /* stray punctuation */         \
 132 \
 133   TK(CPP_STRING,        SPELL_LITERAL)  /* "string" */                  \
 134   TK(CPP_WSTRING,       SPELL_LITERAL)  /* L"string" */                 \
 135   TK(CPP_HEADER_NAME,   SPELL_LITERAL)  /* <stdio.h> in #include */     \
 136 \
 137   TK(CPP_COMMENT,       SPELL_LITERAL)  /* Only if output comments.  */ \
 138                                         /* SPELL_LITERAL 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   } 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 /* This structure is nested inside struct cpp_reader, and
 209    carries all the options visible to the command line.  */
 210 struct cpp_options
 211 {
 212   /* Characters between tab stops.  */
 213   unsigned int tabstop;
 214
 215   /* Map between header names and file names, used only on DOS where
 216      file names are limited in length.  */
 217   struct file_name_map_list *map_list;
 218
 219   /* The language we're preprocessing.  */
 220   enum c_lang lang;
 221
 222   /* Nonzero means use extra default include directories for C++.  */
 223   unsigned char cplusplus;
 224
 225   /* Nonzero means handle cplusplus style comments */
 226   unsigned char cplusplus_comments;
 227
 228   /* Nonzero means define __OBJC__, treat @ as a special token, and
 229      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 230   unsigned char objc;
 231
 232   /* Nonzero means don't copy comments into the output file.  */
 233   unsigned char discard_comments;
 234
 235   /* Nonzero means don't copy comments into the output file during
 236      macro expansion.  */
 237   unsigned char discard_comments_in_macro_exp;
 238
 239   /* Nonzero means process the ISO trigraph sequences.  */
 240   unsigned char trigraphs;
 241
 242   /* Nonzero means process the ISO digraph sequences.  */
 243   unsigned char digraphs;
 244
 245   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 246   unsigned char extended_numbers;
 247
 248   /* Nonzero means print names of header files (-H).  */
 249   unsigned char print_include_names;
 250
 251   /* Nonzero means cpp_pedwarn causes a hard error.  */
 252   unsigned char pedantic_errors;
 253
 254   /* Nonzero means don't print warning messages.  */
 255   unsigned char inhibit_warnings;
 256
 257   /* Nonzero means complain about deprecated features.  */
 258   unsigned char warn_deprecated;
 259
 260   /* Nonzero means don't suppress warnings from system headers.  */
 261   unsigned char warn_system_headers;
 262
 263   /* Nonzero means don't print error messages.  Has no option to
 264      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 265   unsigned char inhibit_errors;
 266
 267   /* Nonzero means warn if slash-star appears in a comment.  */
 268   unsigned char warn_comments;
 269
 270   /* Nonzero means warn if there are any trigraphs.  */
 271   unsigned char warn_trigraphs;
 272
 273   /* Nonzero means warn if #import is used.  */
 274   unsigned char warn_import;
 275
 276   /* Nonzero means warn about multicharacter charconsts.  */
 277   unsigned char warn_multichar;
 278
 279   /* Nonzero means warn about various incompatibilities with
 280      traditional C.  */
 281   unsigned char warn_traditional;
 282
 283   /* Nonzero means warn about long long numeric constants.  */
 284   unsigned char warn_long_long;
 285
 286   /* Nonzero means warn about text after an #endif (or #else).  */
 287   unsigned char warn_endif_labels;
 288
 289   /* Nonzero means warn about implicit sign changes owing to integer
 290      promotions.  */
 291   unsigned char warn_num_sign_change;
 292
 293   /* Nonzero means turn warnings into errors.  */
 294   unsigned char warnings_are_errors;
 295
 296   /* Nonzero means we should look for header.gcc files that remap file
 297      names.  */
 298   unsigned char remap;
 299
 300   /* Zero means dollar signs are punctuation.  */
 301   unsigned char dollars_in_ident;
 302
 303   /* True if we should warn about dollars in identifiers or numbers
 304      for this translation unit.  */
 305   unsigned char warn_dollars;
 306
 307   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 308   unsigned char warn_undef;
 309
 310   /* Nonzero means warn of unused macros from the main file.  */
 311   unsigned char warn_unused_macros;
 312
 313   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 314   unsigned char c99;
 315
 316   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 317   unsigned char std;
 318
 319   /* Nonzero means give all the error messages the ANSI standard requires.  */
 320   unsigned char pedantic;
 321
 322   /* Nonzero means we're looking at already preprocessed code, so don't
 323      bother trying to do macro expansion and whatnot.  */
 324   unsigned char preprocessed;
 325
 326   /* Print column number in error messages.  */
 327   unsigned char show_column;
 328
 329   /* Nonzero means handle C++ alternate operator names.  */
 330   unsigned char operator_names;
 331
 332   /* True for traditional preprocessing.  */
 333   unsigned char traditional;
 334
 335   /* True to warn about precompiled header files we couldn't use.  */
 336   bool warn_invalid_pch;
 337
 338   /* True if dependencies should be restored from a precompiled header.  */
 339   bool restore_pch_deps;
 340
 341   /* Dependency generation.  */
 342   struct
 343   {
 344     /* Style of header dependencies to generate.  */
 345     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 346
 347     /* Assume missing files are generated files.  */
 348     bool missing_files;
 349
 350     /* Generate phony targets for each dependency apart from the first
 351        one.  */
 352     bool phony_targets;
 353
 354     /* If true, no dependency is generated on the main file.  */
 355     bool ignore_main_file;
 356   } deps;
 357
 358   /* Target-specific features set by the front end or client.  */
 359
 360   /* Precision for target CPP arithmetic, target characters, target
 361      ints and target wide characters, respectively.  */
 362   size_t precision, char_precision, int_precision, wchar_precision;
 363
 364   /* True means chars (wide chars) are unsigned.  */
 365   bool unsigned_char, unsigned_wchar;
 366
 367   /* True if target is EBCDIC.  */
 368   bool EBCDIC;
 369
 370   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 371   unsigned char stdc_0_in_system_headers;
 372 };
 373
 374 /* Call backs to cpplib client.  */
 375 struct cpp_callbacks
 376 {
 377   /* Called when a new line of preprocessed output is started.  */
 378   void (*line_change) (cpp_reader *, const cpp_token *, int);
 379   void (*file_change) (cpp_reader *, const struct line_map *);
 380   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 381                    const char *, int);
 382   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 383   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 384   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 385   void (*def_pragma) (cpp_reader *, unsigned int);
 386   int (*valid_pch) (cpp_reader *, const char *, int);
 387   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 388 };
 389
 390 /* Chain of directories to look for include files in.  */
 391 struct cpp_path
 392 {
 393   /* NULL-terminated singly-linked list.  */
 394   struct cpp_path *next;
 395
 396   /* NAME need not be NUL-terminated once inside cpplib.  */
 397   char *name;
 398   unsigned int len;
 399
 400   /* One if a system header, two if a system header that has extern
 401      "C" guards for C++.  */
 402   unsigned char sysp;
 403
 404   /* Mapping of file names for this directory for MS-DOS and
 405      related platforms.  */
 406   struct file_name_map *name_map;
 407
 408   /* The C front end uses these to recognize duplicated
 409      directories in the search path.  */
 410   ino_t ino;
 411   dev_t dev;
 412 };
 413
 414 /* Name under which this program was invoked.  */
 415 extern const char *progname;
 416
 417 /* The structure of a node in the hash table.  The hash table has
 418    entries for all identifiers: either macros defined by #define
 419    commands (type NT_MACRO), assertions created with #assert
 420    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 421    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 422    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 423    identifier that behaves like an operator such as "xor".
 424    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 425    diagnostic may be required for this node.  Currently this only
 426    applies to __VA_ARGS__ and poisoned identifiers.  */
 427
 428 /* Hash node flags.  */
 429 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 430 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 431 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 432 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 433 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 434 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 435 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 436
 437 /* Different flavors of hash node.  */
 438 enum node_type
 439 {
 440   NT_VOID = 0,     /* No definition yet.  */
 441   NT_MACRO,        /* A macro of some form.  */
 442   NT_ASSERTION     /* Predicate for #assert.  */
 443 };
 444
 445 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 446    handle it with the builtin code for efficiency reasons.  */
 447 enum builtin_type
 448 {
 449   BT_SPECLINE = 0,              /* `__LINE__' */
 450   BT_DATE,                      /* `__DATE__' */
 451   BT_FILE,                      /* `__FILE__' */
 452   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 453   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 454   BT_TIME,                      /* `__TIME__' */
 455   BT_STDC,                      /* `__STDC__' */
 456   BT_PRAGMA                     /* `_Pragma' operator */
 457 };
 458
 459 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 460 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 461 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 462 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 463
 464 /* The common part of an identifier node shared amongst all 3 C front
 465    ends.  Also used to store CPP identifiers, which are a superset of
 466    identifiers in the grammatical sense.  */
 467 struct cpp_hashnode GTY(())
 468 {
 469   struct ht_identifier ident;
 470   unsigned int is_directive : 1;
 471   unsigned int directive_index : 7;     /* If is_directive,
 472                                            then index into directive table.
 473                                            Otherwise, a NODE_OPERATOR.  */
 474   unsigned char rid_code;               /* Rid code - for front ends.  */
 475   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 476   unsigned char flags;                  /* CPP flags.  */
 477
 478   union _cpp_hashnode_value
 479   {
 480     /* If a macro.  */
 481     cpp_macro * GTY((skip (""))) macro;
 482     /* Answers to an assertion.  */
 483     struct answer * GTY ((skip (""))) answers;
 484     /* Code for a builtin macro.  */
 485     enum builtin_type GTY ((tag ("1"))) builtin;
 486     /* Macro argument index.  */
 487     unsigned short GTY ((tag ("0"))) arg_index;
 488   } GTY ((desc ("0"))) value;
 489 };
 490
 491 /* Call this first to get a handle to pass to other functions.
 492
 493    If you want cpplib to manage its own hashtable, pass in a NULL
 494    pointer.  Otherwise you should pass in an initialized hash table
 495    that cpplib will share; this technique is used by the C front
 496    ends.  */
 497 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *);
 498
 499 /* Call this to change the selected language standard (e.g. because of
 500    command line options).  */
 501 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 502
 503 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 504    called any number of times before cpp_read_main_file().  If no
 505    targets have been added before cpp_read_main_file(), then the
 506    default target is used.  */
 507 extern void cpp_add_dependency_target (cpp_reader *, const char *, int);
 508
 509 /* Set the include paths.  */
 510 extern void cpp_set_include_chains (cpp_reader *, cpp_path *, cpp_path *, int);
 511
 512 /* Call these to get pointers to the options and callback structures
 513    for a given reader.  These pointers are good until you call
 514    cpp_finish on that reader.  You can either edit the callbacks
 515    through the pointer returned from cpp_get_callbacks, or set them
 516    with cpp_set_callbacks.  */
 517 extern cpp_options *cpp_get_options (cpp_reader *);
 518 extern const struct line_maps *cpp_get_line_maps (cpp_reader *);
 519 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 520 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 521
 522 /* This function reads the file, but does not start preprocessing.  It
 523    returns the name of the original file; this is the same as the
 524    input file, except for preprocessed input.  This will generate at
 525    least one file change callback, and possibly a line change callback
 526    too.  If there was an error opening the file, it returns NULL.  */
 527 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 528
 529 /* Set up built-ins like __FILE__.  */
 530 extern void cpp_init_builtins (cpp_reader *, int);
 531
 532 /* Call this to finish preprocessing.  If you requested dependency
 533    generation, pass an open stream to write the information to,
 534    otherwise NULL.  It is your responsibility to close the stream.
 535
 536    Returns cpp_errors (pfile).  */
 537 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
 538
 539 /* Call this to release the handle at the end of preprocessing.  Any
 540    use of the handle after this function returns is invalid.  Returns
 541    cpp_errors (pfile).  */
 542 extern void cpp_destroy (cpp_reader *);
 543
 544 /* Error count.  */
 545 extern unsigned int cpp_errors (cpp_reader *);
 546
 547 extern unsigned int cpp_token_len (const cpp_token *);
 548 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 549 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 550                                        unsigned char *);
 551 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 552                                  void (*) (cpp_reader *));
 553 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 554                             const cpp_token *);
 555 extern const cpp_token *cpp_get_token (cpp_reader *);
 556 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 557                                                   const cpp_hashnode *);
 558 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 559
 560 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 561 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 562                                           unsigned int *, int *);
 563
 564 /* Used to register macros and assertions, perhaps from the command line.
 565    The text is the same as the command line argument.  */
 566 extern void cpp_define (cpp_reader *, const char *);
 567 extern void cpp_assert (cpp_reader *, const char *);
 568 extern void cpp_undef (cpp_reader *, const char *);
 569 extern void cpp_unassert (cpp_reader *, const char *);
 570
 571 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 572                                     size_t, int, int);
 573 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 574
 575 /* A preprocessing number.  Code assumes that any unused high bits of
 576    the double integer are set to zero.  */
 577 typedef unsigned HOST_WIDE_INT cpp_num_part;
 578 typedef struct cpp_num cpp_num;
 579 struct cpp_num
 580 {
 581   cpp_num_part high;
 582   cpp_num_part low;
 583   bool unsignedp;  /* True if value should be treated as unsigned.  */
 584   bool overflow;   /* True if the most recent calculation overflowed.  */
 585 };
 586
 587 /* cpplib provides two interfaces for interpretation of preprocessing
 588    numbers.
 589
 590    cpp_classify_number categorizes numeric constants according to
 591    their field (integer, floating point, or invalid), radix (decimal,
 592    octal, hexadecimal), and type suffixes.  */
 593
 594 #define CPP_N_CATEGORY  0x000F
 595 #define CPP_N_INVALID   0x0000
 596 #define CPP_N_INTEGER   0x0001
 597 #define CPP_N_FLOATING  0x0002
 598
 599 #define CPP_N_WIDTH     0x00F0
 600 #define CPP_N_SMALL     0x0010  /* int, float.  */
 601 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 602 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 603
 604 #define CPP_N_RADIX     0x0F00
 605 #define CPP_N_DECIMAL   0x0100
 606 #define CPP_N_HEX       0x0200
 607 #define CPP_N_OCTAL     0x0400
 608
 609 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 610 #define CPP_N_IMAGINARY 0x2000
 611
 612 /* Classify a CPP_NUMBER token.  The return value is a combination of
 613    the flags from the above sets.  */
 614 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 615
 616 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 617 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 618                                       unsigned int type);
 619
 620 /* Sign extend a number, with PRECISION significant bits and all
 621    others assumed clear, to fill out a cpp_num structure.  */
 622 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 623
 624 /* Diagnostic levels.  To get a diagnostic without associating a
 625    position in the translation unit with it, use cpp_error_with_line
 626    with a line number of zero.  */
 627
 628 /* Warning, an error with -Werror.  */
 629 #define DL_WARNING              0x00
 630 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
 631 #define DL_WARNING_SYSHDR       0x01
 632 /* Warning, an error with -pedantic-errors or -Werror.  */
 633 #define DL_PEDWARN              0x02
 634 /* An error.  */
 635 #define DL_ERROR                0x03
 636 /* An internal consistency check failed.  Prints "internal error: ",
 637    otherwise the same as DL_ERROR.  */
 638 #define DL_ICE                  0x04
 639 /* Extracts a diagnostic level from an int.  */
 640 #define DL_EXTRACT(l)           (l & 0xf)
 641 /* Nonzero if a diagnostic level is one of the warnings.  */
 642 #define DL_WARNING_P(l)         (DL_EXTRACT (l) >= DL_WARNING \
 643                                  && DL_EXTRACT (l) <= DL_PEDWARN)
 644
 645 /* N.B. The error-message-printer prototypes have not been nicely
 646    formatted because exgettext needs to see 'msgid' on the same line
 647    as the name of the function in order to work properly.  Only the
 648    string argument gets a name in an effort to keep the lines from
 649    getting ridiculously oversized.  */
 650
 651 /* Output a diagnostic of some kind.  */
 652 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
 653   ATTRIBUTE_PRINTF_3;
 654
 655 /* Output a diagnostic with "MSGID: " preceding the
 656    error string of errno.  No location is printed.  */
 657 extern void cpp_errno (cpp_reader *, int, const char *msgid);
 658
 659 /* Same as cpp_error, except additionally specifies a position as a
 660    (translation unit) physical line and physical column.  If the line is
 661    zero, then no location is printed.  */
 662 extern void cpp_error_with_line (cpp_reader *, int, unsigned, unsigned, const char *msgid, ...)
 663   ATTRIBUTE_PRINTF_5;
 664
 665 /* In cpplex.c */
 666 extern int cpp_ideq (const cpp_token *, const char *);
 667 extern void cpp_output_line (cpp_reader *, FILE *);
 668 extern void cpp_output_token (const cpp_token *, FILE *);
 669 extern const char *cpp_type2name (enum cpp_ttype);
 670 /* Returns the value of an escape sequence, truncated to the correct
 671    target precision.  PSTR points to the input pointer, which is just
 672    after the backslash.  LIMIT is how much text we have.  WIDE is true
 673    if the escape sequence is part of a wide character constant or
 674    string literal.  Handles all relevant diagnostics.  */
 675 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 676                                    const unsigned char *limit, int wide);
 677
 678 /* In cpphash.c */
 679
 680 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 681    table if it is not already there.  */
 682 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
 683                                  unsigned int);
 684
 685 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 686 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 687
 688 /* In cppmacro.c */
 689 extern void cpp_scan_nooutput (cpp_reader *);
 690 extern int  cpp_sys_macro_p (cpp_reader *);
 691 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 692                                         unsigned int);
 693
 694 /* In cppfiles.c */
 695 extern int cpp_included (cpp_reader *, const char *);
 696 extern void cpp_make_system_header (cpp_reader *, int, int);
 697 extern void cpp_simplify_path (char *);
 698 extern bool cpp_push_include (cpp_reader *, const char *);
 699 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 700
 701 /* In cpppch.c */
 702 struct save_macro_data;
 703 extern int cpp_save_state (cpp_reader *, FILE *);
 704 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 705 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 706 extern int cpp_valid_state (cpp_reader *, const char *, int);
 707 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 708 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 709                            struct save_macro_data *);
 710
 711 #ifdef __cplusplus
 712 }
 713 #endif
 714
 715 #endif /* ! GCC_CPPLIB_H */