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_dir cpp_dir;
  43
  44 struct answer;
  45
  46 /* The first three groups, apart from '=', can appear in preprocessor
  47    expressions (+= and -= are used to indicate unary + and - resp.).
  48    This allows a lookup table to be implemented in _cpp_parse_expr.
  49
  50    The first group, to CPP_LAST_EQ, can be immediately followed by an
  51    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  52    the same order as their counterparts without the '=', like ">>".  */
  53
  54 /* Positions in the table.  */
  55 #define CPP_LAST_EQ CPP_MAX
  56 #define CPP_FIRST_DIGRAPH CPP_HASH
  57 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  58 #define CPP_LAST_CPP_OP CPP_LESS_EQ
  59
  60 #define TTYPE_TABLE                             \
  61   OP(CPP_EQ = 0,        "=")                    \
  62   OP(CPP_NOT,           "!")                    \
  63   OP(CPP_GREATER,       ">")    /* compare */   \
  64   OP(CPP_LESS,          "<")                    \
  65   OP(CPP_PLUS,          "+")    /* math */      \
  66   OP(CPP_MINUS,         "-")                    \
  67   OP(CPP_MULT,          "*")                    \
  68   OP(CPP_DIV,           "/")                    \
  69   OP(CPP_MOD,           "%")                    \
  70   OP(CPP_AND,           "&")    /* bit ops */   \
  71   OP(CPP_OR,            "|")                    \
  72   OP(CPP_XOR,           "^")                    \
  73   OP(CPP_RSHIFT,        ">>")                   \
  74   OP(CPP_LSHIFT,        "<<")                   \
  75   OP(CPP_MIN,           "<?")   /* extension */ \
  76   OP(CPP_MAX,           ">?")                   \
  77 \
  78   OP(CPP_COMPL,         "~")                    \
  79   OP(CPP_AND_AND,       "&&")   /* logical */   \
  80   OP(CPP_OR_OR,         "||")                   \
  81   OP(CPP_QUERY,         "?")                    \
  82   OP(CPP_COLON,         ":")                    \
  83   OP(CPP_COMMA,         ",")    /* grouping */  \
  84   OP(CPP_OPEN_PAREN,    "(")                    \
  85   OP(CPP_CLOSE_PAREN,   ")")                    \
  86   TK(CPP_EOF,           SPELL_NONE)             \
  87   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  88   OP(CPP_NOT_EQ,        "!=")                   \
  89   OP(CPP_GREATER_EQ,    ">=")                   \
  90   OP(CPP_LESS_EQ,       "<=")                   \
  91 \
  92   /* These two are unary + / - in preprocessor expressions.  */ \
  93   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  94   OP(CPP_MINUS_EQ,      "-=")                   \
  95 \
  96   OP(CPP_MULT_EQ,       "*=")                   \
  97   OP(CPP_DIV_EQ,        "/=")                   \
  98   OP(CPP_MOD_EQ,        "%=")                   \
  99   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 100   OP(CPP_OR_EQ,         "|=")                   \
 101   OP(CPP_XOR_EQ,        "^=")                   \
 102   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 103   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 104   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 105   OP(CPP_MAX_EQ,        ">?=")                  \
 106   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 107   OP(CPP_HASH,          "#")    /* digraphs */  \
 108   OP(CPP_PASTE,         "##")                   \
 109   OP(CPP_OPEN_SQUARE,   "[")                    \
 110   OP(CPP_CLOSE_SQUARE,  "]")                    \
 111   OP(CPP_OPEN_BRACE,    "{")                    \
 112   OP(CPP_CLOSE_BRACE,   "}")                    \
 113   /* The remainder of the punctuation.  Order is not significant.  */   \
 114   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 115   OP(CPP_ELLIPSIS,      "...")                  \
 116   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 117   OP(CPP_MINUS_MINUS,   "--")                   \
 118   OP(CPP_DEREF,         "->")   /* accessors */ \
 119   OP(CPP_DOT,           ".")                    \
 120   OP(CPP_SCOPE,         "::")                   \
 121   OP(CPP_DEREF_STAR,    "->*")                  \
 122   OP(CPP_DOT_STAR,      ".*")                   \
 123   OP(CPP_ATSIGN,        "@")  /* used in Objective-C */ \
 124 \
 125   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 126   TK(CPP_AT_NAME,       SPELL_IDENT)    /* @word - Objective-C */       \
 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_OBJC_STRING,   SPELL_LITERAL)  /* @"string" - Objective-C */   \
 136   TK(CPP_HEADER_NAME,   SPELL_LITERAL)  /* <stdio.h> in #include */     \
 137 \
 138   TK(CPP_COMMENT,       SPELL_LITERAL)  /* Only if output comments.  */ \
 139                                         /* SPELL_LITERAL happens to DTRT.  */ \
 140   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 141   TK(CPP_PADDING,       SPELL_NONE)     /* Whitespace for cpp0.  */
 142
 143 #define OP(e, s) e,
 144 #define TK(e, s) e,
 145 enum cpp_ttype
 146 {
 147   TTYPE_TABLE
 148   N_TTYPES
 149 };
 150 #undef OP
 151 #undef TK
 152
 153 /* C language kind, used when calling cpp_reader_init.  */
 154 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
 155              CLK_GNUCXX, CLK_CXX98, CLK_ASM};
 156
 157 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
 158 struct cpp_string
 159 {
 160   unsigned int len;
 161   const unsigned char *text;
 162 };
 163
 164 /* Flags for the cpp_token structure.  */
 165 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 166 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 167 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 168 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 169 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
 170 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 171 #define BOL             (1 << 6) /* Token at beginning of line.  */
 172
 173 /* A preprocessing token.  This has been carefully packed and should
 174    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 175 struct cpp_token
 176 {
 177   unsigned int line;            /* Logical line of first char of token.  */
 178   unsigned short col;           /* Column of first char of token.  */
 179   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 180   unsigned char flags;          /* flags - see above */
 181
 182   union
 183   {
 184     cpp_hashnode *node;         /* An identifier.  */
 185     const cpp_token *source;    /* Inherit padding from this token.  */
 186     struct cpp_string str;      /* A string, or number.  */
 187     unsigned int arg_no;        /* Argument no. for a CPP_MACRO_ARG.  */
 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    The width of this type is capped at 32 bits; there do exist targets
 195    where wchar_t is 64 bits, but only in a non-default mode, and there
 196    would be no meaningful interpretation for a wchar_t value greater
 197    than 2^32 anyway -- the widest wide-character encoding around is
 198    ISO 10646, which stops at 2^31.  */
 199 #if CHAR_BIT * SIZEOF_INT >= 32
 200 # define CPPCHAR_SIGNED_T int
 201 #elif CHAR_BIT * SIZEOF_LONG >= 32
 202 # define CPPCHAR_SIGNED_T long
 203 #else
 204 # error "Cannot find a least-32-bit signed integer type"
 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   /* The language we're preprocessing.  */
 217   enum c_lang lang;
 218
 219   /* Nonzero means use extra default include directories for C++.  */
 220   unsigned char cplusplus;
 221
 222   /* Nonzero means handle cplusplus style comments */
 223   unsigned char cplusplus_comments;
 224
 225   /* Nonzero means define __OBJC__, treat @ as a special token, and
 226      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 227   unsigned char objc;
 228
 229   /* Nonzero means don't copy comments into the output file.  */
 230   unsigned char discard_comments;
 231
 232   /* Nonzero means don't copy comments into the output file during
 233      macro expansion.  */
 234   unsigned char discard_comments_in_macro_exp;
 235
 236   /* Nonzero means process the ISO trigraph sequences.  */
 237   unsigned char trigraphs;
 238
 239   /* Nonzero means process the ISO digraph sequences.  */
 240   unsigned char digraphs;
 241
 242   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 243   unsigned char extended_numbers;
 244
 245   /* Nonzero means print names of header files (-H).  */
 246   unsigned char print_include_names;
 247
 248   /* Nonzero means cpp_pedwarn causes a hard error.  */
 249   unsigned char pedantic_errors;
 250
 251   /* Nonzero means don't print warning messages.  */
 252   unsigned char inhibit_warnings;
 253
 254   /* Nonzero means complain about deprecated features.  */
 255   unsigned char warn_deprecated;
 256
 257   /* Nonzero means don't suppress warnings from system headers.  */
 258   unsigned char warn_system_headers;
 259
 260   /* Nonzero means don't print error messages.  Has no option to
 261      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 262   unsigned char inhibit_errors;
 263
 264   /* Nonzero means warn if slash-star appears in a comment.  */
 265   unsigned char warn_comments;
 266
 267   /* Nonzero means warn if there are any trigraphs.  */
 268   unsigned char warn_trigraphs;
 269
 270   /* Nonzero means warn if #import is used.  */
 271   unsigned char warn_import;
 272
 273   /* Nonzero means warn about multicharacter charconsts.  */
 274   unsigned char warn_multichar;
 275
 276   /* Nonzero means warn about various incompatibilities with
 277      traditional C.  */
 278   unsigned char warn_traditional;
 279
 280   /* Nonzero means warn about long long numeric constants.  */
 281   unsigned char warn_long_long;
 282
 283   /* Nonzero means warn about text after an #endif (or #else).  */
 284   unsigned char warn_endif_labels;
 285
 286   /* Nonzero means warn about implicit sign changes owing to integer
 287      promotions.  */
 288   unsigned char warn_num_sign_change;
 289
 290   /* Nonzero means turn warnings into errors.  */
 291   unsigned char warnings_are_errors;
 292
 293   /* Nonzero means we should look for header.gcc files that remap file
 294      names.  */
 295   unsigned char remap;
 296
 297   /* Zero means dollar signs are punctuation.  */
 298   unsigned char dollars_in_ident;
 299
 300   /* True if we should warn about dollars in identifiers or numbers
 301      for this translation unit.  */
 302   unsigned char warn_dollars;
 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   /* Holds the name of the target (execution) character set.  */
 333   const char *narrow_charset;
 334
 335   /* Holds the name of the target wide character set.  */
 336   const char *wide_charset;
 337
 338   /* True to warn about precompiled header files we couldn't use.  */
 339   bool warn_invalid_pch;
 340
 341   /* True if dependencies should be restored from a precompiled header.  */
 342   bool restore_pch_deps;
 343
 344   /* Dependency generation.  */
 345   struct
 346   {
 347     /* Style of header dependencies to generate.  */
 348     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 349
 350     /* Assume missing files are generated files.  */
 351     bool missing_files;
 352
 353     /* Generate phony targets for each dependency apart from the first
 354        one.  */
 355     bool phony_targets;
 356
 357     /* If true, no dependency is generated on the main file.  */
 358     bool ignore_main_file;
 359   } deps;
 360
 361   /* Target-specific features set by the front end or client.  */
 362
 363   /* Precision for target CPP arithmetic, target characters, target
 364      ints and target wide characters, respectively.  */
 365   size_t precision, char_precision, int_precision, wchar_precision;
 366
 367   /* True means chars (wide chars) are unsigned.  */
 368   bool unsigned_char, unsigned_wchar;
 369
 370   /* True if the most significant byte in a word has the lowest
 371      address in memory.  */
 372   bool bytes_big_endian;
 373
 374   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 375   unsigned char stdc_0_in_system_headers;
 376 };
 377
 378 /* Call backs to cpplib client.  */
 379 struct cpp_callbacks
 380 {
 381   /* Called when a new line of preprocessed output is started.  */
 382   void (*line_change) (cpp_reader *, const cpp_token *, int);
 383   void (*file_change) (cpp_reader *, const struct line_map *);
 384   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 385                    const char *, int);
 386   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 387   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 388   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 389   void (*def_pragma) (cpp_reader *, unsigned int);
 390   int (*valid_pch) (cpp_reader *, const char *, int);
 391   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 392 };
 393
 394 /* Chain of directories to look for include files in.  */
 395 struct cpp_dir
 396 {
 397   /* NULL-terminated singly-linked list.  */
 398   struct cpp_dir *next;
 399
 400   /* NAME of the directory, NUL-terminated.  */
 401   char *name;
 402   unsigned int len;
 403
 404   /* One if a system header, two if a system header that has extern
 405      "C" guards for C++.  */
 406   unsigned char sysp;
 407
 408   /* Mapping of file names for this directory for MS-DOS and related
 409      platforms.  A NULL-terminated array of (from, to) pairs.  */
 410   const char **name_map;
 411
 412   /* The C front end uses these to recognize duplicated
 413      directories in the search path.  */
 414   ino_t ino;
 415   dev_t dev;
 416 };
 417
 418 /* Name under which this program was invoked.  */
 419 extern const char *progname;
 420
 421 /* The structure of a node in the hash table.  The hash table has
 422    entries for all identifiers: either macros defined by #define
 423    commands (type NT_MACRO), assertions created with #assert
 424    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 425    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 426    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 427    identifier that behaves like an operator such as "xor".
 428    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 429    diagnostic may be required for this node.  Currently this only
 430    applies to __VA_ARGS__ and poisoned identifiers.  */
 431
 432 /* Hash node flags.  */
 433 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 434 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 435 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 436 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 437 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 438 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 439 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 440
 441 /* Different flavors of hash node.  */
 442 enum node_type
 443 {
 444   NT_VOID = 0,     /* No definition yet.  */
 445   NT_MACRO,        /* A macro of some form.  */
 446   NT_ASSERTION     /* Predicate for #assert.  */
 447 };
 448
 449 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 450    handle it with the builtin code for efficiency reasons.  */
 451 enum builtin_type
 452 {
 453   BT_SPECLINE = 0,              /* `__LINE__' */
 454   BT_DATE,                      /* `__DATE__' */
 455   BT_FILE,                      /* `__FILE__' */
 456   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 457   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 458   BT_TIME,                      /* `__TIME__' */
 459   BT_STDC,                      /* `__STDC__' */
 460   BT_PRAGMA                     /* `_Pragma' operator */
 461 };
 462
 463 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 464 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 465 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 466 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 467
 468 /* The common part of an identifier node shared amongst all 3 C front
 469    ends.  Also used to store CPP identifiers, which are a superset of
 470    identifiers in the grammatical sense.  */
 471 struct cpp_hashnode GTY(())
 472 {
 473   struct ht_identifier ident;
 474   unsigned int is_directive : 1;
 475   unsigned int directive_index : 7;     /* If is_directive,
 476                                            then index into directive table.
 477                                            Otherwise, a NODE_OPERATOR.  */
 478   unsigned char rid_code;               /* Rid code - for front ends.  */
 479   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 480   unsigned char flags;                  /* CPP flags.  */
 481
 482   union _cpp_hashnode_value
 483   {
 484     /* If a macro.  */
 485     cpp_macro * GTY((skip (""))) macro;
 486     /* Answers to an assertion.  */
 487     struct answer * GTY ((skip (""))) answers;
 488     /* Code for a builtin macro.  */
 489     enum builtin_type GTY ((tag ("1"))) builtin;
 490     /* Macro argument index.  */
 491     unsigned short GTY ((tag ("0"))) arg_index;
 492   } GTY ((desc ("0"))) value;
 493 };
 494
 495 /* Call this first to get a handle to pass to other functions.
 496
 497    If you want cpplib to manage its own hashtable, pass in a NULL
 498    pointer.  Otherwise you should pass in an initialized hash table
 499    that cpplib will share; this technique is used by the C front
 500    ends.  */
 501 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *);
 502
 503 /* Call this to change the selected language standard (e.g. because of
 504    command line options).  */
 505 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 506
 507 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 508    called any number of times before cpp_read_main_file().  If no
 509    targets have been added before cpp_read_main_file(), then the
 510    default target is used.  */
 511 extern void cpp_add_dependency_target (cpp_reader *, const char *, int);
 512
 513 /* Set the include paths.  */
 514 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 515
 516 /* Call these to get pointers to the options and callback structures
 517    for a given reader.  These pointers are good until you call
 518    cpp_finish on that reader.  You can either edit the callbacks
 519    through the pointer returned from cpp_get_callbacks, or set them
 520    with cpp_set_callbacks.  */
 521 extern cpp_options *cpp_get_options (cpp_reader *);
 522 extern const struct line_maps *cpp_get_line_maps (cpp_reader *);
 523 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 524 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 525
 526 /* This function reads the file, but does not start preprocessing.  It
 527    returns the name of the original file; this is the same as the
 528    input file, except for preprocessed input.  This will generate at
 529    least one file change callback, and possibly a line change callback
 530    too.  If there was an error opening the file, it returns NULL.  */
 531 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 532
 533 /* Stacks a new file.  It will return false if there was an error
 534    opening the file.  */
 535 extern bool cpp_stack_file (cpp_reader *, const char *);
 536
 537 /* Set up built-ins like __FILE__.  */
 538 extern void cpp_init_builtins (cpp_reader *, int);
 539
 540 /* Set up translation to the target character set.  */
 541 extern void cpp_init_iconv (cpp_reader *);
 542
 543 /* Call this to finish preprocessing.  If you requested dependency
 544    generation, pass an open stream to write the information to,
 545    otherwise NULL.  It is your responsibility to close the stream.
 546
 547    Returns cpp_errors (pfile).  */
 548 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
 549
 550 /* Call this to release the handle at the end of preprocessing.  Any
 551    use of the handle after this function returns is invalid.  Returns
 552    cpp_errors (pfile).  */
 553 extern void cpp_destroy (cpp_reader *);
 554
 555 /* Error count.  */
 556 extern unsigned int cpp_errors (cpp_reader *);
 557
 558 extern unsigned int cpp_token_len (const cpp_token *);
 559 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 560 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 561                                        unsigned char *);
 562 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 563                                  void (*) (cpp_reader *));
 564 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 565                             const cpp_token *);
 566 extern const cpp_token *cpp_get_token (cpp_reader *);
 567 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 568                                                   const cpp_hashnode *);
 569 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 570
 571 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 572 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 573                                           unsigned int *, int *);
 574 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
 575 extern bool cpp_interpret_string (cpp_reader *,
 576                                   const cpp_string *, size_t,
 577                                   cpp_string *, bool);
 578
 579 /* Used to register macros and assertions, perhaps from the command line.
 580    The text is the same as the command line argument.  */
 581 extern void cpp_define (cpp_reader *, const char *);
 582 extern void cpp_assert (cpp_reader *, const char *);
 583 extern void cpp_undef (cpp_reader *, const char *);
 584 extern void cpp_unassert (cpp_reader *, const char *);
 585
 586 /* Undefine all macros and assertions.  */
 587 extern void cpp_undef_all (cpp_reader *);
 588
 589 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 590                                     size_t, int, int);
 591 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 592
 593 /* A preprocessing number.  Code assumes that any unused high bits of
 594    the double integer are set to zero.  */
 595 typedef unsigned HOST_WIDE_INT cpp_num_part;
 596 typedef struct cpp_num cpp_num;
 597 struct cpp_num
 598 {
 599   cpp_num_part high;
 600   cpp_num_part low;
 601   bool unsignedp;  /* True if value should be treated as unsigned.  */
 602   bool overflow;   /* True if the most recent calculation overflowed.  */
 603 };
 604
 605 /* cpplib provides two interfaces for interpretation of preprocessing
 606    numbers.
 607
 608    cpp_classify_number categorizes numeric constants according to
 609    their field (integer, floating point, or invalid), radix (decimal,
 610    octal, hexadecimal), and type suffixes.  */
 611
 612 #define CPP_N_CATEGORY  0x000F
 613 #define CPP_N_INVALID   0x0000
 614 #define CPP_N_INTEGER   0x0001
 615 #define CPP_N_FLOATING  0x0002
 616
 617 #define CPP_N_WIDTH     0x00F0
 618 #define CPP_N_SMALL     0x0010  /* int, float.  */
 619 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 620 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 621
 622 #define CPP_N_RADIX     0x0F00
 623 #define CPP_N_DECIMAL   0x0100
 624 #define CPP_N_HEX       0x0200
 625 #define CPP_N_OCTAL     0x0400
 626
 627 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 628 #define CPP_N_IMAGINARY 0x2000
 629
 630 /* Classify a CPP_NUMBER token.  The return value is a combination of
 631    the flags from the above sets.  */
 632 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 633
 634 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 635 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 636                                       unsigned int type);
 637
 638 /* Sign extend a number, with PRECISION significant bits and all
 639    others assumed clear, to fill out a cpp_num structure.  */
 640 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 641
 642 /* Diagnostic levels.  To get a diagnostic without associating a
 643    position in the translation unit with it, use cpp_error_with_line
 644    with a line number of zero.  */
 645
 646 /* Warning, an error with -Werror.  */
 647 #define DL_WARNING              0x00
 648 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
 649 #define DL_WARNING_SYSHDR       0x01
 650 /* Warning, an error with -pedantic-errors or -Werror.  */
 651 #define DL_PEDWARN              0x02
 652 /* An error.  */
 653 #define DL_ERROR                0x03
 654 /* An internal consistency check failed.  Prints "internal error: ",
 655    otherwise the same as DL_ERROR.  */
 656 #define DL_ICE                  0x04
 657 /* Extracts a diagnostic level from an int.  */
 658 #define DL_EXTRACT(l)           (l & 0xf)
 659 /* Nonzero if a diagnostic level is one of the warnings.  */
 660 #define DL_WARNING_P(l)         (DL_EXTRACT (l) >= DL_WARNING \
 661                                  && DL_EXTRACT (l) <= DL_PEDWARN)
 662
 663 /* N.B. The error-message-printer prototypes have not been nicely
 664    formatted because exgettext needs to see 'msgid' on the same line
 665    as the name of the function in order to work properly.  Only the
 666    string argument gets a name in an effort to keep the lines from
 667    getting ridiculously oversized.  */
 668
 669 /* Output a diagnostic of some kind.  */
 670 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
 671   ATTRIBUTE_PRINTF_3;
 672
 673 /* Output a diagnostic with "MSGID: " preceding the
 674    error string of errno.  No location is printed.  */
 675 extern void cpp_errno (cpp_reader *, int, const char *msgid);
 676
 677 /* Same as cpp_error, except additionally specifies a position as a
 678    (translation unit) physical line and physical column.  If the line is
 679    zero, then no location is printed.  */
 680 extern void cpp_error_with_line (cpp_reader *, int, unsigned, unsigned, const char *msgid, ...)
 681   ATTRIBUTE_PRINTF_5;
 682
 683 /* In cpplex.c */
 684 extern int cpp_ideq (const cpp_token *, const char *);
 685 extern void cpp_output_line (cpp_reader *, FILE *);
 686 extern void cpp_output_token (const cpp_token *, FILE *);
 687 extern const char *cpp_type2name (enum cpp_ttype);
 688 /* Returns the value of an escape sequence, truncated to the correct
 689    target precision.  PSTR points to the input pointer, which is just
 690    after the backslash.  LIMIT is how much text we have.  WIDE is true
 691    if the escape sequence is part of a wide character constant or
 692    string literal.  Handles all relevant diagnostics.  */
 693 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 694                                    const unsigned char *limit, int wide);
 695
 696 /* In cpphash.c */
 697
 698 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 699    table if it is not already there.  */
 700 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
 701                                  unsigned int);
 702
 703 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 704 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 705
 706 /* In cppmacro.c */
 707 extern void cpp_scan_nooutput (cpp_reader *);
 708 extern int  cpp_sys_macro_p (cpp_reader *);
 709 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 710                                         unsigned int);
 711
 712 /* In cppfiles.c */
 713 extern bool cpp_included (cpp_reader *, const char *);
 714 extern void cpp_make_system_header (cpp_reader *, int, int);
 715 extern void cpp_simplify_path (char *);
 716 extern bool cpp_push_include (cpp_reader *, const char *);
 717 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 718
 719 /* In cpppch.c */
 720 struct save_macro_data;
 721 extern int cpp_save_state (cpp_reader *, FILE *);
 722 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 723 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 724 extern int cpp_valid_state (cpp_reader *, const char *, int);
 725 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 726 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 727                            struct save_macro_data *);
 728
 729 #ifdef __cplusplus
 730 }
 731 #endif
 732
 733 #endif /* ! GCC_CPPLIB_H */