gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
   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 /* For complex reasons, cpp_reader is also typedefed in c-pragma.h.  */
  35 #ifndef GCC_C_PRAGMA_H
  36 typedef struct cpp_reader cpp_reader;
  37 #endif
  38 typedef struct cpp_buffer cpp_buffer;
  39 typedef struct cpp_options cpp_options;
  40 typedef struct cpp_token cpp_token;
  41 typedef struct cpp_string cpp_string;
  42 typedef struct cpp_hashnode cpp_hashnode;
  43 typedef struct cpp_macro cpp_macro;
  44 typedef struct cpp_callbacks cpp_callbacks;
  45
  46 struct answer;
  47 struct file_name_map_list;
  48
  49 /* The first three groups, apart from '=', can appear in preprocessor
  50    expressions (+= and -= are used to indicate unary + and - resp.).
  51    This allows a lookup table to be implemented in _cpp_parse_expr.
  52
  53    The first group, to CPP_LAST_EQ, can be immediately followed by an
  54    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  55    the same order as their counterparts without the '=', like ">>".  */
  56
  57 /* Positions in the table.  */
  58 #define CPP_LAST_EQ CPP_MAX
  59 #define CPP_FIRST_DIGRAPH CPP_HASH
  60 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  61 #define CPP_LAST_CPP_OP CPP_LESS_EQ
  62
  63 #define TTYPE_TABLE                             \
  64   OP(CPP_EQ = 0,        "=")                    \
  65   OP(CPP_NOT,           "!")                    \
  66   OP(CPP_GREATER,       ">")    /* compare */   \
  67   OP(CPP_LESS,          "<")                    \
  68   OP(CPP_PLUS,          "+")    /* math */      \
  69   OP(CPP_MINUS,         "-")                    \
  70   OP(CPP_MULT,          "*")                    \
  71   OP(CPP_DIV,           "/")                    \
  72   OP(CPP_MOD,           "%")                    \
  73   OP(CPP_AND,           "&")    /* bit ops */   \
  74   OP(CPP_OR,            "|")                    \
  75   OP(CPP_XOR,           "^")                    \
  76   OP(CPP_RSHIFT,        ">>")                   \
  77   OP(CPP_LSHIFT,        "<<")                   \
  78   OP(CPP_MIN,           "<?")   /* extension */ \
  79   OP(CPP_MAX,           ">?")                   \
  80 \
  81   OP(CPP_COMPL,         "~")                    \
  82   OP(CPP_AND_AND,       "&&")   /* logical */   \
  83   OP(CPP_OR_OR,         "||")                   \
  84   OP(CPP_QUERY,         "?")                    \
  85   OP(CPP_COLON,         ":")                    \
  86   OP(CPP_COMMA,         ",")    /* grouping */  \
  87   OP(CPP_OPEN_PAREN,    "(")                    \
  88   OP(CPP_CLOSE_PAREN,   ")")                    \
  89   TK(CPP_EOF,           SPELL_NONE)             \
  90   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  91   OP(CPP_NOT_EQ,        "!=")                   \
  92   OP(CPP_GREATER_EQ,    ">=")                   \
  93   OP(CPP_LESS_EQ,       "<=")                   \
  94 \
  95   /* These two are unary + / - in preprocessor expressions.  */ \
  96   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  97   OP(CPP_MINUS_EQ,      "-=")                   \
  98 \
  99   OP(CPP_MULT_EQ,       "*=")                   \
 100   OP(CPP_DIV_EQ,        "/=")                   \
 101   OP(CPP_MOD_EQ,        "%=")                   \
 102   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 103   OP(CPP_OR_EQ,         "|=")                   \
 104   OP(CPP_XOR_EQ,        "^=")                   \
 105   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 106   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 107   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 108   OP(CPP_MAX_EQ,        ">?=")                  \
 109   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 110   OP(CPP_HASH,          "#")    /* digraphs */  \
 111   OP(CPP_PASTE,         "##")                   \
 112   OP(CPP_OPEN_SQUARE,   "[")                    \
 113   OP(CPP_CLOSE_SQUARE,  "]")                    \
 114   OP(CPP_OPEN_BRACE,    "{")                    \
 115   OP(CPP_CLOSE_BRACE,   "}")                    \
 116   /* The remainder of the punctuation.  Order is not significant.  */   \
 117   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 118   OP(CPP_ELLIPSIS,      "...")                  \
 119   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 120   OP(CPP_MINUS_MINUS,   "--")                   \
 121   OP(CPP_DEREF,         "->")   /* accessors */ \
 122   OP(CPP_DOT,           ".")                    \
 123   OP(CPP_SCOPE,         "::")                   \
 124   OP(CPP_DEREF_STAR,    "->*")                  \
 125   OP(CPP_DOT_STAR,      ".*")                   \
 126   OP(CPP_ATSIGN,        "@")  /* used in Objective C */ \
 127 \
 128   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 129   TK(CPP_NUMBER,        SPELL_NUMBER)   /* 34_be+ta  */                 \
 130 \
 131   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 132   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 133   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 134 \
 135   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 136   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 137   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 138 \
 139   TK(CPP_COMMENT,       SPELL_NUMBER)   /* Only if output comments.  */ \
 140                                         /* SPELL_NUMBER 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_OBJC, CLK_OBJCXX, 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     unsigned char c;            /* Character represented by CPP_OTHER.  */
 190   } val;
 191 };
 192
 193 /* A type wide enough to hold any multibyte source character.
 194    cpplib's character constant interpreter requires an unsigned type.
 195    Also, a typedef for the signed equivalent.  */
 196 #ifndef MAX_WCHAR_TYPE_SIZE
 197 # define MAX_WCHAR_TYPE_SIZE WCHAR_TYPE_SIZE
 198 #endif
 199 #if SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
 200 # define CPPCHAR_SIGNED_T int
 201 #else
 202 # if SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG
 203 #  define CPPCHAR_SIGNED_T long
 204 # else
 205 #  define CPPCHAR_SIGNED_T long long
 206 # endif
 207 #endif
 208 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
 209 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
 210
 211 /* Values for opts.dump_macros.
 212   dump_only means inhibit output of the preprocessed text
 213              and instead output the definitions of all user-defined
 214              macros in a form suitable for use as input to cpp.
 215    dump_names means pass #define and the macro name through to output.
 216    dump_definitions means pass the whole definition (plus #define) through
 217 */
 218 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 219
 220 /* This structure is nested inside struct cpp_reader, and
 221    carries all the options visible to the command line.  */
 222 struct cpp_options
 223 {
 224   /* Name of input and output files.  */
 225   const char *in_fname;
 226   const char *out_fname;
 227
 228   /* Characters between tab stops.  */
 229   unsigned int tabstop;
 230
 231   /* Pending options - -D, -U, -A, -I, -ixxx.  */
 232   struct cpp_pending *pending;
 233
 234   /* File name which deps are being written to.  This is 0 if deps are
 235      being written to stdout.  */
 236   const char *deps_file;
 237
 238   /* Search paths for include files.  */
 239   struct search_path *quote_include;    /* "" */
 240   struct search_path *bracket_include;  /* <> */
 241
 242   /* Map between header names and file names, used only on DOS where
 243      file names are limited in length.  */
 244   struct file_name_map_list *map_list;
 245
 246   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 247      in the standard include file directories.  */
 248   const char *include_prefix;
 249   unsigned int include_prefix_len;
 250
 251   /* -fleading_underscore sets this to "_".  */
 252   const char *user_label_prefix;
 253
 254   /* Precision for target CPP arithmetic, target characters, target
 255      ints and target wide characters, respectively.  */
 256   size_t precision, char_precision, int_precision, wchar_precision;
 257
 258   /* The language we're preprocessing.  */
 259   enum c_lang lang;
 260
 261   /* Non-0 means -v, so print the full set of include dirs.  */
 262   unsigned char verbose;
 263
 264   /* Nonzero means chars are signed.  */
 265   unsigned char signed_char;
 266
 267   /* Nonzero means use extra default include directories for C++.  */
 268   unsigned char cplusplus;
 269
 270   /* Nonzero means handle cplusplus style comments */
 271   unsigned char cplusplus_comments;
 272
 273   /* Nonzero means handle #import, for objective C.  */
 274   unsigned char objc;
 275
 276   /* Nonzero means don't copy comments into the output file.  */
 277   unsigned char discard_comments;
 278
 279   /* Nonzero means don't copy comments into the output file during
 280      macro expansion.  */
 281   unsigned char discard_comments_in_macro_exp;
 282
 283   /* Nonzero means process the ISO trigraph sequences.  */
 284   unsigned char trigraphs;
 285
 286   /* Nonzero means process the ISO digraph sequences.  */
 287   unsigned char digraphs;
 288
 289   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 290   unsigned char extended_numbers;
 291
 292   /* Nonzero means print the names of included files rather than the
 293      preprocessed output.  1 means just the #include "...", 2 means
 294      #include <...> as well.  */
 295   unsigned char print_deps;
 296
 297   /* Nonzero if phony targets are created for each header.  */
 298   unsigned char deps_phony_targets;
 299
 300   /* Nonzero if missing .h files in -M output are assumed to be
 301      generated files and not errors.  */
 302   unsigned char print_deps_missing_files;
 303
 304   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w").  */
 305   unsigned char print_deps_append;
 306
 307   /* Nonzero means print names of header files (-H).  */
 308   unsigned char print_include_names;
 309
 310   /* Nonzero means cpp_pedwarn causes a hard error.  */
 311   unsigned char pedantic_errors;
 312
 313   /* Nonzero means don't print warning messages.  */
 314   unsigned char inhibit_warnings;
 315
 316   /* Nonzero means don't suppress warnings from system headers.  */
 317   unsigned char warn_system_headers;
 318
 319   /* Nonzero means don't print error messages.  Has no option to
 320      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 321   unsigned char inhibit_errors;
 322
 323   /* Nonzero means warn if slash-star appears in a comment.  */
 324   unsigned char warn_comments;
 325
 326   /* Nonzero means warn if there are any trigraphs.  */
 327   unsigned char warn_trigraphs;
 328
 329   /* Nonzero means warn if #import is used.  */
 330   unsigned char warn_import;
 331
 332   /* Nonzero means warn about various incompatibilities with
 333      traditional C.  */
 334   unsigned char warn_traditional;
 335
 336   /* Nonzero means warn about text after an #endif (or #else).  */
 337   unsigned char warn_endif_labels;
 338
 339   /* Nonzero means turn warnings into errors.  */
 340   unsigned char warnings_are_errors;
 341
 342   /* Nonzero causes output not to be done, but directives such as
 343      #define that have side effects are still obeyed.  */
 344   unsigned char no_output;
 345
 346   /* Nonzero means we should look for header.gcc files that remap file
 347      names.  */
 348   unsigned char remap;
 349
 350   /* Nonzero means don't output line number information.  */
 351   unsigned char no_line_commands;
 352
 353   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 354      the source-file directory.  */
 355   unsigned char ignore_srcdir;
 356
 357   /* Zero means dollar signs are punctuation.  */
 358   unsigned char dollars_in_ident;
 359
 360   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 361   unsigned char warn_undef;
 362
 363   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 364   unsigned char c99;
 365
 366   /* Nonzero means give all the error messages the ANSI standard requires.  */
 367   unsigned char pedantic;
 368
 369   /* Nonzero means we're looking at already preprocessed code, so don't
 370      bother trying to do macro expansion and whatnot.  */
 371   unsigned char preprocessed;
 372
 373   /* Nonzero disables all the standard directories for headers.  */
 374   unsigned char no_standard_includes;
 375
 376   /* Nonzero disables the C++-specific standard directories for headers.  */
 377   unsigned char no_standard_cplusplus_includes;
 378
 379   /* Nonzero means dump macros in some fashion - see above.  */
 380   unsigned char dump_macros;
 381
 382   /* Nonzero means pass #include lines through to the output.  */
 383   unsigned char dump_includes;
 384
 385   /* Print column number in error messages.  */
 386   unsigned char show_column;
 387
 388   /* Nonzero means handle C++ alternate operator names.  */
 389   unsigned char operator_names;
 390
 391   /* True if --help, --version or --target-help appeared in the
 392      options.  Stand-alone CPP should then bail out after option
 393      parsing; drivers might want to continue printing help.  */
 394   unsigned char help_only;
 395 };
 396
 397 /* Call backs.  */
 398 struct cpp_callbacks
 399 {
 400   /* Called when a new line of preprocessed output is started.  */
 401   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
 402   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
 403   void (*include) PARAMS ((cpp_reader *, unsigned int,
 404                            const unsigned char *, const cpp_token *));
 405   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 406   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 407   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
 408   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
 409   /* Called when the client has a chance to properly register
 410      built-ins with cpp_define() and cpp_assert().  */
 411   void (*register_builtins) PARAMS ((cpp_reader *));
 412 };
 413
 414 #define CPP_FATAL_LIMIT 1000
 415 /* True if we have seen a "fatal" error.  */
 416 #define CPP_FATAL_ERRORS(PFILE) (cpp_errors (PFILE) >= CPP_FATAL_LIMIT)
 417
 418 /* Name under which this program was invoked.  */
 419 extern const char *progname;
 420
 421 /* The structure of a node in the hash table.  The hash table has
 422    entries for all identifiers: either macros defined by #define
 423    commands (type NT_MACRO), assertions created with #assert
 424    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 425    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 426    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 427    identifier that behaves like an operator such as "xor".
 428    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 429    diagnostic may be required for this node.  Currently this only
 430    applies to __VA_ARGS__ and poisoned identifiers.  */
 431
 432 /* Hash node flags.  */
 433 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 434 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 435 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 436 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 437 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 438 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 439
 440 /* Different flavors of hash node.  */
 441 enum node_type
 442 {
 443   NT_VOID = 0,     /* No definition yet.  */
 444   NT_MACRO,        /* A macro of some form.  */
 445   NT_ASSERTION     /* Predicate for #assert.  */
 446 };
 447
 448 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 449    handle it with the builtin code for efficiency reasons.  */
 450 enum builtin_type
 451 {
 452   BT_SPECLINE = 0,              /* `__LINE__' */
 453   BT_DATE,                      /* `__DATE__' */
 454   BT_FILE,                      /* `__FILE__' */
 455   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 456   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 457   BT_TIME,                      /* `__TIME__' */
 458   BT_STDC,                      /* `__STDC__' */
 459   BT_PRAGMA                     /* `_Pragma' operator */
 460 };
 461
 462 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 463 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 464 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 465 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 466
 467 /* The common part of an identifier node shared amongst all 3 C front
 468    ends.  Also used to store CPP identifiers, which are a superset of
 469    identifiers in the grammatical sense.  */
 470 struct cpp_hashnode
 471 {
 472   struct ht_identifier ident;
 473   unsigned short arg_index;             /* Macro argument index.  */
 474   unsigned char directive_index;        /* Index into directive table.  */
 475   unsigned char rid_code;               /* Rid code - for front ends.  */
 476   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 477   unsigned char flags;                  /* CPP flags.  */
 478
 479   union
 480   {
 481     cpp_macro *macro;                   /* If a macro.  */
 482     struct answer *answers;             /* Answers to an assertion.  */
 483     enum cpp_ttype operator;            /* Code for a named operator.  */
 484     enum builtin_type builtin;          /* Code for a builtin macro.  */
 485   } value;
 486 };
 487
 488 /* Call this first to get a handle to pass to other functions.  */
 489 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 490
 491 /* Call these to get pointers to the options and callback structures
 492    for a given reader.  These pointers are good until you call
 493    cpp_finish on that reader.  You can either edit the callbacks
 494    through the pointer returned from cpp_get_callbacks, or set them
 495    with cpp_set_callbacks.  */
 496 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
 497 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
 498 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
 499 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
 500
 501 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
 502    return value is the number of arguments used.  If
 503    cpp_handle_options returns without using all arguments, it couldn't
 504    understand the next switch.  When there are no switches left, you
 505    must call cpp_post_options before calling cpp_read_main_file.  Only
 506    after cpp_post_options are the contents of the cpp_options
 507    structure reliable.  Options processing is not completed until you
 508    call cpp_finish_options.  */
 509 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 510 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **, int));
 511 extern void cpp_post_options PARAMS ((cpp_reader *));
 512
 513 /* This function reads the file, but does not start preprocessing.  It
 514    returns the name of the original file; this is the same as the
 515    input file, except for preprocessed input.  This will generate at
 516    least one file change callback, and possibly a line change callback
 517    too.  If there was an error opening the file, it returns NULL.
 518
 519    If you want cpplib to manage its own hashtable, pass in a NULL
 520    pointer.  Otherise you should pass in an initialised hash table
 521    that cpplib will share; this technique is used by the C front
 522    ends.  */
 523 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
 524                                                struct ht *));
 525
 526 /* Deferred handling of command line options that can generate debug
 527    callbacks, such as -D and -imacros.  Call this after
 528    cpp_read_main_file.  The front ends need this separation so they
 529    can initialize debug output with the original file name, returned
 530    from cpp_read_main_file, before they get debug callbacks.  */
 531 extern void cpp_finish_options PARAMS ((cpp_reader *));
 532
 533 /* Call this to release the handle at the end of preprocessing.  Any
 534    use of the handle after this function returns is invalid.  Returns
 535    cpp_errors (pfile).  */
 536 extern int cpp_destroy PARAMS ((cpp_reader *));
 537
 538 /* Error count.  */
 539 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
 540
 541 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 542 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 543                                                  const cpp_token *));
 544 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 545                                                unsigned char *));
 546 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 547                                          const char *, const char *,
 548                                          void (*) PARAMS ((cpp_reader *))));
 549
 550 extern void cpp_finish PARAMS ((cpp_reader *));
 551 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 552                                     const cpp_token *));
 553 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
 554 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 555                                                   const cpp_hashnode *));
 556 extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
 557
 558 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 559 extern cppchar_t
 560 cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
 561                                  int, unsigned int *, int *));
 562
 563 /* Used to register builtins during the register_builtins callback.
 564    The text is the same as the command line argument.  */
 565 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 566 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 567 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 568 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 569
 570 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 571                                             const unsigned char *, size_t,
 572                                             int, int));
 573 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 574
 575 /* Diagnostic levels.  To get a dianostic without associating a
 576    position in the translation unit with it, use cpp_error_with_line
 577    with a line number of zero.  */
 578
 579 /* Warning, an error with -Werror.  */
 580 #define DL_WARNING              0x00
 581 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
 582 #define DL_WARNING_SYSHDR       0x01
 583 /* Warning, an error with -pedantic-errors or -Werror.  */
 584 #define DL_PEDWARN              0x02
 585 /* An error.  */
 586 #define DL_ERROR                0x03
 587 /* A fatal error.  We do not exit, to support use of cpplib as a
 588    library, but may only return CPP_EOF tokens thereon.  It is the
 589    caller's responsibility to check CPP_FATAL_ERRORS.  */
 590 #define DL_FATAL                0x04
 591 /* An internal consistency check failed.  Prints "internal error: ",
 592    otherwise the same as DL_FATAL.  */
 593 #define DL_ICE                  0x05
 594 /* Extracts a diagnostic level from an int.  */
 595 #define DL_EXTRACT(l)           (l & 0xf)
 596 /* Non-zero if a diagnostic level is one of the warnings.  */
 597 #define DL_WARNING_P(l)         (DL_EXTRACT (l) >= DL_WARNING \
 598                                  && DL_EXTRACT (l) <= DL_PEDWARN)
 599
 600 /* N.B. The error-message-printer prototypes have not been nicely
 601    formatted because exgettext needs to see 'msgid' on the same line
 602    as the name of the function in order to work properly.  Only the
 603    string argument gets a name in an effort to keep the lines from
 604    getting ridiculously oversized.  */
 605
 606 /* Output a diagnostic of some kind.  */
 607 extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
 608   ATTRIBUTE_PRINTF_3;
 609
 610 /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
 611    error string of errno.  No location is printed.  */
 612 extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
 613
 614 /* Same as cpp_error, except additionally specifies a position as a
 615    (translation unit) physical line and physical column.  If the line is
 616    zero, then no location is printed.  */
 617 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
 618   ATTRIBUTE_PRINTF_5;
 619
 620 /* In cpplex.c */
 621 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 622                                                  const char *));
 623 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 624 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 625 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 626 /* Returns the value of an escape sequence, truncated to the correct
 627    target precision.  PSTR points to the input pointer, which is just
 628    after the backslash.  LIMIT is how much text we have.  WIDE is true
 629    if the escape sequence is part of a wide character constant or
 630    string literal.  Handles all relevant diagnostics.  */
 631 extern cppchar_t cpp_parse_escape       PARAMS ((cpp_reader *,
 632                                                  const unsigned char ** pstr,
 633                                                  const unsigned char *limit,
 634                                                  int wide));
 635
 636 /* In cpphash.c */
 637
 638 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 639    table if it is not already there.  */
 640 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 641                                                  const unsigned char *,
 642                                                  unsigned int));
 643
 644 typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
 645 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 646                                                  cpp_cb, void *));
 647
 648 /* In cppmacro.c */
 649 extern void cpp_scan_nooutput           PARAMS ((cpp_reader *));
 650 extern int  cpp_sys_macro_p             PARAMS ((cpp_reader *));
 651 extern unsigned char *cpp_quote_string  PARAMS ((unsigned char *,
 652                                                  const unsigned char *,
 653                                                  unsigned int));
 654
 655 /* In cppfiles.c */
 656 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 657 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
 658
 659 /* In cppmain.c */
 660 extern void cpp_preprocess_file PARAMS ((cpp_reader *));
 661
 662 #ifdef __cplusplus
 663 }
 664 #endif
 665
 666 #endif /* ! GCC_CPPLIB_H */