gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999 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, and allow
 350      unknown directives, which could be comments.  */
 351
 352   int lang_asm;
 353
 354   /* Nonzero means turn NOTREACHED into #pragma NOTREACHED etc */
 355
 356   char for_lint;
 357
 358   /* Nonzero means handle CHILL comment syntax
 359      and output CHILL string delimiter for __DATE___ etc. */
 360
 361   char chill;
 362
 363   /* Nonzero means copy comments into the output file.  */
 364
 365   char put_out_comments;
 366
 367   /* Nonzero means process the ANSI trigraph sequences.  */
 368
 369   char trigraphs;
 370
 371   /* Nonzero means print the names of included files rather than
 372      the preprocessed output.  1 means just the #include "...",
 373      2 means #include <...> as well.  */
 374
 375   char print_deps;
 376
 377   /* Nonzero if missing .h files in -M output are assumed to be generated
 378      files and not errors.  */
 379
 380   char print_deps_missing_files;
 381
 382   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 383   char print_deps_append;
 384
 385   /* Nonzero means print names of header files (-H).  */
 386
 387   char print_include_names;
 388
 389   /* Nonzero means try to make failure to fit ANSI C an error.  */
 390
 391   char pedantic_errors;
 392
 393   /* Nonzero means don't print warning messages.  -w.  */
 394
 395   char inhibit_warnings;
 396
 397   /* Nonzero means warn if slash-star appears in a comment.  */
 398
 399   char warn_comments;
 400
 401   /* Nonzero means warn if there are any trigraphs.  */
 402
 403   char warn_trigraphs;
 404
 405   /* Nonzero means warn if #import is used.  */
 406
 407   char warn_import;
 408
 409   /* Nonzero means warn if a macro argument is (or would be)
 410      stringified with -traditional.  */
 411
 412   char warn_stringify;
 413
 414   /* Nonzero means turn warnings into errors.  */
 415
 416   char warnings_are_errors;
 417
 418   /* Nonzero causes output not to be done,
 419      but directives such as #define that have side effects
 420      are still obeyed.  */
 421
 422   char no_output;
 423
 424   /* Nonzero means we should look for header.gcc files that remap file
 425      names.  */
 426   char remap;
 427
 428   /* Nonzero means don't output line number information.  */
 429
 430   char no_line_commands;
 431
 432 /* Nonzero means output the text in failing conditionals,
 433    inside #failed ... #endfailed.  */
 434
 435   char output_conditionals;
 436
 437   /* Nonzero means -I- has been seen,
 438      so don't look for #include "foo" the source-file directory.  */
 439   char ignore_srcdir;
 440
 441   /* Zero means dollar signs are punctuation.
 442      This used to be needed for conformance to the C Standard,
 443      before the C Standard was corrected.  */
 444   char dollars_in_ident;
 445
 446   /* Nonzero means try to imitate old fashioned non-ANSI preprocessor.  */
 447   char traditional;
 448
 449   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 450   char warn_undef;
 451
 452   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 453   char c89;
 454
 455   /* Nonzero for the 199x C Standard, including corrigenda and amendments.  */
 456   char c9x;
 457
 458   /* Nonzero means give all the error messages the ANSI standard requires.  */
 459   char pedantic;
 460
 461   /* Nonzero means we're looking at already preprocessed code, so don't
 462      bother trying to do macro expansion and whatnot.  */
 463   char preprocessed;
 464
 465   char done_initializing;
 466
 467   /* Search paths for include files.  */
 468   struct file_name_list *quote_include;  /* First dir to search for "file" */
 469   struct file_name_list *bracket_include;/* First dir to search for <file> */
 470
 471   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 472      in the standard include file directories.  */
 473   char *include_prefix;
 474   int include_prefix_len;
 475
 476   char no_standard_includes;
 477   char no_standard_cplusplus_includes;
 478
 479 /* dump_only means inhibit output of the preprocessed text
 480              and instead output the definitions of all user-defined
 481              macros in a form suitable for use as input to cccp.
 482    dump_names means pass #define and the macro name through to output.
 483    dump_definitions means pass the whole definition (plus #define) through
 484 */
 485
 486   enum {dump_none = 0, dump_only, dump_names, dump_definitions}
 487      dump_macros;
 488
 489 /* Nonzero means pass all #define and #undef directives which we actually
 490    process through to the output stream.  This feature is used primarily
 491    to allow cc1 to record the #defines and #undefs for the sake of
 492    debuggers which understand about preprocessor macros, but it may
 493    also be useful with -E to figure out how symbols are defined, and
 494    where they are defined.  */
 495   int debug_output;
 496
 497   /* Nonzero means pass #include lines through to the output,
 498      even if they are ifdefed out.  */
 499   int dump_includes;
 500
 501   /* Pending options - -D, -U, -A, -I, -ixxx. */
 502   struct cpp_pending *pending;
 503
 504   /* File name which deps are being written to.
 505      This is 0 if deps are being written to stdout.  */
 506   char *deps_file;
 507
 508   /* Target-name to write with the dependency information.  */
 509   char *deps_target;
 510 };
 511
 512 #define CPP_TRADITIONAL(PFILE) (CPP_OPTIONS(PFILE)-> traditional)
 513 #define CPP_WARN_UNDEF(PFILE) (CPP_OPTIONS(PFILE)->warn_undef)
 514 #define CPP_C89(PFILE) (CPP_OPTIONS(PFILE)->c89)
 515 #define CPP_PEDANTIC(PFILE) (CPP_OPTIONS (PFILE)->pedantic)
 516 #define CPP_PREPROCESSED(PFILE) (CPP_OPTIONS (PFILE)->preprocessed)
 517 #define CPP_PRINT_DEPS(PFILE) (CPP_OPTIONS (PFILE)->print_deps)
 518
 519 /* List of directories to look for include files in. */
 520 struct file_name_list
 521 {
 522   struct file_name_list *next;
 523   struct file_name_list *alloc; /* for the cache of
 524                                    current directory entries */
 525   char *name;
 526   unsigned int nlen;
 527   /* We use these to tell if the directory mentioned here is a duplicate
 528      of an earlier directory on the search path. */
 529   ino_t ino;
 530   dev_t dev;
 531   /* If the following is nonzero, it is a C-language system include
 532      directory.  */
 533   int sysp;
 534   /* Mapping of file names for this directory.
 535      Only used on MS-DOS and related platforms. */
 536   struct file_name_map *name_map;
 537 };
 538 #define ABSOLUTE_PATH ((struct file_name_list *)-1)
 539
 540 /* This structure is used for the table of all includes.  It is
 541    indexed by the `short name' (the name as it appeared in the
 542    #include statement) which is stored in *nshort.  */
 543 struct include_hash
 544 {
 545   struct include_hash *next;
 546   /* Next file with the same short name but a
 547      different (partial) pathname). */
 548   struct include_hash *next_this_file;
 549
 550   /* Location of the file in the include search path.
 551      Used for include_next */
 552   struct file_name_list *foundhere;
 553   const char *name;             /* (partial) pathname of file */
 554   const char *nshort;           /* name of file as referenced in #include */
 555   const char *control_macro;    /* macro, if any, preventing reinclusion -
 556                                    see redundant_include_p */
 557   char *buf, *limit;            /* for file content cache,
 558                                    not yet implemented */
 559 };
 560
 561 /* Name under which this program was invoked.  */
 562
 563 extern const char *progname;
 564
 565 /* The structure of a node in the hash table.  The hash table
 566    has entries for all tokens defined by #define commands (type T_MACRO),
 567    plus some special tokens like __LINE__ (these each have their own
 568    type, and the appropriate code is run when that type of node is seen.
 569    It does not contain control words like "#define", which are recognized
 570    by a separate piece of code. */
 571
 572 /* different flavors of hash nodes --- also used in keyword table */
 573 enum node_type {
 574  T_DEFINE = 1,  /* the `#define' keyword */
 575  T_INCLUDE,     /* the `#include' keyword */
 576  T_INCLUDE_NEXT, /* the `#include_next' keyword */
 577  T_IMPORT,      /* the `#import' keyword */
 578  T_IFDEF,       /* the `#ifdef' keyword */
 579  T_IFNDEF,      /* the `#ifndef' keyword */
 580  T_IF,          /* the `#if' keyword */
 581  T_ELSE,        /* `#else' */
 582  T_PRAGMA,      /* `#pragma' */
 583  T_ELIF,        /* `#elif' */
 584  T_UNDEF,       /* `#undef' */
 585  T_LINE,        /* `#line' */
 586  T_ERROR,       /* `#error' */
 587  T_WARNING,     /* `#warning' */
 588  T_ENDIF,       /* `#endif' */
 589  T_SCCS,        /* `#sccs', used on system V.  */
 590  T_IDENT,       /* `#ident', used on system V.  */
 591  T_ASSERT,      /* `#assert', taken from system V.  */
 592  T_UNASSERT,    /* `#unassert', taken from system V.  */
 593  T_SPECLINE,    /* special symbol `__LINE__' */
 594  T_DATE,        /* `__DATE__' */
 595  T_FILE,        /* `__FILE__' */
 596  T_BASE_FILE,   /* `__BASE_FILE__' */
 597  T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
 598  T_VERSION,     /* `__VERSION__' */
 599  T_TIME,        /* `__TIME__' */
 600  T_STDC,        /* `__STDC__' */
 601  T_CONST,       /* Constant string, used by `__SIZE_TYPE__' etc */
 602  T_MACRO,       /* macro defined by `#define' */
 603  T_DISABLED,    /* macro temporarily turned off for rescan */
 604  T_PCSTRING,    /* precompiled string (hashval is KEYDEF *) */
 605  T_POISON,      /* defined with `#pragma poison' */
 606  T_UNUSED       /* Used for something not defined.  */
 607  };
 608
 609 /* Structure returned by create_definition */
 610 typedef struct macrodef MACRODEF;
 611 struct macrodef
 612 {
 613   struct definition *defn;
 614   const U_CHAR *symnam;
 615   int symlen;
 616 };
 617
 618 /* Structure allocated for every #define.  For a simple replacement
 619    such as
 620         #define foo bar ,
 621    nargs = -1, the `pattern' list is null, and the expansion is just
 622    the replacement text.  Nargs = 0 means a functionlike macro with no args,
 623    e.g.,
 624        #define getchar() getc (stdin) .
 625    When there are args, the expansion is the replacement text with the
 626    args squashed out, and the reflist is a list describing how to
 627    build the output from the input: e.g., "3 chars, then the 1st arg,
 628    then 9 chars, then the 3rd arg, then 0 chars, then the 2nd arg".
 629    The chars here come from the expansion.  Whatever is left of the
 630    expansion after the last arg-occurrence is copied after that arg.
 631    Note that the reflist can be arbitrarily long---
 632    its length depends on the number of times the arguments appear in
 633    the replacement text, not how many args there are.  Example:
 634    #define f(x) x+x+x+x+x+x+x would have replacement text "++++++" and
 635    pattern list
 636      { (0, 1), (1, 1), (1, 1), ..., (1, 1), NULL }
 637    where (x, y) means (nchars, argno). */
 638
 639 typedef struct definition DEFINITION;
 640 struct definition {
 641   int nargs;
 642   int length;                   /* length of expansion string */
 643   int predefined;               /* True if the macro was builtin or */
 644                                 /* came from the command line */
 645   unsigned char *expansion;
 646   int line;                     /* Line number of definition */
 647   const char *file;             /* File of definition */
 648   char rest_args;               /* Nonzero if last arg. absorbs the rest */
 649   struct reflist {
 650     struct reflist *next;
 651     char stringify;             /* nonzero if this arg was preceded by a
 652                                    # operator. */
 653     char raw_before;            /* Nonzero if a ## operator before arg. */
 654     char raw_after;             /* Nonzero if a ## operator after arg. */
 655     char rest_args;             /* Nonzero if this arg. absorbs the rest */
 656     int nchars;                 /* Number of literal chars to copy before
 657                                    this arg occurrence.  */
 658     int argno;                  /* Number of arg to substitute (origin-0) */
 659   } *pattern;
 660   union {
 661     /* Names of macro args, concatenated in reverse order
 662        with comma-space between them.
 663        The only use of this is that we warn on redefinition
 664        if this differs between the old and new definitions.  */
 665     unsigned char *argnames;
 666   } args;
 667 };
 668
 669 /* Character classes.
 670    If the definition of `numchar' looks odd to you, please look up the
 671    definition of a pp-number in the C standard [section 6.4.8 of C99] */
 672 #define ISidnum         0x01    /* a-zA-Z0-9_ */
 673 #define ISidstart       0x02    /* _a-zA-Z */
 674 #define ISnumstart      0x04    /* 0-9 */
 675 #define IShspace        0x08    /* ' ' \t \f \v */
 676 #define ISspace         0x10    /* ' ' \t \f \v \n */
 677
 678 #define is_idchar(x)    (IStable[x] & ISidnum)
 679 #define is_numchar(x)   (IStable[x] & ISidnum)
 680 #define is_idstart(x)   (IStable[x] & ISidstart)
 681 #define is_numstart(x)  (IStable[x] & ISnumstart)
 682 #define is_hspace(x)    (IStable[x] & IShspace)
 683 #define is_space(x)     (IStable[x] & ISspace)
 684
 685 /* This table is not really `const', but it is only modified at
 686    initialization time, in a separate translation unit from the rest
 687    of the library.  We let the rest of the library think it is `const'
 688    to get better code and some additional compile-time checks.  */
 689 #ifndef FAKE_CONST
 690 #define FAKE_CONST const
 691 #endif
 692 extern FAKE_CONST unsigned char IStable[256];
 693 #undef FAKE_CONST
 694
 695 /* Stack of conditionals currently in progress
 696    (including both successful and failing conditionals).  */
 697
 698 struct if_stack {
 699   struct if_stack *next;        /* for chaining to the next stack frame */
 700   const char *fname;            /* copied from input when frame is made */
 701   int lineno;                   /* similarly */
 702   int if_succeeded;             /* true if a leg of this if-group
 703                                     has been passed through rescan */
 704   unsigned char *control_macro; /* For #ifndef at start of file,
 705                                    this is the macro name tested.  */
 706   enum node_type type;          /* type of last directive seen in this group */
 707 };
 708 typedef struct if_stack IF_STACK_FRAME;
 709
 710 extern void cpp_buf_line_and_col PARAMS((cpp_buffer *, long *, long *));
 711 extern cpp_buffer* cpp_file_buffer PARAMS((cpp_reader *));
 712 extern void cpp_define PARAMS ((cpp_reader *, unsigned char *));
 713 extern void cpp_assert PARAMS ((cpp_reader *, unsigned char *));
 714 extern void cpp_undef  PARAMS ((cpp_reader *, unsigned char *));
 715 extern void cpp_unassert PARAMS ((cpp_reader *, unsigned char *));
 716
 717 extern void cpp_error PVPROTO ((cpp_reader *, const char *, ...))
 718   ATTRIBUTE_PRINTF_2;
 719 extern void cpp_warning PVPROTO ((cpp_reader *, const char *, ...))
 720   ATTRIBUTE_PRINTF_2;
 721 extern void cpp_pedwarn PVPROTO ((cpp_reader *, const char *, ...))
 722   ATTRIBUTE_PRINTF_2;
 723 extern void cpp_error_with_line PVPROTO ((cpp_reader *, int, int, const char *, ...))
 724   ATTRIBUTE_PRINTF_4;
 725 extern void cpp_warning_with_line PVPROTO ((cpp_reader *, int, int, const char *, ...))
 726   ATTRIBUTE_PRINTF_4;
 727 extern void cpp_pedwarn_with_line PVPROTO ((cpp_reader *, int, int, const char *, ...))
 728   ATTRIBUTE_PRINTF_4;
 729 extern void cpp_pedwarn_with_file_and_line PVPROTO ((cpp_reader *, const char *, int, const char *, ...))
 730   ATTRIBUTE_PRINTF_4;
 731 extern void cpp_message_from_errno PROTO ((cpp_reader *, int, const char *));
 732 extern void cpp_error_from_errno PROTO ((cpp_reader *, const char *));
 733 extern void cpp_perror_with_name PROTO ((cpp_reader *, const char *));
 734 extern void v_cpp_message PROTO ((cpp_reader *, int, const char *, va_list));
 735
 736 extern void cpp_grow_buffer PARAMS ((cpp_reader *, long));
 737 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 738                                             unsigned char *, long));
 739 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 740
 741 extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *, const unsigned char *,
 742                                          int, int));
 743 extern void cpp_reader_init PARAMS ((cpp_reader *));
 744 extern void cpp_options_init PARAMS ((cpp_options *));
 745 extern int cpp_start_read PARAMS ((cpp_reader *, char *));
 746 extern int cpp_read_check_assertion PARAMS ((cpp_reader *));
 747 extern int scan_decls PARAMS ((cpp_reader *, int, char **));
 748 extern void skip_rest_of_line PARAMS ((cpp_reader *));
 749 extern void cpp_finish PARAMS ((cpp_reader *));
 750
 751 extern void quote_string                PARAMS ((cpp_reader *, const char *));
 752 extern void cpp_expand_to_buffer        PARAMS ((cpp_reader *, const U_CHAR *,
 753                                                  int));
 754 extern void cpp_scan_buffer             PARAMS ((cpp_reader *));
 755 extern int check_macro_name             PARAMS ((cpp_reader *, const U_CHAR *));
 756
 757 /* Last arg to output_line_command.  */
 758 enum file_change_code {same_file, enter_file, leave_file};
 759 extern void output_line_command         PARAMS ((cpp_reader *,
 760                                                  enum file_change_code));
 761
 762 /* From cpperror.c */
 763 extern void cpp_fatal PVPROTO ((cpp_reader *, const char *, ...))
 764   ATTRIBUTE_PRINTF_2;
 765 extern void cpp_message PVPROTO ((cpp_reader *, int, const char *, ...))
 766   ATTRIBUTE_PRINTF_3;
 767 extern void cpp_pfatal_with_name PROTO ((cpp_reader *, const char *))
 768   ATTRIBUTE_NORETURN;
 769 extern void cpp_file_line_for_message PROTO ((cpp_reader *, const char *,
 770                                               int, int));
 771 extern void cpp_print_containing_files PROTO ((cpp_reader *));
 772 extern void cpp_notice PVPROTO ((const char *msgid, ...)) ATTRIBUTE_PRINTF_1;
 773
 774 /* In cppfiles.c */
 775 extern void simplify_pathname           PROTO ((char *));
 776 extern void merge_include_chains        PROTO ((struct cpp_options *));
 777 extern int find_include_file            PROTO ((cpp_reader *, const char *,
 778                                                 struct file_name_list *,
 779                                                 struct include_hash **,
 780                                                 int *));
 781 extern int finclude                     PROTO ((cpp_reader *, int,
 782                                                 struct include_hash *));
 783 extern void deps_output                 PROTO ((cpp_reader *,
 784                                                 const char *, int));
 785 extern struct include_hash *include_hash PROTO ((cpp_reader *, const char *, int));
 786
 787 #ifndef INCLUDE_LEN_FUDGE
 788 #define INCLUDE_LEN_FUDGE 0
 789 #endif
 790
 791
 792 #ifdef __cplusplus
 793 }
 794 #endif
 795 #endif /* __GCC_CPPLIB__ */
 796