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_MAX
  50 #define CPP_FIRST_DIGRAPH CPP_HASH
  51
  52 #define TTYPE_TABLE                             \
  53   OP(CPP_EQ = 0,        "=")                    \
  54   OP(CPP_NOT,           "!")                    \
  55   OP(CPP_GREATER,       ">")    /* compare */   \
  56   OP(CPP_LESS,          "<")                    \
  57   OP(CPP_PLUS,          "+")    /* math */      \
  58   OP(CPP_MINUS,         "-")                    \
  59   OP(CPP_MULT,          "*")                    \
  60   OP(CPP_DIV,           "/")                    \
  61   OP(CPP_MOD,           "%")                    \
  62   OP(CPP_AND,           "&")    /* bit ops */   \
  63   OP(CPP_OR,            "|")                    \
  64   OP(CPP_XOR,           "^")                    \
  65   OP(CPP_RSHIFT,        ">>")                   \
  66   OP(CPP_LSHIFT,        "<<")                   \
  67   OP(CPP_MIN,           "<?")   /* extension */ \
  68   OP(CPP_MAX,           ">?")                   \
  69 \
  70   OP(CPP_COMPL,         "~")                    \
  71   OP(CPP_AND_AND,       "&&")   /* logical */   \
  72   OP(CPP_OR_OR,         "||")                   \
  73   OP(CPP_QUERY,         "?")                    \
  74   OP(CPP_COLON,         ":")                    \
  75   OP(CPP_COMMA,         ",")    /* grouping */  \
  76   OP(CPP_OPEN_PAREN,    "(")                    \
  77   OP(CPP_CLOSE_PAREN,   ")")                    \
  78   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  79   OP(CPP_NOT_EQ,        "!=")                   \
  80   OP(CPP_GREATER_EQ,    ">=")                   \
  81   OP(CPP_LESS_EQ,       "<=")                   \
  82 \
  83   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  84   OP(CPP_MINUS_EQ,      "-=")                   \
  85   OP(CPP_MULT_EQ,       "*=")                   \
  86   OP(CPP_DIV_EQ,        "/=")                   \
  87   OP(CPP_MOD_EQ,        "%=")                   \
  88   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
  89   OP(CPP_OR_EQ,         "|=")                   \
  90   OP(CPP_XOR_EQ,        "^=")                   \
  91   OP(CPP_RSHIFT_EQ,     ">>=")                  \
  92   OP(CPP_LSHIFT_EQ,     "<<=")                  \
  93   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
  94   OP(CPP_MAX_EQ,        ">?=")                  \
  95   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
  96   OP(CPP_HASH,          "#")    /* digraphs */  \
  97   OP(CPP_PASTE,         "##")                   \
  98   OP(CPP_OPEN_SQUARE,   "[")                    \
  99   OP(CPP_CLOSE_SQUARE,  "]")                    \
 100   OP(CPP_OPEN_BRACE,    "{")                    \
 101   OP(CPP_CLOSE_BRACE,   "}")                    \
 102   /* The remainder of the punctuation.  Order is not significant.  */   \
 103   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 104   OP(CPP_ELLIPSIS,      "...")                  \
 105   OP(CPP_BACKSLASH,     "\\")                   \
 106   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 107   OP(CPP_MINUS_MINUS,   "--")                   \
 108   OP(CPP_DEREF,         "->")   /* accessors */ \
 109   OP(CPP_DOT,           ".")                    \
 110   OP(CPP_SCOPE,         "::")                   \
 111   OP(CPP_DEREF_STAR,    "->*")                  \
 112   OP(CPP_DOT_STAR,      ".*")                   \
 113   OP(CPP_DEFINED,       "defined") /* #if */    \
 114 \
 115   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 116   TK(CPP_INT,           SPELL_STRING)   /* 23 */                        \
 117   TK(CPP_FLOAT,         SPELL_STRING)   /* 3.14159 */                   \
 118   TK(CPP_NUMBER,        SPELL_STRING)   /* 34_be+ta  */                 \
 119 \
 120   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 121   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 122   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 123 \
 124   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 125   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 126   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 127 \
 128   TK(CPP_COMMENT,       SPELL_STRING)   /* Only if output comments.  */ \
 129   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 130   TK(CPP_PLACEMARKER,   SPELL_NONE)     /* Placemarker token.  */       \
 131   TK(CPP_EOF,           SPELL_NONE)     /* End of file.  */
 132
 133 #define OP(e, s) e,
 134 #define TK(e, s) e,
 135 enum cpp_ttype
 136 {
 137   TTYPE_TABLE
 138   N_TTYPES
 139 };
 140 #undef OP
 141 #undef TK
 142
 143 /* Payload of a NUMBER, FLOAT, STRING, or COMMENT token.  */
 144 struct cpp_string
 145 {
 146   unsigned int len;
 147   const unsigned char *text;
 148 };
 149
 150 /* Flags for the cpp_token structure.  */
 151 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 152 #define BOL             (1 << 1) /* Beginning of logical line.  */
 153 #define DIGRAPH         (1 << 2) /* If it was a digraph.  */
 154 #define STRINGIFY_ARG   (1 << 3) /* If macro argument to be stringified.  */
 155 #define PASTE_LEFT      (1 << 4) /* If on LHS of a ## operator.  */
 156 #define PASTED          (1 << 5) /* The result of a ## operator.  */
 157 #define NAMED_OP        (1 << 6) /* C++ named operators, also "defined".  */
 158 #define VOID_REST       (1 << 7) /* When a rest arg gets zero actual args.  */
 159
 160 /* A preprocessing token.  This has been carefully packed and should
 161    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 162 struct cpp_token
 163 {
 164   unsigned int line;            /* starting line number of this token */
 165   unsigned short col;           /* starting column of this token */
 166   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 167   unsigned char flags;          /* flags - see above */
 168
 169   union
 170   {
 171     HOST_WIDEST_INT integer;    /* an integer */
 172     struct cpp_hashnode *node;  /* an identifier */
 173     struct cpp_string str;      /* a string, or number */
 174     unsigned int aux;           /* argument no. for a CPP_MACRO_ARG, or
 175                                    character represented by CPP_OTHER.  */
 176   } val;
 177 };
 178
 179 /* cpp_toklist flags.  */
 180 #define LIST_OFFSET     (1 << 0)
 181 #define VAR_ARGS        (1 << 1)
 182 #define BEG_OF_FILE     (1 << 2)
 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 don't copy comments into the output file.  */
 318   unsigned char discard_comments;
 319
 320   /* Nonzero means process the ISO trigraph sequences.  */
 321   unsigned char trigraphs;
 322
 323   /* Nonzero means process the ISO digraph sequences.  */
 324   unsigned char digraphs;
 325
 326   /* Nonzero means print the names of included files rather than the
 327      preprocessed output.  1 means just the #include "...", 2 means
 328      #include <...> as well.  */
 329   unsigned char print_deps;
 330
 331   /* Nonzero if missing .h files in -M output are assumed to be
 332      generated files and not errors.  */
 333   unsigned char print_deps_missing_files;
 334
 335   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 336   unsigned char print_deps_append;
 337
 338   /* Nonzero means print names of header files (-H).  */
 339   unsigned char print_include_names;
 340
 341   /* Nonzero means cpp_pedwarn causes a hard error.  */
 342   unsigned char pedantic_errors;
 343
 344   /* Nonzero means don't print warning messages.  */
 345   unsigned char inhibit_warnings;
 346
 347   /* Nonzero means don't print error messages.  Has no option to
 348      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 349   unsigned char inhibit_errors;
 350
 351   /* Nonzero means warn if slash-star appears in a comment.  */
 352   unsigned char warn_comments;
 353
 354   /* Nonzero means warn if there are any trigraphs.  */
 355   unsigned char warn_trigraphs;
 356
 357   /* Nonzero means warn if #import is used.  */
 358   unsigned char warn_import;
 359
 360   /* Nonzero means warn about various incompatibilities with
 361      traditional C.  */
 362   unsigned char warn_traditional;
 363
 364   /* Nonzero means warn if ## is applied to two tokens that cannot be
 365      pasted together.  */
 366   unsigned char warn_paste;
 367
 368   /* Nonzero means turn warnings into errors.  */
 369   unsigned char warnings_are_errors;
 370
 371   /* Nonzero causes output not to be done, but directives such as
 372      #define that have side effects are still obeyed.  */
 373   unsigned char no_output;
 374
 375   /* Nonzero means we should look for header.gcc files that remap file
 376      names.  */
 377   unsigned char remap;
 378
 379   /* Nonzero means don't output line number information.  */
 380   unsigned char no_line_commands;
 381
 382   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 383      the source-file directory.  */
 384   unsigned char ignore_srcdir;
 385
 386   /* Zero means dollar signs are punctuation. */
 387   unsigned char dollars_in_ident;
 388
 389   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 390   unsigned char warn_undef;
 391
 392   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 393   unsigned char c89;
 394
 395   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 396   unsigned char c99;
 397
 398   /* Nonzero means give all the error messages the ANSI standard requires.  */
 399   unsigned char pedantic;
 400
 401   /* Nonzero means we're looking at already preprocessed code, so don't
 402      bother trying to do macro expansion and whatnot.  */
 403   unsigned char preprocessed;
 404
 405   /* Nonzero disables all the standard directories for headers.  */
 406   unsigned char no_standard_includes;
 407
 408   /* Nonzero disables the C++-specific standard directories for headers.  */
 409   unsigned char no_standard_cplusplus_includes;
 410
 411   /* Nonzero means dump macros in some fashion - see above.  */
 412   unsigned char dump_macros;
 413
 414   /* Nonzero means pass all #define and #undef directives which we
 415      actually process through to the output stream.  This feature is
 416      used primarily to allow cc1 to record the #defines and #undefs
 417      for the sake of debuggers which understand about preprocessor
 418      macros, but it may also be useful with -E to figure out how
 419      symbols are defined, and where they are defined.  */
 420   unsigned char debug_output;
 421
 422   /* Nonzero means pass #include lines through to the output.  */
 423   unsigned char dump_includes;
 424
 425   /* Print column number in error messages.  */
 426   unsigned char show_column;
 427 };
 428
 429 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 430    Applying cpp_get_token repeatedly yields a stream of pre-processor
 431    tokens.  Usually, there is only one cpp_reader object active. */
 432
 433 struct cpp_reader
 434 {
 435   /* Top of buffer stack.  */
 436   cpp_buffer *buffer;
 437
 438   /* Error counter for exit code */
 439   unsigned int errors;
 440
 441   /* Line and column where a newline was first seen in a string constant.  */
 442   unsigned int multiline_string_line;
 443   unsigned int multiline_string_column;
 444
 445   /* Current depth in #include directives that use <...>.  */
 446   unsigned int system_include_depth;
 447
 448   /* Current depth of buffer stack. */
 449   unsigned int buffer_stack_depth;
 450
 451   /* Current depth in #include directives.  */
 452   unsigned int include_depth;
 453
 454   /* Hash table of macros and assertions.  See cpphash.c */
 455   struct htab *hashtab;
 456
 457   /* Tree of other included files.  See cppfiles.c */
 458   struct splay_tree_s *all_include_files;
 459
 460   /* Chain of `actual directory' file_name_list entries,
 461      for "" inclusion. */
 462   struct file_name_list *actual_dirs;
 463
 464   /* Current maximum length of directory names in the search path
 465      for include files.  (Altered as we get more of them.)  */
 466   unsigned int max_include_len;
 467
 468   /* Potential controlling macro for the current buffer.  This is only
 469      live between the #endif and the end of file, and there can only
 470      be one at a time, so it is per-reader not per-buffer.  */
 471   const cpp_hashnode *potential_control_macro;
 472
 473   /* Token column position adjustment owing to tabs in whitespace.  */
 474   unsigned int col_adjust;
 475
 476   /* Token list used to store logical lines with new lexer.  */
 477   cpp_toklist token_list;
 478
 479   /* Temporary token store.  */
 480   cpp_token **temp_tokens;
 481   unsigned int temp_cap;
 482   unsigned int temp_alloced;
 483   unsigned int temp_used;
 484
 485   /* Date and time tokens.  Calculated together if either is requested.  */
 486   cpp_token *date;
 487   cpp_token *time;
 488
 489   /* The # of a the current directive. It may not be first in line if
 490      we append, and finding it is tedious.  */
 491   const cpp_token *first_directive_token;
 492
 493   /* Context stack.  Used for macro expansion and for determining
 494      which macros are disabled.  */
 495   unsigned int context_cap;
 496   unsigned int cur_context;
 497   unsigned int no_expand_level;
 498   unsigned int paste_level;
 499   struct cpp_context *contexts;
 500
 501   /* Current arguments when scanning arguments. Used for pointer
 502      fix-up.  */
 503   struct macro_args *args;
 504
 505   /* Buffer of -M output.  */
 506   struct deps *deps;
 507
 508   /* Obstack holding all macro hash nodes.  This never shrinks.
 509      See cpphash.c */
 510   struct obstack *hash_ob;
 511
 512   /* Obstack holding buffer and conditional structures.  This is a
 513      real stack.  See cpplib.c */
 514   struct obstack *buffer_ob;
 515
 516   /* Pragma table - dynamic, because a library user can add to the
 517      list of recognized pragmas.  */
 518   struct pragma_entry *pragmas;
 519
 520   /* Call backs.  */
 521   struct {
 522     void (*enter_file) PARAMS ((cpp_reader *));
 523     void (*leave_file) PARAMS ((cpp_reader *));
 524     void (*include) PARAMS ((cpp_reader *, const unsigned char *,
 525                              const unsigned char *, unsigned int, int));
 526     void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
 527     void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
 528     void (*poison) PARAMS ((cpp_reader *));
 529     void (*ident) PARAMS ((cpp_reader *, const cpp_token *));
 530     void (*def_pragma) PARAMS ((cpp_reader *));
 531   } cb;
 532
 533   /* User visible options.  */
 534   struct cpp_options opts;
 535
 536   /* Nonzero means we have printed (while error reporting) a list of
 537      containing files that matches the current status.  */
 538   unsigned char input_stack_listing_current;
 539
 540   /* We're printed a warning recommending against using #import.  */
 541   unsigned char import_warning;
 542
 543   /* True after cpp_start_read completes.  Used to inhibit some
 544      warnings while parsing the command line.  */
 545   unsigned char done_initializing;
 546
 547   /* True if we are skipping a failed conditional group.  */
 548   unsigned char skipping;
 549
 550   /* True if we need to save parameter spellings - only if -pedantic,
 551      or we might need to write out definitions.  */
 552   unsigned char save_parameter_spellings;
 553
 554   /* If we're in lex_line.  */
 555   unsigned char in_lex_line;
 556
 557   /* True if output_line_command needs to output a newline.  */
 558   unsigned char need_newline;
 559
 560   /* Special nodes - identifiers with predefined significance to the
 561      preprocessor.  */
 562   struct spec_nodes *spec_nodes;
 563 };
 564
 565 /* struct cpp_printer encapsulates state used to convert the stream of
 566    tokens coming from cpp_get_token back into a text file.  Not
 567    everyone wants to do that, hence we separate the function.  */
 568
 569 struct cpp_printer
 570 {
 571   FILE *outf;                   /* stream to write to */
 572   const char *last_fname;       /* previous file name */
 573   unsigned int lineno;          /* line currently being written */
 574 };
 575
 576 #define CPP_FATAL_LIMIT 1000
 577 /* True if we have seen a "fatal" error. */
 578 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 579
 580 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 581 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 582 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
 583 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + pfile->col_adjust)
 584 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
 585
 586 /* Name under which this program was invoked.  */
 587 extern const char *progname;
 588
 589 /* The structure of a node in the hash table.  The hash table
 590    has entries for all tokens defined by #define commands (type T_MACRO),
 591    plus some special tokens like __LINE__ (these each have their own
 592    type, and the appropriate code is run when that type of node is seen.
 593    It does not contain control words like "#define", which are recognized
 594    by a separate piece of code. */
 595
 596 /* different flavors of hash nodes */
 597 enum node_type
 598 {
 599   T_VOID = 0,      /* no definition yet */
 600   T_SPECLINE,      /* `__LINE__' */
 601   T_DATE,          /* `__DATE__' */
 602   T_FILE,          /* `__FILE__' */
 603   T_BASE_FILE,     /* `__BASE_FILE__' */
 604   T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
 605   T_TIME,          /* `__TIME__' */
 606   T_STDC,          /* `__STDC__' */
 607   T_OPERATOR,      /* operator with a name; val.code is token type */
 608   T_POISON,        /* poisoned identifier */
 609   T_MACRO,         /* a macro, either object-like or function-like */
 610   T_ASSERTION      /* predicate for #assert */
 611 };
 612
 613 /* There is a slot in the hashnode for use by front ends when integrated
 614    with cpplib.  It holds a tree (see tree.h) but we mustn't drag that
 615    header into every user of cpplib.h.  cpplib does not do anything with
 616    this slot except clear it when a new node is created.  */
 617 union tree_node;
 618
 619 struct cpp_hashnode
 620 {
 621   unsigned int hash;                    /* cached hash value */
 622   unsigned short length;                /* length of name */
 623   ENUM_BITFIELD(node_type) type : 8;    /* node type */
 624
 625   union
 626   {
 627     const cpp_toklist *expansion;       /* a macro's replacement list.  */
 628     struct answer *answers;             /* answers to an assertion.  */
 629     enum cpp_ttype code;                /* code for a named operator.  */
 630   } value;
 631
 632   union tree_node *fe_value;            /* front end value */
 633
 634   const unsigned char name[1];          /* name[length] */
 635 };
 636
 637 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 638 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 639 extern void cpp_reader_init PARAMS ((cpp_reader *));
 640 extern cpp_printer *cpp_printer_init PARAMS ((cpp_reader *, cpp_printer *));
 641
 642 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 643                                          const char *, const char *,
 644                                          void (*) PARAMS ((cpp_reader *))));
 645 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
 646
 647 extern int cpp_start_read PARAMS ((cpp_reader *, cpp_printer *, const char *));
 648 extern void cpp_output_tokens PARAMS ((cpp_reader *, cpp_printer *,
 649                                        unsigned int));
 650 extern void cpp_finish PARAMS ((cpp_reader *, cpp_printer *));
 651 extern void cpp_cleanup PARAMS ((cpp_reader *));
 652
 653 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
 654
 655 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 656 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 657 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 658 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 659
 660 extern void cpp_free_token_list PARAMS ((cpp_toklist *));
 661 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 662                                             const unsigned char *, long));
 663 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 664 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 665
 666 /* N.B. The error-message-printer prototypes have not been nicely
 667    formatted because exgettext needs to see 'msgid' on the same line
 668    as the name of the function in order to work properly.  Only the
 669    string argument gets a name in an effort to keep the lines from
 670    getting ridiculously oversized.  */
 671
 672 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 673   ATTRIBUTE_PRINTF_2;
 674 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 675   ATTRIBUTE_PRINTF_2;
 676 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 677   ATTRIBUTE_PRINTF_2;
 678 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 679   ATTRIBUTE_PRINTF_2;
 680 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 681   ATTRIBUTE_PRINTF_2;
 682 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 683   ATTRIBUTE_PRINTF_2;
 684 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 685   ATTRIBUTE_PRINTF_4;
 686 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 687   ATTRIBUTE_PRINTF_4;
 688 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 689   ATTRIBUTE_PRINTF_4;
 690 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 691   ATTRIBUTE_PRINTF_5;
 692 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 693 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 694
 695 /* In cpplex.c */
 696 extern cpp_buffer *cpp_push_buffer      PARAMS ((cpp_reader *,
 697                                                  const unsigned char *, long));
 698 extern cpp_buffer *cpp_pop_buffer       PARAMS ((cpp_reader *));
 699 extern void cpp_scan_buffer             PARAMS ((cpp_reader *, cpp_printer *));
 700 extern void cpp_scan_buffer_nooutput    PARAMS ((cpp_reader *));
 701 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 702                                                  const char *));
 703 extern void cpp_printf                  PARAMS ((cpp_reader *, cpp_printer *,
 704                                                  const char *, ...));
 705
 706 extern void cpp_output_list             PARAMS ((cpp_reader *, FILE *,
 707                                                  const cpp_toklist *,
 708                                                  const cpp_token *));
 709
 710 /* In cpphash.c */
 711 extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
 712                                          const unsigned char *, size_t));
 713 extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
 714                                             int (*) PARAMS ((cpp_reader *,
 715                                                              cpp_hashnode *))));
 716 /* In cppmacro.c */
 717 extern void cpp_dump_definition PARAMS ((cpp_reader *, FILE *,
 718                                          const cpp_hashnode *));
 719
 720 /* In cppfiles.c */
 721 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 722 extern int cpp_read_file PARAMS ((cpp_reader *, const char *));
 723 extern void cpp_make_system_header PARAMS ((cpp_reader *, cpp_buffer *, int));
 724 extern const char *cpp_syshdr_flags PARAMS ((cpp_reader *, cpp_buffer *));
 725
 726 #ifdef __cplusplus
 727 }
 728 #endif
 729 #endif /* __GCC_CPPLIB__ */