gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   3    Free Software Foundation, Inc.
   4    Written by Per Bothner, 1994-95.
   5
   6 This program is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20  In other words, you are welcome to use, share and improve this program.
  21  You are forbidden to forbid anyone else to use, share and improve
  22  what you give them.   Help stamp out software-hoarding!  */
  23 #ifndef GCC_CPPLIB_H
  24 #define GCC_CPPLIB_H
  25
  26 #include <sys/types.h>
  27 #include "hashtable.h"
  28 #include "line-map.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 typedef struct cpp_reader cpp_reader;
  35 typedef struct cpp_buffer cpp_buffer;
  36 typedef struct cpp_options cpp_options;
  37 typedef struct cpp_token cpp_token;
  38 typedef struct cpp_string cpp_string;
  39 typedef struct cpp_hashnode cpp_hashnode;
  40 typedef struct cpp_macro cpp_macro;
  41 typedef struct cpp_callbacks cpp_callbacks;
  42 typedef struct cpp_path cpp_path;
  43
  44 struct answer;
  45 struct file_name_map_list;
  46
  47 /* The first three groups, apart from '=', can appear in preprocessor
  48    expressions (+= and -= are used to indicate unary + and - resp.).
  49    This allows a lookup table to be implemented in _cpp_parse_expr.
  50
  51    The first group, to CPP_LAST_EQ, can be immediately followed by an
  52    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  53    the same order as their counterparts without the '=', like ">>".  */
  54
  55 /* Positions in the table.  */
  56 #define CPP_LAST_EQ CPP_MAX
  57 #define CPP_FIRST_DIGRAPH CPP_HASH
  58 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  59 #define CPP_LAST_CPP_OP CPP_LESS_EQ
  60
  61 #define TTYPE_TABLE                             \
  62   OP(CPP_EQ = 0,        "=")                    \
  63   OP(CPP_NOT,           "!")                    \
  64   OP(CPP_GREATER,       ">")    /* compare */   \
  65   OP(CPP_LESS,          "<")                    \
  66   OP(CPP_PLUS,          "+")    /* math */      \
  67   OP(CPP_MINUS,         "-")                    \
  68   OP(CPP_MULT,          "*")                    \
  69   OP(CPP_DIV,           "/")                    \
  70   OP(CPP_MOD,           "%")                    \
  71   OP(CPP_AND,           "&")    /* bit ops */   \
  72   OP(CPP_OR,            "|")                    \
  73   OP(CPP_XOR,           "^")                    \
  74   OP(CPP_RSHIFT,        ">>")                   \
  75   OP(CPP_LSHIFT,        "<<")                   \
  76   OP(CPP_MIN,           "<?")   /* extension */ \
  77   OP(CPP_MAX,           ">?")                   \
  78 \
  79   OP(CPP_COMPL,         "~")                    \
  80   OP(CPP_AND_AND,       "&&")   /* logical */   \
  81   OP(CPP_OR_OR,         "||")                   \
  82   OP(CPP_QUERY,         "?")                    \
  83   OP(CPP_COLON,         ":")                    \
  84   OP(CPP_COMMA,         ",")    /* grouping */  \
  85   OP(CPP_OPEN_PAREN,    "(")                    \
  86   OP(CPP_CLOSE_PAREN,   ")")                    \
  87   TK(CPP_EOF,           SPELL_NONE)             \
  88   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  89   OP(CPP_NOT_EQ,        "!=")                   \
  90   OP(CPP_GREATER_EQ,    ">=")                   \
  91   OP(CPP_LESS_EQ,       "<=")                   \
  92 \
  93   /* These two are unary + / - in preprocessor expressions.  */ \
  94   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  95   OP(CPP_MINUS_EQ,      "-=")                   \
  96 \
  97   OP(CPP_MULT_EQ,       "*=")                   \
  98   OP(CPP_DIV_EQ,        "/=")                   \
  99   OP(CPP_MOD_EQ,        "%=")                   \
 100   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 101   OP(CPP_OR_EQ,         "|=")                   \
 102   OP(CPP_XOR_EQ,        "^=")                   \
 103   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 104   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 105   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 106   OP(CPP_MAX_EQ,        ">?=")                  \
 107   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 108   OP(CPP_HASH,          "#")    /* digraphs */  \
 109   OP(CPP_PASTE,         "##")                   \
 110   OP(CPP_OPEN_SQUARE,   "[")                    \
 111   OP(CPP_CLOSE_SQUARE,  "]")                    \
 112   OP(CPP_OPEN_BRACE,    "{")                    \
 113   OP(CPP_CLOSE_BRACE,   "}")                    \
 114   /* The remainder of the punctuation.  Order is not significant.  */   \
 115   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 116   OP(CPP_ELLIPSIS,      "...")                  \
 117   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 118   OP(CPP_MINUS_MINUS,   "--")                   \
 119   OP(CPP_DEREF,         "->")   /* accessors */ \
 120   OP(CPP_DOT,           ".")                    \
 121   OP(CPP_SCOPE,         "::")                   \
 122   OP(CPP_DEREF_STAR,    "->*")                  \
 123   OP(CPP_DOT_STAR,      ".*")                   \
 124   OP(CPP_ATSIGN,        "@")  /* used in Objective-C */ \
 125 \
 126   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 127   TK(CPP_NUMBER,        SPELL_NUMBER)   /* 34_be+ta  */                 \
 128 \
 129   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 130   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 131   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 132 \
 133   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 134   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 135   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 136 \
 137   TK(CPP_COMMENT,       SPELL_NUMBER)   /* Only if output comments.  */ \
 138                                         /* SPELL_NUMBER happens to DTRT.  */ \
 139   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 140   TK(CPP_PADDING,       SPELL_NONE)     /* Whitespace for cpp0.  */
 141
 142 #define OP(e, s) e,
 143 #define TK(e, s) e,
 144 enum cpp_ttype
 145 {
 146   TTYPE_TABLE
 147   N_TTYPES
 148 };
 149 #undef OP
 150 #undef TK
 151
 152 /* C language kind, used when calling cpp_reader_init.  */
 153 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
 154              CLK_GNUCXX, CLK_CXX98, CLK_ASM};
 155
 156 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
 157 struct cpp_string
 158 {
 159   unsigned int len;
 160   const unsigned char *text;
 161 };
 162
 163 /* Flags for the cpp_token structure.  */
 164 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 165 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 166 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 167 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 168 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
 169 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 170 #define BOL             (1 << 6) /* Token at beginning of line.  */
 171
 172 /* A preprocessing token.  This has been carefully packed and should
 173    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 174 struct cpp_token
 175 {
 176   unsigned int line;            /* Logical line of first char of token.  */
 177   unsigned short col;           /* Column of first char of token.  */
 178   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 179   unsigned char flags;          /* flags - see above */
 180
 181   union
 182   {
 183     cpp_hashnode *node;         /* An identifier.  */
 184     const cpp_token *source;    /* Inherit padding from this token.  */
 185     struct cpp_string str;      /* A string, or number.  */
 186     unsigned int arg_no;        /* Argument no. for a CPP_MACRO_ARG.  */
 187     unsigned char c;            /* Character represented by CPP_OTHER.  */
 188   } val;
 189 };
 190
 191 /* A type wide enough to hold any multibyte source character.
 192    cpplib's character constant interpreter requires an unsigned type.
 193    Also, a typedef for the signed equivalent.  */
 194 #ifndef MAX_WCHAR_TYPE_SIZE
 195 # define MAX_WCHAR_TYPE_SIZE WCHAR_TYPE_SIZE
 196 #endif
 197 #if CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
 198 # define CPPCHAR_SIGNED_T int
 199 #else
 200 # if CHAR_BIT * SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG
 201 #  define CPPCHAR_SIGNED_T long
 202 # else
 203 #  define CPPCHAR_SIGNED_T long long
 204 # endif
 205 #endif
 206 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
 207 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
 208
 209 /* This structure is nested inside struct cpp_reader, and
 210    carries all the options visible to the command line.  */
 211 struct cpp_options
 212 {
 213   /* Characters between tab stops.  */
 214   unsigned int tabstop;
 215
 216   /* Pending options - -D, -U, -A, -I, -ixxx.  */
 217   struct cpp_pending *pending;
 218
 219   /* Map between header names and file names, used only on DOS where
 220      file names are limited in length.  */
 221   struct file_name_map_list *map_list;
 222
 223   /* The language we're preprocessing.  */
 224   enum c_lang lang;
 225
 226   /* Nonzero means use extra default include directories for C++.  */
 227   unsigned char cplusplus;
 228
 229   /* Nonzero means handle cplusplus style comments */
 230   unsigned char cplusplus_comments;
 231
 232   /* Nonzero means define __OBJC__, treat @ as a special token, and
 233      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 234   unsigned char objc;
 235
 236   /* Nonzero means don't copy comments into the output file.  */
 237   unsigned char discard_comments;
 238
 239   /* Nonzero means don't copy comments into the output file during
 240      macro expansion.  */
 241   unsigned char discard_comments_in_macro_exp;
 242
 243   /* Nonzero means process the ISO trigraph sequences.  */
 244   unsigned char trigraphs;
 245
 246   /* Nonzero means process the ISO digraph sequences.  */
 247   unsigned char digraphs;
 248
 249   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 250   unsigned char extended_numbers;
 251
 252   /* Nonzero means print names of header files (-H).  */
 253   unsigned char print_include_names;
 254
 255   /* Nonzero means cpp_pedwarn causes a hard error.  */
 256   unsigned char pedantic_errors;
 257
 258   /* Nonzero means don't print warning messages.  */
 259   unsigned char inhibit_warnings;
 260
 261   /* Nonzero means complain about deprecated features.  */
 262   unsigned char warn_deprecated;
 263
 264   /* Nonzero means don't suppress warnings from system headers.  */
 265   unsigned char warn_system_headers;
 266
 267   /* Nonzero means don't print error messages.  Has no option to
 268      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 269   unsigned char inhibit_errors;
 270
 271   /* Nonzero means warn if slash-star appears in a comment.  */
 272   unsigned char warn_comments;
 273
 274   /* Nonzero means warn if there are any trigraphs.  */
 275   unsigned char warn_trigraphs;
 276
 277   /* Nonzero means warn if #import is used.  */
 278   unsigned char warn_import;
 279
 280   /* Nonzero means warn about multicharacter charconsts.  */
 281   unsigned char warn_multichar;
 282
 283   /* Nonzero means warn about various incompatibilities with
 284      traditional C.  */
 285   unsigned char warn_traditional;
 286
 287   /* Nonzero means warn about long long numeric constants.  */
 288   unsigned char warn_long_long;
 289
 290   /* Nonzero means warn about text after an #endif (or #else).  */
 291   unsigned char warn_endif_labels;
 292
 293   /* Nonzero means warn about implicit sign changes owing to integer
 294      promotions.  */
 295   unsigned char warn_num_sign_change;
 296
 297   /* Nonzero means turn warnings into errors.  */
 298   unsigned char warnings_are_errors;
 299
 300   /* Nonzero means we should look for header.gcc files that remap file
 301      names.  */
 302   unsigned char remap;
 303
 304   /* Zero means dollar signs are punctuation.  */
 305   unsigned char dollars_in_ident;
 306
 307   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 308   unsigned char warn_undef;
 309
 310   /* Nonzero means warn of unused macros from the main file.  */
 311   unsigned char warn_unused_macros;
 312
 313   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 314   unsigned char c99;
 315
 316   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 317   unsigned char std;
 318
 319   /* Nonzero means give all the error messages the ANSI standard requires.  */
 320   unsigned char pedantic;
 321
 322   /* Nonzero means we're looking at already preprocessed code, so don't
 323      bother trying to do macro expansion and whatnot.  */
 324   unsigned char preprocessed;
 325
 326   /* Print column number in error messages.  */
 327   unsigned char show_column;
 328
 329   /* Nonzero means handle C++ alternate operator names.  */
 330   unsigned char operator_names;
 331
 332   /* True for traditional preprocessing.  */
 333   unsigned char traditional;
 334
 335   /* Dependency generation.  */
 336   struct
 337   {
 338     /* Style of header dependencies to generate.  */
 339     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 340
 341     /* Assume missing files are generated files.  */
 342     bool missing_files;
 343
 344     /* Generate phony targets for each dependency apart from the first
 345        one.  */
 346     bool phony_targets;
 347
 348     /* If true, no dependency is generated on the main file.  */
 349     bool ignore_main_file;
 350   } deps;
 351
 352   /* Target-specific features set by the front end or client.  */
 353
 354   /* Precision for target CPP arithmetic, target characters, target
 355      ints and target wide characters, respectively.  */
 356   size_t precision, char_precision, int_precision, wchar_precision;
 357
 358   /* True means chars (wide chars) are unsigned.  */
 359   bool unsigned_char, unsigned_wchar;
 360
 361   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 362   unsigned char stdc_0_in_system_headers;
 363
 364   /* True to warn about precompiled header files we couldn't use.  */
 365   bool warn_invalid_pch;
 366
 367   /* True if dependencies should be restored from a precompiled header.  */
 368   bool restore_pch_deps;
 369 };
 370
 371 /* Call backs.  */
 372 struct cpp_callbacks
 373 {
 374   /* Called when a new line of preprocessed output is started.  */
 375   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
 376   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
 377   void (*include) PARAMS ((cpp_reader *, unsigned int,
 378                            const unsigned char *, const cpp_token *));
 379   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 380   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 381   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
 382   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
 383   /* Called when the client has a chance to properly register
 384      built-ins with cpp_define() and cpp_assert().  */
 385   void (*register_builtins) PARAMS ((cpp_reader *));
 386   int (*valid_pch) PARAMS ((cpp_reader *, const char *, int));
 387   void (*read_pch) PARAMS ((cpp_reader *, const char *, int, const char *));
 388 };
 389
 390 /* Chain of directories to look for include files in.  */
 391 struct cpp_path
 392 {
 393   /* NULL-terminated singly-linked list.  */
 394   struct cpp_path *next;
 395
 396   /* NAME need not be NUL-terminated once inside cpplib.  */
 397   char *name;
 398   unsigned int len;
 399
 400   /* One if a system header, two if a system header that has extern
 401      "C" guards for C++.  */
 402   unsigned char sysp;
 403
 404   /* Mapping of file names for this directory for MS-DOS and
 405      related platforms.  */
 406   struct file_name_map *name_map;
 407
 408   /* The C front end uses these to recognize duplicated
 409      directories in the search path.  */
 410   ino_t ino;
 411   dev_t dev;
 412 };
 413
 414 /* Name under which this program was invoked.  */
 415 extern const char *progname;
 416
 417 /* The structure of a node in the hash table.  The hash table has
 418    entries for all identifiers: either macros defined by #define
 419    commands (type NT_MACRO), assertions created with #assert
 420    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 421    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 422    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 423    identifier that behaves like an operator such as "xor".
 424    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 425    diagnostic may be required for this node.  Currently this only
 426    applies to __VA_ARGS__ and poisoned identifiers.  */
 427
 428 /* Hash node flags.  */
 429 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 430 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 431 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 432 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 433 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 434 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 435 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing. */
 436
 437 /* Different flavors of hash node.  */
 438 enum node_type
 439 {
 440   NT_VOID = 0,     /* No definition yet.  */
 441   NT_MACRO,        /* A macro of some form.  */
 442   NT_ASSERTION     /* Predicate for #assert.  */
 443 };
 444
 445 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 446    handle it with the builtin code for efficiency reasons.  */
 447 enum builtin_type
 448 {
 449   BT_SPECLINE = 0,              /* `__LINE__' */
 450   BT_DATE,                      /* `__DATE__' */
 451   BT_FILE,                      /* `__FILE__' */
 452   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 453   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 454   BT_TIME,                      /* `__TIME__' */
 455   BT_STDC,                      /* `__STDC__' */
 456   BT_PRAGMA                     /* `_Pragma' operator */
 457 };
 458
 459 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 460 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 461 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 462 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 463
 464 /* The common part of an identifier node shared amongst all 3 C front
 465    ends.  Also used to store CPP identifiers, which are a superset of
 466    identifiers in the grammatical sense.  */
 467 struct cpp_hashnode GTY(())
 468 {
 469   struct ht_identifier ident;
 470   unsigned int is_directive : 1;
 471   unsigned int directive_index : 7;     /* If is_directive,
 472                                            then index into directive table.
 473                                            Otherwise, a NODE_OPERATOR. */
 474   unsigned char rid_code;               /* Rid code - for front ends.  */
 475   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 476   unsigned char flags;                  /* CPP flags.  */
 477
 478   union _cpp_hashnode_value
 479   {
 480     /* If a macro.  */
 481     cpp_macro * GTY((skip (""))) macro;
 482     /* Answers to an assertion.  */
 483     struct answer * GTY ((skip (""))) answers;
 484     /* Code for a builtin macro.  */
 485     enum builtin_type GTY ((tag ("1"))) builtin;
 486     /* Macro argument index.  */
 487     unsigned short GTY ((tag ("0"))) arg_index;
 488   } GTY ((desc ("0"))) value;
 489 };
 490
 491 /* Call this first to get a handle to pass to other functions.  */
 492 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 493
 494 /* Call this to change the selected language standard (e.g. because of
 495    command line options).  */
 496 extern void cpp_set_lang PARAMS ((cpp_reader *, enum c_lang));
 497
 498 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 499    called any number of times before cpp_read_main_file().  If no
 500    targets have been added before cpp_read_main_file(), then the
 501    default target is used.  */
 502 extern void cpp_add_dependency_target PARAMS ((cpp_reader *,
 503                                                const char * target,
 504                                                int quote));
 505
 506 /* Set the include paths.  */
 507 extern void cpp_set_include_chains PARAMS ((cpp_reader *, cpp_path *,
 508                                             cpp_path *, int));
 509
 510 /* Call these to get pointers to the options and callback structures
 511    for a given reader.  These pointers are good until you call
 512    cpp_finish on that reader.  You can either edit the callbacks
 513    through the pointer returned from cpp_get_callbacks, or set them
 514    with cpp_set_callbacks.  */
 515 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
 516 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
 517 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
 518 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
 519
 520 /* Now call cpp_handle_option to handle 1 switch.  The return value is
 521    the number of arguments used.  Options processing is not completed
 522    until you call cpp_finish_options.  */
 523 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 524
 525 /* This function reads the file, but does not start preprocessing.  It
 526    returns the name of the original file; this is the same as the
 527    input file, except for preprocessed input.  This will generate at
 528    least one file change callback, and possibly a line change callback
 529    too.  If there was an error opening the file, it returns NULL.
 530
 531    If you want cpplib to manage its own hashtable, pass in a NULL
 532    pointer.  Otherwise you should pass in an initialized hash table
 533    that cpplib will share; this technique is used by the C front
 534    ends.  */
 535 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
 536                                                struct ht *));
 537
 538 /* Deferred handling of command line options that can generate debug
 539    callbacks, such as -D and -imacros.  Call this after
 540    cpp_read_main_file.  The front ends need this separation so they
 541    can initialize debug output with the original file name, returned
 542    from cpp_read_main_file, before they get debug callbacks.  */
 543 extern void cpp_finish_options PARAMS ((cpp_reader *));
 544
 545 /* Call this to finish preprocessing.  If you requested dependency
 546    generation, pass an open stream to write the information to,
 547    otherwise NULL.  It is your responsibility to close the stream.
 548
 549    Returns cpp_errors (pfile).  */
 550 extern int cpp_finish PARAMS ((cpp_reader *, FILE *deps_stream));
 551
 552 /* Call this to release the handle at the end of preprocessing.  Any
 553    use of the handle after this function returns is invalid.  Returns
 554    cpp_errors (pfile).  */
 555 extern void cpp_destroy PARAMS ((cpp_reader *));
 556
 557 /* Error count.  */
 558 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
 559
 560 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 561 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 562                                                  const cpp_token *));
 563 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 564                                                unsigned char *));
 565 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 566                                          const char *, const char *,
 567                                          void (*) PARAMS ((cpp_reader *))));
 568
 569 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 570                                     const cpp_token *));
 571 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
 572 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 573                                                   const cpp_hashnode *));
 574 extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
 575
 576 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 577 extern cppchar_t
 578 cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
 579                                  unsigned int *, int *));
 580
 581 /* Used to register builtins during the register_builtins callback.
 582    The text is the same as the command line argument.  */
 583 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 584 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 585 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 586 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 587
 588 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 589                                             const unsigned char *, size_t,
 590                                             int, int));
 591 extern int cpp_defined PARAMS ((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 PARAMS ((cpp_reader *, const cpp_token *));
 633
 634 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 635 extern cpp_num cpp_interpret_integer PARAMS ((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 PARAMS ((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 PARAMS ((cpp_reader *, int, const char *msgid, ...))
 671   ATTRIBUTE_PRINTF_3;
 672
 673 /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
 674    error string of errno.  No location is printed.  */
 675 extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
 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 PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
 681   ATTRIBUTE_PRINTF_5;
 682
 683 /* In cpplex.c */
 684 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 685                                                  const char *));
 686 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 687 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 688 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 689 /* Returns the value of an escape sequence, truncated to the correct
 690    target precision.  PSTR points to the input pointer, which is just
 691    after the backslash.  LIMIT is how much text we have.  WIDE is true
 692    if the escape sequence is part of a wide character constant or
 693    string literal.  Handles all relevant diagnostics.  */
 694 extern cppchar_t cpp_parse_escape       PARAMS ((cpp_reader *,
 695                                                  const unsigned char ** pstr,
 696                                                  const unsigned char *limit,
 697                                                  int wide));
 698
 699 /* In cpphash.c */
 700
 701 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 702    table if it is not already there.  */
 703 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 704                                                  const unsigned char *,
 705                                                  unsigned int));
 706
 707 typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
 708 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 709                                                  cpp_cb, void *));
 710
 711 /* In cppmacro.c */
 712 extern void cpp_scan_nooutput           PARAMS ((cpp_reader *));
 713 extern int  cpp_sys_macro_p             PARAMS ((cpp_reader *));
 714 extern unsigned char *cpp_quote_string  PARAMS ((unsigned char *,
 715                                                  const unsigned char *,
 716                                                  unsigned int));
 717
 718 /* In cppfiles.c */
 719 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 720 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
 721 extern void cpp_simplify_path PARAMS ((char *));
 722 extern bool cpp_push_include PARAMS ((cpp_reader *, const char *));
 723 extern void cpp_rename_file PARAMS ((cpp_reader *, const char *));
 724
 725 /* In cpppch.c */
 726 struct save_macro_data;
 727 extern int cpp_save_state PARAMS ((cpp_reader *, FILE *));
 728 extern int cpp_write_pch_deps PARAMS ((cpp_reader *, FILE *));
 729 extern int cpp_write_pch_state PARAMS ((cpp_reader *, FILE *));
 730 extern int cpp_valid_state PARAMS ((cpp_reader *, const char *, int));
 731 extern void cpp_prepare_state PARAMS ((cpp_reader *,
 732                                        struct save_macro_data **));
 733 extern int cpp_read_state PARAMS ((cpp_reader *, const char *, FILE *,
 734                                    struct save_macro_data *));
 735
 736 #ifdef __cplusplus
 737 }
 738 #endif
 739
 740 #endif /* ! GCC_CPPLIB_H */