gcc/cpplib.h

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