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 unsigned char U_CHAR;
  32
  33 typedef struct cpp_reader cpp_reader;
  34 typedef struct cpp_buffer cpp_buffer;
  35 typedef struct cpp_options cpp_options;
  36 typedef struct hashnode cpp_hashnode;
  37
  38 enum cpp_token {
  39   CPP_EOF = -1,
  40   CPP_OTHER = 0,
  41   CPP_COMMENT = 1,
  42   CPP_HSPACE,
  43   CPP_VSPACE, /* newlines and #line directives */
  44   CPP_NAME,
  45   CPP_NUMBER,
  46   CPP_CHAR,
  47   CPP_STRING,
  48   CPP_DIRECTIVE,
  49   CPP_LPAREN,   /* "(" */
  50   CPP_RPAREN,   /* ")" */
  51   CPP_LBRACE,   /* "{" */
  52   CPP_RBRACE,   /* "}" */
  53   CPP_COMMA,    /* "," */
  54   CPP_SEMICOLON,/* ";" */
  55   CPP_3DOTS,    /* "..." */
  56 #if 0
  57   CPP_ANDAND, /* "&&" */
  58   CPP_OROR,   /* "||" */
  59   CPP_LSH,    /* "<<" */
  60   CPP_RSH,    /* ">>" */
  61   CPP_EQL,    /* "==" */
  62   CPP_NEQ,    /* "!=" */
  63   CPP_LEQ,    /* "<=" */
  64   CPP_GEQ,    /* ">=" */
  65   CPP_PLPL,   /* "++" */
  66   CPP_MINMIN, /* "--" */
  67 #endif
  68   /* POP_TOKEN is returned when we've popped a cpp_buffer. */
  69   CPP_POP
  70 };
  71
  72 typedef enum cpp_token (*parse_underflow_t) PARAMS((cpp_reader *));
  73 typedef int (*parse_cleanup_t) PARAMS((cpp_buffer *, cpp_reader *));
  74
  75 extern void parse_set_mark      PARAMS ((cpp_reader *));
  76 extern void parse_clear_mark    PARAMS ((cpp_reader *));
  77 extern void parse_goto_mark     PARAMS ((cpp_reader *));
  78
  79 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
  80 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
  81 extern enum cpp_token cpp_get_token PARAMS ((cpp_reader *));
  82 extern void cpp_skip_hspace PARAMS((cpp_reader *));
  83 extern enum cpp_token cpp_get_non_space_token PARAMS ((cpp_reader *));
  84
  85 /* This frees resources used by PFILE. */
  86 extern void cpp_cleanup PARAMS ((cpp_reader *PFILE));
  87
  88 struct cpp_buffer
  89 {
  90   unsigned char *cur;    /* current position */
  91   unsigned char *rlimit; /* end of valid data */
  92   unsigned char *buf;    /* entire buffer */
  93   unsigned char *alimit; /* end of allocated buffer */
  94   unsigned char *line_base; /* start of current line */
  95
  96   struct cpp_buffer *prev;
  97
  98   /* Real filename.  (Alias to ->ihash->fname, obsolete). */
  99   const char *fname;
 100   /* Filename specified with #line command.  */
 101   const char *nominal_fname;
 102   /* Last filename specified with #line command.  */
 103   const char *last_nominal_fname;
 104   /* Actual directory of this file, used only for "" includes */
 105   struct file_name_list *actual_dir;
 106
 107   /* Pointer into the include hash table.  Used for include_next and
 108      to record control macros. */
 109   struct include_hash *ihash;
 110
 111   long lineno; /* Line number at CPP_LINE_BASE. */
 112   long colno; /* Column number at CPP_LINE_BASE. */
 113   long mark;  /* Saved position for lengthy backtrack. */
 114   parse_underflow_t underflow;
 115   parse_cleanup_t cleanup;
 116   void *data;
 117
 118   /* Value of if_stack at start of this file.
 119      Used to prohibit unmatched #endif (etc) in an include file.  */
 120   struct if_stack *if_stack;
 121
 122   /* True if this is a header file included using <FILENAME>.  */
 123   char system_header_p;
 124   char seen_eof;
 125
 126   /* True if buffer contains escape sequences.
 127      Currently there are two kinds:
 128      "\r-" means following identifier should not be macro-expanded.
 129      "\r " means a token-separator.  This turns into " " in final output
 130           if not stringizing and needed to separate tokens; otherwise nothing.
 131      Any other two-character sequence beginning with \r is an error.
 132
 133      If this is NOT set, then \r is a one-character escape meaning backslash
 134      newline.  This is guaranteed not to occur in the middle of a token.
 135      The two interpretations of \r do not conflict, because the two-character
 136      escapes are used only in macro buffers, and backslash-newline is removed
 137      from macro expansion text in collect_expansion and/or macarg.  */
 138   char has_escapes;
 139
 140   /* Used by the C++ frontend to implement redirected input (such as for
 141      default argument and/or template parsing).  */
 142   char manual_pop;
 143
 144   /* True if we have already warned about C++ comments in this file.
 145      The warning happens only for C89 extended mode with -pedantic on,
 146      and only once per file (otherwise it would be far too noisy).  */
 147   char warned_cplusplus_comments;
 148 };
 149
 150 struct file_name_map_list;
 151
 152 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
 153    efficiency, and partly to limit runaway recursion.  */
 154 #define CPP_STACK_MAX 200
 155
 156 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 157    Applying cpp_get_token repeatedly yields a stream of pre-processor
 158    tokens.  Usually, there is only one cpp_reader object active. */
 159
 160 struct cpp_reader
 161 {
 162   parse_underflow_t get_token;
 163   cpp_buffer *buffer;
 164   cpp_options *opts;
 165
 166   /* A buffer used for both for cpp_get_token's output, and also internally. */
 167   unsigned char *token_buffer;
 168   /* Allocated size of token_buffer.  CPP_RESERVE allocates space.  */
 169   unsigned int token_buffer_size;
 170   /* End of the written part of token_buffer. */
 171   unsigned char *limit;
 172
 173   /* Error counter for exit code */
 174   int errors;
 175
 176   /* Line where a newline was first seen in a string constant.  */
 177   int multiline_string_line;
 178
 179   /* Current depth in #include directives that use <...>.  */
 180   int system_include_depth;
 181
 182   /* Current depth of buffer stack. */
 183   int buffer_stack_depth;
 184
 185   /* Hash table of macros and assertions.  See cpphash.c */
 186 #define HASHSIZE 1403
 187   struct hashnode **hashtab;
 188
 189   /* Hash table of other included files.  See cppfiles.c */
 190 #define ALL_INCLUDE_HASHSIZE 71
 191   struct include_hash *all_include_files[ALL_INCLUDE_HASHSIZE];
 192
 193   /* Chain of `actual directory' file_name_list entries,
 194      for "" inclusion. */
 195   struct file_name_list *actual_dirs;
 196
 197   /* Current maximum length of directory names in the search path
 198      for include files.  (Altered as we get more of them.)  */
 199   unsigned int max_include_len;
 200
 201   struct if_stack *if_stack;
 202
 203   /* Nonzero means we have printed (while error reporting) a list of
 204      containing files that matches the current status. */
 205   char input_stack_listing_current;
 206
 207   /* If non-zero, macros are not expanded. */
 208   char no_macro_expand;
 209
 210   /* If non-zero, directives cause a hard error.  Used when parsing
 211      macro arguments.  */
 212
 213   char no_directives;
 214
 215   /* Print column number in error messages. */
 216   char show_column;
 217
 218   /* We're printed a warning recommending against using #import. */
 219   char import_warning;
 220
 221   /* If true, character between '<' and '>' are a single (string) token. */
 222   char parsing_include_directive;
 223
 224   /* True if escape sequences (as described for has_escapes in
 225      parse_buffer) should be emitted. */
 226   char output_escapes;
 227
 228   /* 0: Have seen non-white-space on this line.
 229      1: Only seen white space so far on this line.
 230      2: Only seen white space so far in this file. */
 231    char only_seen_white;
 232
 233   /* Nonzero means this file was included with a -imacros or -include
 234      command line and should not be recorded as an include file.  */
 235
 236   int no_record_file;
 237
 238   long lineno;
 239
 240   struct tm *timebuf;
 241
 242   /* Buffer of -M output.  */
 243   char *deps_buffer;
 244
 245   /* Number of bytes allocated in above.  */
 246   int deps_allocated_size;
 247
 248   /* Number of bytes used.  */
 249   int deps_size;
 250
 251   /* Number of bytes since the last newline.  */
 252   int deps_column;
 253
 254   /* A buffer and a table, used only by read_and_prescan (in cppfiles.c)
 255      which are allocated once per cpp_reader object to keep them off the
 256      stack and avoid setup costs.  */
 257   U_CHAR *input_buffer;
 258   U_CHAR *input_speccase;
 259   size_t input_buffer_len;
 260 };
 261
 262 #define CPP_FATAL_LIMIT 1000
 263 /* True if we have seen a "fatal" error. */
 264 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 265
 266 #define CPP_BUF_PEEK(BUFFER) \
 267   ((BUFFER)->cur < (BUFFER)->rlimit ? *(BUFFER)->cur : EOF)
 268 #define CPP_BUF_GET(BUFFER) \
 269   ((BUFFER)->cur < (BUFFER)->rlimit ? *(BUFFER)->cur++ : EOF)
 270 #define CPP_FORWARD(BUFFER, N) ((BUFFER)->cur += (N))
 271
 272 /* Macros for manipulating the token_buffer. */
 273
 274 #define CPP_OUT_BUFFER(PFILE) ((PFILE)->token_buffer)
 275
 276 /* Number of characters currently in PFILE's output buffer. */
 277 #define CPP_WRITTEN(PFILE) ((size_t)((PFILE)->limit - (PFILE)->token_buffer))
 278 #define CPP_PWRITTEN(PFILE) ((PFILE)->limit)
 279
 280 /* Make sure PFILE->token_buffer has space for at least N more characters. */
 281 #define CPP_RESERVE(PFILE, N) \
 282   (CPP_WRITTEN (PFILE) + (size_t)(N) > (PFILE)->token_buffer_size \
 283    && (cpp_grow_buffer (PFILE, N), 0))
 284
 285 /* Append string STR (of length N) to PFILE's output buffer.
 286    Assume there is enough space. */
 287 #define CPP_PUTS_Q(PFILE, STR, N) \
 288   (memcpy ((PFILE)->limit, STR, (N)), (PFILE)->limit += (N))
 289 /* Append string STR (of length N) to PFILE's output buffer.  Make space. */
 290 #define CPP_PUTS(PFILE, STR, N) CPP_RESERVE(PFILE, N), CPP_PUTS_Q(PFILE, STR,N)
 291 /* Append character CH to PFILE's output buffer.  Assume sufficient space. */
 292 #define CPP_PUTC_Q(PFILE, CH) (*(PFILE)->limit++ = (CH))
 293 /* Append character CH to PFILE's output buffer.  Make space if need be. */
 294 #define CPP_PUTC(PFILE, CH) (CPP_RESERVE (PFILE, 1), CPP_PUTC_Q (PFILE, CH))
 295 /* Make sure PFILE->limit is followed by '\0'. */
 296 #define CPP_NUL_TERMINATE_Q(PFILE) (*(PFILE)->limit = 0)
 297 #define CPP_NUL_TERMINATE(PFILE) (CPP_RESERVE(PFILE, 1), *(PFILE)->limit = 0)
 298 #define CPP_ADJUST_WRITTEN(PFILE,DELTA) ((PFILE)->limit += (DELTA))
 299 #define CPP_SET_WRITTEN(PFILE,N) ((PFILE)->limit = (PFILE)->token_buffer + (N))
 300
 301 /* Advance the current line by one. */
 302 #define CPP_BUMP_BUFFER_LINE(PBUF) ((PBUF)->lineno++,\
 303                                     (PBUF)->line_base = (PBUF)->cur)
 304 #define CPP_BUMP_LINE(PFILE) CPP_BUMP_BUFFER_LINE(CPP_BUFFER(PFILE))
 305
 306 #define CPP_OPTIONS(PFILE) ((PFILE)->opts)
 307 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 308 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->prev)
 309 /* The bottom of the buffer stack. */
 310 #define CPP_NULL_BUFFER(PFILE) NULL
 311
 312 /* The `pending' structure accumulates all the options that are not
 313    actually processed until we hit cpp_start_read.  It consists of
 314    several lists, one for each type of option.  We keep both head and
 315    tail pointers for quick insertion. */
 316 struct cpp_pending
 317 {
 318   struct pending_option *define_head, *define_tail;
 319   struct pending_option *assert_head, *assert_tail;
 320
 321   struct file_name_list *quote_head, *quote_tail;
 322   struct file_name_list *brack_head, *brack_tail;
 323   struct file_name_list *systm_head, *systm_tail;
 324   struct file_name_list *after_head, *after_tail;
 325
 326   struct pending_option *imacros_head, *imacros_tail;
 327   struct pending_option *include_head, *include_tail;
 328 };
 329
 330 /* Pointed to by cpp_reader.opts. */
 331 struct cpp_options {
 332   char *in_fname;
 333
 334   /* Name of output file, for error messages.  */
 335   const char *out_fname;
 336
 337   struct file_name_map_list *map_list;
 338
 339   /* Non-0 means -v, so print the full set of include dirs.  */
 340   char verbose;
 341
 342   /* Nonzero means use extra default include directories for C++.  */
 343
 344   char cplusplus;
 345
 346   /* Nonzero means handle cplusplus style comments */
 347
 348   char cplusplus_comments;
 349
 350   /* Nonzero means handle #import, for objective C.  */
 351
 352   char objc;
 353
 354   /* Nonzero means this is an assembly file, so ignore unrecognized
 355      directives and the "# 33" form of #line, both of which are
 356      probably comments.  Also, permit unbalanced ' strings (again,
 357      likely to be in comments).  */
 358
 359   char lang_asm;
 360
 361   /* Nonzero means this is Fortran, and we don't know where the
 362      comments are, so permit unbalanced ' strings.  Unlike lang_asm,
 363      this does not ignore unrecognized directives.  */
 364
 365   char lang_fortran;
 366
 367   /* Nonzero means handle CHILL comment syntax
 368      and output CHILL string delimiter for __DATE___ etc. */
 369
 370   char chill;
 371
 372   /* Nonzero means copy comments into the output file.  */
 373
 374   char put_out_comments;
 375
 376   /* Nonzero means process the ANSI trigraph sequences.  */
 377
 378   char trigraphs;
 379
 380   /* Nonzero means print the names of included files rather than
 381      the preprocessed output.  1 means just the #include "...",
 382      2 means #include <...> as well.  */
 383
 384   char print_deps;
 385
 386   /* Nonzero if missing .h files in -M output are assumed to be generated
 387      files and not errors.  */
 388
 389   char print_deps_missing_files;
 390
 391   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 392   char print_deps_append;
 393
 394   /* Nonzero means print names of header files (-H).  */
 395
 396   char print_include_names;
 397
 398   /* Nonzero means try to make failure to fit ANSI C an error.  */
 399
 400   char pedantic_errors;
 401
 402   /* Nonzero means don't print warning messages.  -w.  */
 403
 404   char inhibit_warnings;
 405
 406   /* Nonzero means warn if slash-star appears in a comment.  */
 407
 408   char warn_comments;
 409
 410   /* Nonzero means warn if there are any trigraphs.  */
 411
 412   char warn_trigraphs;
 413
 414   /* Nonzero means warn if #import is used.  */
 415
 416   char warn_import;
 417
 418   /* Nonzero means warn if a macro argument is (or would be)
 419      stringified with -traditional.  */
 420
 421   char warn_stringify;
 422
 423   /* Nonzero means turn warnings into errors.  */
 424
 425   char warnings_are_errors;
 426
 427   /* Nonzero causes output not to be done,
 428      but directives such as #define that have side effects
 429      are still obeyed.  */
 430
 431   char no_output;
 432
 433   /* Nonzero means we should look for header.gcc files that remap file
 434      names.  */
 435   char remap;
 436
 437   /* Nonzero means don't output line number information.  */
 438
 439   char no_line_commands;
 440
 441 /* Nonzero means output the text in failing conditionals,
 442    inside #failed ... #endfailed.  */
 443
 444   char output_conditionals;
 445
 446   /* Nonzero means -I- has been seen,
 447      so don't look for #include "foo" the source-file directory.  */
 448   char ignore_srcdir;
 449
 450   /* Zero means dollar signs are punctuation.
 451      This used to be needed for conformance to the C Standard,
 452      before the C Standard was corrected.  */
 453   char dollars_in_ident;
 454
 455   /* Nonzero means try to imitate old fashioned non-ANSI preprocessor.  */
 456   char traditional;
 457
 458   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 459   char warn_undef;
 460
 461   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 462   char c89;
 463
 464   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 465   char c99;
 466
 467   /* Nonzero means give all the error messages the ANSI standard requires.  */
 468   char pedantic;
 469
 470   /* Nonzero means we're looking at already preprocessed code, so don't
 471      bother trying to do macro expansion and whatnot.  */
 472   char preprocessed;
 473
 474   char done_initializing;
 475
 476   /* Search paths for include files.  */
 477   struct file_name_list *quote_include;  /* First dir to search for "file" */
 478   struct file_name_list *bracket_include;/* First dir to search for <file> */
 479
 480   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 481      in the standard include file directories.  */
 482   char *include_prefix;
 483   int include_prefix_len;
 484
 485   char no_standard_includes;
 486   char no_standard_cplusplus_includes;
 487
 488 /* dump_only means inhibit output of the preprocessed text
 489              and instead output the definitions of all user-defined
 490              macros in a form suitable for use as input to cccp.
 491    dump_names means pass #define and the macro name through to output.
 492    dump_definitions means pass the whole definition (plus #define) through
 493 */
 494
 495   enum {dump_none = 0, dump_only, dump_names, dump_definitions}
 496      dump_macros;
 497
 498 /* Nonzero means pass all #define and #undef directives which we actually
 499    process through to the output stream.  This feature is used primarily
 500    to allow cc1 to record the #defines and #undefs for the sake of
 501    debuggers which understand about preprocessor macros, but it may
 502    also be useful with -E to figure out how symbols are defined, and
 503    where they are defined.  */
 504   int debug_output;
 505
 506   /* Nonzero means pass #include lines through to the output,
 507      even if they are ifdefed out.  */
 508   int dump_includes;
 509
 510   /* Pending options - -D, -U, -A, -I, -ixxx. */
 511   struct cpp_pending *pending;
 512
 513   /* File name which deps are being written to.
 514      This is 0 if deps are being written to stdout.  */
 515   char *deps_file;
 516
 517   /* Target-name to write with the dependency information.  */
 518   char *deps_target;
 519 };
 520
 521 #define CPP_TRADITIONAL(PFILE) (CPP_OPTIONS(PFILE)-> traditional)
 522 #define CPP_WARN_UNDEF(PFILE) (CPP_OPTIONS(PFILE)->warn_undef)
 523 #define CPP_C89(PFILE) (CPP_OPTIONS(PFILE)->c89)
 524 #define CPP_PEDANTIC(PFILE) (CPP_OPTIONS (PFILE)->pedantic)
 525 #define CPP_PREPROCESSED(PFILE) (CPP_OPTIONS (PFILE)->preprocessed)
 526 #define CPP_PRINT_DEPS(PFILE) (CPP_OPTIONS (PFILE)->print_deps)
 527
 528 /* List of directories to look for include files in. */
 529 struct file_name_list
 530 {
 531   struct file_name_list *next;
 532   struct file_name_list *alloc; /* for the cache of
 533                                    current directory entries */
 534   char *name;
 535   unsigned int nlen;
 536   /* We use these to tell if the directory mentioned here is a duplicate
 537      of an earlier directory on the search path. */
 538   ino_t ino;
 539   dev_t dev;
 540   /* If the following is nonzero, it is a C-language system include
 541      directory.  */
 542   int sysp;
 543   /* Mapping of file names for this directory.
 544      Only used on MS-DOS and related platforms. */
 545   struct file_name_map *name_map;
 546 };
 547 #define ABSOLUTE_PATH ((struct file_name_list *)-1)
 548
 549 /* This structure is used for the table of all includes.  It is
 550    indexed by the `short name' (the name as it appeared in the
 551    #include statement) which is stored in *nshort.  */
 552 struct include_hash
 553 {
 554   struct include_hash *next;
 555   /* Next file with the same short name but a
 556      different (partial) pathname). */
 557   struct include_hash *next_this_file;
 558
 559   /* Location of the file in the include search path.
 560      Used for include_next */
 561   struct file_name_list *foundhere;
 562   const char *name;             /* (partial) pathname of file */
 563   const char *nshort;           /* name of file as referenced in #include */
 564   const char *control_macro;    /* macro, if any, preventing reinclusion -
 565                                    see redundant_include_p */
 566   char *buf, *limit;            /* for file content cache,
 567                                    not yet implemented */
 568 };
 569
 570 /* Name under which this program was invoked.  */
 571
 572 extern const char *progname;
 573
 574 /* The structure of a node in the hash table.  The hash table
 575    has entries for all tokens defined by #define commands (type T_MACRO),
 576    plus some special tokens like __LINE__ (these each have their own
 577    type, and the appropriate code is run when that type of node is seen.
 578    It does not contain control words like "#define", which are recognized
 579    by a separate piece of code. */
 580
 581 /* different flavors of hash nodes --- also used in keyword table */
 582 enum node_type {
 583  T_DEFINE = 1,  /* the `#define' keyword */
 584  T_INCLUDE,     /* the `#include' keyword */
 585  T_INCLUDE_NEXT, /* the `#include_next' keyword */
 586  T_IMPORT,      /* the `#import' keyword */
 587  T_IFDEF,       /* the `#ifdef' keyword */
 588  T_IFNDEF,      /* the `#ifndef' keyword */
 589  T_IF,          /* the `#if' keyword */
 590  T_ELSE,        /* `#else' */
 591  T_PRAGMA,      /* `#pragma' */
 592  T_ELIF,        /* `#elif' */
 593  T_UNDEF,       /* `#undef' */
 594  T_LINE,        /* `#line' */
 595  T_ERROR,       /* `#error' */
 596  T_WARNING,     /* `#warning' */
 597  T_ENDIF,       /* `#endif' */
 598  T_SCCS,        /* `#sccs', used on system V.  */
 599  T_IDENT,       /* `#ident', used on system V.  */
 600  T_ASSERT,      /* `#assert', taken from system V.  */
 601  T_UNASSERT,    /* `#unassert', taken from system V.  */
 602  T_SPECLINE,    /* special symbol `__LINE__' */
 603  T_DATE,        /* `__DATE__' */
 604  T_FILE,        /* `__FILE__' */
 605  T_BASE_FILE,   /* `__BASE_FILE__' */
 606  T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
 607  T_VERSION,     /* `__VERSION__' */
 608  T_TIME,        /* `__TIME__' */
 609  T_STDC,        /* `__STDC__' */
 610  T_CONST,       /* Constant string, used by `__SIZE_TYPE__' etc */
 611  T_MACRO,       /* macro defined by `#define' */
 612  T_DISABLED,    /* macro temporarily turned off for rescan */
 613  T_PCSTRING,    /* precompiled string (hashval is KEYDEF *) */
 614  T_POISON,      /* defined with `#pragma poison' */
 615  T_UNUSED       /* Used for something not defined.  */
 616  };
 617
 618 /* Structure returned by create_definition */
 619 typedef struct macrodef MACRODEF;
 620 struct macrodef
 621 {
 622   struct definition *defn;
 623   const U_CHAR *symnam;
 624   int symlen;
 625 };
 626
 627 /* Structure allocated for every #define.  For a simple replacement
 628    such as
 629         #define foo bar ,
 630    nargs = -1, the `pattern' list is null, and the expansion is just
 631    the replacement text.  Nargs = 0 means a functionlike macro with no args,
 632    e.g.,
 633        #define getchar() getc (stdin) .
 634    When there are args, the expansion is the replacement text with the
 635    args squashed out, and the reflist is a list describing how to
 636    build the output from the input: e.g., "3 chars, then the 1st arg,
 637    then 9 chars, then the 3rd arg, then 0 chars, then the 2nd arg".
 638    The chars here come from the expansion.  Whatever is left of the
 639    expansion after the last arg-occurrence is copied after that arg.
 640    Note that the reflist can be arbitrarily long---
 641    its length depends on the number of times the arguments appear in
 642    the replacement text, not how many args there are.  Example:
 643    #define f(x) x+x+x+x+x+x+x would have replacement text "++++++" and
 644    pattern list
 645      { (0, 1), (1, 1), (1, 1), ..., (1, 1), NULL }
 646    where (x, y) means (nchars, argno). */
 647
 648 typedef struct definition DEFINITION;
 649 struct definition {
 650   int nargs;
 651   int length;                   /* length of expansion string */
 652   int predefined;               /* True if the macro was builtin or */
 653                                 /* came from the command line */
 654   unsigned char *expansion;
 655   int line;                     /* Line number of definition */
 656   const char *file;             /* File of definition */
 657   char rest_args;               /* Nonzero if last arg. absorbs the rest */
 658   struct reflist {
 659     struct reflist *next;
 660     char stringify;             /* nonzero if this arg was preceded by a
 661                                    # operator. */
 662     char raw_before;            /* Nonzero if a ## operator before arg. */
 663     char raw_after;             /* Nonzero if a ## operator after arg. */
 664     char rest_args;             /* Nonzero if this arg. absorbs the rest */
 665     int nchars;                 /* Number of literal chars to copy before
 666                                    this arg occurrence.  */
 667     int argno;                  /* Number of arg to substitute (origin-0) */
 668   } *pattern;
 669   union {
 670     /* Names of macro args, concatenated in reverse order
 671        with comma-space between them.
 672        The only use of this is that we warn on redefinition
 673        if this differs between the old and new definitions.  */
 674     unsigned char *argnames;
 675   } args;
 676 };
 677
 678 /* Character classes.
 679    If the definition of `numchar' looks odd to you, please look up the
 680    definition of a pp-number in the C standard [section 6.4.8 of C99] */
 681 #define ISidnum         0x01    /* a-zA-Z0-9_ */
 682 #define ISidstart       0x02    /* _a-zA-Z */
 683 #define ISnumstart      0x04    /* 0-9 */
 684 #define IShspace        0x08    /* ' ' \t \f \v */
 685 #define ISspace         0x10    /* ' ' \t \f \v \n */
 686
 687 #define is_idchar(x)    (IStable[x] & ISidnum)
 688 #define is_numchar(x)   (IStable[x] & ISidnum)
 689 #define is_idstart(x)   (IStable[x] & ISidstart)
 690 #define is_numstart(x)  (IStable[x] & ISnumstart)
 691 #define is_hspace(x)    (IStable[x] & IShspace)
 692 #define is_space(x)     (IStable[x] & ISspace)
 693
 694 /* This table is not really `const', but it is only modified at
 695    initialization time, in a separate translation unit from the rest
 696    of the library.  We let the rest of the library think it is `const'
 697    to get better code and some additional compile-time checks.  */
 698 #ifndef FAKE_CONST
 699 #define FAKE_CONST const
 700 #endif
 701 extern FAKE_CONST unsigned char IStable[256];
 702 #undef FAKE_CONST
 703
 704 /* Stack of conditionals currently in progress
 705    (including both successful and failing conditionals).  */
 706
 707 struct if_stack {
 708   struct if_stack *next;        /* for chaining to the next stack frame */
 709   const char *fname;            /* copied from input when frame is made */
 710   int lineno;                   /* similarly */
 711   int if_succeeded;             /* true if a leg of this if-group
 712                                     has been passed through rescan */
 713   unsigned char *control_macro; /* For #ifndef at start of file,
 714                                    this is the macro name tested.  */
 715   enum node_type type;          /* type of last directive seen in this group */
 716 };
 717 typedef struct if_stack IF_STACK_FRAME;
 718
 719 extern void cpp_buf_line_and_col PARAMS((cpp_buffer *, long *, long *));
 720 extern cpp_buffer* cpp_file_buffer PARAMS((cpp_reader *));
 721 extern void cpp_define PARAMS ((cpp_reader *, unsigned char *));
 722 extern void cpp_assert PARAMS ((cpp_reader *, unsigned char *));
 723 extern void cpp_undef  PARAMS ((cpp_reader *, unsigned char *));
 724 extern void cpp_unassert PARAMS ((cpp_reader *, unsigned char *));
 725
 726 extern void cpp_error PARAMS ((cpp_reader *, const char *, ...))
 727   ATTRIBUTE_PRINTF_2;
 728 extern void cpp_warning PARAMS ((cpp_reader *, const char *, ...))
 729   ATTRIBUTE_PRINTF_2;
 730 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *, ...))
 731   ATTRIBUTE_PRINTF_2;
 732 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *, ...))
 733   ATTRIBUTE_PRINTF_4;
 734 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *, ...))
 735   ATTRIBUTE_PRINTF_4;
 736 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *, ...))
 737   ATTRIBUTE_PRINTF_4;
 738 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, const char *, ...))
 739   ATTRIBUTE_PRINTF_4;
 740 extern void cpp_message_from_errno PARAMS ((cpp_reader *, int, const char *));
 741 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 742 extern void cpp_perror_with_name PARAMS ((cpp_reader *, const char *));
 743 extern void v_cpp_message PARAMS ((cpp_reader *, int, const char *, va_list));
 744
 745 extern void cpp_grow_buffer PARAMS ((cpp_reader *, long));
 746 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 747                                             unsigned char *, long));
 748 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 749
 750 extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *, const unsigned char *,
 751                                          int, int));
 752 extern void cpp_reader_init PARAMS ((cpp_reader *));
 753 extern void cpp_options_init PARAMS ((cpp_options *));
 754 extern int cpp_start_read PARAMS ((cpp_reader *, char *));
 755 extern int cpp_read_check_assertion PARAMS ((cpp_reader *));
 756 extern int scan_decls PARAMS ((cpp_reader *, int, char **));
 757 extern void skip_rest_of_line PARAMS ((cpp_reader *));
 758 extern void cpp_finish PARAMS ((cpp_reader *));
 759
 760 extern void quote_string                PARAMS ((cpp_reader *, const char *));
 761 extern void cpp_expand_to_buffer        PARAMS ((cpp_reader *, const U_CHAR *,
 762                                                  int));
 763 extern void cpp_scan_buffer             PARAMS ((cpp_reader *));
 764 extern int check_macro_name             PARAMS ((cpp_reader *, const U_CHAR *));
 765
 766 /* Last arg to output_line_command.  */
 767 enum file_change_code {same_file, enter_file, leave_file};
 768 extern void output_line_command         PARAMS ((cpp_reader *,
 769                                                  enum file_change_code));
 770
 771 /* From cpperror.c */
 772 extern void cpp_fatal PARAMS ((cpp_reader *, const char *, ...))
 773   ATTRIBUTE_PRINTF_2;
 774 extern void cpp_message PARAMS ((cpp_reader *, int, const char *, ...))
 775   ATTRIBUTE_PRINTF_3;
 776 extern void cpp_pfatal_with_name PARAMS ((cpp_reader *, const char *))
 777   ATTRIBUTE_NORETURN;
 778 extern void cpp_file_line_for_message PARAMS ((cpp_reader *, const char *,
 779                                               int, int));
 780 extern void cpp_print_containing_files PARAMS ((cpp_reader *));
 781 extern void cpp_notice PARAMS ((const char *msgid, ...)) ATTRIBUTE_PRINTF_1;
 782
 783 /* In cppfiles.c */
 784 extern void simplify_pathname           PARAMS ((char *));
 785 extern void merge_include_chains        PARAMS ((struct cpp_options *));
 786 extern int find_include_file            PARAMS ((cpp_reader *, const char *,
 787                                                 struct file_name_list *,
 788                                                 struct include_hash **,
 789                                                 int *));
 790 extern int finclude                     PARAMS ((cpp_reader *, int,
 791                                                 struct include_hash *));
 792 extern void deps_output                 PARAMS ((cpp_reader *,
 793                                                 const char *, int));
 794 extern struct include_hash *include_hash PARAMS ((cpp_reader *, const char *, int));
 795
 796 #ifndef INCLUDE_LEN_FUDGE
 797 #define INCLUDE_LEN_FUDGE 0
 798 #endif
 799
 800
 801 #ifdef __cplusplus
 802 }
 803 #endif
 804 #endif /* __GCC_CPPLIB__ */