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