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