gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
   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   fileline 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 about multicharacter charconsts.  */
 271   unsigned char warn_multichar;
 272
 273   /* Nonzero means warn about various incompatibilities with
 274      traditional C.  */
 275   unsigned char warn_traditional;
 276
 277   /* Nonzero means warn about long long numeric constants.  */
 278   unsigned char warn_long_long;
 279
 280   /* Nonzero means warn about text after an #endif (or #else).  */
 281   unsigned char warn_endif_labels;
 282
 283   /* Nonzero means warn about implicit sign changes owing to integer
 284      promotions.  */
 285   unsigned char warn_num_sign_change;
 286
 287   /* Nonzero means turn warnings into errors.  */
 288   unsigned char warnings_are_errors;
 289
 290   /* Nonzero means we should look for header.gcc files that remap file
 291      names.  */
 292   unsigned char remap;
 293
 294   /* Zero means dollar signs are punctuation.  */
 295   unsigned char dollars_in_ident;
 296
 297   /* True if we should warn about dollars in identifiers or numbers
 298      for this translation unit.  */
 299   unsigned char warn_dollars;
 300
 301   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 302   unsigned char warn_undef;
 303
 304   /* Nonzero means warn of unused macros from the main file.  */
 305   unsigned char warn_unused_macros;
 306
 307   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 308   unsigned char c99;
 309
 310   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 311   unsigned char std;
 312
 313   /* Nonzero means give all the error messages the ANSI standard requires.  */
 314   unsigned char pedantic;
 315
 316   /* Nonzero means we're looking at already preprocessed code, so don't
 317      bother trying to do macro expansion and whatnot.  */
 318   unsigned char preprocessed;
 319
 320   /* Print column number in error messages.  */
 321   unsigned char show_column;
 322
 323   /* Nonzero means handle C++ alternate operator names.  */
 324   unsigned char operator_names;
 325
 326   /* True for traditional preprocessing.  */
 327   unsigned char traditional;
 328
 329   /* Holds the name of the target (execution) character set.  */
 330   const char *narrow_charset;
 331
 332   /* Holds the name of the target wide character set.  */
 333   const char *wide_charset;
 334
 335   /* Holds the name of the input character set.  */
 336   const char *input_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
 384   /* Called when switching to/from a new file.
 385      The line_map is for the new file.  It is NULL if there is no new file.
 386      (In C this happens when done with <built-in>+<command line> and also
 387      when done with a main file.)  This can be used for resource cleanup.  */
 388   void (*file_change) (cpp_reader *, const struct line_map *);
 389
 390   void (*dir_change) (cpp_reader *, const char *);
 391   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 392                    const char *, int);
 393   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 394   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 395   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 396   void (*def_pragma) (cpp_reader *, unsigned int);
 397   int (*valid_pch) (cpp_reader *, const char *, int);
 398   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 399 };
 400
 401 /* Chain of directories to look for include files in.  */
 402 struct cpp_dir
 403 {
 404   /* NULL-terminated singly-linked list.  */
 405   struct cpp_dir *next;
 406
 407   /* NAME of the directory, NUL-terminated.  */
 408   char *name;
 409   unsigned int len;
 410
 411   /* One if a system header, two if a system header that has extern
 412      "C" guards for C++.  */
 413   unsigned char sysp;
 414
 415   /* Mapping of file names for this directory for MS-DOS and related
 416      platforms.  A NULL-terminated array of (from, to) pairs.  */
 417   const char **name_map;
 418
 419   /* The C front end uses these to recognize duplicated
 420      directories in the search path.  */
 421   ino_t ino;
 422   dev_t dev;
 423 };
 424
 425 /* Name under which this program was invoked.  */
 426 extern const char *progname;
 427
 428 /* The structure of a node in the hash table.  The hash table has
 429    entries for all identifiers: either macros defined by #define
 430    commands (type NT_MACRO), assertions created with #assert
 431    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 432    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 433    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 434    identifier that behaves like an operator such as "xor".
 435    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 436    diagnostic may be required for this node.  Currently this only
 437    applies to __VA_ARGS__ and poisoned identifiers.  */
 438
 439 /* Hash node flags.  */
 440 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 441 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 442 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 443 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 444 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 445 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 446 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 447
 448 /* Different flavors of hash node.  */
 449 enum node_type
 450 {
 451   NT_VOID = 0,     /* No definition yet.  */
 452   NT_MACRO,        /* A macro of some form.  */
 453   NT_ASSERTION     /* Predicate for #assert.  */
 454 };
 455
 456 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 457    handle it with the builtin code for efficiency reasons.  */
 458 enum builtin_type
 459 {
 460   BT_SPECLINE = 0,              /* `__LINE__' */
 461   BT_DATE,                      /* `__DATE__' */
 462   BT_FILE,                      /* `__FILE__' */
 463   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 464   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 465   BT_TIME,                      /* `__TIME__' */
 466   BT_STDC,                      /* `__STDC__' */
 467   BT_PRAGMA                     /* `_Pragma' operator */
 468 };
 469
 470 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 471 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 472 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 473 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 474
 475 /* The common part of an identifier node shared amongst all 3 C front
 476    ends.  Also used to store CPP identifiers, which are a superset of
 477    identifiers in the grammatical sense.  */
 478 struct cpp_hashnode GTY(())
 479 {
 480   struct ht_identifier ident;
 481   unsigned int is_directive : 1;
 482   unsigned int directive_index : 7;     /* If is_directive,
 483                                            then index into directive table.
 484                                            Otherwise, a NODE_OPERATOR.  */
 485   unsigned char rid_code;               /* Rid code - for front ends.  */
 486   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 487   unsigned char flags;                  /* CPP flags.  */
 488
 489   union _cpp_hashnode_value
 490   {
 491     /* If a macro.  */
 492     cpp_macro * GTY((skip (""))) macro;
 493     /* Answers to an assertion.  */
 494     struct answer * GTY ((skip (""))) answers;
 495     /* Code for a builtin macro.  */
 496     enum builtin_type GTY ((tag ("1"))) builtin;
 497     /* Macro argument index.  */
 498     unsigned short GTY ((tag ("0"))) arg_index;
 499   } GTY ((desc ("0"))) value;
 500 };
 501
 502 /* Call this first to get a handle to pass to other functions.
 503
 504    If you want cpplib to manage its own hashtable, pass in a NULL
 505    pointer.  Otherwise you should pass in an initialized hash table
 506    that cpplib will share; this technique is used by the C front
 507    ends.  */
 508 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *);
 509
 510 /* Call this to change the selected language standard (e.g. because of
 511    command line options).  */
 512 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 513
 514 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 515    called any number of times before cpp_read_main_file().  If no
 516    targets have been added before cpp_read_main_file(), then the
 517    default target is used.  */
 518 extern void cpp_add_dependency_target (cpp_reader *, const char *, int);
 519
 520 /* Set the include paths.  */
 521 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 522
 523 /* Call these to get pointers to the options and callback structures
 524    for a given reader.  These pointers are good until you call
 525    cpp_finish on that reader.  You can either edit the callbacks
 526    through the pointer returned from cpp_get_callbacks, or set them
 527    with cpp_set_callbacks.  */
 528 extern cpp_options *cpp_get_options (cpp_reader *);
 529 extern struct line_maps *cpp_get_line_maps (cpp_reader *);
 530 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 531 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 532
 533 /* This function reads the file, but does not start preprocessing.  It
 534    returns the name of the original file; this is the same as the
 535    input file, except for preprocessed input.  This will generate at
 536    least one file change callback, and possibly a line change callback
 537    too.  If there was an error opening the file, it returns NULL. */
 538 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 539
 540 /* Set up built-ins like __FILE__.  */
 541 extern void cpp_init_builtins (cpp_reader *, int);
 542
 543 /* This is called after options have been parsed, and partially
 544    processed.  */
 545 extern void cpp_post_options (cpp_reader *);
 546
 547 /* Set up translation to the target character set.  */
 548 extern void cpp_init_iconv (cpp_reader *);
 549
 550 /* Call this to finish preprocessing.  If you requested dependency
 551    generation, pass an open stream to write the information to,
 552    otherwise NULL.  It is your responsibility to close the stream.
 553
 554    Returns cpp_errors (pfile).  */
 555 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
 556
 557 /* Call this to release the handle at the end of preprocessing.  Any
 558    use of the handle after this function returns is invalid.  Returns
 559    cpp_errors (pfile).  */
 560 extern void cpp_destroy (cpp_reader *);
 561
 562 /* Error count.  */
 563 extern unsigned int cpp_errors (cpp_reader *);
 564
 565 extern unsigned int cpp_token_len (const cpp_token *);
 566 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 567 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 568                                        unsigned char *);
 569 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 570                                  void (*) (cpp_reader *));
 571 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 572                             const cpp_token *);
 573 extern const cpp_token *cpp_get_token (cpp_reader *);
 574 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 575                                                   const cpp_hashnode *);
 576 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 577
 578 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 579 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 580                                           unsigned int *, int *);
 581 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
 582 extern bool cpp_interpret_string (cpp_reader *,
 583                                   const cpp_string *, size_t,
 584                                   cpp_string *, bool);
 585
 586 /* Used to register macros and assertions, perhaps from the command line.
 587    The text is the same as the command line argument.  */
 588 extern void cpp_define (cpp_reader *, const char *);
 589 extern void cpp_assert (cpp_reader *, const char *);
 590 extern void cpp_undef (cpp_reader *, const char *);
 591 extern void cpp_unassert (cpp_reader *, const char *);
 592
 593 /* Undefine all macros and assertions.  */
 594 extern void cpp_undef_all (cpp_reader *);
 595
 596 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 597                                     size_t, int);
 598 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 599
 600 /* A preprocessing number.  Code assumes that any unused high bits of
 601    the double integer are set to zero.  */
 602 typedef unsigned HOST_WIDE_INT cpp_num_part;
 603 typedef struct cpp_num cpp_num;
 604 struct cpp_num
 605 {
 606   cpp_num_part high;
 607   cpp_num_part low;
 608   bool unsignedp;  /* True if value should be treated as unsigned.  */
 609   bool overflow;   /* True if the most recent calculation overflowed.  */
 610 };
 611
 612 /* cpplib provides two interfaces for interpretation of preprocessing
 613    numbers.
 614
 615    cpp_classify_number categorizes numeric constants according to
 616    their field (integer, floating point, or invalid), radix (decimal,
 617    octal, hexadecimal), and type suffixes.  */
 618
 619 #define CPP_N_CATEGORY  0x000F
 620 #define CPP_N_INVALID   0x0000
 621 #define CPP_N_INTEGER   0x0001
 622 #define CPP_N_FLOATING  0x0002
 623
 624 #define CPP_N_WIDTH     0x00F0
 625 #define CPP_N_SMALL     0x0010  /* int, float.  */
 626 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 627 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 628
 629 #define CPP_N_RADIX     0x0F00
 630 #define CPP_N_DECIMAL   0x0100
 631 #define CPP_N_HEX       0x0200
 632 #define CPP_N_OCTAL     0x0400
 633
 634 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 635 #define CPP_N_IMAGINARY 0x2000
 636
 637 /* Classify a CPP_NUMBER token.  The return value is a combination of
 638    the flags from the above sets.  */
 639 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 640
 641 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 642 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 643                                       unsigned int type);
 644
 645 /* Sign extend a number, with PRECISION significant bits and all
 646    others assumed clear, to fill out a cpp_num structure.  */
 647 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 648
 649 /* Diagnostic levels.  To get a diagnostic without associating a
 650    position in the translation unit with it, use cpp_error_with_line
 651    with a line number of zero.  */
 652
 653 /* Warning, an error with -Werror.  */
 654 #define CPP_DL_WARNING          0x00
 655 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
 656 #define CPP_DL_WARNING_SYSHDR   0x01
 657 /* Warning, an error with -pedantic-errors or -Werror.  */
 658 #define CPP_DL_PEDWARN          0x02
 659 /* An error.  */
 660 #define CPP_DL_ERROR            0x03
 661 /* An internal consistency check failed.  Prints "internal error: ",
 662    otherwise the same as CPP_DL_ERROR.  */
 663 #define CPP_DL_ICE              0x04
 664 /* Extracts a diagnostic level from an int.  */
 665 #define CPP_DL_EXTRACT(l)       (l & 0xf)
 666 /* Nonzero if a diagnostic level is one of the warnings.  */
 667 #define CPP_DL_WARNING_P(l)     (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
 668                                  && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
 669
 670 /* N.B. The error-message-printer prototypes have not been nicely
 671    formatted because exgettext needs to see 'msgid' on the same line
 672    as the name of the function in order to work properly.  Only the
 673    string argument gets a name in an effort to keep the lines from
 674    getting ridiculously oversized.  */
 675
 676 /* Output a diagnostic of some kind.  */
 677 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
 678   ATTRIBUTE_PRINTF_3;
 679
 680 /* Output a diagnostic with "MSGID: " preceding the
 681    error string of errno.  No location is printed.  */
 682 extern void cpp_errno (cpp_reader *, int, const char *msgid);
 683
 684 /* Same as cpp_error, except additionally specifies a position as a
 685    (translation unit) physical line and physical column.  If the line is
 686    zero, then no location is printed.  */
 687 extern void cpp_error_with_line (cpp_reader *, int, fileline, unsigned,
 688                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
 689
 690 /* In cpplex.c */
 691 extern int cpp_ideq (const cpp_token *, const char *);
 692 extern void cpp_output_line (cpp_reader *, FILE *);
 693 extern void cpp_output_token (const cpp_token *, FILE *);
 694 extern const char *cpp_type2name (enum cpp_ttype);
 695 /* Returns the value of an escape sequence, truncated to the correct
 696    target precision.  PSTR points to the input pointer, which is just
 697    after the backslash.  LIMIT is how much text we have.  WIDE is true
 698    if the escape sequence is part of a wide character constant or
 699    string literal.  Handles all relevant diagnostics.  */
 700 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 701                                    const unsigned char *limit, int wide);
 702
 703 /* In cpphash.c */
 704
 705 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 706    table if it is not already there.  */
 707 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
 708                                  unsigned int);
 709
 710 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 711 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 712
 713 /* In cppmacro.c */
 714 extern void cpp_scan_nooutput (cpp_reader *);
 715 extern int  cpp_sys_macro_p (cpp_reader *);
 716 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 717                                         unsigned int);
 718
 719 /* In cppfiles.c */
 720 extern bool cpp_included (cpp_reader *, const char *);
 721 extern void cpp_make_system_header (cpp_reader *, int, int);
 722 extern bool cpp_push_include (cpp_reader *, const char *);
 723 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 724
 725 /* In cpppch.c */
 726 struct save_macro_data;
 727 extern int cpp_save_state (cpp_reader *, FILE *);
 728 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 729 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 730 extern int cpp_valid_state (cpp_reader *, const char *, int);
 731 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 732 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 733                            struct save_macro_data *);
 734
 735 #ifdef __cplusplus
 736 }
 737 #endif
 738
 739 #endif /* ! GCC_CPPLIB_H */