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   /* Characters between tab stops.  */
 225   unsigned int tabstop;
 226
 227   /* Pending options - -D, -U, -A, -I, -ixxx.  */
 228   struct cpp_pending *pending;
 229
 230   /* Search paths for include files.  */
 231   struct search_path *quote_include;    /* "" */
 232   struct search_path *bracket_include;  /* <> */
 233
 234   /* Map between header names and file names, used only on DOS where
 235      file names are limited in length.  */
 236   struct file_name_map_list *map_list;
 237
 238   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 239      in the standard include file directories.  */
 240   const char *include_prefix;
 241   unsigned int include_prefix_len;
 242
 243   /* The language we're preprocessing.  */
 244   enum c_lang lang;
 245
 246   /* Non-0 means -v, so print the full set of include dirs.  */
 247   unsigned char verbose;
 248
 249   /* Nonzero means use extra default include directories for C++.  */
 250   unsigned char cplusplus;
 251
 252   /* Nonzero means handle cplusplus style comments */
 253   unsigned char cplusplus_comments;
 254
 255   /* Nonzero means define __OBJC__, treat @ as a special token, and
 256      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 257   unsigned char objc;
 258
 259   /* Nonzero means don't copy comments into the output file.  */
 260   unsigned char discard_comments;
 261
 262   /* Nonzero means don't copy comments into the output file during
 263      macro expansion.  */
 264   unsigned char discard_comments_in_macro_exp;
 265
 266   /* Nonzero means process the ISO trigraph sequences.  */
 267   unsigned char trigraphs;
 268
 269   /* Nonzero means process the ISO digraph sequences.  */
 270   unsigned char digraphs;
 271
 272   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 273   unsigned char extended_numbers;
 274
 275   /* Nonzero means print names of header files (-H).  */
 276   unsigned char print_include_names;
 277
 278   /* Nonzero means cpp_pedwarn causes a hard error.  */
 279   unsigned char pedantic_errors;
 280
 281   /* Nonzero means don't print warning messages.  */
 282   unsigned char inhibit_warnings;
 283
 284   /* Nonzero means don't suppress warnings from system headers.  */
 285   unsigned char warn_system_headers;
 286
 287   /* Nonzero means don't print error messages.  Has no option to
 288      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 289   unsigned char inhibit_errors;
 290
 291   /* Nonzero means warn if slash-star appears in a comment.  */
 292   unsigned char warn_comments;
 293
 294   /* Nonzero means warn if there are any trigraphs.  */
 295   unsigned char warn_trigraphs;
 296
 297   /* Nonzero means warn if #import is used.  */
 298   unsigned char warn_import;
 299
 300   /* Nonzero means warn about multicharacter charconsts.  */
 301   unsigned char warn_multichar;
 302
 303   /* Nonzero means warn about various incompatibilities with
 304      traditional C.  */
 305   unsigned char warn_traditional;
 306
 307   /* Nonzero means warn about long long numeric constants.  */
 308   unsigned char warn_long_long;
 309
 310   /* Nonzero means warn about text after an #endif (or #else).  */
 311   unsigned char warn_endif_labels;
 312
 313   /* Nonzero means warn about implicit sign changes owing to integer
 314      promotions.  */
 315   unsigned char warn_num_sign_change;
 316
 317   /* Nonzero means turn warnings into errors.  */
 318   unsigned char warnings_are_errors;
 319
 320   /* Nonzero causes output not to be done, but directives such as
 321      #define that have side effects are still obeyed.  */
 322   unsigned char no_output;
 323
 324   /* Nonzero means we should look for header.gcc files that remap file
 325      names.  */
 326   unsigned char remap;
 327
 328   /* Nonzero means don't output line number information.  */
 329   unsigned char no_line_commands;
 330
 331   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 332      the source-file directory.  */
 333   unsigned char ignore_srcdir;
 334
 335   /* Zero means dollar signs are punctuation.  */
 336   unsigned char dollars_in_ident;
 337
 338   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 339   unsigned char warn_undef;
 340
 341   /* Nonzero means warn of unused macros from the main file.  */
 342   unsigned char warn_unused_macros;
 343
 344   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 345   unsigned char c99;
 346
 347   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 348   unsigned char std;
 349
 350   /* Nonzero means give all the error messages the ANSI standard requires.  */
 351   unsigned char pedantic;
 352
 353   /* Nonzero means we're looking at already preprocessed code, so don't
 354      bother trying to do macro expansion and whatnot.  */
 355   unsigned char preprocessed;
 356
 357   /* Nonzero disables all the standard directories for headers.  */
 358   unsigned char no_standard_includes;
 359
 360   /* Nonzero disables the C++-specific standard directories for headers.  */
 361   unsigned char no_standard_cplusplus_includes;
 362
 363   /* Nonzero means dump macros in some fashion - see above.  */
 364   unsigned char dump_macros;
 365
 366   /* Nonzero means pass #include lines through to the output.  */
 367   unsigned char dump_includes;
 368
 369   /* Print column number in error messages.  */
 370   unsigned char show_column;
 371
 372   /* Nonzero means handle C++ alternate operator names.  */
 373   unsigned char operator_names;
 374
 375   /* True for traditional preprocessing.  */
 376   unsigned char traditional;
 377
 378   /* Dependency generation.  */
 379   struct
 380   {
 381     /* Style of header dependencies to generate.  */
 382     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 383
 384     /* Assume missing files are generated files.  */
 385     bool missing_files;
 386
 387     /* Generate phony targets for each dependency apart from the first
 388        one.  */
 389     bool phony_targets;
 390
 391     /* If true, no dependency is generated on the main file.  */
 392     bool ignore_main_file;
 393   } deps;
 394
 395   /* Target-specific features set by the front end or client.  */
 396
 397   /* Precision for target CPP arithmetic, target characters, target
 398      ints and target wide characters, respectively.  */
 399   size_t precision, char_precision, int_precision, wchar_precision;
 400
 401   /* True means chars (wide chars) are unsigned.  */
 402   bool unsigned_char, unsigned_wchar;
 403
 404   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 405   unsigned char stdc_0_in_system_headers;
 406 };
 407
 408 /* Call backs.  */
 409 struct cpp_callbacks
 410 {
 411   /* Called when a new line of preprocessed output is started.  */
 412   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
 413   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
 414   void (*include) PARAMS ((cpp_reader *, unsigned int,
 415                            const unsigned char *, const cpp_token *));
 416   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 417   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
 418   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
 419   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
 420   /* Called when the client has a chance to properly register
 421      built-ins with cpp_define() and cpp_assert().  */
 422   void (*register_builtins) PARAMS ((cpp_reader *));
 423 };
 424
 425 /* Name under which this program was invoked.  */
 426 extern const char *progname;
 427
 428 /* The structure of a node in the hash table.  The hash table has
 429    entries for all identifiers: either macros defined by #define
 430    commands (type NT_MACRO), assertions created with #assert
 431    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 432    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 433    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 434    identifier that behaves like an operator such as "xor".
 435    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 436    diagnostic may be required for this node.  Currently this only
 437    applies to __VA_ARGS__ and poisoned identifiers.  */
 438
 439 /* Hash node flags.  */
 440 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 441 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 442 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 443 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 444 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 445 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 446 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing. */
 447
 448 /* Different flavors of hash node.  */
 449 enum node_type
 450 {
 451   NT_VOID = 0,     /* No definition yet.  */
 452   NT_MACRO,        /* A macro of some form.  */
 453   NT_ASSERTION     /* Predicate for #assert.  */
 454 };
 455
 456 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 457    handle it with the builtin code for efficiency reasons.  */
 458 enum builtin_type
 459 {
 460   BT_SPECLINE = 0,              /* `__LINE__' */
 461   BT_DATE,                      /* `__DATE__' */
 462   BT_FILE,                      /* `__FILE__' */
 463   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 464   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 465   BT_TIME,                      /* `__TIME__' */
 466   BT_STDC,                      /* `__STDC__' */
 467   BT_PRAGMA                     /* `_Pragma' operator */
 468 };
 469
 470 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 471 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 472 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 473 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 474
 475 /* The common part of an identifier node shared amongst all 3 C front
 476    ends.  Also used to store CPP identifiers, which are a superset of
 477    identifiers in the grammatical sense.  */
 478 struct cpp_hashnode
 479 {
 480   struct ht_identifier ident;
 481   unsigned int is_directive : 1;
 482   unsigned int directive_index : 7;     /* If is_directive,
 483                                            then index into directive table.
 484                                            Otherwise, a NODE_OPERATOR. */
 485   unsigned char rid_code;               /* Rid code - for front ends.  */
 486   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 487   unsigned char flags;                  /* CPP flags.  */
 488
 489   union _cpp_hashnode_value
 490   {
 491     cpp_macro *macro;                   /* If a macro.  */
 492     struct answer *answers;             /* Answers to an assertion.  */
 493     enum builtin_type builtin;          /* Code for a builtin macro.  */
 494     unsigned short arg_index;           /* Macro argument index.  */
 495   } value;
 496 };
 497
 498 /* Call this first to get a handle to pass to other functions.  */
 499 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 500
 501 /* Call this to change the selected language standard (e.g. because of
 502    command line options).  */
 503 extern void cpp_set_lang PARAMS ((cpp_reader *, enum c_lang));
 504
 505 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 506    called any number of times before cpp_read_main_file().  If no
 507    targets have been added before cpp_read_main_file(), then the
 508    default target is used.  */
 509 extern void cpp_add_dependency_target PARAMS ((cpp_reader *,
 510                                                const char * target,
 511                                                int quote));
 512
 513 /* Call these to get pointers to the options and callback structures
 514    for a given reader.  These pointers are good until you call
 515    cpp_finish on that reader.  You can either edit the callbacks
 516    through the pointer returned from cpp_get_callbacks, or set them
 517    with cpp_set_callbacks.  */
 518 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
 519 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
 520 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
 521 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
 522
 523 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
 524    return value is the number of arguments used.  If
 525    cpp_handle_options returns without using all arguments, it couldn't
 526    understand the next switch.  Options processing is not completed
 527    until you call cpp_finish_options.  */
 528 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 529 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 530
 531 /* This function reads the file, but does not start preprocessing.  It
 532    returns the name of the original file; this is the same as the
 533    input file, except for preprocessed input.  This will generate at
 534    least one file change callback, and possibly a line change callback
 535    too.  If there was an error opening the file, it returns NULL.
 536
 537    If you want cpplib to manage its own hashtable, pass in a NULL
 538    pointer.  Otherise you should pass in an initialized hash table
 539    that cpplib will share; this technique is used by the C front
 540    ends.  */
 541 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
 542                                                struct ht *));
 543
 544 /* Deferred handling of command line options that can generate debug
 545    callbacks, such as -D and -imacros.  Call this after
 546    cpp_read_main_file.  The front ends need this separation so they
 547    can initialize debug output with the original file name, returned
 548    from cpp_read_main_file, before they get debug callbacks.  */
 549 extern void cpp_finish_options PARAMS ((cpp_reader *));
 550
 551 /* Call this to finish preprocessing.  If you requested dependency
 552    generation, pass an open stream to write the information to,
 553    otherwise NULL.  It is your responsibility to close the stream.
 554
 555    Returns cpp_errors (pfile).  */
 556 extern int cpp_finish PARAMS ((cpp_reader *, FILE *deps_stream));
 557
 558 /* Call this to release the handle at the end of preprocessing.  Any
 559    use of the handle after this function returns is invalid.  Returns
 560    cpp_errors (pfile).  */
 561 extern void cpp_destroy PARAMS ((cpp_reader *));
 562
 563 /* Error count.  */
 564 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
 565
 566 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 567 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 568                                                  const cpp_token *));
 569 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 570                                                unsigned char *));
 571 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 572                                          const char *, const char *,
 573                                          void (*) PARAMS ((cpp_reader *))));
 574
 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 /* Nonzero 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 *, const char *, FILE *));
 730
 731 #ifdef __cplusplus
 732 }
 733 #endif
 734
 735 #endif /* ! GCC_CPPLIB_H */