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