1 /* Definitions for CPP library.
2 Copyright (C) 1995 Free Software Foundation, Inc.
3 Written by Per Bothner, 1994-95.
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
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.
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, 675 Mass Ave, Cambridge, MA 02139, USA.
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! */
23 #include <sys/types.h>
30 #define STATIC_BUFFERS
32 typedef unsigned char U_CHAR;
34 #ifndef FAILURE_EXIT_CODE
35 #define FAILURE_EXIT_CODE 33 /* gnu cc command understands this */
38 #ifndef SUCCESS_EXIT_CODE
39 #define SUCCESS_EXIT_CODE 0 /* 0 means success on Unix. */
43 typedef struct cpp_reader cpp_reader;
44 typedef struct cpp_buffer cpp_buffer;
45 typedef struct cpp_options cpp_options;
46 typedef struct hashnode cpp_hashnode;
53 CPP_VSPACE, /* newlines and #line directives */
64 CPP_SEMICOLON,/* ";" */
65 CPP_3DOTS, /* "..." */
67 CPP_ANDAND, /* "&&" */
76 CPP_MINMIN, /* "--" */
78 /* POP_TOKEN is returned when we've popped a cpp_buffer. */
90 typedef enum cpp_token (*parse_underflow_t) PARAMS((cpp_reader*));
91 typedef int (*parse_cleanup_t) PARAMS((cpp_buffer *, cpp_reader*));
93 /* A parse_marker indicates a previous position,
94 which we can backtrack to. */
98 struct parse_marker *next;
102 extern void parse_set_mark PARAMS ((struct parse_marker*, cpp_reader*));
103 extern void parse_clear_mark PARAMS ((struct parse_marker*));
104 extern void parse_goto_mark PARAMS((struct parse_marker*, cpp_reader*));
105 extern void parse_move_mark PARAMS((struct parse_marker*, cpp_reader*));
107 extern int cpp_handle_options PARAMS ((cpp_reader*, int, char**));
108 extern enum cpp_token cpp_get_token PARAMS ((struct parse_marker*));
109 extern void cpp_skip_hspace PARAMS((cpp_reader*));
110 extern enum cpp_token cpp_get_non_space_token PARAMS ((cpp_reader *));
113 /* Maintain and search list of included files, for #import. */
115 #define IMPORT_HASH_SIZE 31
121 struct import_file *next;
124 /* If we have a huge buffer, may need to cache more recent counts */
125 #define CPP_LINE_BASE(BUF) ((BUF)->buf + (BUF)->line_base)
130 unsigned char *rlimit; /* end of valid data */
131 unsigned char *alimit; /* end of allocated buffer */
132 unsigned char *prev; /* start of current token */
135 /* Filename specified with #line command. */
138 /* Record where in the search path this file was found.
139 For #include_next. */
140 struct file_name_list *dir;
143 long lineno; /* Line number at CPP_LINE_BASE. */
144 long colno; /* Column number at CPP_LINE_BASE. */
145 #ifndef STATIC_BUFFERS
148 parse_underflow_t underflow;
149 parse_cleanup_t cleanup;
151 struct parse_marker *marks;
152 /* Value of if_stack at start of this file.
153 Used to prohibit unmatched #endif (etc) in an include file. */
154 struct if_stack *if_stack;
156 /* True if this is a header file included using <FILENAME>. */
157 char system_header_p;
160 /* True if buffer contains escape sequences.
161 Currently there are are only two kind:
162 "@-" means following identifier should not be macro-expanded.
163 "@@" means a normal '@'. */
167 struct cpp_pending; /* Forward declaration - for C++. */
169 typedef struct assertion_hashnode ASSERTION_HASHNODE;
170 #define ASSERTION_HASHSIZE 37
172 #ifdef STATIC_BUFFERS
173 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
174 efficiency, and partly to limit runaway recursion. */
175 #define CPP_STACK_MAX 200
179 unsigned char *limit;
180 parse_underflow_t get_token;
182 #ifdef STATIC_BUFFERS
183 cpp_buffer buffer_stack[CPP_STACK_MAX];
186 int errors; /* Error counter for exit code */
187 /* While scanning a comment or a string constant,
188 this records the line it started on, for error messages. */
192 U_CHAR *token_buffer;
193 int token_buffer_size;
195 /* Current depth in #include directives that use <...>. */
196 int system_include_depth;
198 /* List of included files that contained #pragma once. */
199 struct file_name_list *dont_repeat_files;
201 /* List of other included files.
202 If ->control_macro if nonzero, the file had a #ifndef
203 around the entire contents, and ->control_macro gives the macro name. */
204 struct file_name_list *all_include_files;
206 /* Current maximum length of directory names in the search path
207 for include files. (Altered as we get more of them.) */
210 /* Hash table of files already included with #include or #import. */
211 struct import_file *import_hash_table[IMPORT_HASH_SIZE];
213 struct if_stack *if_stack;
215 /* Nonzero means we are inside an IF during a -pcp run. In this mode
216 macro expansion is done, and preconditions are output for all macro
217 uses requiring them. */
220 /* Nonzero means we have printed (while error reporting) a list of
221 containing files that matches the current status. */
222 char input_stack_listing_current;
224 /* If non-zero, macros are not expanded. */
225 char no_macro_expand;
227 /* Print column number in error messages. */
230 /* We're printed a warning recommending against using #import. */
233 /* If true, character between '<' and '>' are a single (string) token. */
234 char parsing_include_directive;
236 /* True if escape sequences (as described for has_escapes in
237 parse_buffer) should be emitted. */
240 /* 0: Have seen non-white-space on this line.
241 1: Only seen white space so far on this line.
242 2: Only seen white space so far in this file. */
243 char only_seen_white;
245 /* Nonzero means this file was included with a -imacros or -include
246 command line and should not be recorded as an include file. */
254 ASSERTION_HASHNODE *assertion_hashtab[ASSERTION_HASHSIZE];
256 /* Buffer of -M output. */
259 /* Number of bytes allocated in above. */
260 int deps_allocated_size;
262 /* Number of bytes used. */
265 /* Number of bytes since the last newline. */
269 #define CPP_BUF_PEEK(BUFFER) \
270 ((BUFFER)->cur < (BUFFER)->rlimit ? *(BUFFER)->cur : EOF)
271 #define CPP_BUF_GET(BUFFER) \
272 ((BUFFER)->cur < (BUFFER)->rlimit ? *(BUFFER)->cur++ : EOF)
273 #define CPP_FORWARD(BUFFER, N) ((BUFFER)->cur += (N))
275 /* Number of characters currently in PFILE's output buffer. */
276 #define CPP_WRITTEN(PFILE) ((PFILE)->limit - (PFILE)->token_buffer)
277 #define CPP_PWRITTEN(PFILE) ((PFILE)->limit)
279 /* Make sure PFILE->token_buffer has space for at least N more characters. */
280 #define CPP_RESERVE(PFILE, N) \
281 (CPP_WRITTEN (PFILE) + N > (PFILE)->token_buffer_size \
282 && (cpp_grow_buffer (PFILE, N), 0))
284 /* Append string STR (of length N) to PFILE's output buffer.
285 Assume there is enough space. */
286 #define CPP_PUTS_Q(PFILE, STR, N) \
287 (bcopy (STR, (PFILE)->limit, (N)), (PFILE)->limit += (N))
288 /* Append string STR (of length N) to PFILE's output buffer. Make space. */
289 #define CPP_PUTS(PFILE, STR, N) CPP_RESERVE(PFILE, N), CPP_PUTS_Q(PFILE, STR,N)
290 /* Append character CH to PFILE's output buffer. Assume sufficient space. */
291 #define CPP_PUTC_Q(PFILE, CH) (*(PFILE)->limit++ = (CH))
292 /* Append character CH to PFILE's output buffer. Make space if need be. */
293 #define CPP_PUTC(PFILE, CH) (CPP_RESERVE (PFILE, 1), CPP_PUTC_Q (PFILE, CH))
294 /* Make sure PFILE->limit is followed by '\0'. */
295 #define CPP_NUL_TERMINATE_Q(PFILE) (*(PFILE)->limit = 0)
296 #define CPP_NUL_TERMINATE(PFILE) (CPP_RESERVE(PFILE, 1), *(PFILE)->limit = 0)
297 #define CPP_ADJUST_WRITTEN(PFILE,DELTA) ((PFILE)->limit += (DELTA))
298 #define CPP_SET_WRITTEN(PFILE,N) ((PFILE)->limit = (PFILE)->token_buffer + (N))
300 #define CPP_OPTIONS(PFILE) ((cpp_options*)(PFILE)->data)
301 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
302 #ifdef STATIC_BUFFERS
303 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)+1)
304 #define CPP_NULL_BUFFER(PFILE) (&(PFILE)->buffer_stack[CPP_STACK_MAX])
306 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->chain)
307 #define CPP_NULL_BUFFER(PFILE) ((cpp_buffer*)0)
310 /* Pointed to by parse_file::data. */
314 /* Name of output file, for error messages. */
317 /* Non-0 means -v, so print the full set of include dirs. */
320 /* Nonzero means use extra default include directories for C++. */
324 /* Nonzero means handle cplusplus style comments */
326 char cplusplus_comments;
328 /* Nonzero means handle #import, for objective C. */
332 /* Nonzero means this is an assembly file, and allow
333 unknown directives, which could be comments. */
337 /* Nonzero means turn NOTREACHED into #pragma NOTREACHED etc */
341 /* Nonzero means handle CHILL comment syntax
342 and output CHILL string delimeter for __DATE___ etc. */
346 /* Nonzero means copy comments into the output file. */
348 char put_out_comments;
350 /* Nonzero means don't process the ANSI trigraph sequences. */
354 /* Nonzero means print the names of included files rather than
355 the preprocessed output. 1 means just the #include "...",
356 2 means #include <...> as well. */
360 /* Nonzero if missing .h files in -M output are assumed to be generated
361 files and not errors. */
363 char print_deps_missing_files;
365 /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
366 char print_deps_append;
368 /* Nonzero means print names of header files (-H). */
370 char print_include_names;
372 /* Nonzero means try to make failure to fit ANSI C an error. */
374 char pedantic_errors;
376 /* Nonzero means don't print warning messages. -w. */
378 char inhibit_warnings;
380 /* Nonzero means warn if slash-star appears in a comment. */
384 /* Nonzero means warn if there are any trigraphs. */
388 /* Nonzero means warn if #import is used. */
392 /* Nonzero means warn if a macro argument is (or would be)
393 stringified with -traditional. */
397 /* Nonzero means turn warnings into errors. */
399 char warnings_are_errors;
401 /* Nonzero causes output not to be done,
402 but directives such as #define that have side effects
407 /* Nonzero means don't output line number information. */
409 char no_line_commands;
411 /* Nonzero means output the text in failing conditionals,
412 inside #failed ... #endfailed. */
414 char output_conditionals;
416 /* Nonzero means -I- has been seen,
417 so don't look for #include "foo" the source-file directory. */
420 /* Zero means dollar signs are punctuation.
421 -$ stores 0; -traditional may store 1. Default is 1 for VMS, 0 otherwise.
422 This must be 0 for correct processing of this ANSI C program:
424 #define lose(b) foo (b)
427 char dollars_in_ident;
428 #ifndef DOLLARS_IN_IDENTIFIERS
429 #define DOLLARS_IN_IDENTIFIERS 1
432 /* Nonzero means try to imitate old fashioned non-ANSI preprocessor. */
435 /* Nonzero means give all the error messages the ANSI standard requires. */
438 char done_initializing;
440 struct file_name_list *include; /* First dir to search */
441 /* First dir to search for <file> */
442 /* This is the first element to use for #include <...>.
443 If it is 0, use the entire chain for such includes. */
444 struct file_name_list *first_bracket_include;
445 /* This is the first element in the chain that corresponds to
446 a directory of system header files. */
447 struct file_name_list *first_system_include;
448 struct file_name_list *last_include; /* Last in chain */
450 /* Chain of include directories to put at the end of the other chain. */
451 struct file_name_list *after_include;
452 struct file_name_list *last_after_include; /* Last in chain */
454 /* Chain to put at the start of the system include files. */
455 struct file_name_list *before_system;
456 struct file_name_list *last_before_system; /* Last in chain */
458 /* Directory prefix that should replace `/usr' in the standard
459 include file directories. */
460 char *include_prefix;
462 char inhibit_predefs;
463 char no_standard_includes;
464 char no_standard_cplusplus_includes;
466 /* dump_only means inhibit output of the preprocessed text
467 and instead output the definitions of all user-defined
468 macros in a form suitable for use as input to cccp.
469 dump_names means pass #define and the macro name through to output.
470 dump_definitions means pass the whole definition (plus #define) through
473 enum {dump_none = 0, dump_only, dump_names, dump_definitions}
476 /* Nonzero means pass all #define and #undef directives which we actually
477 process through to the output stream. This feature is used primarily
478 to allow cc1 to record the #defines and #undefs for the sake of
479 debuggers which understand about preprocessor macros, but it may
480 also be useful with -E to figure out how symbols are defined, and
481 where they are defined. */
484 /* Pending -D, -U and -A options, in reverse order. */
485 struct cpp_pending *pending;
487 /* File name which deps are being written to.
488 This is 0 if deps are being written to stdout. */
491 /* Target-name to write with the dependency information. */
495 #define CPP_TRADITIONAL(PFILE) (CPP_OPTIONS(PFILE)-> traditional)
496 #define CPP_PEDANTIC(PFILE) (CPP_OPTIONS (PFILE)->pedantic)
497 #define CPP_PRINT_DEPS(PFILE) (CPP_OPTIONS (PFILE)->print_deps)
499 #define PARSE_GETC(IN) ((IN)-> cur < (IN)->limit || ((IN)->cur = (IN)->token_buffer, (IN)->underflow (IN) != EOF_TOKEN) ? *(IN)->cur++ : EOF)
501 /* Name under which this program was invoked. */
503 extern char *progname;
505 /* The structure of a node in the hash table. The hash table
506 has entries for all tokens defined by #define commands (type T_MACRO),
507 plus some special tokens like __LINE__ (these each have their own
508 type, and the appropriate code is run when that type of node is seen.
509 It does not contain control words like "#define", which are recognized
510 by a separate piece of code. */
512 /* different flavors of hash nodes --- also used in keyword table */
514 T_DEFINE = 1, /* the `#define' keyword */
515 T_INCLUDE, /* the `#include' keyword */
516 T_INCLUDE_NEXT, /* the `#include_next' keyword */
517 T_IMPORT, /* the `#import' keyword */
518 T_IFDEF, /* the `#ifdef' keyword */
519 T_IFNDEF, /* the `#ifndef' keyword */
520 T_IF, /* the `#if' keyword */
521 T_ELSE, /* `#else' */
522 T_PRAGMA, /* `#pragma' */
523 T_ELIF, /* `#elif' */
524 T_UNDEF, /* `#undef' */
525 T_LINE, /* `#line' */
526 T_ERROR, /* `#error' */
527 T_WARNING, /* `#warning' */
528 T_ENDIF, /* `#endif' */
529 T_SCCS, /* `#sccs', used on system V. */
530 T_IDENT, /* `#ident', used on system V. */
531 T_ASSERT, /* `#assert', taken from system V. */
532 T_UNASSERT, /* `#unassert', taken from system V. */
533 T_SPECLINE, /* special symbol `__LINE__' */
534 T_DATE, /* `__DATE__' */
535 T_FILE, /* `__FILE__' */
536 T_BASE_FILE, /* `__BASE_FILE__' */
537 T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
538 T_VERSION, /* `__VERSION__' */
539 T_SIZE_TYPE, /* `__SIZE_TYPE__' */
540 T_PTRDIFF_TYPE, /* `__PTRDIFF_TYPE__' */
541 T_WCHAR_TYPE, /* `__WCHAR_TYPE__' */
542 T_USER_LABEL_PREFIX_TYPE, /* `__USER_LABEL_PREFIX__' */
543 T_REGISTER_PREFIX_TYPE, /* `__REGISTER_PREFIX__' */
544 T_TIME, /* `__TIME__' */
545 T_CONST, /* Constant value, used by `__STDC__' */
546 T_MACRO, /* macro defined by `#define' */
547 T_DISABLED, /* macro temporarily turned off for rescan */
548 T_SPEC_DEFINED, /* special `defined' macro for use in #if statements */
549 T_PCSTRING, /* precompiled string (hashval is KEYDEF *) */
550 T_UNUSED /* Used for something not defined. */
553 /* Structure returned by create_definition */
554 typedef struct macrodef MACRODEF;
557 struct definition *defn;
562 /* Structure allocated for every #define. For a simple replacement
565 nargs = -1, the `pattern' list is null, and the expansion is just
566 the replacement text. Nargs = 0 means a functionlike macro with no args,
568 #define getchar() getc (stdin) .
569 When there are args, the expansion is the replacement text with the
570 args squashed out, and the reflist is a list describing how to
571 build the output from the input: e.g., "3 chars, then the 1st arg,
572 then 9 chars, then the 3rd arg, then 0 chars, then the 2nd arg".
573 The chars here come from the expansion. Whatever is left of the
574 expansion after the last arg-occurrence is copied after that arg.
575 Note that the reflist can be arbitrarily long---
576 its length depends on the number of times the arguments appear in
577 the replacement text, not how many args there are. Example:
578 #define f(x) x+x+x+x+x+x+x would have replacement text "++++++" and
580 { (0, 1), (1, 1), (1, 1), ..., (1, 1), NULL }
581 where (x, y) means (nchars, argno). */
583 typedef struct definition DEFINITION;
586 int length; /* length of expansion string */
587 int predefined; /* True if the macro was builtin or */
588 /* came from the command line */
590 int line; /* Line number of definition */
591 char *file; /* File of definition */
592 char rest_args; /* Nonzero if last arg. absorbs the rest */
594 struct reflist *next;
595 char stringify; /* nonzero if this arg was preceded by a
597 char raw_before; /* Nonzero if a ## operator before arg. */
598 char raw_after; /* Nonzero if a ## operator after arg. */
599 char rest_args; /* Nonzero if this arg. absorbs the rest */
600 int nchars; /* Number of literal chars to copy before
601 this arg occurrence. */
602 int argno; /* Number of arg to substitute (origin-0) */
605 /* Names of macro args, concatenated in reverse order
606 with comma-space between them.
607 The only use of this is that we warn on redefinition
608 if this differs between the old and new definitions. */
613 extern U_CHAR is_idchar[256];
615 /* Stack of conditionals currently in progress
616 (including both successful and failing conditionals). */
619 struct if_stack *next; /* for chaining to the next stack frame */
620 char *fname; /* copied from input when frame is made */
621 int lineno; /* similarly */
622 int if_succeeded; /* true if a leg of this if-group
623 has been passed through rescan */
624 U_CHAR *control_macro; /* For #ifndef at start of file,
625 this is the macro name tested. */
626 enum node_type type; /* type of last directive seen in this group */
628 typedef struct if_stack IF_STACK_FRAME;
630 extern void cpp_buf_line_and_col PARAMS((cpp_buffer*, long*, long*));
631 extern cpp_buffer* cpp_file_buffer PARAMS((cpp_reader*));
633 extern void cpp_error ();
634 extern void cpp_warning ();
635 extern void cpp_pedwarn ();
636 extern void cpp_error_with_line ();
637 extern void cpp_warning_with_line ();
638 extern void cpp_pedwarn_with_line ();
639 extern void cpp_pedwarn_with_file_and_line ();
640 extern void fatal ();
641 extern void cpp_error_from_errno ();
642 extern void cpp_perror_with_name ();
643 extern void cpp_pfatal_with_name ();
645 extern void cpp_grow_buffer PARAMS ((cpp_reader*, long));
646 extern int cpp_parse_escape PARAMS ((cpp_reader*, char**));
647 extern cpp_buffer* cpp_push_buffer PARAMS ((cpp_reader *, U_CHAR*, long));
648 extern cpp_buffer* cpp_pop_buffer PARAMS ((cpp_reader *));
650 extern cpp_hashnode* cpp_lookup PARAMS ((cpp_reader*, const U_CHAR*,