gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 96-98, 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 /* A parse_marker indicates a previous position,
  76    which we can backtrack to. */
  77
  78 struct parse_marker {
  79   cpp_buffer *buf;
  80   struct parse_marker *next;
  81   int position;
  82 };
  83
  84 extern void parse_set_mark PARAMS ((struct parse_marker *, cpp_reader *));
  85 extern void parse_clear_mark PARAMS ((struct parse_marker *));
  86 extern void parse_goto_mark PARAMS((struct parse_marker *, cpp_reader *));
  87 extern void parse_move_mark PARAMS((struct parse_marker *, cpp_reader *));
  88
  89 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
  90 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
  91 extern enum cpp_token cpp_get_token PARAMS ((cpp_reader *));
  92 extern void cpp_skip_hspace PARAMS((cpp_reader *));
  93 extern enum cpp_token cpp_get_non_space_token PARAMS ((cpp_reader *));
  94
  95 /* This frees resources used by PFILE. */
  96 extern void cpp_cleanup PARAMS ((cpp_reader *PFILE));
  97
  98 /* If we have a huge buffer, may need to cache more recent counts */
  99 #define CPP_LINE_BASE(BUF) ((BUF)->buf + (BUF)->line_base)
 100
 101 struct cpp_buffer {
 102   unsigned char *buf;
 103   unsigned char *cur;
 104   unsigned char *rlimit; /* end of valid data */
 105   unsigned char *alimit; /* end of allocated buffer */
 106   unsigned char *prev;  /* start of current token */
 107
 108   char *fname;
 109   /* Filename specified with #line command.  */
 110   char *nominal_fname;
 111   /* Actual directory of this file, used only for "" includes */
 112   struct file_name_list *actual_dir;
 113
 114   /* Pointer into the include hash table.  Used for include_next and
 115      to record control macros.
 116      ->fname is an alias to ->ihash->fname. */
 117   struct include_hash *ihash;
 118
 119   long line_base;
 120   long lineno; /* Line number at CPP_LINE_BASE. */
 121   long colno; /* Column number at CPP_LINE_BASE. */
 122   parse_underflow_t underflow;
 123   parse_cleanup_t cleanup;
 124   void *data;
 125   struct parse_marker *marks;
 126   /* Value of if_stack at start of this file.
 127      Used to prohibit unmatched #endif (etc) in an include file.  */
 128   struct if_stack *if_stack;
 129
 130   /* True if this is a header file included using <FILENAME>.  */
 131   char system_header_p;
 132   char seen_eof;
 133
 134   /* True if buffer contains escape sequences.
 135      Currently there are three kinds:
 136      "@-" means following identifier should not be macro-expanded.
 137      "@ " means a token-separator.  This turns into " " in final output
 138           if not stringizing and needed to separate tokens; otherwise nothing.
 139      "@@" means a normal '@'.
 140      (An '@' inside a string stands for itself and is never an escape.) */
 141   char has_escapes;
 142 };
 143
 144 struct cpp_pending;  /* Forward declaration - for C++. */
 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   /* Hash table of other included files.  See cppfiles.c */
 178 #define ALL_INCLUDE_HASHSIZE 71
 179   struct include_hash *all_include_files[ALL_INCLUDE_HASHSIZE];
 180
 181   /* Chain of `actual directory' file_name_list entries,
 182      for "" inclusion. */
 183   struct file_name_list *actual_dirs;
 184
 185   /* Current maximum length of directory names in the search path
 186      for include files.  (Altered as we get more of them.)  */
 187   unsigned int max_include_len;
 188
 189   struct if_stack *if_stack;
 190
 191   /* Nonzero means we are inside an IF during a -pcp run.  In this mode
 192      macro expansion is done, and preconditions are output for all macro
 193      uses requiring them. */
 194   char pcp_inside_if;
 195
 196   /* Nonzero means we have printed (while error reporting) a list of
 197      containing files that matches the current status. */
 198   char input_stack_listing_current;
 199
 200   /* If non-zero, macros are not expanded. */
 201   char no_macro_expand;
 202
 203   /* Print column number in error messages. */
 204   char show_column;
 205
 206   /* We're printed a warning recommending against using #import. */
 207   char import_warning;
 208
 209   /* If true, character between '<' and '>' are a single (string) token. */
 210   char parsing_include_directive;
 211
 212   /* True if escape sequences (as described for has_escapes in
 213      parse_buffer) should be emitted. */
 214   char output_escapes;
 215
 216   /* 0: Have seen non-white-space on this line.
 217      1: Only seen white space so far on this line.
 218      2: Only seen white space so far in this file. */
 219    char only_seen_white;
 220
 221   /* Nonzero means this file was included with a -imacros or -include
 222      command line and should not be recorded as an include file.  */
 223
 224   int no_record_file;
 225
 226   long lineno;
 227
 228   struct tm *timebuf;
 229
 230   /* Buffer of -M output.  */
 231   char *deps_buffer;
 232
 233   /* Number of bytes allocated in above.  */
 234   int deps_allocated_size;
 235
 236   /* Number of bytes used.  */
 237   int deps_size;
 238
 239   /* Number of bytes since the last newline.  */
 240   int deps_column;
 241
 242 #ifdef __cplusplus
 243   ~cpp_reader () { cpp_cleanup (this); }
 244 #endif
 245
 246   cpp_buffer buffer_stack[CPP_STACK_MAX];
 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   (bcopy (STR, (PFILE)->limit, (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 #define CPP_OPTIONS(PFILE) ((PFILE)->opts)
 289
 290 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 291 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)+1)
 292 /* The bottom of the buffer stack. */
 293 #define CPP_NULL_BUFFER(PFILE) (&(PFILE)->buffer_stack[CPP_STACK_MAX])
 294
 295 /* Pointed to by cpp_reader.opts. */
 296 struct cpp_options {
 297   char *in_fname;
 298
 299   /* Name of output file, for error messages.  */
 300   char *out_fname;
 301
 302   struct file_name_map_list *map_list;
 303
 304   /* Non-0 means -v, so print the full set of include dirs.  */
 305   char verbose;
 306
 307   /* Nonzero means use extra default include directories for C++.  */
 308
 309   char cplusplus;
 310
 311   /* Nonzero means handle cplusplus style comments */
 312
 313   char cplusplus_comments;
 314
 315   /* Nonzero means handle #import, for objective C.  */
 316
 317   char objc;
 318
 319   /* Nonzero means this is an assembly file, and allow
 320      unknown directives, which could be comments.  */
 321
 322   int lang_asm;
 323
 324   /* Nonzero means turn NOTREACHED into #pragma NOTREACHED etc */
 325
 326   char for_lint;
 327
 328   /* Nonzero means handle CHILL comment syntax
 329      and output CHILL string delimiter for __DATE___ etc. */
 330
 331   char chill;
 332
 333   /* Nonzero means copy comments into the output file.  */
 334
 335   char put_out_comments;
 336
 337   /* Nonzero means don't process the ANSI trigraph sequences.  */
 338
 339   char no_trigraphs;
 340
 341   /* Nonzero means print the names of included files rather than
 342      the preprocessed output.  1 means just the #include "...",
 343      2 means #include <...> as well.  */
 344
 345   char print_deps;
 346
 347   /* Nonzero if missing .h files in -M output are assumed to be generated
 348      files and not errors.  */
 349
 350   char print_deps_missing_files;
 351
 352   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 353   char print_deps_append;
 354
 355   /* Nonzero means print names of header files (-H).  */
 356
 357   char print_include_names;
 358
 359   /* Nonzero means try to make failure to fit ANSI C an error.  */
 360
 361   char pedantic_errors;
 362
 363   /* Nonzero means don't print warning messages.  -w.  */
 364
 365   char inhibit_warnings;
 366
 367   /* Nonzero means warn if slash-star appears in a comment.  */
 368
 369   char warn_comments;
 370
 371   /* Nonzero means warn if there are any trigraphs.  */
 372
 373   char warn_trigraphs;
 374
 375   /* Nonzero means warn if #import is used.  */
 376
 377   char warn_import;
 378
 379   /* Nonzero means warn if a macro argument is (or would be)
 380      stringified with -traditional.  */
 381
 382   char warn_stringify;
 383
 384   /* Nonzero means turn warnings into errors.  */
 385
 386   char warnings_are_errors;
 387
 388   /* Nonzero causes output not to be done,
 389      but directives such as #define that have side effects
 390      are still obeyed.  */
 391
 392   char no_output;
 393
 394   /* Nonzero means we should look for header.gcc files that remap file
 395      names.  */
 396   char remap;
 397
 398   /* Nonzero means don't output line number information.  */
 399
 400   char no_line_commands;
 401
 402 /* Nonzero means output the text in failing conditionals,
 403    inside #failed ... #endfailed.  */
 404
 405   char output_conditionals;
 406
 407   /* Nonzero means -I- has been seen,
 408      so don't look for #include "foo" the source-file directory.  */
 409   char ignore_srcdir;
 410
 411   /* Zero means dollar signs are punctuation.
 412      This used to be needed for conformance to the C Standard,
 413      before the C Standard was corrected.  */
 414   char dollars_in_ident;
 415
 416   /* Nonzero means try to imitate old fashioned non-ANSI preprocessor.  */
 417   char traditional;
 418
 419   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 420   char warn_undef;
 421
 422   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 423   char c89;
 424
 425   /* Nonzero means give all the error messages the ANSI standard requires.  */
 426   char pedantic;
 427
 428   char done_initializing;
 429
 430   /* Search paths for include files.  system_include, after_include are
 431      only used during option parsing. */
 432   struct file_name_list *quote_include;  /* First dir to search for "file" */
 433   struct file_name_list *bracket_include;/* First dir to search for <file> */
 434   struct file_name_list *system_include; /* First dir with system headers  */
 435   struct file_name_list *after_include;  /* Headers to search after system */
 436
 437   /* Directory prefix that should replace `/usr' in the standard
 438      include file directories.  */
 439   char *include_prefix;
 440
 441   char inhibit_predefs;
 442   char no_standard_includes;
 443   char no_standard_cplusplus_includes;
 444
 445 /* dump_only means inhibit output of the preprocessed text
 446              and instead output the definitions of all user-defined
 447              macros in a form suitable for use as input to cccp.
 448    dump_names means pass #define and the macro name through to output.
 449    dump_definitions means pass the whole definition (plus #define) through
 450 */
 451
 452   enum {dump_none = 0, dump_only, dump_names, dump_definitions}
 453      dump_macros;
 454
 455 /* Nonzero means pass all #define and #undef directives which we actually
 456    process through to the output stream.  This feature is used primarily
 457    to allow cc1 to record the #defines and #undefs for the sake of
 458    debuggers which understand about preprocessor macros, but it may
 459    also be useful with -E to figure out how symbols are defined, and
 460    where they are defined.  */
 461   int debug_output;
 462
 463   /* Nonzero means pass #include lines through to the output,
 464      even if they are ifdefed out.  */
 465   int dump_includes;
 466
 467   /* Pending -D, -U and -A options, in reverse order. */
 468   struct cpp_pending *pending;
 469
 470   /* File name which deps are being written to.
 471      This is 0 if deps are being written to stdout.  */
 472   char *deps_file;
 473
 474   /* Target-name to write with the dependency information.  */
 475   char *deps_target;
 476 };
 477
 478 #define CPP_TRADITIONAL(PFILE) (CPP_OPTIONS(PFILE)-> traditional)
 479 #define CPP_WARN_UNDEF(PFILE) (CPP_OPTIONS(PFILE)->warn_undef)
 480 #define CPP_C89(PFILE) (CPP_OPTIONS(PFILE)->c89)
 481 #define CPP_PEDANTIC(PFILE) (CPP_OPTIONS (PFILE)->pedantic)
 482 #define CPP_PRINT_DEPS(PFILE) (CPP_OPTIONS (PFILE)->print_deps)
 483
 484 /* List of directories to look for include files in. */
 485 struct file_name_list
 486 {
 487   struct file_name_list *next;
 488   struct file_name_list *alloc; /* for the cache of
 489                                    current directory entries */
 490   char *name;
 491   unsigned int nlen;
 492   /* We use these to tell if the directory mentioned here is a duplicate
 493      of an earlier directory on the search path. */
 494   ino_t ino;
 495   dev_t dev;
 496   /* If the following is nonzero, it is a C-language system include
 497      directory.  */
 498   int sysp;
 499   /* Mapping of file names for this directory.
 500      Only used on MS-DOS and related platforms. */
 501   struct file_name_map *name_map;
 502 };
 503 #define ABSOLUTE_PATH ((struct file_name_list *)-1)
 504
 505 /* This structure is used for the table of all includes.  It is
 506    indexed by the `short name' (the name as it appeared in the
 507    #include statement) which is stored in *nshort.  */
 508 struct include_hash
 509 {
 510   struct include_hash *next;
 511   /* Next file with the same short name but a
 512      different (partial) pathname). */
 513   struct include_hash *next_this_file;
 514
 515   /* Location of the file in the include search path.
 516      Used for include_next */
 517   struct file_name_list *foundhere;
 518   char *name;           /* (partial) pathname of file */
 519   char *nshort;         /* name of file as referenced in #include */
 520   char *control_macro;  /* macro, if any, preventing reinclusion - see
 521                            redundant_include_p */
 522   char *buf, *limit;    /* for file content cache, not yet implemented */
 523 };
 524
 525 /* If a buffer's dir field is SELF_DIR_DUMMY, it means the file was found
 526    via the same directory as the file that #included it.  */
 527 #define SELF_DIR_DUMMY ((struct file_name_list *) (~0))
 528
 529
 530 /* Name under which this program was invoked.  */
 531
 532 extern char *progname;
 533
 534 /* The structure of a node in the hash table.  The hash table
 535    has entries for all tokens defined by #define commands (type T_MACRO),
 536    plus some special tokens like __LINE__ (these each have their own
 537    type, and the appropriate code is run when that type of node is seen.
 538    It does not contain control words like "#define", which are recognized
 539    by a separate piece of code. */
 540
 541 /* different flavors of hash nodes --- also used in keyword table */
 542 enum node_type {
 543  T_DEFINE = 1,  /* the `#define' keyword */
 544  T_INCLUDE,     /* the `#include' keyword */
 545  T_INCLUDE_NEXT, /* the `#include_next' keyword */
 546  T_IMPORT,      /* the `#import' keyword */
 547  T_IFDEF,       /* the `#ifdef' keyword */
 548  T_IFNDEF,      /* the `#ifndef' keyword */
 549  T_IF,          /* the `#if' keyword */
 550  T_ELSE,        /* `#else' */
 551  T_PRAGMA,      /* `#pragma' */
 552  T_ELIF,        /* `#elif' */
 553  T_UNDEF,       /* `#undef' */
 554  T_LINE,        /* `#line' */
 555  T_ERROR,       /* `#error' */
 556  T_WARNING,     /* `#warning' */
 557  T_ENDIF,       /* `#endif' */
 558  T_SCCS,        /* `#sccs', used on system V.  */
 559  T_IDENT,       /* `#ident', used on system V.  */
 560  T_ASSERT,      /* `#assert', taken from system V.  */
 561  T_UNASSERT,    /* `#unassert', taken from system V.  */
 562  T_SPECLINE,    /* special symbol `__LINE__' */
 563  T_DATE,        /* `__DATE__' */
 564  T_FILE,        /* `__FILE__' */
 565  T_BASE_FILE,   /* `__BASE_FILE__' */
 566  T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
 567  T_VERSION,     /* `__VERSION__' */
 568  T_SIZE_TYPE,   /* `__SIZE_TYPE__' */
 569  T_PTRDIFF_TYPE,   /* `__PTRDIFF_TYPE__' */
 570  T_WCHAR_TYPE,   /* `__WCHAR_TYPE__' */
 571  T_USER_LABEL_PREFIX_TYPE, /* `__USER_LABEL_PREFIX__' */
 572  T_REGISTER_PREFIX_TYPE,   /* `__REGISTER_PREFIX__' */
 573  T_TIME,        /* `__TIME__' */
 574  T_CONST,       /* Constant value, used by `__STDC__' */
 575  T_MACRO,       /* macro defined by `#define' */
 576  T_DISABLED,    /* macro temporarily turned off for rescan */
 577  T_SPEC_DEFINED, /* special `defined' macro for use in #if statements */
 578  T_PCSTRING,    /* precompiled string (hashval is KEYDEF *) */
 579  T_UNUSED       /* Used for something not defined.  */
 580  };
 581
 582 /* Structure returned by create_definition */
 583 typedef struct macrodef MACRODEF;
 584 struct macrodef
 585 {
 586   struct definition *defn;
 587   unsigned char *symnam;
 588   int symlen;
 589 };
 590
 591 /* Structure allocated for every #define.  For a simple replacement
 592    such as
 593         #define foo bar ,
 594    nargs = -1, the `pattern' list is null, and the expansion is just
 595    the replacement text.  Nargs = 0 means a functionlike macro with no args,
 596    e.g.,
 597        #define getchar() getc (stdin) .
 598    When there are args, the expansion is the replacement text with the
 599    args squashed out, and the reflist is a list describing how to
 600    build the output from the input: e.g., "3 chars, then the 1st arg,
 601    then 9 chars, then the 3rd arg, then 0 chars, then the 2nd arg".
 602    The chars here come from the expansion.  Whatever is left of the
 603    expansion after the last arg-occurrence is copied after that arg.
 604    Note that the reflist can be arbitrarily long---
 605    its length depends on the number of times the arguments appear in
 606    the replacement text, not how many args there are.  Example:
 607    #define f(x) x+x+x+x+x+x+x would have replacement text "++++++" and
 608    pattern list
 609      { (0, 1), (1, 1), (1, 1), ..., (1, 1), NULL }
 610    where (x, y) means (nchars, argno). */
 611
 612 typedef struct definition DEFINITION;
 613 struct definition {
 614   int nargs;
 615   int length;                   /* length of expansion string */
 616   int predefined;               /* True if the macro was builtin or */
 617                                 /* came from the command line */
 618   unsigned char *expansion;
 619   int line;                     /* Line number of definition */
 620   char *file;                   /* File of definition */
 621   char rest_args;               /* Nonzero if last arg. absorbs the rest */
 622   struct reflist {
 623     struct reflist *next;
 624     char stringify;             /* nonzero if this arg was preceded by a
 625                                    # operator. */
 626     char raw_before;            /* Nonzero if a ## operator before arg. */
 627     char raw_after;             /* Nonzero if a ## operator after arg. */
 628     char rest_args;             /* Nonzero if this arg. absorbs the rest */
 629     int nchars;                 /* Number of literal chars to copy before
 630                                    this arg occurrence.  */
 631     int argno;                  /* Number of arg to substitute (origin-0) */
 632   } *pattern;
 633   union {
 634     /* Names of macro args, concatenated in reverse order
 635        with comma-space between them.
 636        The only use of this is that we warn on redefinition
 637        if this differs between the old and new definitions.  */
 638     unsigned char *argnames;
 639   } args;
 640 };
 641
 642 extern unsigned char is_idchar[256];
 643 extern unsigned char is_hor_space[256];
 644 extern unsigned char is_space[256];
 645
 646 /* Stack of conditionals currently in progress
 647    (including both successful and failing conditionals).  */
 648
 649 struct if_stack {
 650   struct if_stack *next;        /* for chaining to the next stack frame */
 651   char *fname;          /* copied from input when frame is made */
 652   int lineno;                   /* similarly */
 653   int if_succeeded;             /* true if a leg of this if-group
 654                                     has been passed through rescan */
 655   unsigned char *control_macro; /* For #ifndef at start of file,
 656                                    this is the macro name tested.  */
 657   enum node_type type;          /* type of last directive seen in this group */
 658 };
 659 typedef struct if_stack IF_STACK_FRAME;
 660
 661 /* Find the largest host integer type and set its size and type.
 662    Watch out: on some crazy hosts `long' is shorter than `int'.  */
 663
 664 #ifndef HOST_WIDE_INT
 665 #include "machmode.h"
 666 #endif
 667
 668 extern void cpp_buf_line_and_col PARAMS((cpp_buffer *, long *, long *));
 669 extern cpp_buffer* cpp_file_buffer PARAMS((cpp_reader *));
 670 extern void cpp_define PARAMS ((cpp_reader*, unsigned char *));
 671
 672 extern void cpp_error PVPROTO ((cpp_reader *, const char *, ...))
 673   ATTRIBUTE_PRINTF_2;
 674 extern void cpp_warning PVPROTO ((cpp_reader *, const char *, ...))
 675   ATTRIBUTE_PRINTF_2;
 676 extern void cpp_pedwarn PVPROTO ((cpp_reader *, const char *, ...))
 677   ATTRIBUTE_PRINTF_2;
 678 extern void cpp_error_with_line PVPROTO ((cpp_reader *, int, int, const char *, ...))
 679   ATTRIBUTE_PRINTF_4;
 680 extern void cpp_pedwarn_with_line PVPROTO ((cpp_reader *, int, int, const char *, ...))
 681   ATTRIBUTE_PRINTF_4;
 682 extern void cpp_pedwarn_with_file_and_line PVPROTO ((cpp_reader *, char *, int, const char *, ...))
 683   ATTRIBUTE_PRINTF_4;
 684 extern void cpp_message_from_errno PROTO ((cpp_reader *, int, const char *));
 685 extern void cpp_error_from_errno PROTO ((cpp_reader *, const char *));
 686 extern void cpp_perror_with_name PROTO ((cpp_reader *, const char *));
 687 extern void v_cpp_message PROTO ((cpp_reader *, int, const char *, va_list));
 688
 689 extern void cpp_grow_buffer PARAMS ((cpp_reader *, long));
 690 extern HOST_WIDE_INT cpp_parse_escape PARAMS ((cpp_reader *, char **, HOST_WIDE_INT));
 691 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 692                                             unsigned char *, long));
 693 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 694
 695 extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *, const unsigned char *,
 696                                          int, int));
 697 extern void cpp_reader_init PARAMS ((cpp_reader *));
 698 extern void cpp_options_init PARAMS ((cpp_options *));
 699 extern int cpp_start_read PARAMS ((cpp_reader *, char *));
 700 extern int cpp_read_check_assertion PARAMS ((cpp_reader *));
 701 extern int scan_decls PARAMS ((cpp_reader *, int, char **));
 702 extern void skip_rest_of_line PARAMS ((cpp_reader *));
 703 extern void cpp_finish PARAMS ((cpp_reader *));
 704
 705 /* From cpperror.c */
 706 extern void cpp_fatal PVPROTO ((cpp_reader *, const char *, ...))
 707   ATTRIBUTE_PRINTF_2;
 708 extern void cpp_message PVPROTO ((cpp_reader *, int, const char *, ...))
 709   ATTRIBUTE_PRINTF_3;
 710 extern void cpp_pfatal_with_name PROTO ((cpp_reader *, const char *));
 711 extern void cpp_file_line_for_message PROTO ((cpp_reader *, char *, int, int));
 712 extern void cpp_print_containing_files PROTO ((cpp_reader *));
 713
 714 /* In cppfiles.c */
 715 extern void append_include_chain        PROTO ((cpp_reader *,
 716                                                 struct file_name_list **,
 717                                                 const char *, int));
 718 extern void merge_include_chains        PROTO ((struct cpp_options *));
 719 extern int find_include_file            PROTO ((cpp_reader *, char *,
 720                                                 struct file_name_list *,
 721                                                 struct include_hash **,
 722                                                 int *));
 723 extern int finclude                     PROTO ((cpp_reader *, int,
 724                                                 struct include_hash *));
 725 extern void deps_output                 PROTO ((cpp_reader *, char *, int));
 726 extern struct include_hash *include_hash PROTO ((cpp_reader *, char *, int));
 727
 728 #ifndef INCLUDE_LEN_FUDGE
 729 #define INCLUDE_LEN_FUDGE 0
 730 #endif
 731
 732
 733 #ifdef __cplusplus
 734 }
 735 #endif
 736 #endif /* __GCC_CPPLIB__ */
 737