gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000
   3    Free Software Foundation, Inc.
   4    Written by Per Bothner, 1994-95.
   5
   6 This program is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20  In other words, you are welcome to use, share and improve this program.
  21  You are forbidden to forbid anyone else to use, share and improve
  22  what you give them.   Help stamp out software-hoarding!  */
  23 #ifndef __GCC_CPPLIB__
  24 #define __GCC_CPPLIB__
  25
  26 #include <sys/types.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* For complex reasons, cpp_reader is also typedefed in c-pragma.h.  */
  33 #ifndef _C_PRAGMA_H
  34 typedef struct cpp_reader cpp_reader;
  35 #endif
  36 typedef struct cpp_buffer cpp_buffer;
  37 typedef struct cpp_options cpp_options;
  38 typedef struct cpp_token cpp_token;
  39 typedef struct cpp_string cpp_string;
  40 typedef struct cpp_hashnode cpp_hashnode;
  41 typedef struct cpp_pool cpp_pool;
  42 typedef struct cpp_macro cpp_macro;
  43 typedef struct cpp_lexer_pos cpp_lexer_pos;
  44 typedef struct cpp_lookahead cpp_lookahead;
  45
  46 struct directive;               /* These are deliberately incomplete.  */
  47 struct answer;
  48 struct cpp_macro;
  49 struct macro_args;
  50 struct cpp_chunk;
  51 struct file_name_map_list;
  52 struct htab;
  53
  54 /* The first two groups, apart from '=', can appear in preprocessor
  55    expressions.  This allows a lookup table to be implemented in
  56    _cpp_parse_expr.
  57
  58    The first group, to CPP_LAST_EQ, can be immediately followed by an
  59    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  60    the same order as their counterparts without the '=', like ">>".  */
  61
  62 /* Positions in the table.  */
  63 #define CPP_LAST_EQ CPP_MAX
  64 #define CPP_FIRST_DIGRAPH CPP_HASH
  65 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  66
  67 #define TTYPE_TABLE                             \
  68   OP(CPP_EQ = 0,        "=")                    \
  69   OP(CPP_NOT,           "!")                    \
  70   OP(CPP_GREATER,       ">")    /* compare */   \
  71   OP(CPP_LESS,          "<")                    \
  72   OP(CPP_PLUS,          "+")    /* math */      \
  73   OP(CPP_MINUS,         "-")                    \
  74   OP(CPP_MULT,          "*")                    \
  75   OP(CPP_DIV,           "/")                    \
  76   OP(CPP_MOD,           "%")                    \
  77   OP(CPP_AND,           "&")    /* bit ops */   \
  78   OP(CPP_OR,            "|")                    \
  79   OP(CPP_XOR,           "^")                    \
  80   OP(CPP_RSHIFT,        ">>")                   \
  81   OP(CPP_LSHIFT,        "<<")                   \
  82   OP(CPP_MIN,           "<?")   /* extension */ \
  83   OP(CPP_MAX,           ">?")                   \
  84 \
  85   OP(CPP_COMPL,         "~")                    \
  86   OP(CPP_AND_AND,       "&&")   /* logical */   \
  87   OP(CPP_OR_OR,         "||")                   \
  88   OP(CPP_QUERY,         "?")                    \
  89   OP(CPP_COLON,         ":")                    \
  90   OP(CPP_COMMA,         ",")    /* grouping */  \
  91   OP(CPP_OPEN_PAREN,    "(")                    \
  92   OP(CPP_CLOSE_PAREN,   ")")                    \
  93   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  94   OP(CPP_NOT_EQ,        "!=")                   \
  95   OP(CPP_GREATER_EQ,    ">=")                   \
  96   OP(CPP_LESS_EQ,       "<=")                   \
  97 \
  98   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  99   OP(CPP_MINUS_EQ,      "-=")                   \
 100   OP(CPP_MULT_EQ,       "*=")                   \
 101   OP(CPP_DIV_EQ,        "/=")                   \
 102   OP(CPP_MOD_EQ,        "%=")                   \
 103   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 104   OP(CPP_OR_EQ,         "|=")                   \
 105   OP(CPP_XOR_EQ,        "^=")                   \
 106   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 107   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 108   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 109   OP(CPP_MAX_EQ,        ">?=")                  \
 110   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 111   OP(CPP_HASH,          "#")    /* digraphs */  \
 112   OP(CPP_PASTE,         "##")                   \
 113   OP(CPP_OPEN_SQUARE,   "[")                    \
 114   OP(CPP_CLOSE_SQUARE,  "]")                    \
 115   OP(CPP_OPEN_BRACE,    "{")                    \
 116   OP(CPP_CLOSE_BRACE,   "}")                    \
 117   /* The remainder of the punctuation.  Order is not significant.  */   \
 118   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 119   OP(CPP_ELLIPSIS,      "...")                  \
 120   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 121   OP(CPP_MINUS_MINUS,   "--")                   \
 122   OP(CPP_DEREF,         "->")   /* accessors */ \
 123   OP(CPP_DOT,           ".")                    \
 124   OP(CPP_SCOPE,         "::")                   \
 125   OP(CPP_DEREF_STAR,    "->*")                  \
 126   OP(CPP_DOT_STAR,      ".*")                   \
 127 \
 128   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 129   TK(CPP_INT,           SPELL_STRING)   /* 23 */                        \
 130   TK(CPP_FLOAT,         SPELL_STRING)   /* 3.14159 */                   \
 131   TK(CPP_NUMBER,        SPELL_STRING)   /* 34_be+ta  */                 \
 132 \
 133   TK(CPP_CHAR,          SPELL_STRING)   /* 'char' */                    \
 134   TK(CPP_WCHAR,         SPELL_STRING)   /* L'char' */                   \
 135   TK(CPP_OTHER,         SPELL_CHAR)     /* stray punctuation */         \
 136 \
 137   TK(CPP_STRING,        SPELL_STRING)   /* "string" */                  \
 138   TK(CPP_WSTRING,       SPELL_STRING)   /* L"string" */                 \
 139   TK(CPP_OSTRING,       SPELL_STRING)   /* @"string" - Objective C */   \
 140   TK(CPP_HEADER_NAME,   SPELL_STRING)   /* <stdio.h> in #include */     \
 141 \
 142   TK(CPP_COMMENT,       SPELL_STRING)   /* Only if output comments.  */ \
 143   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 144   OP(CPP_EOF,           "EOL")          /* End of line or file.  */
 145
 146 #define OP(e, s) e,
 147 #define TK(e, s) e,
 148 enum cpp_ttype
 149 {
 150   TTYPE_TABLE
 151   N_TTYPES
 152 };
 153 #undef OP
 154 #undef TK
 155
 156 /* C language kind, used when calling cpp_reader_init.  */
 157 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
 158              CLK_GNUCXX, CLK_CXX98, CLK_OBJC, CLK_OBJCXX, CLK_ASM};
 159
 160 /* Multiple-include optimisation.  */
 161 enum mi_state {MI_FAILED = 0, MI_OUTSIDE};
 162 enum mi_ind {MI_IND_NONE = 0, MI_IND_NOT};
 163
 164 /* Payload of a NUMBER, FLOAT, STRING, or COMMENT token.  */
 165 struct cpp_string
 166 {
 167   unsigned int len;
 168   const unsigned char *text;
 169 };
 170
 171 /* Flags for the cpp_token structure.  */
 172 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 173 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 174 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 175 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 176 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
 177 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 178
 179 /* A preprocessing token.  This has been carefully packed and should
 180    occupy 12 bytes on 32-bit hosts and 16 bytes on 64-bit hosts.  */
 181 struct cpp_token
 182 {
 183   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 184   unsigned char flags;          /* flags - see above */
 185
 186   union
 187   {
 188     struct cpp_hashnode *node;  /* An identifier.  */
 189     struct cpp_string str;      /* A string, or number.  */
 190     unsigned int arg_no;        /* Argument no. for a CPP_MACRO_ARG.  */
 191     unsigned char c;            /* Character represented by CPP_OTHER.  */
 192   } val;
 193 };
 194
 195 /* The position of a token in the current file.  */
 196 struct cpp_lexer_pos
 197 {
 198   unsigned int line;
 199   unsigned int output_line;
 200   unsigned short col;
 201 };
 202
 203 typedef struct cpp_token_with_pos cpp_token_with_pos;
 204 struct cpp_token_with_pos
 205 {
 206   cpp_token token;
 207   cpp_lexer_pos pos;
 208 };
 209
 210 /* Token lookahead.  */
 211 struct cpp_lookahead
 212 {
 213   struct cpp_lookahead *next;
 214   cpp_token_with_pos *tokens;
 215   cpp_lexer_pos pos;
 216   unsigned int cur, count, cap;
 217 };
 218
 219 /* Memory pools.  */
 220 struct cpp_pool
 221 {
 222   struct cpp_chunk *cur, *locked;
 223   unsigned char *pos;           /* Current position.  */
 224   unsigned int align;
 225   unsigned int locks;
 226 };
 227
 228 typedef struct toklist toklist;
 229 struct toklist
 230 {
 231   cpp_token *first;
 232   cpp_token *limit;
 233 };
 234
 235 typedef struct cpp_context cpp_context;
 236 struct cpp_context
 237 {
 238   /* Doubly-linked list.  */
 239   cpp_context *next, *prev;
 240
 241   /* Contexts other than the base context are contiguous tokens.
 242      e.g. macro expansions, expanded argument tokens.  */
 243   struct toklist list;
 244
 245   /* For a macro context, these are the macro and its arguments.  */
 246   cpp_macro *macro;
 247 };
 248
 249 /* A standalone character.  We may want to make it unsigned for the
 250    same reason we use unsigned char - to avoid signedness issues.  */
 251 typedef int cppchar_t;
 252
 253 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
 254    efficiency, and partly to limit runaway recursion.  */
 255 #define CPP_STACK_MAX 200
 256
 257 /* Values for opts.dump_macros.
 258   dump_only means inhibit output of the preprocessed text
 259              and instead output the definitions of all user-defined
 260              macros in a form suitable for use as input to cpp.
 261    dump_names means pass #define and the macro name through to output.
 262    dump_definitions means pass the whole definition (plus #define) through
 263 */
 264 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 265
 266 /* This structure is nested inside struct cpp_reader, and
 267    carries all the options visible to the command line.  */
 268 struct cpp_options
 269 {
 270   /* Name of input and output files.  */
 271   const char *in_fname;
 272   const char *out_fname;
 273
 274   /* Characters between tab stops.  */
 275   unsigned int tabstop;
 276
 277   /* Pending options - -D, -U, -A, -I, -ixxx. */
 278   struct cpp_pending *pending;
 279
 280   /* File name which deps are being written to.  This is 0 if deps are
 281      being written to stdout.  */
 282   const char *deps_file;
 283
 284   /* Target-name to write with the dependency information.  */
 285   char *deps_target;
 286
 287   /* Search paths for include files.  */
 288   struct file_name_list *quote_include;  /* First dir to search for "file" */
 289   struct file_name_list *bracket_include;/* First dir to search for <file> */
 290
 291   /* Map between header names and file names, used only on DOS where
 292      file names are limited in length.  */
 293   struct file_name_map_list *map_list;
 294
 295   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 296      in the standard include file directories.  */
 297   const char *include_prefix;
 298   unsigned int include_prefix_len;
 299
 300   /* -fleading_underscore sets this to "_".  */
 301   const char *user_label_prefix;
 302
 303   /* The language we're preprocessing.  */
 304   enum c_lang lang;
 305
 306   /* Non-0 means -v, so print the full set of include dirs.  */
 307   unsigned char verbose;
 308
 309   /* Nonzero means use extra default include directories for C++.  */
 310   unsigned char cplusplus;
 311
 312   /* Nonzero means handle cplusplus style comments */
 313   unsigned char cplusplus_comments;
 314
 315   /* Nonzero means handle #import, for objective C.  */
 316   unsigned char objc;
 317
 318   /* Nonzero means don't copy comments into the output file.  */
 319   unsigned char discard_comments;
 320
 321   /* Nonzero means process the ISO trigraph sequences.  */
 322   unsigned char trigraphs;
 323
 324   /* Nonzero means process the ISO digraph sequences.  */
 325   unsigned char digraphs;
 326
 327   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 328   unsigned char extended_numbers;
 329
 330   /* Nonzero means print the names of included files rather than the
 331      preprocessed output.  1 means just the #include "...", 2 means
 332      #include <...> as well.  */
 333   unsigned char print_deps;
 334
 335   /* Nonzero if missing .h files in -M output are assumed to be
 336      generated files and not errors.  */
 337   unsigned char print_deps_missing_files;
 338
 339   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 340   unsigned char print_deps_append;
 341
 342   /* Nonzero means print names of header files (-H).  */
 343   unsigned char print_include_names;
 344
 345   /* Nonzero means cpp_pedwarn causes a hard error.  */
 346   unsigned char pedantic_errors;
 347
 348   /* Nonzero means don't print warning messages.  */
 349   unsigned char inhibit_warnings;
 350
 351   /* Nonzero means don't suppress warnings from system headers.  */
 352   unsigned char warn_system_headers;
 353
 354   /* Nonzero means don't print error messages.  Has no option to
 355      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 356   unsigned char inhibit_errors;
 357
 358   /* Nonzero means warn if slash-star appears in a comment.  */
 359   unsigned char warn_comments;
 360
 361   /* Nonzero means warn if there are any trigraphs.  */
 362   unsigned char warn_trigraphs;
 363
 364   /* Nonzero means warn if #import is used.  */
 365   unsigned char warn_import;
 366
 367   /* Nonzero means warn about various incompatibilities with
 368      traditional C.  */
 369   unsigned char warn_traditional;
 370
 371   /* Nonzero means turn warnings into errors.  */
 372   unsigned char warnings_are_errors;
 373
 374   /* Nonzero causes output not to be done, but directives such as
 375      #define that have side effects are still obeyed.  */
 376   unsigned char no_output;
 377
 378   /* Nonzero means we should look for header.gcc files that remap file
 379      names.  */
 380   unsigned char remap;
 381
 382   /* Nonzero means don't output line number information.  */
 383   unsigned char no_line_commands;
 384
 385   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 386      the source-file directory.  */
 387   unsigned char ignore_srcdir;
 388
 389   /* Zero means dollar signs are punctuation. */
 390   unsigned char dollars_in_ident;
 391
 392   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 393   unsigned char warn_undef;
 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   /* Treat C++ alternate operator names special.  */
 429   unsigned char operator_names;
 430 };
 431
 432 struct lexer_state
 433 {
 434   /* Nonzero if first token on line is CPP_HASH.  */
 435   unsigned char in_directive;
 436
 437   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 438   unsigned char angled_headers;
 439
 440   /* Nonzero to save comments.  Turned off if discard_comments, and in
 441      all directives apart from #define.  */
 442   unsigned char save_comments;
 443
 444   /* If nonzero the next token is at the beginning of the line.  */
 445   unsigned char next_bol;
 446
 447   /* Nonzero if we're mid-comment.  */
 448   unsigned char lexing_comment;
 449
 450   /* Nonzero if lexing __VA_ARGS__ is valid.  */
 451   unsigned char va_args_ok;
 452
 453   /* Nonzero if lexing poisoned identifiers is valid.  */
 454   unsigned char poisoned_ok;
 455
 456   /* Nonzero to prevent macro expansion.  */
 457   unsigned char prevent_expansion;
 458
 459   /* Nonzero when parsing arguments to a function-like macro.  */
 460   unsigned char parsing_args;
 461
 462   /* Nonzero when in a # NUMBER directive.  */
 463   unsigned char line_extension;
 464 };
 465
 466 /* Special nodes - identifiers with predefined significance.  */
 467 struct spec_nodes
 468 {
 469   cpp_hashnode *n_L;                    /* L"str" */
 470   cpp_hashnode *n_defined;              /* defined operator */
 471   cpp_hashnode *n__Pragma;              /* _Pragma operator */
 472   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 473   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 474   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 475 };
 476
 477 /* This structure is passed to the call back when changing file.  */
 478 enum cpp_fc_reason {FC_ENTER = 0, FC_LEAVE, FC_RENAME};
 479
 480 struct cpp_file_loc
 481 {
 482   const char *filename;
 483   unsigned int lineno;
 484 };
 485
 486 typedef struct cpp_file_change cpp_file_change;
 487 struct cpp_file_change
 488 {
 489   struct cpp_file_loc from;     /* Line of #include or #line.  */
 490   struct cpp_file_loc to;       /* Line after #include or #line, or start.  */
 491   enum cpp_fc_reason reason;    /* Reason for change.  */
 492   unsigned char sysp;           /* Nonzero if system header.  */
 493   unsigned char externc;        /* Nonzero if wrapper needed.  */
 494 };
 495
 496 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 497    Applying cpp_get_token repeatedly yields a stream of pre-processor
 498    tokens.  Usually, there is only one cpp_reader object active.  */
 499
 500 struct cpp_reader
 501 {
 502   /* Top of buffer stack.  */
 503   cpp_buffer *buffer;
 504
 505   /* Lexer state.  */
 506   struct lexer_state state;
 507
 508   /* The position of the last lexed token and last lexed directive.  */
 509   cpp_lexer_pos lexer_pos;
 510   cpp_lexer_pos directive_pos;
 511
 512   /* Memory pools.  */
 513   cpp_pool ident_pool;          /* For all identifiers, and permanent
 514                                    numbers and strings.  */
 515   cpp_pool temp_string_pool;    /* For temporary numbers and strings.   */
 516   cpp_pool macro_pool;          /* For macro definitions.  Permanent.  */
 517   cpp_pool argument_pool;       /* For macro arguments.  Temporary.   */
 518   cpp_pool* string_pool;        /* Either temp_string_pool or ident_pool.   */
 519
 520   /* Context stack.  */
 521   struct cpp_context base_context;
 522   struct cpp_context *context;
 523
 524   /* If in_directive, the directive if known.  */
 525   const struct directive *directive;
 526
 527   /* Multiple inlcude optimisation.  */
 528   enum mi_state mi_state;
 529   enum mi_ind mi_if_not_defined;
 530   unsigned int mi_lexed;
 531   const cpp_hashnode *mi_cmacro;
 532   const cpp_hashnode *mi_ind_cmacro;
 533
 534   /* Token lookahead.  */
 535   struct cpp_lookahead *la_read;        /* Read from this lookahead.  */
 536   struct cpp_lookahead *la_write;       /* Write to this lookahead.  */
 537   struct cpp_lookahead *la_unused;      /* Free store.  */
 538   struct cpp_lookahead *la_saved;       /* Backup when entering directive.  */
 539
 540   /* Error counter for exit code.  */
 541   unsigned int errors;
 542
 543   /* Line and column where a newline was first seen in a string
 544      constant (multi-line strings).  */
 545   cpp_lexer_pos mlstring_pos;
 546
 547   /* Buffer to hold macro definition string.  */
 548   unsigned char *macro_buffer;
 549   unsigned int macro_buffer_len;
 550
 551   /* Current depth in #include directives that use <...>.  */
 552   unsigned int system_include_depth;
 553
 554   /* Current depth of buffer stack.  */
 555   unsigned int buffer_stack_depth;
 556
 557   /* Current depth in #include directives.  */
 558   unsigned int include_depth;
 559
 560   /* Hash table of macros and assertions.  See cpphash.c.  */
 561   struct htab *hashtab;
 562
 563   /* Tree of other included files.  See cppfiles.c.  */
 564   struct splay_tree_s *all_include_files;
 565
 566   /* Chain of `actual directory' file_name_list entries, for ""
 567      inclusion.  */
 568   struct file_name_list *actual_dirs;
 569
 570   /* Current maximum length of directory names in the search path
 571      for include files.  (Altered as we get more of them.)  */
 572   unsigned int max_include_len;
 573
 574   /* Date and time tokens.  Calculated together if either is requested.  */
 575   cpp_token date;
 576   cpp_token time;
 577
 578   /* Buffer of -M output.  */
 579   struct deps *deps;
 580
 581   /* Obstack holding all macro hash nodes.  This never shrinks.
 582      See cpphash.c */
 583   struct obstack *hash_ob;
 584
 585   /* Obstack holding buffer and conditional structures.  This is a
 586      real stack.  See cpplib.c */
 587   struct obstack *buffer_ob;
 588
 589   /* Pragma table - dynamic, because a library user can add to the
 590      list of recognized pragmas.  */
 591   struct pragma_entry *pragmas;
 592
 593   /* Call backs.  */
 594   struct {
 595     void (*change_file) PARAMS ((cpp_reader *, const cpp_file_change *));
 596     void (*include) PARAMS ((cpp_reader *, const unsigned char *,
 597                              const cpp_token *));
 598     void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
 599     void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
 600     void (*poison) PARAMS ((cpp_reader *));
 601     void (*ident) PARAMS ((cpp_reader *, const cpp_string *));
 602     void (*def_pragma) PARAMS ((cpp_reader *));
 603   } cb;
 604
 605   /* User visible options.  */
 606   struct cpp_options opts;
 607
 608   /* Special nodes - identifiers with predefined significance to the
 609      preprocessor.  */
 610   struct spec_nodes spec_nodes;
 611
 612   /* We're printed a warning recommending against using #import.  */
 613   unsigned char import_warning;
 614
 615   /* True after cpp_start_read completes.  Used to inhibit some
 616      warnings while parsing the command line.  */
 617   unsigned char done_initializing;
 618
 619   /* True if we are skipping a failed conditional group.  */
 620   unsigned char skipping;
 621 };
 622
 623 #define CPP_FATAL_LIMIT 1000
 624 /* True if we have seen a "fatal" error. */
 625 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 626
 627 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 628 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 629 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
 630 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
 631 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
 632
 633 /* Name under which this program was invoked.  */
 634 extern const char *progname;
 635
 636 /* Where does this buffer come from?  A faked include, a source file,
 637    a builtin macro, a command-line option, or a _Pragma operator.  */
 638 enum cpp_buffer_type {BUF_FAKE, BUF_FILE, BUF_BUILTIN,
 639                       BUF_CL_OPTION, BUF_PRAGMA};
 640
 641 /* The structure of a node in the hash table.  The hash table has
 642    entries for all identifiers: either macros defined by #define
 643    commands (type NT_MACRO), assertions created with #assert
 644    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 645    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 646    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 647    identifier that behaves like an operator such as "xor".
 648    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 649    diagnostic may be required for this node.  Currently this only
 650    applies to __VA_ARGS__ and poisoned identifiers.  */
 651
 652 /* Hash node flags.  */
 653 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 654 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 655 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 656 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 657
 658 /* Different flavors of hash node.  */
 659 enum node_type
 660 {
 661   NT_VOID = 0,     /* No definition yet.  */
 662   NT_MACRO,        /* A macro of some form.  */
 663   NT_ASSERTION     /* Predicate for #assert.  */
 664 };
 665
 666 /* Different flavors of builtin macro.  */
 667 enum builtin_type
 668 {
 669   BT_SPECLINE = 0,              /* `__LINE__' */
 670   BT_DATE,                      /* `__DATE__' */
 671   BT_FILE,                      /* `__FILE__' */
 672   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 673   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 674   BT_TIME,                      /* `__TIME__' */
 675   BT_STDC                       /* `__STDC__' */
 676 };
 677
 678 /* There is a slot in the hashnode for use by front ends when integrated
 679    with cpplib.  It holds a tree (see tree.h) but we mustn't drag that
 680    header into every user of cpplib.h.  cpplib does not do anything with
 681    this slot except clear it when a new node is created.  */
 682 union tree_node;
 683
 684 struct cpp_hashnode
 685 {
 686   const unsigned char *name;            /* Null-terminated name.  */
 687   unsigned int hash;                    /* Cached hash value.  */
 688   unsigned short length;                /* Length of name excluding null.  */
 689   unsigned short arg_index;             /* Macro argument index.  */
 690   unsigned char directive_index;        /* Index into directive table.  */
 691   ENUM_BITFIELD(node_type) type : 8;    /* Node type.  */
 692   unsigned char flags;                  /* Node flags.  */
 693
 694   union
 695   {
 696     cpp_macro *macro;                   /* If a macro.  */
 697     struct answer *answers;             /* Answers to an assertion.  */
 698     enum cpp_ttype operator;            /* Code for a named operator.  */
 699     enum builtin_type builtin;          /* Code for a builtin macro.  */
 700   } value;
 701
 702   union tree_node *fe_value;            /* Front end value.  */
 703 };
 704
 705 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 706 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 707 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 708                                                  const cpp_token *));
 709 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 710                                                unsigned char *));
 711 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 712 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 713 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 714                                          const char *, const char *,
 715                                          void (*) PARAMS ((cpp_reader *))));
 716 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
 717
 718 extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
 719 extern void cpp_finish PARAMS ((cpp_reader *));
 720 extern void cpp_cleanup PARAMS ((cpp_reader *));
 721 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 722                                     const cpp_token *));
 723 extern enum cpp_ttype cpp_can_paste PARAMS ((cpp_reader *, const cpp_token *,
 724                                              const cpp_token *, int *));
 725 extern void cpp_get_token PARAMS ((cpp_reader *, cpp_token *));
 726 extern const cpp_lexer_pos *cpp_get_line PARAMS ((cpp_reader *));
 727 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 728                                                   const cpp_hashnode *));
 729
 730 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 731 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 732 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 733 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 734
 735 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 736                                             const unsigned char *, size_t,
 737                                             enum cpp_buffer_type,
 738                                             const char *));
 739 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 740 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 741
 742 /* N.B. The error-message-printer prototypes have not been nicely
 743    formatted because exgettext needs to see 'msgid' on the same line
 744    as the name of the function in order to work properly.  Only the
 745    string argument gets a name in an effort to keep the lines from
 746    getting ridiculously oversized.  */
 747
 748 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 749   ATTRIBUTE_PRINTF_2;
 750 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 751   ATTRIBUTE_PRINTF_2;
 752 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 753   ATTRIBUTE_PRINTF_2;
 754 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 755   ATTRIBUTE_PRINTF_2;
 756 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 757   ATTRIBUTE_PRINTF_2;
 758 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 759   ATTRIBUTE_PRINTF_2;
 760 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 761   ATTRIBUTE_PRINTF_4;
 762 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 763   ATTRIBUTE_PRINTF_4;
 764 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 765   ATTRIBUTE_PRINTF_4;
 766 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 767   ATTRIBUTE_PRINTF_5;
 768 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 769 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 770
 771 /* In cpplex.c */
 772 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 773                                                  const char *));
 774 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 775 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 776 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 777
 778 /* In cpphash.c */
 779 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 780                                                  const unsigned char *, size_t));
 781 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 782                                                  int (*) PARAMS ((cpp_reader *,
 783                                                                   cpp_hashnode *,
 784                                                                   void *)),
 785                                                  void *));
 786
 787 /* In cppmacro.c */
 788 extern void cpp_scan_buffer_nooutput    PARAMS ((cpp_reader *, int));
 789 extern void cpp_start_lookahead         PARAMS ((cpp_reader *));
 790 extern void cpp_stop_lookahead          PARAMS ((cpp_reader *, int));
 791
 792 /* In cppfiles.c */
 793 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 794 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
 795
 796 /* These are inline functions instead of macros so we can get type
 797    checking.  */
 798 typedef unsigned char U_CHAR;
 799 #define U (const U_CHAR *)  /* Intended use: U"string" */
 800
 801 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 802 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 803                                          size_t));
 804 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 805 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 806 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 807 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 808
 809 static inline int
 810 ustrcmp (s1, s2)
 811      const U_CHAR *s1, *s2;
 812 {
 813   return strcmp ((const char *)s1, (const char *)s2);
 814 }
 815
 816 static inline int
 817 ustrncmp (s1, s2, n)
 818      const U_CHAR *s1, *s2;
 819      size_t n;
 820 {
 821   return strncmp ((const char *)s1, (const char *)s2, n);
 822 }
 823
 824 static inline size_t
 825 ustrlen (s1)
 826      const U_CHAR *s1;
 827 {
 828   return strlen ((const char *)s1);
 829 }
 830
 831 static inline U_CHAR *
 832 uxstrdup (s1)
 833      const U_CHAR *s1;
 834 {
 835   return (U_CHAR *) xstrdup ((const char *)s1);
 836 }
 837
 838 static inline U_CHAR *
 839 ustrchr (s1, c)
 840      const U_CHAR *s1;
 841      int c;
 842 {
 843   return (U_CHAR *) strchr ((const char *)s1, c);
 844 }
 845
 846 static inline int
 847 ufputs (s, f)
 848      const U_CHAR *s;
 849      FILE *f;
 850 {
 851   return fputs ((const char *)s, f);
 852 }
 853
 854 #ifdef __cplusplus
 855 }
 856 #endif
 857 #endif /* __GCC_CPPLIB__ */