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