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   /* Nonzero means turn warnings into errors.  */
 287   unsigned char warnings_are_errors;
 288
 289   /* Nonzero means we should look for header.gcc files that remap file
 290      names.  */
 291   unsigned char remap;
 292
 293   /* Zero means dollar signs are punctuation.  */
 294   unsigned char dollars_in_ident;
 295
 296   /* True if we should warn about dollars in identifiers or numbers
 297      for this translation unit.  */
 298   unsigned char warn_dollars;
 299
 300   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 301   unsigned char warn_undef;
 302
 303   /* Nonzero means warn of unused macros from the main file.  */
 304   unsigned char warn_unused_macros;
 305
 306   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 307   unsigned char c99;
 308
 309   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 310   unsigned char std;
 311
 312   /* Nonzero means give all the error messages the ANSI standard requires.  */
 313   unsigned char pedantic;
 314
 315   /* Nonzero means we're looking at already preprocessed code, so don't
 316      bother trying to do macro expansion and whatnot.  */
 317   unsigned char preprocessed;
 318
 319   /* Print column number in error messages.  */
 320   unsigned char show_column;
 321
 322   /* Nonzero means handle C++ alternate operator names.  */
 323   unsigned char operator_names;
 324
 325   /* True for traditional preprocessing.  */
 326   unsigned char traditional;
 327
 328   /* Holds the name of the target (execution) character set.  */
 329   const char *narrow_charset;
 330
 331   /* Holds the name of the target wide character set.  */
 332   const char *wide_charset;
 333
 334   /* Holds the name of the input character set.  */
 335   const char *input_charset;
 336
 337   /* True to warn about precompiled header files we couldn't use.  */
 338   bool warn_invalid_pch;
 339
 340   /* True if dependencies should be restored from a precompiled header.  */
 341   bool restore_pch_deps;
 342
 343   /* Dependency generation.  */
 344   struct
 345   {
 346     /* Style of header dependencies to generate.  */
 347     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 348
 349     /* Assume missing files are generated files.  */
 350     bool missing_files;
 351
 352     /* Generate phony targets for each dependency apart from the first
 353        one.  */
 354     bool phony_targets;
 355
 356     /* If true, no dependency is generated on the main file.  */
 357     bool ignore_main_file;
 358   } deps;
 359
 360   /* Target-specific features set by the front end or client.  */
 361
 362   /* Precision for target CPP arithmetic, target characters, target
 363      ints and target wide characters, respectively.  */
 364   size_t precision, char_precision, int_precision, wchar_precision;
 365
 366   /* True means chars (wide chars) are unsigned.  */
 367   bool unsigned_char, unsigned_wchar;
 368
 369   /* True if the most significant byte in a word has the lowest
 370      address in memory.  */
 371   bool bytes_big_endian;
 372
 373   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 374   unsigned char stdc_0_in_system_headers;
 375 };
 376
 377 /* Call backs to cpplib client.  */
 378 struct cpp_callbacks
 379 {
 380   /* Called when a new line of preprocessed output is started.  */
 381   void (*line_change) (cpp_reader *, const cpp_token *, int);
 382
 383   /* Called when switching to/from a new file.
 384      The line_map is for the new file.  It is NULL if there is no new file.
 385      (In C this happens when done with <built-in>+<command line> and also
 386      when done with a main file.)  This can be used for resource cleanup.  */
 387   void (*file_change) (cpp_reader *, const struct line_map *);
 388
 389   void (*dir_change) (cpp_reader *, const char *);
 390   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 391                    const char *, int);
 392   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 393   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 394   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 395   void (*def_pragma) (cpp_reader *, unsigned int);
 396   int (*valid_pch) (cpp_reader *, const char *, int);
 397   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 398 };
 399
 400 /* Chain of directories to look for include files in.  */
 401 struct cpp_dir
 402 {
 403   /* NULL-terminated singly-linked list.  */
 404   struct cpp_dir *next;
 405
 406   /* NAME of the directory, NUL-terminated.  */
 407   char *name;
 408   unsigned int len;
 409
 410   /* One if a system header, two if a system header that has extern
 411      "C" guards for C++.  */
 412   unsigned char sysp;
 413
 414   /* Mapping of file names for this directory for MS-DOS and related
 415      platforms.  A NULL-terminated array of (from, to) pairs.  */
 416   const char **name_map;
 417
 418   /* The C front end uses these to recognize duplicated
 419      directories in the search path.  */
 420   ino_t ino;
 421   dev_t dev;
 422 };
 423
 424 /* Name under which this program was invoked.  */
 425 extern const char *progname;
 426
 427 /* The structure of a node in the hash table.  The hash table has
 428    entries for all identifiers: either macros defined by #define
 429    commands (type NT_MACRO), assertions created with #assert
 430    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 431    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 432    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 433    identifier that behaves like an operator such as "xor".
 434    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 435    diagnostic may be required for this node.  Currently this only
 436    applies to __VA_ARGS__ and poisoned identifiers.  */
 437
 438 /* Hash node flags.  */
 439 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 440 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 441 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 442 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 443 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 444 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 445 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 446
 447 /* Different flavors of hash node.  */
 448 enum node_type
 449 {
 450   NT_VOID = 0,     /* No definition yet.  */
 451   NT_MACRO,        /* A macro of some form.  */
 452   NT_ASSERTION     /* Predicate for #assert.  */
 453 };
 454
 455 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 456    handle it with the builtin code for efficiency reasons.  */
 457 enum builtin_type
 458 {
 459   BT_SPECLINE = 0,              /* `__LINE__' */
 460   BT_DATE,                      /* `__DATE__' */
 461   BT_FILE,                      /* `__FILE__' */
 462   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 463   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 464   BT_TIME,                      /* `__TIME__' */
 465   BT_STDC,                      /* `__STDC__' */
 466   BT_PRAGMA                     /* `_Pragma' operator */
 467 };
 468
 469 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 470 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 471 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 472 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 473
 474 /* The common part of an identifier node shared amongst all 3 C front
 475    ends.  Also used to store CPP identifiers, which are a superset of
 476    identifiers in the grammatical sense.  */
 477 struct cpp_hashnode GTY(())
 478 {
 479   struct ht_identifier ident;
 480   unsigned int is_directive : 1;
 481   unsigned int directive_index : 7;     /* If is_directive,
 482                                            then index into directive table.
 483                                            Otherwise, a NODE_OPERATOR.  */
 484   unsigned char rid_code;               /* Rid code - for front ends.  */
 485   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 486   unsigned char flags;                  /* CPP flags.  */
 487
 488   union _cpp_hashnode_value
 489   {
 490     /* If a macro.  */
 491     cpp_macro * GTY((skip (""))) macro;
 492     /* Answers to an assertion.  */
 493     struct answer * GTY ((skip (""))) answers;
 494     /* Code for a builtin macro.  */
 495     enum builtin_type GTY ((tag ("1"))) builtin;
 496     /* Macro argument index.  */
 497     unsigned short GTY ((tag ("0"))) arg_index;
 498   } GTY ((desc ("0"))) value;
 499 };
 500
 501 /* Call this first to get a handle to pass to other functions.
 502
 503    If you want cpplib to manage its own hashtable, pass in a NULL
 504    pointer.  Otherwise you should pass in an initialized hash table
 505    that cpplib will share; this technique is used by the C front
 506    ends.  */
 507 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
 508                                       struct line_maps *);
 509
 510 /* Call this to change the selected language standard (e.g. because of
 511    command line options).  */
 512 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 513
 514 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 515    called any number of times before cpp_read_main_file().  If no
 516    targets have been added before cpp_read_main_file(), then the
 517    default target is used.  */
 518 extern void cpp_add_dependency_target (cpp_reader *, const char *, int);
 519
 520 /* Set the include paths.  */
 521 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 522
 523 /* Call these to get pointers to the options and callback structures
 524    for a given reader.  These pointers are good until you call
 525    cpp_finish on that reader.  You can either edit the callbacks
 526    through the pointer returned from cpp_get_callbacks, or set them
 527    with cpp_set_callbacks.  */
 528 extern cpp_options *cpp_get_options (cpp_reader *);
 529 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 530 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 531
 532 /* This function reads the file, but does not start preprocessing.  It
 533    returns the name of the original file; this is the same as the
 534    input file, except for preprocessed input.  This will generate at
 535    least one file change callback, and possibly a line change callback
 536    too.  If there was an error opening the file, it returns NULL.  */
 537 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 538
 539 /* Set up built-ins like __FILE__.  */
 540 extern void cpp_init_builtins (cpp_reader *, int);
 541
 542 /* This is called after options have been parsed, and partially
 543    processed.  */
 544 extern void cpp_post_options (cpp_reader *);
 545
 546 /* Set up translation to the target character set.  */
 547 extern void cpp_init_iconv (cpp_reader *);
 548
 549 /* Call this to finish preprocessing.  If you requested dependency
 550    generation, pass an open stream to write the information to,
 551    otherwise NULL.  It is your responsibility to close the stream.
 552
 553    Returns cpp_errors (pfile).  */
 554 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
 555
 556 /* Call this to release the handle at the end of preprocessing.  Any
 557    use of the handle after this function returns is invalid.  Returns
 558    cpp_errors (pfile).  */
 559 extern void cpp_destroy (cpp_reader *);
 560
 561 /* Error count.  */
 562 extern unsigned int cpp_errors (cpp_reader *);
 563
 564 extern unsigned int cpp_token_len (const cpp_token *);
 565 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 566 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 567                                        unsigned char *);
 568 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 569                                  void (*) (cpp_reader *));
 570 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 571                             const cpp_token *);
 572 extern const cpp_token *cpp_get_token (cpp_reader *);
 573 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 574                                                   const cpp_hashnode *);
 575 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 576
 577 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 578 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 579                                           unsigned int *, int *);
 580 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
 581 extern bool cpp_interpret_string (cpp_reader *,
 582                                   const cpp_string *, size_t,
 583                                   cpp_string *, bool);
 584 extern bool cpp_interpret_string_notranslate (cpp_reader *,
 585                                               const cpp_string *, size_t,
 586                                               cpp_string *, bool);
 587
 588 /* Used to register macros and assertions, perhaps from the command line.
 589    The text is the same as the command line argument.  */
 590 extern void cpp_define (cpp_reader *, const char *);
 591 extern void cpp_assert (cpp_reader *, const char *);
 592 extern void cpp_undef (cpp_reader *, const char *);
 593 extern void cpp_unassert (cpp_reader *, const char *);
 594
 595 /* Undefine all macros and assertions.  */
 596 extern void cpp_undef_all (cpp_reader *);
 597
 598 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 599                                     size_t, int);
 600 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 601
 602 /* A preprocessing number.  Code assumes that any unused high bits of
 603    the double integer are set to zero.  */
 604 typedef unsigned HOST_WIDE_INT cpp_num_part;
 605 typedef struct cpp_num cpp_num;
 606 struct cpp_num
 607 {
 608   cpp_num_part high;
 609   cpp_num_part low;
 610   bool unsignedp;  /* True if value should be treated as unsigned.  */
 611   bool overflow;   /* True if the most recent calculation overflowed.  */
 612 };
 613
 614 /* cpplib provides two interfaces for interpretation of preprocessing
 615    numbers.
 616
 617    cpp_classify_number categorizes numeric constants according to
 618    their field (integer, floating point, or invalid), radix (decimal,
 619    octal, hexadecimal), and type suffixes.  */
 620
 621 #define CPP_N_CATEGORY  0x000F
 622 #define CPP_N_INVALID   0x0000
 623 #define CPP_N_INTEGER   0x0001
 624 #define CPP_N_FLOATING  0x0002
 625
 626 #define CPP_N_WIDTH     0x00F0
 627 #define CPP_N_SMALL     0x0010  /* int, float.  */
 628 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 629 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 630
 631 #define CPP_N_RADIX     0x0F00
 632 #define CPP_N_DECIMAL   0x0100
 633 #define CPP_N_HEX       0x0200
 634 #define CPP_N_OCTAL     0x0400
 635
 636 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 637 #define CPP_N_IMAGINARY 0x2000
 638
 639 /* Classify a CPP_NUMBER token.  The return value is a combination of
 640    the flags from the above sets.  */
 641 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 642
 643 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 644 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 645                                       unsigned int type);
 646
 647 /* Sign extend a number, with PRECISION significant bits and all
 648    others assumed clear, to fill out a cpp_num structure.  */
 649 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 650
 651 /* Diagnostic levels.  To get a diagnostic without associating a
 652    position in the translation unit with it, use cpp_error_with_line
 653    with a line number of zero.  */
 654
 655 /* Warning, an error with -Werror.  */
 656 #define CPP_DL_WARNING          0x00
 657 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
 658 #define CPP_DL_WARNING_SYSHDR   0x01
 659 /* Warning, an error with -pedantic-errors or -Werror.  */
 660 #define CPP_DL_PEDWARN          0x02
 661 /* An error.  */
 662 #define CPP_DL_ERROR            0x03
 663 /* An internal consistency check failed.  Prints "internal error: ",
 664    otherwise the same as CPP_DL_ERROR.  */
 665 #define CPP_DL_ICE              0x04
 666 /* Extracts a diagnostic level from an int.  */
 667 #define CPP_DL_EXTRACT(l)       (l & 0xf)
 668 /* Nonzero if a diagnostic level is one of the warnings.  */
 669 #define CPP_DL_WARNING_P(l)     (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
 670                                  && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
 671
 672 /* N.B. The error-message-printer prototypes have not been nicely
 673    formatted because exgettext needs to see 'msgid' on the same line
 674    as the name of the function in order to work properly.  Only the
 675    string argument gets a name in an effort to keep the lines from
 676    getting ridiculously oversized.  */
 677
 678 /* Output a diagnostic of some kind.  */
 679 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
 680   ATTRIBUTE_PRINTF_3;
 681
 682 /* Output a diagnostic with "MSGID: " preceding the
 683    error string of errno.  No location is printed.  */
 684 extern void cpp_errno (cpp_reader *, int, const char *msgid);
 685
 686 /* Same as cpp_error, except additionally specifies a position as a
 687    (translation unit) physical line and physical column.  If the line is
 688    zero, then no location is printed.  */
 689 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
 690                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
 691
 692 /* In cpplex.c */
 693 extern int cpp_ideq (const cpp_token *, const char *);
 694 extern void cpp_output_line (cpp_reader *, FILE *);
 695 extern void cpp_output_token (const cpp_token *, FILE *);
 696 extern const char *cpp_type2name (enum cpp_ttype);
 697 /* Returns the value of an escape sequence, truncated to the correct
 698    target precision.  PSTR points to the input pointer, which is just
 699    after the backslash.  LIMIT is how much text we have.  WIDE is true
 700    if the escape sequence is part of a wide character constant or
 701    string literal.  Handles all relevant diagnostics.  */
 702 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 703                                    const unsigned char *limit, 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 (cpp_reader *, const unsigned char *,
 710                                  unsigned int);
 711
 712 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 713 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 714
 715 /* In cppmacro.c */
 716 extern void cpp_scan_nooutput (cpp_reader *);
 717 extern int  cpp_sys_macro_p (cpp_reader *);
 718 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 719                                         unsigned int);
 720
 721 /* In cppfiles.c */
 722 extern bool cpp_included (cpp_reader *, const char *);
 723 extern void cpp_make_system_header (cpp_reader *, int, int);
 724 extern bool cpp_push_include (cpp_reader *, const char *);
 725 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 726
 727 /* In cpppch.c */
 728 struct save_macro_data;
 729 extern int cpp_save_state (cpp_reader *, FILE *);
 730 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 731 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 732 extern int cpp_valid_state (cpp_reader *, const char *, int);
 733 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 734 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 735                            struct save_macro_data *);
 736
 737 #ifdef __cplusplus
 738 }
 739 #endif
 740
 741 #endif /* ! GCC_CPPLIB_H */