gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 96-99, 2000 Free Software Foundation, Inc.
   3    Written by Per Bothner, 1994-95.
   4
   5 This program is free software; you can redistribute it and/or modify it
   6 under the terms of the GNU General Public License as published by the
   7 Free Software Foundation; either version 2, or (at your option) any
   8 later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19  In other words, you are welcome to use, share and improve this program.
  20  You are forbidden to forbid anyone else to use, share and improve
  21  what you give them.   Help stamp out software-hoarding!  */
  22 #ifndef __GCC_CPPLIB__
  23 #define __GCC_CPPLIB__
  24
  25 #include <sys/types.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /* For complex reasons, cpp_reader is also typedefed in c-pragma.h.  */
  32 #ifndef _C_PRAGMA_H
  33 typedef struct cpp_reader cpp_reader;
  34 #endif
  35 typedef struct cpp_buffer cpp_buffer;
  36 typedef struct cpp_options cpp_options;
  37 typedef struct cpp_printer cpp_printer;
  38 typedef struct cpp_token cpp_token;
  39 typedef struct cpp_toklist cpp_toklist;
  40 typedef struct cpp_string cpp_string;
  41 typedef struct cpp_hashnode cpp_hashnode;
  42
  43 /* The first two groups, apart from '=', can appear in preprocessor
  44    expressions.  This allows a lookup table to be implemented in
  45    _cpp_parse_expr.
  46
  47    The first group, to CPP_LAST_EQ, can be immediately followed by an
  48    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  49    the same order as their counterparts without the '=', like ">>".  */
  50
  51 /* Positions in the table.  */
  52 #define CPP_LAST_EQ CPP_MAX
  53 #define CPP_FIRST_DIGRAPH CPP_HASH
  54 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  55
  56 #define TTYPE_TABLE                             \
  57   OP(CPP_EQ = 0,        "=")                    \
  58   OP(CPP_NOT,           "!")                    \
  59   OP(CPP_GREATER,       ">")    /* compare */   \
  60   OP(CPP_LESS,          "<")                    \
  61   OP(CPP_PLUS,          "+")    /* math */      \
  62   OP(CPP_MINUS,         "-")                    \
  63   OP(CPP_MULT,          "*")                    \
  64   OP(CPP_DIV,           "/")                    \
  65   OP(CPP_MOD,           "%")                    \
  66   OP(CPP_AND,           "&")    /* bit ops */   \
  67   OP(CPP_OR,            "|")                    \
  68   OP(CPP_XOR,           "^")                    \
  69   OP(CPP_RSHIFT,        ">>")                   \
  70   OP(CPP_LSHIFT,        "<<")                   \
  71   OP(CPP_MIN,           "<?")   /* extension */ \
  72   OP(CPP_MAX,           ">?")                   \
  73 \
  74   OP(CPP_COMPL,         "~")                    \
  75   OP(CPP_AND_AND,       "&&")   /* logical */   \
  76   OP(CPP_OR_OR,         "||")                   \
  77   OP(CPP_QUERY,         "?")                    \
  78   OP(CPP_COLON,         ":")                    \
  79   OP(CPP_COMMA,         ",")    /* grouping */  \
  80   OP(CPP_OPEN_PAREN,    "(")                    \
  81   OP(CPP_CLOSE_PAREN,   ")")                    \
  82   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  83   OP(CPP_NOT_EQ,        "!=")                   \
  84   OP(CPP_GREATER_EQ,    ">=")                   \
  85   OP(CPP_LESS_EQ,       "<=")                   \
  86 \
  87   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  88   OP(CPP_MINUS_EQ,      "-=")                   \
  89   OP(CPP_MULT_EQ,       "*=")                   \
  90   OP(CPP_DIV_EQ,        "/=")                   \
  91   OP(CPP_MOD_EQ,        "%=")                   \
  92   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
  93   OP(CPP_OR_EQ,         "|=")                   \
  94   OP(CPP_XOR_EQ,        "^=")                   \
  95   OP(CPP_RSHIFT_EQ,     ">>=")                  \
  96   OP(CPP_LSHIFT_EQ,     "<<=")                  \
  97   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
  98   OP(CPP_MAX_EQ,        ">?=")                  \
  99   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 100   OP(CPP_HASH,          "#")    /* digraphs */  \
 101   OP(CPP_PASTE,         "##")                   \
 102   OP(CPP_OPEN_SQUARE,   "[")                    \
 103   OP(CPP_CLOSE_SQUARE,  "]")                    \
 104   OP(CPP_OPEN_BRACE,    "{")                    \
 105   OP(CPP_CLOSE_BRACE,   "}")                    \
 106   /* The remainder of the punctuation.  Order is not significant.  */   \
 107   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 108   OP(CPP_ELLIPSIS,      "...")                  \
 109   OP(CPP_BACKSLASH,     "\\")                   \
 110   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 111   OP(CPP_MINUS_MINUS,   "--")                   \
 112   OP(CPP_DEREF,         "->")   /* accessors */ \
 113   OP(CPP_DOT,           ".")                    \
 114   OP(CPP_SCOPE,         "::")                   \
 115   OP(CPP_DEREF_STAR,    "->*")                  \
 116   OP(CPP_DOT_STAR,      ".*")                   \
 117   OP(CPP_DEFINED,       "defined") /* #if */    \
 118 \
 119   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 120   TK(CPP_INT,           SPELL_STRING)   /* 23 */                        \
 121   TK(CPP_FLOAT,         SPELL_STRING)   /* 3.14159 */                   \
 122   TK(CPP_NUMBER,        SPELL_STRING)   /* 34_be+ta  */                 \
 123 \
 124   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 125   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 126   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 127 \
 128   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 129   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 130   TK(CPP_OSTRING,       SPELL_STRING)   /* @"string" - Objective C */   \
 131   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 132 \
 133   TK(CPP_COMMENT,       SPELL_STRING)   /* Only if output comments.  */ \
 134   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 135   TK(CPP_PLACEMARKER,   SPELL_NONE)     /* Placemarker token.  */       \
 136   TK(CPP_EOF,           SPELL_NONE)     /* End of file.  */
 137
 138 #define OP(e, s) e,
 139 #define TK(e, s) e,
 140 enum cpp_ttype
 141 {
 142   TTYPE_TABLE
 143   N_TTYPES
 144 };
 145 #undef OP
 146 #undef TK
 147
 148 /* Payload of a NUMBER, FLOAT, STRING, or COMMENT token.  */
 149 struct cpp_string
 150 {
 151   unsigned int len;
 152   const unsigned char *text;
 153 };
 154
 155 /* Flags for the cpp_token structure.  */
 156 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 157 #define BOL             (1 << 1) /* Beginning of logical line.  */
 158 #define DIGRAPH         (1 << 2) /* If it was a digraph.  */
 159 #define STRINGIFY_ARG   (1 << 3) /* If macro argument to be stringified.  */
 160 #define PASTE_LEFT      (1 << 4) /* If on LHS of a ## operator.  */
 161 #define PASTED          (1 << 5) /* The result of a ## operator.  */
 162 #define NAMED_OP        (1 << 6) /* C++ named operators, also "defined".  */
 163 #define VOID_REST       (1 << 7) /* When a rest arg gets zero actual args.  */
 164
 165 /* A preprocessing token.  This has been carefully packed and should
 166    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 167 struct cpp_token
 168 {
 169   unsigned int line;            /* starting line number of this token */
 170   unsigned short col;           /* starting column of this token */
 171   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 172   unsigned char flags;          /* flags - see above */
 173
 174   union
 175   {
 176     HOST_WIDEST_INT integer;    /* an integer */
 177     struct cpp_hashnode *node;  /* an identifier */
 178     struct cpp_string str;      /* a string, or number */
 179     unsigned int aux;           /* argument no. for a CPP_MACRO_ARG, or
 180                                    character represented by CPP_OTHER.  */
 181   } val;
 182 };
 183
 184 /* cpp_toklist flags.  */
 185 #define VAR_ARGS        (1 << 0)
 186 #define BEG_OF_FILE     (1 << 1)
 187
 188 struct directive;               /* These are deliberately incomplete.  */
 189 struct answer;
 190 struct macro_args;
 191 struct cpp_context;
 192
 193 struct cpp_toklist
 194 {
 195   cpp_token *tokens;            /* actual tokens as an array */
 196   unsigned int tokens_used;     /* tokens used */
 197   unsigned int tokens_cap;      /* tokens allocated */
 198
 199   unsigned char *namebuf;       /* names buffer */
 200   unsigned int name_used;       /* _bytes_ used */
 201   unsigned int name_cap;        /* _bytes_ allocated */
 202
 203   /* If the list represents a directive, this points to it.  */
 204   const struct directive *directive;
 205
 206   const char *file;             /* in file name */
 207   unsigned int line;            /* starting line number */
 208
 209   unsigned short params_len;    /* length of macro parameter names.  */
 210
 211   short int paramc;             /* no. of macro params (-1 = obj-like).  */
 212
 213   /* Per-list flags, see above */
 214   unsigned short flags;
 215 };
 216
 217 /* A standalone character.  We may want to make it unsigned for the
 218    same reason we use unsigned char - to avoid signedness issues.  */
 219 typedef int cppchar_t;
 220
 221 struct cpp_buffer
 222 {
 223   const unsigned char *cur;      /* current position */
 224   const unsigned char *rlimit; /* end of valid data */
 225   const unsigned char *line_base; /* start of current line */
 226   cppchar_t read_ahead;         /* read ahead character */
 227   cppchar_t extra_char;         /* extra read-ahead for long tokens.  */
 228
 229   struct cpp_reader *pfile;     /* Owns this buffer.  */
 230   struct cpp_buffer *prev;
 231
 232   const unsigned char *buf;      /* entire buffer */
 233
 234   /* Filename specified with #line command.  */
 235   const char *nominal_fname;
 236
 237   /* Actual directory of this file, used only for "" includes */
 238   struct file_name_list *actual_dir;
 239
 240   /* Pointer into the include table.  Used for include_next and
 241      to record control macros. */
 242   struct include_file *inc;
 243
 244   /* Value of if_stack at start of this file.
 245      Used to prohibit unmatched #endif (etc) in an include file.  */
 246   struct if_stack *if_stack;
 247
 248   /* Token column position adjustment owing to tabs in whitespace.  */
 249   unsigned int col_adjust;
 250
 251   /* Line number at line_base (above). */
 252   unsigned int lineno;
 253
 254   /* True if we have already warned about C++ comments in this file.
 255      The warning happens only for C89 extended mode with -pedantic on,
 256      or for -Wtraditional, and only once per file (otherwise it would
 257      be far too noisy).  */
 258   char warned_cplusplus_comments;
 259 };
 260
 261 struct file_name_map_list;
 262 struct htab;
 263
 264 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
 265    efficiency, and partly to limit runaway recursion.  */
 266 #define CPP_STACK_MAX 200
 267
 268 /* Values for opts.dump_macros.
 269   dump_only means inhibit output of the preprocessed text
 270              and instead output the definitions of all user-defined
 271              macros in a form suitable for use as input to cpp.
 272    dump_names means pass #define and the macro name through to output.
 273    dump_definitions means pass the whole definition (plus #define) through
 274 */
 275 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 276
 277 /* This structure is nested inside struct cpp_reader, and
 278    carries all the options visible to the command line.  */
 279 struct cpp_options
 280 {
 281   /* Name of input and output files.  */
 282   const char *in_fname;
 283   const char *out_fname;
 284
 285   /* Characters between tab stops.  */
 286   unsigned int tabstop;
 287
 288   /* Pending options - -D, -U, -A, -I, -ixxx. */
 289   struct cpp_pending *pending;
 290
 291   /* File name which deps are being written to.  This is 0 if deps are
 292      being written to stdout.  */
 293   const char *deps_file;
 294
 295   /* Target-name to write with the dependency information.  */
 296   char *deps_target;
 297
 298   /* Search paths for include files.  */
 299   struct file_name_list *quote_include;  /* First dir to search for "file" */
 300   struct file_name_list *bracket_include;/* First dir to search for <file> */
 301
 302   /* Map between header names and file names, used only on DOS where
 303      file names are limited in length.  */
 304   struct file_name_map_list *map_list;
 305
 306   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 307      in the standard include file directories.  */
 308   const char *include_prefix;
 309   unsigned int include_prefix_len;
 310
 311   /* -fleading_underscore sets this to "_".  */
 312   const char *user_label_prefix;
 313
 314   /* Non-0 means -v, so print the full set of include dirs.  */
 315   unsigned char verbose;
 316
 317   /* Nonzero means use extra default include directories for C++.  */
 318   unsigned char cplusplus;
 319
 320   /* Nonzero means handle cplusplus style comments */
 321   unsigned char cplusplus_comments;
 322
 323   /* Nonzero means handle #import, for objective C.  */
 324   unsigned char objc;
 325
 326   /* Nonzero means this is an assembly file, so ignore unrecognized
 327      directives and the "# 33" form of #line, both of which are
 328      probably comments.  Also, permit unbalanced ' strings (again,
 329      likely to be in comments).  */
 330   unsigned char lang_asm;
 331
 332   /* Nonzero means don't copy comments into the output file.  */
 333   unsigned char discard_comments;
 334
 335   /* Nonzero means process the ISO trigraph sequences.  */
 336   unsigned char trigraphs;
 337
 338   /* Nonzero means process the ISO digraph sequences.  */
 339   unsigned char digraphs;
 340
 341   /* Nonzero means print the names of included files rather than the
 342      preprocessed output.  1 means just the #include "...", 2 means
 343      #include <...> as well.  */
 344   unsigned char print_deps;
 345
 346   /* Nonzero if missing .h files in -M output are assumed to be
 347      generated files and not errors.  */
 348   unsigned char print_deps_missing_files;
 349
 350   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 351   unsigned char print_deps_append;
 352
 353   /* Nonzero means print names of header files (-H).  */
 354   unsigned char print_include_names;
 355
 356   /* Nonzero means cpp_pedwarn causes a hard error.  */
 357   unsigned char pedantic_errors;
 358
 359   /* Nonzero means don't print warning messages.  */
 360   unsigned char inhibit_warnings;
 361
 362   /* Nonzero means don't suppress warnings from system headers.  */
 363   unsigned char warn_system_headers;
 364
 365   /* Nonzero means don't print error messages.  Has no option to
 366      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 367   unsigned char inhibit_errors;
 368
 369   /* Nonzero means warn if slash-star appears in a comment.  */
 370   unsigned char warn_comments;
 371
 372   /* Nonzero means warn if there are any trigraphs.  */
 373   unsigned char warn_trigraphs;
 374
 375   /* Nonzero means warn if #import is used.  */
 376   unsigned char warn_import;
 377
 378   /* Nonzero means warn about various incompatibilities with
 379      traditional C.  */
 380   unsigned char warn_traditional;
 381
 382   /* Nonzero means warn if ## is applied to two tokens that cannot be
 383      pasted together.  */
 384   unsigned char warn_paste;
 385
 386   /* Nonzero means turn warnings into errors.  */
 387   unsigned char warnings_are_errors;
 388
 389   /* Nonzero causes output not to be done, but directives such as
 390      #define that have side effects are still obeyed.  */
 391   unsigned char no_output;
 392
 393   /* Nonzero means we should look for header.gcc files that remap file
 394      names.  */
 395   unsigned char remap;
 396
 397   /* Nonzero means don't output line number information.  */
 398   unsigned char no_line_commands;
 399
 400   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 401      the source-file directory.  */
 402   unsigned char ignore_srcdir;
 403
 404   /* Zero means dollar signs are punctuation. */
 405   unsigned char dollars_in_ident;
 406
 407   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 408   unsigned char warn_undef;
 409
 410   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 411   unsigned char c89;
 412
 413   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 414   unsigned char c99;
 415
 416   /* Nonzero means give all the error messages the ANSI standard requires.  */
 417   unsigned char pedantic;
 418
 419   /* Nonzero means we're looking at already preprocessed code, so don't
 420      bother trying to do macro expansion and whatnot.  */
 421   unsigned char preprocessed;
 422
 423   /* Nonzero disables all the standard directories for headers.  */
 424   unsigned char no_standard_includes;
 425
 426   /* Nonzero disables the C++-specific standard directories for headers.  */
 427   unsigned char no_standard_cplusplus_includes;
 428
 429   /* Nonzero means dump macros in some fashion - see above.  */
 430   unsigned char dump_macros;
 431
 432   /* Nonzero means pass all #define and #undef directives which we
 433      actually process through to the output stream.  This feature is
 434      used primarily to allow cc1 to record the #defines and #undefs
 435      for the sake of debuggers which understand about preprocessor
 436      macros, but it may also be useful with -E to figure out how
 437      symbols are defined, and where they are defined.  */
 438   unsigned char debug_output;
 439
 440   /* Nonzero means pass #include lines through to the output.  */
 441   unsigned char dump_includes;
 442
 443   /* Print column number in error messages.  */
 444   unsigned char show_column;
 445 };
 446
 447 struct lexer_state
 448 {
 449   /* Nonzero if first token on line is CPP_HASH.  */
 450   unsigned char in_directive;
 451
 452   /* Nonzero if the directive's # was not in the first column.  Used
 453      by -Wtraditional.  */
 454   unsigned char indented;
 455
 456   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 457   unsigned char angled_headers;
 458
 459   /* Nonzero to save comments.  Turned off if discard_comments, and in
 460      all directives apart from #define.  */
 461   unsigned char save_comments;
 462
 463   /* Nonzero to force the lexer to skip newlines.  */
 464   unsigned char skip_newlines;
 465
 466   /* Nonzero if we're in the subroutine lex_line.  */
 467   unsigned char in_lex_line;
 468
 469   /* Nonzero if we're mid-comment.  */
 470   unsigned char lexing_comment;
 471
 472   /* Tells parse_number we saw a leading period.  */
 473   unsigned char seen_dot;
 474 };
 475 #define IN_DIRECTIVE(pfile) (pfile->state.in_directive)
 476 #define KNOWN_DIRECTIVE(list) (list->directive != 0)
 477
 478 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 479    Applying cpp_get_token repeatedly yields a stream of pre-processor
 480    tokens.  Usually, there is only one cpp_reader object active. */
 481
 482 struct cpp_reader
 483 {
 484   /* Top of buffer stack.  */
 485   cpp_buffer *buffer;
 486
 487   /* Lexer state.  */
 488   struct lexer_state state;
 489
 490   /* Error counter for exit code */
 491   unsigned int errors;
 492
 493   /* Line and column where a newline was first seen in a string
 494      constant (multi-line strings).  */
 495   unsigned int mls_line;
 496   unsigned int mls_column;
 497
 498   /* Current depth in #include directives that use <...>.  */
 499   unsigned int system_include_depth;
 500
 501   /* Current depth of buffer stack. */
 502   unsigned int buffer_stack_depth;
 503
 504   /* Current depth in #include directives.  */
 505   unsigned int include_depth;
 506
 507   /* Hash table of macros and assertions.  See cpphash.c */
 508   struct htab *hashtab;
 509
 510   /* Tree of other included files.  See cppfiles.c */
 511   struct splay_tree_s *all_include_files;
 512
 513   /* Chain of `actual directory' file_name_list entries,
 514      for "" inclusion. */
 515   struct file_name_list *actual_dirs;
 516
 517   /* Current maximum length of directory names in the search path
 518      for include files.  (Altered as we get more of them.)  */
 519   unsigned int max_include_len;
 520
 521   /* Potential controlling macro for the current buffer.  This is only
 522      live between the #endif and the end of file, and there can only
 523      be one at a time, so it is per-reader not per-buffer.  */
 524   const cpp_hashnode *potential_control_macro;
 525
 526   /* Token list used to store logical lines with new lexer.  */
 527   cpp_toklist token_list;
 528
 529   /* Temporary token store.  */
 530   cpp_token **temp_tokens;
 531   unsigned int temp_cap;
 532   unsigned int temp_alloced;
 533   unsigned int temp_used;
 534
 535   /* Date and time tokens.  Calculated together if either is requested.  */
 536   cpp_token *date;
 537   cpp_token *time;
 538
 539   /* The # of a the current directive. It may not be first in line if
 540      we append, and finding it is tedious.  */
 541   const cpp_token *first_directive_token;
 542
 543   /* Context stack.  Used for macro expansion and for determining
 544      which macros are disabled.  */
 545   unsigned int context_cap;
 546   unsigned int cur_context;
 547   unsigned int no_expand_level;
 548   unsigned int paste_level;
 549   struct cpp_context *contexts;
 550
 551   /* Current arguments when scanning arguments. Used for pointer
 552      fix-up.  */
 553   struct macro_args *args;
 554
 555   /* Buffer of -M output.  */
 556   struct deps *deps;
 557
 558   /* Obstack holding all macro hash nodes.  This never shrinks.
 559      See cpphash.c */
 560   struct obstack *hash_ob;
 561
 562   /* Obstack holding buffer and conditional structures.  This is a
 563      real stack.  See cpplib.c */
 564   struct obstack *buffer_ob;
 565
 566   /* Pragma table - dynamic, because a library user can add to the
 567      list of recognized pragmas.  */
 568   struct pragma_entry *pragmas;
 569
 570   /* Call backs.  */
 571   struct {
 572     void (*enter_file) PARAMS ((cpp_reader *));
 573     void (*leave_file) PARAMS ((cpp_reader *));
 574     void (*rename_file) PARAMS ((cpp_reader *));
 575     void (*include) PARAMS ((cpp_reader *, const unsigned char *,
 576                              const unsigned char *, unsigned int, int));
 577     void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
 578     void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
 579     void (*poison) PARAMS ((cpp_reader *));
 580     void (*ident) PARAMS ((cpp_reader *, const unsigned char *, unsigned int));
 581     void (*def_pragma) PARAMS ((cpp_reader *));
 582   } cb;
 583
 584   /* User visible options.  */
 585   struct cpp_options opts;
 586
 587   /* Nonzero means we have printed (while error reporting) a list of
 588      containing files that matches the current status.  */
 589   unsigned char input_stack_listing_current;
 590
 591   /* We're printed a warning recommending against using #import.  */
 592   unsigned char import_warning;
 593
 594   /* True after cpp_start_read completes.  Used to inhibit some
 595      warnings while parsing the command line.  */
 596   unsigned char done_initializing;
 597
 598   /* True if we are skipping a failed conditional group.  */
 599   unsigned char skipping;
 600
 601   /* True if we need to save parameter spellings - only if -pedantic,
 602      or we might need to write out definitions.  */
 603   unsigned char save_parameter_spellings;
 604
 605   /* True if output_line_command needs to output a newline.  */
 606   unsigned char need_newline;
 607
 608   /* Special nodes - identifiers with predefined significance to the
 609      preprocessor.  */
 610   struct spec_nodes *spec_nodes;
 611 };
 612
 613 /* struct cpp_printer encapsulates state used to convert the stream of
 614    tokens coming from cpp_get_token back into a text file.  Not
 615    everyone wants to do that, hence we separate the function.  */
 616
 617 struct cpp_printer
 618 {
 619   FILE *outf;                   /* stream to write to */
 620   const char *last_fname;       /* previous file name */
 621   unsigned int lineno;          /* line currently being written */
 622 };
 623
 624 #define CPP_FATAL_LIMIT 1000
 625 /* True if we have seen a "fatal" error. */
 626 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 627
 628 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 629 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 630 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
 631 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
 632 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
 633
 634 /* Name under which this program was invoked.  */
 635 extern const char *progname;
 636
 637 /* The structure of a node in the hash table.  The hash table
 638    has entries for all tokens defined by #define commands (type T_MACRO),
 639    plus some special tokens like __LINE__ (these each have their own
 640    type, and the appropriate code is run when that type of node is seen.
 641    It does not contain control words like "#define", which are recognized
 642    by a separate piece of code. */
 643
 644 /* different flavors of hash nodes */
 645 enum node_type
 646 {
 647   T_VOID = 0,      /* no definition yet */
 648   T_SPECLINE,      /* `__LINE__' */
 649   T_DATE,          /* `__DATE__' */
 650   T_FILE,          /* `__FILE__' */
 651   T_BASE_FILE,     /* `__BASE_FILE__' */
 652   T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
 653   T_TIME,          /* `__TIME__' */
 654   T_STDC,          /* `__STDC__' */
 655   T_OPERATOR,      /* operator with a name; val.code is token type */
 656   T_POISON,        /* poisoned identifier */
 657   T_MACRO,         /* a macro, either object-like or function-like */
 658   T_ASSERTION      /* predicate for #assert */
 659 };
 660
 661 /* There is a slot in the hashnode for use by front ends when integrated
 662    with cpplib.  It holds a tree (see tree.h) but we mustn't drag that
 663    header into every user of cpplib.h.  cpplib does not do anything with
 664    this slot except clear it when a new node is created.  */
 665 union tree_node;
 666
 667 struct cpp_hashnode
 668 {
 669   unsigned int hash;                    /* cached hash value */
 670   unsigned short length;                /* length of name */
 671   ENUM_BITFIELD(node_type) type : 8;    /* node type */
 672
 673   union
 674   {
 675     const cpp_toklist *expansion;       /* a macro's replacement list.  */
 676     struct answer *answers;             /* answers to an assertion.  */
 677     enum cpp_ttype code;                /* code for a named operator.  */
 678   } value;
 679
 680   union tree_node *fe_value;            /* front end value */
 681
 682   const unsigned char name[1];          /* name[length] */
 683 };
 684
 685 extern void cpp_init PARAMS ((void));
 686 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 687 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 688 extern void cpp_reader_init PARAMS ((cpp_reader *));
 689 extern cpp_printer *cpp_printer_init PARAMS ((cpp_reader *, cpp_printer *));
 690
 691 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 692                                          const char *, const char *,
 693                                          void (*) PARAMS ((cpp_reader *))));
 694 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
 695
 696 extern int cpp_start_read PARAMS ((cpp_reader *, cpp_printer *, const char *));
 697 extern void cpp_output_tokens PARAMS ((cpp_reader *, cpp_printer *,
 698                                        unsigned int));
 699 extern void cpp_finish PARAMS ((cpp_reader *, cpp_printer *));
 700 extern void cpp_cleanup PARAMS ((cpp_reader *));
 701
 702 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
 703
 704 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 705 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 706 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 707 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 708
 709 extern void cpp_free_token_list PARAMS ((cpp_toklist *));
 710 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 711                                             const unsigned char *, long));
 712 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 713 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 714
 715 /* N.B. The error-message-printer prototypes have not been nicely
 716    formatted because exgettext needs to see 'msgid' on the same line
 717    as the name of the function in order to work properly.  Only the
 718    string argument gets a name in an effort to keep the lines from
 719    getting ridiculously oversized.  */
 720
 721 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 722   ATTRIBUTE_PRINTF_2;
 723 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 724   ATTRIBUTE_PRINTF_2;
 725 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 726   ATTRIBUTE_PRINTF_2;
 727 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 728   ATTRIBUTE_PRINTF_2;
 729 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 730   ATTRIBUTE_PRINTF_2;
 731 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 732   ATTRIBUTE_PRINTF_2;
 733 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 734   ATTRIBUTE_PRINTF_4;
 735 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 736   ATTRIBUTE_PRINTF_4;
 737 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 738   ATTRIBUTE_PRINTF_4;
 739 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 740   ATTRIBUTE_PRINTF_5;
 741 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 742 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 743
 744 extern const char *cpp_type2name PARAMS ((enum cpp_ttype));
 745
 746 /* In cpplex.c */
 747 extern cpp_buffer *cpp_push_buffer      PARAMS ((cpp_reader *,
 748                                                  const unsigned char *, long));
 749 extern cpp_buffer *cpp_pop_buffer       PARAMS ((cpp_reader *));
 750 extern void cpp_scan_buffer             PARAMS ((cpp_reader *, cpp_printer *));
 751 extern void cpp_scan_buffer_nooutput    PARAMS ((cpp_reader *));
 752 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 753                                                  const char *));
 754 extern void cpp_printf                  PARAMS ((cpp_reader *, cpp_printer *,
 755                                                  const char *, ...));
 756
 757 extern void cpp_output_list             PARAMS ((cpp_reader *, FILE *,
 758                                                  const cpp_toklist *,
 759                                                  const cpp_token *));
 760
 761 /* In cpphash.c */
 762 extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
 763                                          const unsigned char *, size_t));
 764 extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
 765                                             int (*) PARAMS ((cpp_reader *,
 766                                                              cpp_hashnode *))));
 767 /* In cppmacro.c */
 768 extern void cpp_dump_definition PARAMS ((cpp_reader *, FILE *,
 769                                          const cpp_hashnode *));
 770
 771 /* In cppfiles.c */
 772 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 773 extern int cpp_read_file PARAMS ((cpp_reader *, const char *));
 774 extern void cpp_make_system_header PARAMS ((cpp_reader *, cpp_buffer *, int));
 775 extern const char *cpp_syshdr_flags PARAMS ((cpp_reader *, cpp_buffer *));
 776
 777 #ifdef __cplusplus
 778 }
 779 #endif
 780 #endif /* __GCC_CPPLIB__ */