747ff18bad127862f0c9ead33ade5e36a4b3b13c
[gcc.git] / 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 /* For complex reasons, cpp_reader is also typedefed in c-pragma.h. */
32 #ifndef _C_PRAGMA_H
33 typedef struct cpp_reader cpp_reader;
34 #endif
35 typedef struct cpp_buffer cpp_buffer;
36 typedef struct cpp_options cpp_options;
37 typedef struct cpp_token cpp_token;
38 typedef struct cpp_string cpp_string;
39 typedef struct cpp_hashnode cpp_hashnode;
40 typedef struct cpp_pool cpp_pool;
41 typedef struct cpp_macro cpp_macro;
42 typedef struct cpp_lexer_pos cpp_lexer_pos;
43 typedef struct cpp_lookahead cpp_lookahead;
44
45 struct directive; /* These are deliberately incomplete. */
46 struct answer;
47 struct cpp_macro;
48 struct macro_args;
49 struct cpp_chunk;
50 struct file_name_map_list;
51 struct htab;
52
53 /* The first two groups, apart from '=', can appear in preprocessor
54 expressions. This allows a lookup table to be implemented in
55 _cpp_parse_expr.
56
57 The first group, to CPP_LAST_EQ, can be immediately followed by an
58 '='. The lexer needs operators ending in '=', like ">>=", to be in
59 the same order as their counterparts without the '=', like ">>". */
60
61 /* Positions in the table. */
62 #define CPP_LAST_EQ CPP_MAX
63 #define CPP_FIRST_DIGRAPH CPP_HASH
64 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
65
66 #define TTYPE_TABLE \
67 OP(CPP_EQ = 0, "=") \
68 OP(CPP_NOT, "!") \
69 OP(CPP_GREATER, ">") /* compare */ \
70 OP(CPP_LESS, "<") \
71 OP(CPP_PLUS, "+") /* math */ \
72 OP(CPP_MINUS, "-") \
73 OP(CPP_MULT, "*") \
74 OP(CPP_DIV, "/") \
75 OP(CPP_MOD, "%") \
76 OP(CPP_AND, "&") /* bit ops */ \
77 OP(CPP_OR, "|") \
78 OP(CPP_XOR, "^") \
79 OP(CPP_RSHIFT, ">>") \
80 OP(CPP_LSHIFT, "<<") \
81 OP(CPP_MIN, "<?") /* extension */ \
82 OP(CPP_MAX, ">?") \
83 \
84 OP(CPP_COMPL, "~") \
85 OP(CPP_AND_AND, "&&") /* logical */ \
86 OP(CPP_OR_OR, "||") \
87 OP(CPP_QUERY, "?") \
88 OP(CPP_COLON, ":") \
89 OP(CPP_COMMA, ",") /* grouping */ \
90 OP(CPP_OPEN_PAREN, "(") \
91 OP(CPP_CLOSE_PAREN, ")") \
92 OP(CPP_EQ_EQ, "==") /* compare */ \
93 OP(CPP_NOT_EQ, "!=") \
94 OP(CPP_GREATER_EQ, ">=") \
95 OP(CPP_LESS_EQ, "<=") \
96 \
97 OP(CPP_PLUS_EQ, "+=") /* math */ \
98 OP(CPP_MINUS_EQ, "-=") \
99 OP(CPP_MULT_EQ, "*=") \
100 OP(CPP_DIV_EQ, "/=") \
101 OP(CPP_MOD_EQ, "%=") \
102 OP(CPP_AND_EQ, "&=") /* bit ops */ \
103 OP(CPP_OR_EQ, "|=") \
104 OP(CPP_XOR_EQ, "^=") \
105 OP(CPP_RSHIFT_EQ, ">>=") \
106 OP(CPP_LSHIFT_EQ, "<<=") \
107 OP(CPP_MIN_EQ, "<?=") /* extension */ \
108 OP(CPP_MAX_EQ, ">?=") \
109 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
110 OP(CPP_HASH, "#") /* digraphs */ \
111 OP(CPP_PASTE, "##") \
112 OP(CPP_OPEN_SQUARE, "[") \
113 OP(CPP_CLOSE_SQUARE, "]") \
114 OP(CPP_OPEN_BRACE, "{") \
115 OP(CPP_CLOSE_BRACE, "}") \
116 /* The remainder of the punctuation. Order is not significant. */ \
117 OP(CPP_SEMICOLON, ";") /* structure */ \
118 OP(CPP_ELLIPSIS, "...") \
119 OP(CPP_BACKSLASH, "\\") \
120 OP(CPP_PLUS_PLUS, "++") /* increment */ \
121 OP(CPP_MINUS_MINUS, "--") \
122 OP(CPP_DEREF, "->") /* accessors */ \
123 OP(CPP_DOT, ".") \
124 OP(CPP_SCOPE, "::") \
125 OP(CPP_DEREF_STAR, "->*") \
126 OP(CPP_DOT_STAR, ".*") \
127 \
128 TK(CPP_NAME, SPELL_IDENT) /* word */ \
129 TK(CPP_INT, SPELL_STRING) /* 23 */ \
130 TK(CPP_FLOAT, SPELL_STRING) /* 3.14159 */ \
131 TK(CPP_NUMBER, SPELL_STRING) /* 34_be+ta */ \
132 \
133 TK(CPP_CHAR, SPELL_STRING) /* 'char' */ \
134 TK(CPP_WCHAR, SPELL_STRING) /* L'char' */ \
135 TK(CPP_OTHER, SPELL_CHAR) /* stray punctuation */ \
136 \
137 TK(CPP_STRING, SPELL_STRING) /* "string" */ \
138 TK(CPP_WSTRING, SPELL_STRING) /* L"string" */ \
139 TK(CPP_OSTRING, SPELL_STRING) /* @"string" - Objective C */ \
140 TK(CPP_HEADER_NAME, SPELL_STRING) /* <stdio.h> in #include */ \
141 \
142 TK(CPP_COMMENT, SPELL_STRING) /* Only if output comments. */ \
143 TK(CPP_DHASH, SPELL_NONE) /* The # of a directive. */ \
144 TK(CPP_MACRO_ARG, SPELL_NONE) /* Macro argument. */ \
145 TK(CPP_PLACEMARKER, SPELL_NONE) /* Placemarker token. */ \
146 OP(CPP_EOF, "EOL") /* End of line or file. */
147
148 #define OP(e, s) e,
149 #define TK(e, s) e,
150 enum cpp_ttype
151 {
152 TTYPE_TABLE
153 N_TTYPES
154 };
155 #undef OP
156 #undef TK
157
158 /* Multiple-include optimisation. */
159 enum mi_state {MI_FAILED = 0, MI_OUTSIDE};
160 enum mi_ind {MI_IND_NONE = 0, MI_IND_NOT};
161
162 /* Payload of a NUMBER, FLOAT, STRING, or COMMENT token. */
163 struct cpp_string
164 {
165 unsigned int len;
166 const unsigned char *text;
167 };
168
169 /* Flags for the cpp_token structure. */
170 #define PREV_WHITE (1 << 0) /* If whitespace before this token. */
171 #define DIGRAPH (1 << 1) /* If it was a digraph. */
172 #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
173 #define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
174 #define NAMED_OP (1 << 4) /* C++ named operators, also "defined". */
175 #define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
176 #define VARARGS_FIRST STRINGIFY_ARG /* First token of varargs expansion. */
177
178 /* A preprocessing token. This has been carefully packed and should
179 occupy 12 bytes on 32-bit hosts and 16 bytes on 64-bit hosts. */
180 struct cpp_token
181 {
182 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
183 unsigned char flags; /* flags - see above */
184
185 union
186 {
187 HOST_WIDEST_INT integer; /* an integer */
188 struct cpp_hashnode *node; /* an identifier */
189 struct cpp_string str; /* a string, or number */
190 unsigned int aux; /* argument no. for a CPP_MACRO_ARG, or
191 character represented by CPP_OTHER. */
192 } val;
193 };
194
195 /* The position of a token in the current file. */
196 struct cpp_lexer_pos
197 {
198 unsigned int line;
199 unsigned int output_line;
200 unsigned short col;
201 };
202
203 typedef struct cpp_token_with_pos cpp_token_with_pos;
204 struct cpp_token_with_pos
205 {
206 cpp_token token;
207 cpp_lexer_pos pos;
208 };
209
210 /* Token lookahead. */
211 struct cpp_lookahead
212 {
213 struct cpp_lookahead *next;
214 cpp_token_with_pos *tokens;
215 cpp_lexer_pos pos;
216 unsigned int cur, count, cap;
217 };
218
219 /* Memory pools. */
220 struct cpp_pool
221 {
222 struct cpp_chunk *cur, *locked;
223 unsigned char *pos; /* Current position. */
224 unsigned int align;
225 unsigned int locks;
226 };
227
228 typedef struct toklist toklist;
229 struct toklist
230 {
231 cpp_token *first;
232 cpp_token *limit;
233 };
234
235 typedef struct cpp_context cpp_context;
236 struct cpp_context
237 {
238 /* Doubly-linked list. */
239 cpp_context *next, *prev;
240
241 /* Contexts other than the base context are contiguous tokens.
242 e.g. macro expansions, expanded argument tokens. */
243 struct toklist list;
244
245 /* For a macro context, these are the macro and its arguments. */
246 cpp_macro *macro;
247 };
248
249 /* A standalone character. We may want to make it unsigned for the
250 same reason we use unsigned char - to avoid signedness issues. */
251 typedef int cppchar_t;
252
253 struct cpp_buffer
254 {
255 const unsigned char *cur; /* current position */
256 const unsigned char *rlimit; /* end of valid data */
257 const unsigned char *line_base; /* start of current line */
258 cppchar_t read_ahead; /* read ahead character */
259 cppchar_t extra_char; /* extra read-ahead for long tokens. */
260
261 struct cpp_reader *pfile; /* Owns this buffer. */
262 struct cpp_buffer *prev;
263
264 const unsigned char *buf; /* entire buffer */
265
266 /* Filename specified with #line command. */
267 const char *nominal_fname;
268
269 /* Actual directory of this file, used only for "" includes */
270 struct file_name_list *actual_dir;
271
272 /* Pointer into the include table. Used for include_next and
273 to record control macros. */
274 struct include_file *inc;
275
276 /* Value of if_stack at start of this file.
277 Used to prohibit unmatched #endif (etc) in an include file. */
278 struct if_stack *if_stack;
279
280 /* Token column position adjustment owing to tabs in whitespace. */
281 unsigned int col_adjust;
282
283 /* Line number at line_base (above). */
284 unsigned int lineno;
285
286 /* True if we have already warned about C++ comments in this file.
287 The warning happens only for C89 extended mode with -pedantic on,
288 or for -Wtraditional, and only once per file (otherwise it would
289 be far too noisy). */
290 char warned_cplusplus_comments;
291 };
292
293 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
294 efficiency, and partly to limit runaway recursion. */
295 #define CPP_STACK_MAX 200
296
297 /* Values for opts.dump_macros.
298 dump_only means inhibit output of the preprocessed text
299 and instead output the definitions of all user-defined
300 macros in a form suitable for use as input to cpp.
301 dump_names means pass #define and the macro name through to output.
302 dump_definitions means pass the whole definition (plus #define) through
303 */
304 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
305
306 /* This structure is nested inside struct cpp_reader, and
307 carries all the options visible to the command line. */
308 struct cpp_options
309 {
310 /* Name of input and output files. */
311 const char *in_fname;
312 const char *out_fname;
313
314 /* Characters between tab stops. */
315 unsigned int tabstop;
316
317 /* Pending options - -D, -U, -A, -I, -ixxx. */
318 struct cpp_pending *pending;
319
320 /* File name which deps are being written to. This is 0 if deps are
321 being written to stdout. */
322 const char *deps_file;
323
324 /* Target-name to write with the dependency information. */
325 char *deps_target;
326
327 /* Search paths for include files. */
328 struct file_name_list *quote_include; /* First dir to search for "file" */
329 struct file_name_list *bracket_include;/* First dir to search for <file> */
330
331 /* Map between header names and file names, used only on DOS where
332 file names are limited in length. */
333 struct file_name_map_list *map_list;
334
335 /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
336 in the standard include file directories. */
337 const char *include_prefix;
338 unsigned int include_prefix_len;
339
340 /* -fleading_underscore sets this to "_". */
341 const char *user_label_prefix;
342
343 /* Non-0 means -v, so print the full set of include dirs. */
344 unsigned char verbose;
345
346 /* Nonzero means use extra default include directories for C++. */
347 unsigned char cplusplus;
348
349 /* Nonzero means handle cplusplus style comments */
350 unsigned char cplusplus_comments;
351
352 /* Nonzero means handle #import, for objective C. */
353 unsigned char objc;
354
355 /* Nonzero means this is an assembly file, so ignore unrecognized
356 directives and the "# 33" form of #line, both of which are
357 probably comments. Also, permit unbalanced ' strings (again,
358 likely to be in comments). */
359 unsigned char lang_asm;
360
361 /* Nonzero means don't copy comments into the output file. */
362 unsigned char discard_comments;
363
364 /* Nonzero means process the ISO trigraph sequences. */
365 unsigned char trigraphs;
366
367 /* Nonzero means process the ISO digraph sequences. */
368 unsigned char digraphs;
369
370 /* Nonzero means print the names of included files rather than the
371 preprocessed output. 1 means just the #include "...", 2 means
372 #include <...> as well. */
373 unsigned char print_deps;
374
375 /* Nonzero if missing .h files in -M output are assumed to be
376 generated files and not errors. */
377 unsigned char print_deps_missing_files;
378
379 /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
380 unsigned char print_deps_append;
381
382 /* Nonzero means print names of header files (-H). */
383 unsigned char print_include_names;
384
385 /* Nonzero means cpp_pedwarn causes a hard error. */
386 unsigned char pedantic_errors;
387
388 /* Nonzero means don't print warning messages. */
389 unsigned char inhibit_warnings;
390
391 /* Nonzero means don't suppress warnings from system headers. */
392 unsigned char warn_system_headers;
393
394 /* Nonzero means don't print error messages. Has no option to
395 select it, but can be set by a user of cpplib (e.g. fix-header). */
396 unsigned char inhibit_errors;
397
398 /* Nonzero means warn if slash-star appears in a comment. */
399 unsigned char warn_comments;
400
401 /* Nonzero means warn if there are any trigraphs. */
402 unsigned char warn_trigraphs;
403
404 /* Nonzero means warn if #import is used. */
405 unsigned char warn_import;
406
407 /* Nonzero means warn about various incompatibilities with
408 traditional C. */
409 unsigned char warn_traditional;
410
411 /* Nonzero means warn if ## is applied to two tokens that cannot be
412 pasted together. */
413 unsigned char warn_paste;
414
415 /* Nonzero means turn warnings into errors. */
416 unsigned char warnings_are_errors;
417
418 /* Nonzero causes output not to be done, but directives such as
419 #define that have side effects are still obeyed. */
420 unsigned char no_output;
421
422 /* Nonzero means we should look for header.gcc files that remap file
423 names. */
424 unsigned char remap;
425
426 /* Nonzero means don't output line number information. */
427 unsigned char no_line_commands;
428
429 /* Nonzero means -I- has been seen, so don't look for #include "foo"
430 the source-file directory. */
431 unsigned char ignore_srcdir;
432
433 /* Zero means dollar signs are punctuation. */
434 unsigned char dollars_in_ident;
435
436 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
437 unsigned char warn_undef;
438
439 /* Nonzero for the 1989 C Standard, including corrigenda and amendments. */
440 unsigned char c89;
441
442 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
443 unsigned char c99;
444
445 /* Nonzero means give all the error messages the ANSI standard requires. */
446 unsigned char pedantic;
447
448 /* Nonzero means we're looking at already preprocessed code, so don't
449 bother trying to do macro expansion and whatnot. */
450 unsigned char preprocessed;
451
452 /* Nonzero disables all the standard directories for headers. */
453 unsigned char no_standard_includes;
454
455 /* Nonzero disables the C++-specific standard directories for headers. */
456 unsigned char no_standard_cplusplus_includes;
457
458 /* Nonzero means dump macros in some fashion - see above. */
459 unsigned char dump_macros;
460
461 /* Nonzero means pass all #define and #undef directives which we
462 actually process through to the output stream. This feature is
463 used primarily to allow cc1 to record the #defines and #undefs
464 for the sake of debuggers which understand about preprocessor
465 macros, but it may also be useful with -E to figure out how
466 symbols are defined, and where they are defined. */
467 unsigned char debug_output;
468
469 /* Nonzero means pass #include lines through to the output. */
470 unsigned char dump_includes;
471
472 /* Print column number in error messages. */
473 unsigned char show_column;
474 };
475
476 struct lexer_state
477 {
478 /* Nonzero if first token on line is CPP_HASH. */
479 unsigned char in_directive;
480
481 /* Nonzero if in a directive that takes angle-bracketed headers. */
482 unsigned char angled_headers;
483
484 /* Nonzero to save comments. Turned off if discard_comments, and in
485 all directives apart from #define. */
486 unsigned char save_comments;
487
488 /* If nonzero the lexer skips newlines. Internal to the lexer. */
489 unsigned char skip_newlines;
490
491 /* Nonzero if we're mid-comment. */
492 unsigned char lexing_comment;
493
494 /* Nonzero if lexing __VA_ARGS__ is valid. */
495 unsigned char va_args_ok;
496
497 /* Nonzero if lexing poisoned identifiers is valid. */
498 unsigned char poisoned_ok;
499
500 /* Nonzero to prevent macro expansion. */
501 unsigned char prevent_expansion;
502
503 /* Nonzero when parsing arguments to a function-like macro. */
504 unsigned char parsing_args;
505 };
506
507 /* Special nodes - identifiers with predefined significance. */
508 struct spec_nodes
509 {
510 cpp_hashnode *n_L; /* L"str" */
511 cpp_hashnode *n_defined; /* defined operator */
512 cpp_hashnode *n__STRICT_ANSI__; /* STDC_0_IN_SYSTEM_HEADERS */
513 cpp_hashnode *n__CHAR_UNSIGNED__; /* plain char is unsigned */
514 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
515 };
516
517 /* a cpp_reader encapsulates the "state" of a pre-processor run.
518 Applying cpp_get_token repeatedly yields a stream of pre-processor
519 tokens. Usually, there is only one cpp_reader object active. */
520
521 struct cpp_reader
522 {
523 /* Top of buffer stack. */
524 cpp_buffer *buffer;
525
526 /* Lexer state. */
527 struct lexer_state state;
528
529 /* The position of the last lexed token, last lexed directive, and
530 last macro invocation. */
531 cpp_lexer_pos lexer_pos;
532 cpp_lexer_pos macro_pos;
533 cpp_lexer_pos directive_pos;
534
535 /* Memory pools. */
536 cpp_pool ident_pool; /* For all identifiers, and permanent
537 numbers and strings. */
538 cpp_pool temp_string_pool; /* For temporary numbers and strings. */
539 cpp_pool macro_pool; /* For macro definitions. Permanent. */
540 cpp_pool argument_pool; /* For macro arguments. Temporary. */
541 cpp_pool* string_pool; /* Either temp_string_pool or ident_pool. */
542
543 /* Context stack. */
544 struct cpp_context base_context;
545 struct cpp_context *context;
546
547 /* If in_directive, the directive if known. */
548 const struct directive *directive;
549
550 /* Multiple inlcude optimisation. */
551 enum mi_state mi_state;
552 enum mi_ind mi_if_not_defined;
553 unsigned int mi_lexed;
554 const cpp_hashnode *mi_cmacro;
555 const cpp_hashnode *mi_ind_cmacro;
556
557 /* Token lookahead. */
558 struct cpp_lookahead *la_read; /* Read from this lookahead. */
559 struct cpp_lookahead *la_write; /* Write to this lookahead. */
560 struct cpp_lookahead *la_unused; /* Free store. */
561
562 /* Error counter for exit code. */
563 unsigned int errors;
564
565 /* Line and column where a newline was first seen in a string
566 constant (multi-line strings). */
567 cpp_lexer_pos mlstring_pos;
568
569 /* Buffer to hold macro definition string. */
570 unsigned char *macro_buffer;
571 unsigned int macro_buffer_len;
572
573 /* Current depth in #include directives that use <...>. */
574 unsigned int system_include_depth;
575
576 /* Current depth of buffer stack. */
577 unsigned int buffer_stack_depth;
578
579 /* Current depth in #include directives. */
580 unsigned int include_depth;
581
582 /* Hash table of macros and assertions. See cpphash.c. */
583 struct htab *hashtab;
584
585 /* Tree of other included files. See cppfiles.c. */
586 struct splay_tree_s *all_include_files;
587
588 /* Chain of `actual directory' file_name_list entries, for ""
589 inclusion. */
590 struct file_name_list *actual_dirs;
591
592 /* Current maximum length of directory names in the search path
593 for include files. (Altered as we get more of them.) */
594 unsigned int max_include_len;
595
596 /* Date and time tokens. Calculated together if either is requested. */
597 cpp_token date;
598 cpp_token time;
599
600 /* Buffer of -M output. */
601 struct deps *deps;
602
603 /* Obstack holding all macro hash nodes. This never shrinks.
604 See cpphash.c */
605 struct obstack *hash_ob;
606
607 /* Obstack holding buffer and conditional structures. This is a
608 real stack. See cpplib.c */
609 struct obstack *buffer_ob;
610
611 /* Pragma table - dynamic, because a library user can add to the
612 list of recognized pragmas. */
613 struct pragma_entry *pragmas;
614
615 /* Call backs. */
616 struct {
617 void (*enter_file) PARAMS ((cpp_reader *));
618 void (*leave_file) PARAMS ((cpp_reader *));
619 void (*rename_file) PARAMS ((cpp_reader *));
620 void (*include) PARAMS ((cpp_reader *, const unsigned char *,
621 const cpp_token *));
622 void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
623 void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
624 void (*poison) PARAMS ((cpp_reader *));
625 void (*ident) PARAMS ((cpp_reader *, const cpp_string *));
626 void (*def_pragma) PARAMS ((cpp_reader *));
627 } cb;
628
629 /* User visible options. */
630 struct cpp_options opts;
631
632 /* Special nodes - identifiers with predefined significance to the
633 preprocessor. */
634 struct spec_nodes spec_nodes;
635
636 /* Nonzero means we have printed (while error reporting) a list of
637 containing files that matches the current status. */
638 unsigned char input_stack_listing_current;
639
640 /* We're printed a warning recommending against using #import. */
641 unsigned char import_warning;
642
643 /* True after cpp_start_read completes. Used to inhibit some
644 warnings while parsing the command line. */
645 unsigned char done_initializing;
646
647 /* True if we are skipping a failed conditional group. */
648 unsigned char skipping;
649 };
650
651 #define CPP_FATAL_LIMIT 1000
652 /* True if we have seen a "fatal" error. */
653 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
654
655 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
656 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
657 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
658 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
659 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
660
661 /* Name under which this program was invoked. */
662 extern const char *progname;
663
664 /* The structure of a node in the hash table. The hash table has
665 entries for all identifiers: either macros defined by #define
666 commands (type NT_MACRO), assertions created with #assert
667 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
668 like __LINE__ are flagged NODE_BUILTIN. Poisioned identifiers are
669 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
670 identifier that behaves like an operator such as "xor".
671 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
672 diagnostic may be required for this node. Currently this only
673 applies to __VA_ARGS__ and poisoned identifiers. */
674
675 /* Hash node flags. */
676 #define NODE_OPERATOR (1 << 0) /* C++ named operator. */
677 #define NODE_POISONED (1 << 1) /* Poisoned identifier. */
678 #define NODE_BUILTIN (1 << 2) /* Builtin macro. */
679 #define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
680
681 /* Different flavors of hash node. */
682 enum node_type
683 {
684 NT_VOID = 0, /* No definition yet. */
685 NT_MACRO, /* A macro of some form. */
686 NT_ASSERTION /* Predicate for #assert. */
687 };
688
689 /* Different flavors of builtin macro. */
690 enum builtin_type
691 {
692 BT_SPECLINE = 0, /* `__LINE__' */
693 BT_DATE, /* `__DATE__' */
694 BT_FILE, /* `__FILE__' */
695 BT_BASE_FILE, /* `__BASE_FILE__' */
696 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
697 BT_TIME, /* `__TIME__' */
698 BT_STDC /* `__STDC__' */
699 };
700
701 /* There is a slot in the hashnode for use by front ends when integrated
702 with cpplib. It holds a tree (see tree.h) but we mustn't drag that
703 header into every user of cpplib.h. cpplib does not do anything with
704 this slot except clear it when a new node is created. */
705 union tree_node;
706
707 struct cpp_hashnode
708 {
709 const unsigned char *name; /* null-terminated name */
710 unsigned int hash; /* cached hash value */
711 unsigned short length; /* length of name excluding null */
712 unsigned short arg_index; /* macro argument index */
713 unsigned char directive_index; /* index into directive table. */
714 ENUM_BITFIELD(node_type) type : 8; /* node type. */
715 unsigned char flags; /* node flags. */
716
717 union
718 {
719 cpp_macro *macro; /* a macro. */
720 struct answer *answers; /* answers to an assertion. */
721 enum cpp_ttype operator; /* code for a named operator. */
722 enum builtin_type builtin; /* code for a builtin macro. */
723 } value;
724
725 union tree_node *fe_value; /* front end value */
726 };
727
728 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
729 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *, const cpp_token *));
730 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
731 unsigned char *));
732 extern void cpp_init PARAMS ((void));
733 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
734 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
735 extern void cpp_reader_init PARAMS ((cpp_reader *));
736
737 extern void cpp_register_pragma PARAMS ((cpp_reader *,
738 const char *, const char *,
739 void (*) PARAMS ((cpp_reader *))));
740 extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
741
742 extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
743 extern void cpp_finish PARAMS ((cpp_reader *));
744 extern void cpp_cleanup PARAMS ((cpp_reader *));
745 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
746 const cpp_token *));
747 extern enum cpp_ttype cpp_can_paste PARAMS ((cpp_reader *, const cpp_token *,
748 const cpp_token *, int *));
749 extern void cpp_get_token PARAMS ((cpp_reader *, cpp_token *));
750 extern const cpp_lexer_pos *cpp_get_line PARAMS ((cpp_reader *));
751 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
752 const cpp_hashnode *));
753
754 extern void cpp_define PARAMS ((cpp_reader *, const char *));
755 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
756 extern void cpp_undef PARAMS ((cpp_reader *, const char *));
757 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
758
759 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
760 const unsigned char *, long));
761 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
762 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
763
764 /* N.B. The error-message-printer prototypes have not been nicely
765 formatted because exgettext needs to see 'msgid' on the same line
766 as the name of the function in order to work properly. Only the
767 string argument gets a name in an effort to keep the lines from
768 getting ridiculously oversized. */
769
770 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
771 ATTRIBUTE_PRINTF_2;
772 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
773 ATTRIBUTE_PRINTF_2;
774 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
775 ATTRIBUTE_PRINTF_2;
776 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
777 ATTRIBUTE_PRINTF_2;
778 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
779 ATTRIBUTE_PRINTF_2;
780 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
781 ATTRIBUTE_PRINTF_2;
782 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
783 ATTRIBUTE_PRINTF_4;
784 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
785 ATTRIBUTE_PRINTF_4;
786 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
787 ATTRIBUTE_PRINTF_4;
788 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
789 ATTRIBUTE_PRINTF_5;
790 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
791 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
792
793 /* In cpplex.c */
794 extern int cpp_ideq PARAMS ((const cpp_token *,
795 const char *));
796 extern void cpp_output_line PARAMS ((cpp_reader *, FILE *));
797 extern void cpp_output_token PARAMS ((const cpp_token *, FILE *));
798 extern const char *cpp_type2name PARAMS ((enum cpp_ttype));
799
800 /* In cpphash.c */
801 extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
802 const unsigned char *, size_t));
803 extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
804 int (*) PARAMS ((cpp_reader *,
805 cpp_hashnode *,
806 void *)),
807 void *));
808
809 /* In cppmacro.c */
810 extern void cpp_scan_buffer_nooutput PARAMS ((cpp_reader *));
811 extern void cpp_start_lookahead PARAMS ((cpp_reader *));
812 extern void cpp_stop_lookahead PARAMS ((cpp_reader *, int));
813
814 /* In cppfiles.c */
815 extern int cpp_included PARAMS ((cpp_reader *, const char *));
816 extern int cpp_read_file PARAMS ((cpp_reader *, const char *));
817 extern void cpp_make_system_header PARAMS ((cpp_reader *, cpp_buffer *, int));
818 extern const char *cpp_syshdr_flags PARAMS ((cpp_reader *, cpp_buffer *));
819
820 /* These are inline functions instead of macros so we can get type
821 checking. */
822 typedef unsigned char U_CHAR;
823 #define U (const U_CHAR *) /* Intended use: U"string" */
824
825 static inline int ustrcmp PARAMS ((const U_CHAR *, const U_CHAR *));
826 static inline int ustrncmp PARAMS ((const U_CHAR *, const U_CHAR *,
827 size_t));
828 static inline size_t ustrlen PARAMS ((const U_CHAR *));
829 static inline U_CHAR *uxstrdup PARAMS ((const U_CHAR *));
830 static inline U_CHAR *ustrchr PARAMS ((const U_CHAR *, int));
831 static inline int ufputs PARAMS ((const U_CHAR *, FILE *));
832
833 static inline int
834 ustrcmp (s1, s2)
835 const U_CHAR *s1, *s2;
836 {
837 return strcmp ((const char *)s1, (const char *)s2);
838 }
839
840 static inline int
841 ustrncmp (s1, s2, n)
842 const U_CHAR *s1, *s2;
843 size_t n;
844 {
845 return strncmp ((const char *)s1, (const char *)s2, n);
846 }
847
848 static inline size_t
849 ustrlen (s1)
850 const U_CHAR *s1;
851 {
852 return strlen ((const char *)s1);
853 }
854
855 static inline U_CHAR *
856 uxstrdup (s1)
857 const U_CHAR *s1;
858 {
859 return (U_CHAR *) xstrdup ((const char *)s1);
860 }
861
862 static inline U_CHAR *
863 ustrchr (s1, c)
864 const U_CHAR *s1;
865 int c;
866 {
867 return (U_CHAR *) strchr ((const char *)s1, c);
868 }
869
870 static inline int
871 ufputs (s, f)
872 const U_CHAR *s;
873 FILE *f;
874 {
875 return fputs ((const char *)s, f);
876 }
877
878 #ifdef __cplusplus
879 }
880 #endif
881 #endif /* __GCC_CPPLIB__ */