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