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