gcc/cpplib.h

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