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_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 CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
 200 # define CPPCHAR_SIGNED_T int
 201 #else
 202 # if CHAR_BIT * 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   /* The language we're preprocessing.  */
 252   enum c_lang lang;
 253
 254   /* Non-0 means -v, so print the full set of include dirs.  */
 255   unsigned char verbose;
 256
 257   /* Nonzero means use extra default include directories for C++.  */
 258   unsigned char cplusplus;
 259
 260   /* Nonzero means handle cplusplus style comments */
 261   unsigned char cplusplus_comments;
 262
 263   /* Nonzero means define __OBJC__, treat @ as a special token, and
 264      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 265   unsigned char objc;
 266
 267   /* Nonzero means don't copy comments into the output file.  */
 268   unsigned char discard_comments;
 269
 270   /* Nonzero means don't copy comments into the output file during
 271      macro expansion.  */
 272   unsigned char discard_comments_in_macro_exp;
 273
 274   /* Nonzero means process the ISO trigraph sequences.  */
 275   unsigned char trigraphs;
 276
 277   /* Nonzero means process the ISO digraph sequences.  */
 278   unsigned char digraphs;
 279
 280   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 281   unsigned char extended_numbers;
 282
 283   /* Nonzero means print the names of included files rather than the
 284      preprocessed output.  1 means just the #include "...", 2 means
 285      #include <...> as well.  */
 286   unsigned char print_deps;
 287
 288   /* Nonzero if phony targets are created for each header.  */
 289   unsigned char deps_phony_targets;
 290
 291   /* Nonzero if missing .h files in -M output are assumed to be
 292      generated files and not errors.  */
 293   unsigned char print_deps_missing_files;
 294
 295   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w").  */
 296   unsigned char print_deps_append;
 297
 298   /* Nonzero means print names of header files (-H).  */
 299   unsigned char print_include_names;
 300
 301   /* Nonzero means cpp_pedwarn causes a hard error.  */
 302   unsigned char pedantic_errors;
 303
 304   /* Nonzero means don't print warning messages.  */
 305   unsigned char inhibit_warnings;
 306
 307   /* Nonzero means don't suppress warnings from system headers.  */
 308   unsigned char warn_system_headers;
 309
 310   /* Nonzero means don't print error messages.  Has no option to
 311      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 312   unsigned char inhibit_errors;
 313
 314   /* Nonzero means warn if slash-star appears in a comment.  */
 315   unsigned char warn_comments;
 316
 317   /* Nonzero means warn if there are any trigraphs.  */
 318   unsigned char warn_trigraphs;
 319
 320   /* Nonzero means warn if #import is used.  */
 321   unsigned char warn_import;
 322
 323   /* Nonzero means warn about multicharacter charconsts.  */
 324   unsigned char warn_multichar;
 325
 326   /* Nonzero means warn about various incompatibilities with
 327      traditional C.  */
 328   unsigned char warn_traditional;
 329
 330   /* Nonzero means warn about long long numeric constants.  */
 331   unsigned char warn_long_long;
 332
 333   /* Nonzero means warn about text after an #endif (or #else).  */
 334   unsigned char warn_endif_labels;
 335
 336   /* Nonzero means warn about implicit sign changes owing to integer
 337      promotions.  */
 338   unsigned char warn_num_sign_change;
 339
 340   /* Nonzero means turn warnings into errors.  */
 341   unsigned char warnings_are_errors;
 342
 343   /* Nonzero causes output not to be done, but directives such as
 344      #define that have side effects are still obeyed.  */
 345   unsigned char no_output;
 346
 347   /* Nonzero means we should look for header.gcc files that remap file
 348      names.  */
 349   unsigned char remap;
 350
 351   /* Nonzero means don't output line number information.  */
 352   unsigned char no_line_commands;
 353
 354   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 355      the source-file directory.  */
 356   unsigned char ignore_srcdir;
 357
 358   /* Zero means dollar signs are punctuation.  */
 359   unsigned char dollars_in_ident;
 360
 361   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 362   unsigned char warn_undef;
 363
 364   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 365   unsigned char c99;
 366
 367   /* Nonzero means give all the error messages the ANSI standard requires.  */
 368   unsigned char pedantic;
 369
 370   /* Nonzero means we're looking at already preprocessed code, so don't
 371      bother trying to do macro expansion and whatnot.  */
 372   unsigned char preprocessed;
 373
 374   /* Nonzero disables all the standard directories for headers.  */
 375   unsigned char no_standard_includes;
 376
 377   /* Nonzero disables the C++-specific standard directories for headers.  */
 378   unsigned char no_standard_cplusplus_includes;
 379
 380   /* Nonzero means dump macros in some fashion - see above.  */
 381   unsigned char dump_macros;
 382
 383   /* Nonzero means pass #include lines through to the output.  */
 384   unsigned char dump_includes;
 385
 386   /* Print column number in error messages.  */
 387   unsigned char show_column;
 388
 389   /* Nonzero means handle C++ alternate operator names.  */
 390   unsigned char operator_names;
 391
 392   /* True if --help, --version or --target-help appeared in the
 393      options.  Stand-alone CPP should then bail out after option
 394      parsing; drivers might want to continue printing help.  */
 395   unsigned char help_only;
 396
 397   /* True for traditional preprocessing.  */
 398   unsigned char traditional;
 399
 400   /* True if only preprocessing and not compiling.  */
 401   unsigned char preprocess_only;
 402
 403   /* Target-specific features set by the front end or client.  */
 404
 405   /* Precision for target CPP arithmetic, target characters, target
 406      ints and target wide characters, respectively.  */
 407   size_t precision, char_precision, int_precision, wchar_precision;
 408
 409   /* True means chars (wide chars) are unsigned.  */
 410   bool unsigned_char, unsigned_wchar;
 411
 412   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 413   unsigned char stdc_0_in_system_headers;
 414 };
 415
 416 /* Call backs.  */
 417 struct cpp_callbacks
 418 {
 419   /* Called when a new line of preprocessed output is started.  */
 420   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
 421   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
 422   void (*include) PARAMS ((cpp_reader *, unsigned int,
 423                            const unsigned char *, const cpp_token *));
 424   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 425   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 426   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
 427   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
 428   /* Called when the client has a chance to properly register
 429      built-ins with cpp_define() and cpp_assert().  */
 430   void (*register_builtins) PARAMS ((cpp_reader *));
 431 };
 432
 433 /* Name under which this program was invoked.  */
 434 extern const char *progname;
 435
 436 /* The structure of a node in the hash table.  The hash table has
 437    entries for all identifiers: either macros defined by #define
 438    commands (type NT_MACRO), assertions created with #assert
 439    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 440    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 441    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 442    identifier that behaves like an operator such as "xor".
 443    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 444    diagnostic may be required for this node.  Currently this only
 445    applies to __VA_ARGS__ and poisoned identifiers.  */
 446
 447 /* Hash node flags.  */
 448 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 449 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 450 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 451 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 452 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 453 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 454
 455 /* Different flavors of hash node.  */
 456 enum node_type
 457 {
 458   NT_VOID = 0,     /* No definition yet.  */
 459   NT_MACRO,        /* A macro of some form.  */
 460   NT_ASSERTION     /* Predicate for #assert.  */
 461 };
 462
 463 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 464    handle it with the builtin code for efficiency reasons.  */
 465 enum builtin_type
 466 {
 467   BT_SPECLINE = 0,              /* `__LINE__' */
 468   BT_DATE,                      /* `__DATE__' */
 469   BT_FILE,                      /* `__FILE__' */
 470   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 471   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 472   BT_TIME,                      /* `__TIME__' */
 473   BT_STDC,                      /* `__STDC__' */
 474   BT_PRAGMA                     /* `_Pragma' operator */
 475 };
 476
 477 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 478 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 479 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 480 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 481
 482 /* The common part of an identifier node shared amongst all 3 C front
 483    ends.  Also used to store CPP identifiers, which are a superset of
 484    identifiers in the grammatical sense.  */
 485 struct cpp_hashnode
 486 {
 487   struct ht_identifier ident;
 488   unsigned short arg_index;             /* Macro argument index.  */
 489   unsigned char directive_index;        /* Index into directive table.  */
 490   unsigned char rid_code;               /* Rid code - for front ends.  */
 491   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 492   unsigned char flags;                  /* CPP flags.  */
 493
 494   union
 495   {
 496     cpp_macro *macro;                   /* If a macro.  */
 497     struct answer *answers;             /* Answers to an assertion.  */
 498     enum cpp_ttype operator;            /* Code for a named operator.  */
 499     enum builtin_type builtin;          /* Code for a builtin macro.  */
 500   } value;
 501 };
 502
 503 /* Call this first to get a handle to pass to other functions.  */
 504 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 505
 506 /* Call these to get pointers to the options and callback structures
 507    for a given reader.  These pointers are good until you call
 508    cpp_finish on that reader.  You can either edit the callbacks
 509    through the pointer returned from cpp_get_callbacks, or set them
 510    with cpp_set_callbacks.  */
 511 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
 512 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
 513 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
 514 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
 515
 516 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
 517    return value is the number of arguments used.  If
 518    cpp_handle_options returns without using all arguments, it couldn't
 519    understand the next switch.  When there are no switches left, you
 520    must call cpp_post_options before calling cpp_read_main_file.  Only
 521    after cpp_post_options are the contents of the cpp_options
 522    structure reliable.  Options processing is not completed until you
 523    call cpp_finish_options.  */
 524 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 525 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 526 extern void cpp_post_options PARAMS ((cpp_reader *));
 527
 528 /* This function reads the file, but does not start preprocessing.  It
 529    returns the name of the original file; this is the same as the
 530    input file, except for preprocessed input.  This will generate at
 531    least one file change callback, and possibly a line change callback
 532    too.  If there was an error opening the file, it returns NULL.
 533
 534    If you want cpplib to manage its own hashtable, pass in a NULL
 535    pointer.  Otherise you should pass in an initialised hash table
 536    that cpplib will share; this technique is used by the C front
 537    ends.  */
 538 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
 539                                                struct ht *));
 540
 541 /* Deferred handling of command line options that can generate debug
 542    callbacks, such as -D and -imacros.  Call this after
 543    cpp_read_main_file.  The front ends need this separation so they
 544    can initialize debug output with the original file name, returned
 545    from cpp_read_main_file, before they get debug callbacks.  */
 546 extern void cpp_finish_options PARAMS ((cpp_reader *));
 547
 548 /* Call this to release the handle at the end of preprocessing.  Any
 549    use of the handle after this function returns is invalid.  Returns
 550    cpp_errors (pfile).  */
 551 extern int cpp_destroy PARAMS ((cpp_reader *));
 552
 553 /* Error count.  */
 554 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
 555
 556 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 557 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 558                                                  const cpp_token *));
 559 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 560                                                unsigned char *));
 561 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 562                                          const char *, const char *,
 563                                          void (*) PARAMS ((cpp_reader *))));
 564
 565 extern void cpp_finish PARAMS ((cpp_reader *));
 566 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 567                                     const cpp_token *));
 568 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
 569 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 570                                                   const cpp_hashnode *));
 571 extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
 572
 573 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 574 extern cppchar_t
 575 cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
 576                                  unsigned int *, int *));
 577
 578 /* Used to register builtins during the register_builtins callback.
 579    The text is the same as the command line argument.  */
 580 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 581 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 582 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 583 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 584
 585 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 586                                             const unsigned char *, size_t,
 587                                             int, int));
 588 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 589
 590 /* A preprocessing number.  Code assumes that any unused high bits of
 591    the double integer are set to zero.  */
 592 typedef unsigned HOST_WIDE_INT cpp_num_part;
 593 typedef struct cpp_num cpp_num;
 594 struct cpp_num
 595 {
 596   cpp_num_part high;
 597   cpp_num_part low;
 598   bool unsignedp;  /* True if value should be treated as unsigned.  */
 599   bool overflow;   /* True if the most recent calculation overflowed.  */
 600 };
 601
 602 /* cpplib provides two interfaces for interpretation of preprocessing
 603    numbers.
 604
 605    cpp_classify_number categorizes numeric constants according to
 606    their field (integer, floating point, or invalid), radix (decimal,
 607    octal, hexadecimal), and type suffixes.  */
 608
 609 #define CPP_N_CATEGORY  0x000F
 610 #define CPP_N_INVALID   0x0000
 611 #define CPP_N_INTEGER   0x0001
 612 #define CPP_N_FLOATING  0x0002
 613
 614 #define CPP_N_WIDTH     0x00F0
 615 #define CPP_N_SMALL     0x0010  /* int, float.  */
 616 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 617 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 618
 619 #define CPP_N_RADIX     0x0F00
 620 #define CPP_N_DECIMAL   0x0100
 621 #define CPP_N_HEX       0x0200
 622 #define CPP_N_OCTAL     0x0400
 623
 624 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 625 #define CPP_N_IMAGINARY 0x2000
 626
 627 /* Classify a CPP_NUMBER token.  The return value is a combination of
 628    the flags from the above sets.  */
 629 extern unsigned cpp_classify_number PARAMS ((cpp_reader *, const cpp_token *));
 630
 631 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 632 extern cpp_num cpp_interpret_integer PARAMS ((cpp_reader *, const cpp_token *,
 633                                               unsigned int type));
 634
 635 /* Sign extend a number, with PRECISION significant bits and all
 636    others assumed clear, to fill out a cpp_num structure.  */
 637 cpp_num cpp_num_sign_extend PARAMS ((cpp_num, size_t));
 638
 639 /* Diagnostic levels.  To get a dianostic without associating a
 640    position in the translation unit with it, use cpp_error_with_line
 641    with a line number of zero.  */
 642
 643 /* Warning, an error with -Werror.  */
 644 #define DL_WARNING              0x00
 645 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
 646 #define DL_WARNING_SYSHDR       0x01
 647 /* Warning, an error with -pedantic-errors or -Werror.  */
 648 #define DL_PEDWARN              0x02
 649 /* An error.  */
 650 #define DL_ERROR                0x03
 651 /* An internal consistency check failed.  Prints "internal error: ",
 652    otherwise the same as DL_ERROR.  */
 653 #define DL_ICE                  0x04
 654 /* Extracts a diagnostic level from an int.  */
 655 #define DL_EXTRACT(l)           (l & 0xf)
 656 /* Non-zero if a diagnostic level is one of the warnings.  */
 657 #define DL_WARNING_P(l)         (DL_EXTRACT (l) >= DL_WARNING \
 658                                  && DL_EXTRACT (l) <= DL_PEDWARN)
 659
 660 /* N.B. The error-message-printer prototypes have not been nicely
 661    formatted because exgettext needs to see 'msgid' on the same line
 662    as the name of the function in order to work properly.  Only the
 663    string argument gets a name in an effort to keep the lines from
 664    getting ridiculously oversized.  */
 665
 666 /* Output a diagnostic of some kind.  */
 667 extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
 668   ATTRIBUTE_PRINTF_3;
 669
 670 /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
 671    error string of errno.  No location is printed.  */
 672 extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
 673
 674 /* Same as cpp_error, except additionally specifies a position as a
 675    (translation unit) physical line and physical column.  If the line is
 676    zero, then no location is printed.  */
 677 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
 678   ATTRIBUTE_PRINTF_5;
 679
 680 /* In cpplex.c */
 681 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 682                                                  const char *));
 683 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 684 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 685 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 686 /* Returns the value of an escape sequence, truncated to the correct
 687    target precision.  PSTR points to the input pointer, which is just
 688    after the backslash.  LIMIT is how much text we have.  WIDE is true
 689    if the escape sequence is part of a wide character constant or
 690    string literal.  Handles all relevant diagnostics.  */
 691 extern cppchar_t cpp_parse_escape       PARAMS ((cpp_reader *,
 692                                                  const unsigned char ** pstr,
 693                                                  const unsigned char *limit,
 694                                                  int wide));
 695
 696 /* In cpphash.c */
 697
 698 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 699    table if it is not already there.  */
 700 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 701                                                  const unsigned char *,
 702                                                  unsigned int));
 703
 704 typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
 705 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 706                                                  cpp_cb, void *));
 707
 708 /* In cppmacro.c */
 709 extern void cpp_scan_nooutput           PARAMS ((cpp_reader *));
 710 extern int  cpp_sys_macro_p             PARAMS ((cpp_reader *));
 711 extern unsigned char *cpp_quote_string  PARAMS ((unsigned char *,
 712                                                  const unsigned char *,
 713                                                  unsigned int));
 714
 715 /* In cppfiles.c */
 716 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 717 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
 718
 719 /* In cppmain.c */
 720 extern void cpp_preprocess_file PARAMS ((cpp_reader *));
 721
 722 #ifdef __cplusplus
 723 }
 724 #endif
 725
 726 #endif /* ! GCC_CPPLIB_H */