gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001
   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   /* Search paths for include files.  */
 285   struct file_name_list *quote_include;  /* First dir to search for "file" */
 286   struct file_name_list *bracket_include;/* First dir to search for <file> */
 287
 288   /* Map between header names and file names, used only on DOS where
 289      file names are limited in length.  */
 290   struct file_name_map_list *map_list;
 291
 292   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 293      in the standard include file directories.  */
 294   const char *include_prefix;
 295   unsigned int include_prefix_len;
 296
 297   /* -fleading_underscore sets this to "_".  */
 298   const char *user_label_prefix;
 299
 300   /* The language we're preprocessing.  */
 301   enum c_lang lang;
 302
 303   /* Non-0 means -v, so print the full set of include dirs.  */
 304   unsigned char verbose;
 305
 306   /* Nonzero means use extra default include directories for C++.  */
 307   unsigned char cplusplus;
 308
 309   /* Nonzero means handle cplusplus style comments */
 310   unsigned char cplusplus_comments;
 311
 312   /* Nonzero means handle #import, for objective C.  */
 313   unsigned char objc;
 314
 315   /* Nonzero means don't copy comments into the output file.  */
 316   unsigned char discard_comments;
 317
 318   /* Nonzero means process the ISO trigraph sequences.  */
 319   unsigned char trigraphs;
 320
 321   /* Nonzero means process the ISO digraph sequences.  */
 322   unsigned char digraphs;
 323
 324   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 325   unsigned char extended_numbers;
 326
 327   /* Nonzero means print the names of included files rather than the
 328      preprocessed output.  1 means just the #include "...", 2 means
 329      #include <...> as well.  */
 330   unsigned char print_deps;
 331
 332   /* Nonzero if phony targets are created for each header.  */
 333   unsigned char deps_phony_targets;
 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 #include lines through to the output.  */
 415   unsigned char dump_includes;
 416
 417   /* Print column number in error messages.  */
 418   unsigned char show_column;
 419
 420   /* Treat C++ alternate operator names special.  */
 421   unsigned char operator_names;
 422 };
 423
 424 struct lexer_state
 425 {
 426   /* Nonzero if first token on line is CPP_HASH.  */
 427   unsigned char in_directive;
 428
 429   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 430   unsigned char angled_headers;
 431
 432   /* Nonzero to save comments.  Turned off if discard_comments, and in
 433      all directives apart from #define.  */
 434   unsigned char save_comments;
 435
 436   /* If nonzero the next token is at the beginning of the line.  */
 437   unsigned char next_bol;
 438
 439   /* Nonzero if we're mid-comment.  */
 440   unsigned char lexing_comment;
 441
 442   /* Nonzero if lexing __VA_ARGS__ is valid.  */
 443   unsigned char va_args_ok;
 444
 445   /* Nonzero if lexing poisoned identifiers is valid.  */
 446   unsigned char poisoned_ok;
 447
 448   /* Nonzero to prevent macro expansion.  */
 449   unsigned char prevent_expansion;
 450
 451   /* Nonzero when parsing arguments to a function-like macro.  */
 452   unsigned char parsing_args;
 453
 454   /* Nonzero when in a # NUMBER directive.  */
 455   unsigned char line_extension;
 456 };
 457
 458 /* Special nodes - identifiers with predefined significance.  */
 459 struct spec_nodes
 460 {
 461   cpp_hashnode *n_L;                    /* L"str" */
 462   cpp_hashnode *n_defined;              /* defined operator */
 463   cpp_hashnode *n__Pragma;              /* _Pragma operator */
 464   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 465   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 466   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 467 };
 468
 469 /* This structure is passed to the call back when changing file.  */
 470 enum cpp_fc_reason {FC_ENTER = 0, FC_LEAVE, FC_RENAME};
 471
 472 struct cpp_file_loc
 473 {
 474   const char *filename;
 475   unsigned int lineno;
 476 };
 477
 478 typedef struct cpp_file_change cpp_file_change;
 479 struct cpp_file_change
 480 {
 481   struct cpp_file_loc from;     /* Line of #include or #line.  */
 482   struct cpp_file_loc to;       /* Line after #include or #line, or start.  */
 483   enum cpp_fc_reason reason;    /* Reason for change.  */
 484   unsigned char sysp;           /* Nonzero if system header.  */
 485   unsigned char externc;        /* Nonzero if wrapper needed.  */
 486 };
 487
 488 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 489    Applying cpp_get_token repeatedly yields a stream of pre-processor
 490    tokens.  Usually, there is only one cpp_reader object active.  */
 491
 492 struct cpp_reader
 493 {
 494   /* Top of buffer stack.  */
 495   cpp_buffer *buffer;
 496
 497   /* Lexer state.  */
 498   struct lexer_state state;
 499
 500   /* The position of the last lexed token and last lexed directive.  */
 501   cpp_lexer_pos lexer_pos;
 502   cpp_lexer_pos directive_pos;
 503
 504   /* Memory pools.  */
 505   cpp_pool ident_pool;          /* For all identifiers, and permanent
 506                                    numbers and strings.  */
 507   cpp_pool macro_pool;          /* For macro definitions.  Permanent.  */
 508   cpp_pool argument_pool;       /* For macro arguments.  Temporary.   */
 509
 510   /* Context stack.  */
 511   struct cpp_context base_context;
 512   struct cpp_context *context;
 513
 514   /* If in_directive, the directive if known.  */
 515   const struct directive *directive;
 516
 517   /* Multiple inlcude optimisation.  */
 518   enum mi_state mi_state;
 519   enum mi_ind mi_if_not_defined;
 520   unsigned int mi_lexed;
 521   const cpp_hashnode *mi_cmacro;
 522   const cpp_hashnode *mi_ind_cmacro;
 523
 524   /* Token lookahead.  */
 525   struct cpp_lookahead *la_read;        /* Read from this lookahead.  */
 526   struct cpp_lookahead *la_write;       /* Write to this lookahead.  */
 527   struct cpp_lookahead *la_unused;      /* Free store.  */
 528   struct cpp_lookahead *la_saved;       /* Backup when entering directive.  */
 529
 530   /* Error counter for exit code.  */
 531   unsigned int errors;
 532
 533   /* Line and column where a newline was first seen in a string
 534      constant (multi-line strings).  */
 535   cpp_lexer_pos mlstring_pos;
 536
 537   /* Buffer to hold macro definition string.  */
 538   unsigned char *macro_buffer;
 539   unsigned int macro_buffer_len;
 540
 541   /* Current depth in #include directives that use <...>.  */
 542   unsigned int system_include_depth;
 543
 544   /* Current depth of buffer stack.  */
 545   unsigned int buffer_stack_depth;
 546
 547   /* Current depth in #include directives.  */
 548   unsigned int include_depth;
 549
 550   /* Hash table of macros and assertions.  See cpphash.c.  */
 551   struct htab *hashtab;
 552
 553   /* Tree of other included files.  See cppfiles.c.  */
 554   struct splay_tree_s *all_include_files;
 555
 556   /* Chain of `actual directory' file_name_list entries, for ""
 557      inclusion.  */
 558   struct file_name_list *actual_dirs;
 559
 560   /* Current maximum length of directory names in the search path
 561      for include files.  (Altered as we get more of them.)  */
 562   unsigned int max_include_len;
 563
 564   /* Date and time tokens.  Calculated together if either is requested.  */
 565   cpp_token date;
 566   cpp_token time;
 567
 568   /* Opaque handle to the dependencies of mkdeps.c.  Used by -M etc.  */
 569   struct deps *deps;
 570
 571   /* Obstack holding all macro hash nodes.  This never shrinks.
 572      See cpphash.c */
 573   struct obstack *hash_ob;
 574
 575   /* Obstack holding buffer and conditional structures.  This is a
 576      real stack.  See cpplib.c */
 577   struct obstack *buffer_ob;
 578
 579   /* Pragma table - dynamic, because a library user can add to the
 580      list of recognized pragmas.  */
 581   struct pragma_entry *pragmas;
 582
 583   /* Call backs.  */
 584   struct {
 585     void (*file_change) PARAMS ((cpp_reader *, const cpp_file_change *));
 586     void (*include) PARAMS ((cpp_reader *, const unsigned char *,
 587                              const cpp_token *));
 588     void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
 589     void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
 590     void (*poison) PARAMS ((cpp_reader *));
 591     void (*ident) PARAMS ((cpp_reader *, const cpp_string *));
 592     void (*def_pragma) PARAMS ((cpp_reader *));
 593   } cb;
 594
 595   /* User visible options.  */
 596   struct cpp_options opts;
 597
 598   /* Special nodes - identifiers with predefined significance to the
 599      preprocessor.  */
 600   struct spec_nodes spec_nodes;
 601
 602   /* We're printed a warning recommending against using #import.  */
 603   unsigned char import_warning;
 604
 605   /* True after cpp_start_read completes.  Used to inhibit some
 606      warnings while parsing the command line.  */
 607   unsigned char done_initializing;
 608
 609   /* True if we are skipping a failed conditional group.  */
 610   unsigned char skipping;
 611
 612   /* True if --help appeared in the options.  Caller should then bail
 613      out after option parsing and printing its own help.  See cppmain.c.  */
 614   unsigned char help_only;
 615 };
 616
 617 #define CPP_FATAL_LIMIT 1000
 618 /* True if we have seen a "fatal" error. */
 619 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 620
 621 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 622 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 623 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
 624 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
 625 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
 626
 627 /* Name under which this program was invoked.  */
 628 extern const char *progname;
 629
 630 /* Where does this buffer come from?  A faked include, a source file,
 631    a builtin macro, a command-line option, or a _Pragma operator.  */
 632 enum cpp_buffer_type {BUF_FAKE, BUF_FILE, BUF_BUILTIN,
 633                       BUF_CL_OPTION, BUF_PRAGMA};
 634
 635 /* The structure of a node in the hash table.  The hash table has
 636    entries for all identifiers: either macros defined by #define
 637    commands (type NT_MACRO), assertions created with #assert
 638    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 639    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
 640    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 641    identifier that behaves like an operator such as "xor".
 642    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 643    diagnostic may be required for this node.  Currently this only
 644    applies to __VA_ARGS__ and poisoned identifiers.  */
 645
 646 /* Hash node flags.  */
 647 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 648 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 649 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 650 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 651
 652 /* Different flavors of hash node.  */
 653 enum node_type
 654 {
 655   NT_VOID = 0,     /* No definition yet.  */
 656   NT_MACRO,        /* A macro of some form.  */
 657   NT_ASSERTION     /* Predicate for #assert.  */
 658 };
 659
 660 /* Different flavors of builtin macro.  */
 661 enum builtin_type
 662 {
 663   BT_SPECLINE = 0,              /* `__LINE__' */
 664   BT_DATE,                      /* `__DATE__' */
 665   BT_FILE,                      /* `__FILE__' */
 666   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 667   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 668   BT_TIME,                      /* `__TIME__' */
 669   BT_STDC                       /* `__STDC__' */
 670 };
 671
 672 /* There is a slot in the hashnode for use by front ends when integrated
 673    with cpplib.  It holds a tree (see tree.h) but we mustn't drag that
 674    header into every user of cpplib.h.  cpplib does not do anything with
 675    this slot except clear it when a new node is created.  */
 676 union tree_node;
 677
 678 struct cpp_hashnode
 679 {
 680   const unsigned char *name;            /* Null-terminated name.  */
 681   unsigned int hash;                    /* Cached hash value.  */
 682   unsigned short length;                /* Length of name excluding null.  */
 683   unsigned short arg_index;             /* Macro argument index.  */
 684   unsigned char directive_index;        /* Index into directive table.  */
 685   ENUM_BITFIELD(node_type) type : 8;    /* Node type.  */
 686   unsigned char flags;                  /* Node flags.  */
 687
 688   union
 689   {
 690     cpp_macro *macro;                   /* If a macro.  */
 691     struct answer *answers;             /* Answers to an assertion.  */
 692     enum cpp_ttype operator;            /* Code for a named operator.  */
 693     enum builtin_type builtin;          /* Code for a builtin macro.  */
 694   } value;
 695
 696   union tree_node *fe_value;            /* Front end value.  */
 697 };
 698
 699 /* Call this first to get a handle to pass to other functions.  */
 700 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
 701
 702 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
 703    return value is the number of arguments used.  If
 704    cpp_handle_options returns without using all arguments, it couldn't
 705    understand the next switch.  When there are no switches left, you
 706    must call cpp_post_options before calling cpp_start_read.  Only
 707    after cpp_post_options are the contents of the cpp_options
 708    structure reliable.  */
 709 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 710 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
 711 extern void cpp_post_options PARAMS ((cpp_reader *));
 712
 713 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
 714 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
 715                                                  const cpp_token *));
 716 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
 717                                                unsigned char *));
 718 extern void cpp_register_pragma PARAMS ((cpp_reader *,
 719                                          const char *, const char *,
 720                                          void (*) PARAMS ((cpp_reader *))));
 721 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
 722
 723 extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
 724 extern void cpp_finish PARAMS ((cpp_reader *));
 725 extern void cpp_cleanup PARAMS ((cpp_reader *));
 726 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
 727                                     const cpp_token *));
 728 extern enum cpp_ttype cpp_can_paste PARAMS ((cpp_reader *, const cpp_token *,
 729                                              const cpp_token *, int *));
 730 extern void cpp_get_token PARAMS ((cpp_reader *, cpp_token *));
 731 extern const cpp_lexer_pos *cpp_get_line PARAMS ((cpp_reader *));
 732 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
 733                                                   const cpp_hashnode *));
 734
 735 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 736 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 737 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 738 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 739
 740 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 741                                             const unsigned char *, size_t,
 742                                             enum cpp_buffer_type,
 743                                             const char *));
 744 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 745 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 746
 747 /* N.B. The error-message-printer prototypes have not been nicely
 748    formatted because exgettext needs to see 'msgid' on the same line
 749    as the name of the function in order to work properly.  Only the
 750    string argument gets a name in an effort to keep the lines from
 751    getting ridiculously oversized.  */
 752
 753 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 754   ATTRIBUTE_PRINTF_2;
 755 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 756   ATTRIBUTE_PRINTF_2;
 757 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 758   ATTRIBUTE_PRINTF_2;
 759 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 760   ATTRIBUTE_PRINTF_2;
 761 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 762   ATTRIBUTE_PRINTF_2;
 763 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 764   ATTRIBUTE_PRINTF_2;
 765 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 766   ATTRIBUTE_PRINTF_4;
 767 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 768   ATTRIBUTE_PRINTF_4;
 769 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 770   ATTRIBUTE_PRINTF_4;
 771 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 772   ATTRIBUTE_PRINTF_5;
 773 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 774 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 775
 776 /* In cpplex.c */
 777 extern int cpp_ideq                     PARAMS ((const cpp_token *,
 778                                                  const char *));
 779 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
 780 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
 781 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
 782
 783 /* In cpphash.c */
 784 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
 785                                                  const unsigned char *, size_t));
 786 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
 787                                                  int (*) PARAMS ((cpp_reader *,
 788                                                                   cpp_hashnode *,
 789                                                                   void *)),
 790                                                  void *));
 791
 792 /* In cppmacro.c */
 793 extern void cpp_scan_buffer_nooutput    PARAMS ((cpp_reader *, int));
 794 extern void cpp_start_lookahead         PARAMS ((cpp_reader *));
 795 extern void cpp_stop_lookahead          PARAMS ((cpp_reader *, int));
 796
 797 /* In cppfiles.c */
 798 extern int cpp_included PARAMS ((cpp_reader *, const char *));
 799 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
 800
 801 /* These are inline functions instead of macros so we can get type
 802    checking.  */
 803 typedef unsigned char U_CHAR;
 804 #define U (const U_CHAR *)  /* Intended use: U"string" */
 805
 806 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 807 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 808                                          size_t));
 809 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 810 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 811 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 812 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 813
 814 static inline int
 815 ustrcmp (s1, s2)
 816      const U_CHAR *s1, *s2;
 817 {
 818   return strcmp ((const char *)s1, (const char *)s2);
 819 }
 820
 821 static inline int
 822 ustrncmp (s1, s2, n)
 823      const U_CHAR *s1, *s2;
 824      size_t n;
 825 {
 826   return strncmp ((const char *)s1, (const char *)s2, n);
 827 }
 828
 829 static inline size_t
 830 ustrlen (s1)
 831      const U_CHAR *s1;
 832 {
 833   return strlen ((const char *)s1);
 834 }
 835
 836 static inline U_CHAR *
 837 uxstrdup (s1)
 838      const U_CHAR *s1;
 839 {
 840   return (U_CHAR *) xstrdup ((const char *)s1);
 841 }
 842
 843 static inline U_CHAR *
 844 ustrchr (s1, c)
 845      const U_CHAR *s1;
 846      int c;
 847 {
 848   return (U_CHAR *) strchr ((const char *)s1, c);
 849 }
 850
 851 static inline int
 852 ufputs (s, f)
 853      const U_CHAR *s;
 854      FILE *f;
 855 {
 856   return fputs ((const char *)s, f);
 857 }
 858
 859 #ifdef __cplusplus
 860 }
 861 #endif
 862 #endif /* __GCC_CPPLIB__ */