Sync usage with man page.
[netbsd-mini2440.git] / gnu / dist / gcc4 / libcpp / internal.h
blob4cec8abe96682a5d2f881a8d2c165aaeea56526b
1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
3 Free Software Foundation, Inc.
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.
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, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
19 /* This header defines all the internal data structures and functions
20 that need to be visible across files. It should not be used outside
21 cpplib. */
23 #ifndef LIBCPP_INTERNAL_H
24 #define LIBCPP_INTERNAL_H
26 #include "symtab.h"
27 #include "cpp-id-data.h"
29 #ifndef HAVE_ICONV_H
30 #undef HAVE_ICONV
31 #endif
33 #if HAVE_ICONV
34 #include <iconv.h>
35 #else
36 #define HAVE_ICONV 0
37 typedef int iconv_t; /* dummy */
38 #endif
40 struct directive; /* Deliberately incomplete. */
41 struct pending_option;
42 struct op;
43 struct _cpp_strbuf;
45 typedef bool (*convert_f) (iconv_t, const unsigned char *, size_t,
46 struct _cpp_strbuf *);
47 struct cset_converter
49 convert_f func;
50 iconv_t cd;
53 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
55 /* Test if a sign is valid within a preprocessing number. */
56 #define VALID_SIGN(c, prevc) \
57 (((c) == '+' || (c) == '-') && \
58 ((prevc) == 'e' || (prevc) == 'E' \
59 || (((prevc) == 'p' || (prevc) == 'P') \
60 && CPP_OPTION (pfile, extended_numbers))))
62 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
63 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
64 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base)
65 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
67 #define CPP_INCREMENT_LINE(PFILE, COLS_HINT) do { \
68 const struct line_maps *line_table = PFILE->line_table; \
69 const struct line_map *map = &line_table->maps[line_table->used-1]; \
70 unsigned int line = SOURCE_LINE (map, line_table->highest_line); \
71 linemap_line_start (PFILE->line_table, line + 1, COLS_HINT); \
72 } while (0)
74 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
75 efficiency, and partly to limit runaway recursion. */
76 #define CPP_STACK_MAX 200
78 /* Host alignment handling. */
79 struct dummy
81 char c;
82 union
84 double d;
85 int *p;
86 } u;
89 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
90 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
91 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
93 #define _cpp_mark_macro_used(NODE) do { \
94 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
95 (NODE)->value.macro->used = 1; } while (0)
97 /* A generic memory buffer, and operations on it. */
98 typedef struct _cpp_buff _cpp_buff;
99 struct _cpp_buff
101 struct _cpp_buff *next;
102 unsigned char *base, *cur, *limit;
105 extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
106 extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
107 extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
108 extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
109 extern void _cpp_free_buff (_cpp_buff *);
110 extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
111 extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
113 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
114 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
115 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
117 /* #include types. */
118 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
120 union utoken
122 const cpp_token *token;
123 const cpp_token **ptoken;
126 /* A "run" of tokens; part of a chain of runs. */
127 typedef struct tokenrun tokenrun;
128 struct tokenrun
130 tokenrun *next, *prev;
131 cpp_token *base, *limit;
134 /* Accessor macros for struct cpp_context. */
135 #define FIRST(c) ((c)->u.iso.first)
136 #define LAST(c) ((c)->u.iso.last)
137 #define CUR(c) ((c)->u.trad.cur)
138 #define RLIMIT(c) ((c)->u.trad.rlimit)
140 typedef struct cpp_context cpp_context;
141 struct cpp_context
143 /* Doubly-linked list. */
144 cpp_context *next, *prev;
146 union
148 /* For ISO macro expansion. Contexts other than the base context
149 are contiguous tokens. e.g. macro expansions, expanded
150 argument tokens. */
151 struct
153 union utoken first;
154 union utoken last;
155 } iso;
157 /* For traditional macro expansion. */
158 struct
160 const unsigned char *cur;
161 const unsigned char *rlimit;
162 } trad;
163 } u;
165 /* If non-NULL, a buffer used for storage related to this context.
166 When the context is popped, the buffer is released. */
167 _cpp_buff *buff;
169 /* For a macro context, the macro node, otherwise NULL. */
170 cpp_hashnode *macro;
172 /* True if utoken element is token, else ptoken. */
173 bool direct_p;
176 struct lexer_state
178 /* Nonzero if first token on line is CPP_HASH. */
179 unsigned char in_directive;
181 /* Nonzero if we are collecting macro arguments */
182 unsigned char collecting_args;
184 /* Nonzero if in a directive that will handle padding tokens itself.
185 #include needs this to avoid problems with computed include and
186 spacing between tokens. */
187 unsigned char directive_wants_padding;
189 /* True if we are skipping a failed conditional group. */
190 unsigned char skipping;
192 /* Nonzero if in a directive that takes angle-bracketed headers. */
193 unsigned char angled_headers;
195 /* Nonzero if in a #if or #elif directive. */
196 unsigned char in_expression;
198 /* Nonzero to save comments. Turned off if discard_comments, and in
199 all directives apart from #define. */
200 unsigned char save_comments;
202 /* Nonzero if lexing __VA_ARGS__ is valid. */
203 unsigned char va_args_ok;
205 /* Nonzero if lexing poisoned identifiers is valid. */
206 unsigned char poisoned_ok;
208 /* Nonzero to prevent macro expansion. */
209 unsigned char prevent_expansion;
211 /* Nonzero when handling a deferred pragma. */
212 unsigned char in_deferred_pragma;
214 /* Nonzero when parsing arguments to a function-like macro. */
215 unsigned char parsing_args;
217 /* Nonzero if prevent_expansion is true only because output is
218 being discarded. */
219 unsigned char discarding_output;
221 /* Nonzero to skip evaluating part of an expression. */
222 unsigned int skip_eval;
225 /* Special nodes - identifiers with predefined significance. */
226 struct spec_nodes
228 cpp_hashnode *n_defined; /* defined operator */
229 cpp_hashnode *n_true; /* C++ keyword true */
230 cpp_hashnode *n_false; /* C++ keyword false */
231 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
234 typedef struct _cpp_line_note _cpp_line_note;
235 struct _cpp_line_note
237 /* Location in the clean line the note refers to. */
238 const unsigned char *pos;
240 /* Type of note. The 9 'from' trigraph characters represent those
241 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
242 intervening space, and anything else is invalid. */
243 unsigned int type;
246 /* Represents the contents of a file cpplib has read in. */
247 struct cpp_buffer
249 const unsigned char *cur; /* Current location. */
250 const unsigned char *line_base; /* Start of current physical line. */
251 const unsigned char *next_line; /* Start of to-be-cleaned logical line. */
253 const unsigned char *buf; /* Entire character buffer. */
254 const unsigned char *rlimit; /* Writable byte at end of file. */
256 _cpp_line_note *notes; /* Array of notes. */
257 unsigned int cur_note; /* Next note to process. */
258 unsigned int notes_used; /* Number of notes. */
259 unsigned int notes_cap; /* Size of allocated array. */
261 struct cpp_buffer *prev;
263 /* Pointer into the file table; non-NULL if this is a file buffer.
264 Used for include_next and to record control macros. */
265 struct _cpp_file *file;
267 /* Value of if_stack at start of this file.
268 Used to prohibit unmatched #endif (etc) in an include file. */
269 struct if_stack *if_stack;
271 /* True if we need to get the next clean line. */
272 bool need_line;
274 /* True if we have already warned about C++ comments in this file.
275 The warning happens only for C89 extended mode with -pedantic on,
276 or for -Wtraditional, and only once per file (otherwise it would
277 be far too noisy). */
278 unsigned int warned_cplusplus_comments : 1;
280 /* True if we don't process trigraphs and escaped newlines. True
281 for preprocessed input, command line directives, and _Pragma
282 buffers. */
283 unsigned int from_stage3 : 1;
285 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
286 true, a CPP_EOF token is then returned. Otherwise, the next
287 token from the enclosing buffer is returned. */
288 unsigned int return_at_eof : 1;
290 /* One for a system header, two for a C system header file that therefore
291 needs to be extern "C" protected in C++, and zero otherwise. */
292 unsigned char sysp;
294 /* The directory of the this buffer's file. Its NAME member is not
295 allocated, so we don't need to worry about freeing it. */
296 struct cpp_dir dir;
298 /* Descriptor for converting from the input character set to the
299 source character set. */
300 struct cset_converter input_cset_desc;
303 /* A cpp_reader encapsulates the "state" of a pre-processor run.
304 Applying cpp_get_token repeatedly yields a stream of pre-processor
305 tokens. Usually, there is only one cpp_reader object active. */
306 struct cpp_reader
308 /* Top of buffer stack. */
309 cpp_buffer *buffer;
311 /* Overlaid buffer (can be different after processing #include). */
312 cpp_buffer *overlaid_buffer;
314 /* Lexer state. */
315 struct lexer_state state;
317 /* Source line tracking. */
318 struct line_maps *line_table;
320 /* The line of the '#' of the current directive. */
321 source_location directive_line;
323 /* Memory buffers. */
324 _cpp_buff *a_buff; /* Aligned permanent storage. */
325 _cpp_buff *u_buff; /* Unaligned permanent storage. */
326 _cpp_buff *free_buffs; /* Free buffer chain. */
328 /* Context stack. */
329 struct cpp_context base_context;
330 struct cpp_context *context;
332 /* If in_directive, the directive if known. */
333 const struct directive *directive;
335 /* Token generated while handling a directive, if any. */
336 cpp_token directive_result;
338 /* Search paths for include files. */
339 struct cpp_dir *quote_include; /* "" */
340 struct cpp_dir *bracket_include; /* <> */
341 struct cpp_dir no_search_path; /* No path. */
343 /* Chain of all hashed _cpp_file instances. */
344 struct _cpp_file *all_files;
346 struct _cpp_file *main_file;
348 /* File and directory hash table. */
349 struct htab *file_hash;
350 struct htab *dir_hash;
351 struct file_hash_entry *file_hash_entries;
352 unsigned int file_hash_entries_allocated, file_hash_entries_used;
354 /* Nonzero means don't look for #include "foo" the source-file
355 directory. */
356 bool quote_ignores_source_dir;
358 /* Nonzero if any file has contained #pragma once or #import has
359 been used. */
360 bool seen_once_only;
362 /* Multiple include optimization. */
363 const cpp_hashnode *mi_cmacro;
364 const cpp_hashnode *mi_ind_cmacro;
365 bool mi_valid;
367 /* Lexing. */
368 cpp_token *cur_token;
369 tokenrun base_run, *cur_run;
370 unsigned int lookaheads;
372 /* Nonzero prevents the lexer from re-using the token runs. */
373 unsigned int keep_tokens;
375 /* Error counter for exit code. */
376 unsigned int errors;
378 /* Buffer to hold macro definition string. */
379 unsigned char *macro_buffer;
380 unsigned int macro_buffer_len;
382 /* Descriptor for converting from the source character set to the
383 execution character set. */
384 struct cset_converter narrow_cset_desc;
386 /* Descriptor for converting from the source character set to the
387 wide execution character set. */
388 struct cset_converter wide_cset_desc;
390 /* Date and time text. Calculated together if either is requested. */
391 const unsigned char *date;
392 const unsigned char *time;
394 /* EOF token, and a token forcing paste avoidance. */
395 cpp_token avoid_paste;
396 cpp_token eof;
398 /* Opaque handle to the dependencies of mkdeps.c. */
399 struct deps *deps;
401 /* Obstack holding all macro hash nodes. This never shrinks.
402 See identifiers.c */
403 struct obstack hash_ob;
405 /* Obstack holding buffer and conditional structures. This is a
406 real stack. See directives.c. */
407 struct obstack buffer_ob;
409 /* Pragma table - dynamic, because a library user can add to the
410 list of recognized pragmas. */
411 struct pragma_entry *pragmas;
413 /* Call backs to cpplib client. */
414 struct cpp_callbacks cb;
416 /* Identifier hash table. */
417 struct ht *hash_table;
419 /* Expression parser stack. */
420 struct op *op_stack, *op_limit;
422 /* User visible options. */
423 struct cpp_options opts;
425 /* Special nodes - identifiers with predefined significance to the
426 preprocessor. */
427 struct spec_nodes spec_nodes;
429 /* Whether cpplib owns the hashtable. */
430 bool our_hashtable;
432 /* Traditional preprocessing output buffer (a logical line). */
433 struct
435 unsigned char *base;
436 unsigned char *limit;
437 unsigned char *cur;
438 source_location first_line;
439 } out;
441 /* Used for buffer overlays by traditional.c. */
442 const unsigned char *saved_cur, *saved_rlimit, *saved_line_base;
444 /* A saved list of the defined macros, for dependency checking
445 of precompiled headers. */
446 struct cpp_savedstate *savedstate;
449 /* Character classes. Based on the more primitive macros in safe-ctype.h.
450 If the definition of `numchar' looks odd to you, please look up the
451 definition of a pp-number in the C standard [section 6.4.8 of C99].
453 In the unlikely event that characters other than \r and \n enter
454 the set is_vspace, the macro handle_newline() in lex.c must be
455 updated. */
456 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
458 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
459 #define is_numchar(x) ISIDNUM(x)
460 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
461 #define is_numstart(x) ISDIGIT(x)
462 #define is_hspace(x) ISBLANK(x)
463 #define is_vspace(x) IS_VSPACE(x)
464 #define is_nvspace(x) IS_NVSPACE(x)
465 #define is_space(x) IS_SPACE_OR_NUL(x)
467 /* This table is constant if it can be initialized at compile time,
468 which is the case if cpp was compiled with GCC >=2.7, or another
469 compiler that supports C99. */
470 #if HAVE_DESIGNATED_INITIALIZERS
471 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
472 #else
473 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
474 #endif
476 /* Macros. */
478 static inline int cpp_in_system_header (cpp_reader *);
479 static inline int
480 cpp_in_system_header (cpp_reader *pfile)
482 return pfile->buffer ? pfile->buffer->sysp : 0;
484 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
485 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
487 /* In errors.c */
488 extern int _cpp_begin_message (cpp_reader *, int,
489 source_location, unsigned int);
491 /* In macro.c */
492 extern void _cpp_free_definition (cpp_hashnode *);
493 extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
494 extern void _cpp_pop_context (cpp_reader *);
495 extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
496 const unsigned char *, size_t);
497 extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
498 extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
499 unsigned int);
500 extern const unsigned char *_cpp_builtin_macro_text (cpp_reader *,
501 cpp_hashnode *);
502 int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
503 /* In identifiers.c */
504 extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
505 extern void _cpp_destroy_hashtable (cpp_reader *);
507 /* In files.c */
508 typedef struct _cpp_file _cpp_file;
509 extern _cpp_file *_cpp_find_file (cpp_reader *, const char *, cpp_dir *,
510 bool, int);
511 extern bool _cpp_find_failed (_cpp_file *);
512 extern void _cpp_mark_file_once_only (cpp_reader *, struct _cpp_file *);
513 extern void _cpp_fake_include (cpp_reader *, const char *);
514 extern bool _cpp_stack_file (cpp_reader *, _cpp_file*, bool);
515 extern bool _cpp_stack_include (cpp_reader *, const char *, int,
516 enum include_type);
517 extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
518 extern void _cpp_report_missing_guards (cpp_reader *);
519 extern void _cpp_init_files (cpp_reader *);
520 extern void _cpp_cleanup_files (cpp_reader *);
521 extern void _cpp_pop_file_buffer (cpp_reader *, struct _cpp_file *);
522 extern bool _cpp_save_file_entries (cpp_reader *pfile, FILE *f);
523 extern bool _cpp_read_file_entries (cpp_reader *, FILE *);
525 /* In expr.c */
526 extern bool _cpp_parse_expr (cpp_reader *);
527 extern struct op *_cpp_expand_op_stack (cpp_reader *);
529 /* In lex.c */
530 extern void _cpp_process_line_notes (cpp_reader *, int);
531 extern void _cpp_clean_line (cpp_reader *);
532 extern bool _cpp_get_fresh_line (cpp_reader *);
533 extern bool _cpp_skip_block_comment (cpp_reader *);
534 extern cpp_token *_cpp_temp_token (cpp_reader *);
535 extern const cpp_token *_cpp_lex_token (cpp_reader *);
536 extern cpp_token *_cpp_lex_direct (cpp_reader *);
537 extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
538 extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
540 /* In init.c. */
541 extern void _cpp_maybe_push_include_file (cpp_reader *);
543 /* In directives.c */
544 extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
545 extern int _cpp_handle_directive (cpp_reader *, int);
546 extern void _cpp_define_builtin (cpp_reader *, const char *);
547 extern char ** _cpp_save_pragma_names (cpp_reader *);
548 extern void _cpp_restore_pragma_names (cpp_reader *, char **);
549 extern void _cpp_do__Pragma (cpp_reader *);
550 extern void _cpp_init_directives (cpp_reader *);
551 extern void _cpp_init_internal_pragmas (cpp_reader *);
552 extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
553 unsigned int, unsigned int);
554 extern void _cpp_pop_buffer (cpp_reader *);
556 /* In traditional.c. */
557 extern bool _cpp_scan_out_logical_line (cpp_reader *, cpp_macro *);
558 extern bool _cpp_read_logical_line_trad (cpp_reader *);
559 extern void _cpp_overlay_buffer (cpp_reader *pfile, const unsigned char *,
560 size_t);
561 extern void _cpp_remove_overlay (cpp_reader *);
562 extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
563 extern bool _cpp_expansions_different_trad (const cpp_macro *,
564 const cpp_macro *);
565 extern unsigned char *_cpp_copy_replacement_text (const cpp_macro *,
566 unsigned char *);
567 extern size_t _cpp_replacement_text_len (const cpp_macro *);
569 /* In charset.c. */
571 /* The normalization state at this point in the sequence.
572 It starts initialized to all zeros, and at the end
573 'level' is the normalization level of the sequence. */
575 struct normalize_state
577 /* The previous character. */
578 cppchar_t previous;
579 /* The combining class of the previous character. */
580 unsigned char prev_class;
581 /* The lowest normalization level so far. */
582 enum cpp_normalize_level level;
584 #define INITIAL_NORMALIZE_STATE { 0, 0, normalized_KC }
585 #define NORMALIZE_STATE_RESULT(st) ((st)->level)
587 /* We saw a character that matches ISIDNUM(), update a
588 normalize_state appropriately. */
589 #define NORMALIZE_STATE_UPDATE_IDNUM(st) \
590 ((st)->previous = 0, (st)->prev_class = 0)
592 extern cppchar_t _cpp_valid_ucn (cpp_reader *, const unsigned char **,
593 const unsigned char *, int,
594 struct normalize_state *state);
595 extern void _cpp_destroy_iconv (cpp_reader *);
596 extern unsigned char *_cpp_convert_input (cpp_reader *, const char *,
597 unsigned char *, size_t, size_t,
598 off_t *);
599 extern const char *_cpp_default_encoding (void);
600 extern cpp_hashnode * _cpp_interpret_identifier (cpp_reader *pfile,
601 const unsigned char *id,
602 size_t len);
604 /* Utility routines and macros. */
605 #define DSC(str) (const unsigned char *)str, sizeof str - 1
607 /* These are inline functions instead of macros so we can get type
608 checking. */
609 static inline int ustrcmp (const unsigned char *, const unsigned char *);
610 static inline int ustrncmp (const unsigned char *, const unsigned char *,
611 size_t);
612 static inline size_t ustrlen (const unsigned char *);
613 static inline unsigned char *uxstrdup (const unsigned char *);
614 static inline unsigned char *ustrchr (const unsigned char *, int);
615 static inline int ufputs (const unsigned char *, FILE *);
617 /* Use a const char for the second parameter since it is usually a literal. */
618 static inline int ustrcspn (const unsigned char *, const char *);
620 static inline int
621 ustrcmp (const unsigned char *s1, const unsigned char *s2)
623 return strcmp ((const char *)s1, (const char *)s2);
626 static inline int
627 ustrncmp (const unsigned char *s1, const unsigned char *s2, size_t n)
629 return strncmp ((const char *)s1, (const char *)s2, n);
632 static inline int
633 ustrcspn (const unsigned char *s1, const char *s2)
635 return strcspn ((const char *)s1, s2);
638 static inline size_t
639 ustrlen (const unsigned char *s1)
641 return strlen ((const char *)s1);
644 static inline unsigned char *
645 uxstrdup (const unsigned char *s1)
647 return (unsigned char *) xstrdup ((const char *)s1);
650 static inline unsigned char *
651 ustrchr (const unsigned char *s1, int c)
653 return (unsigned char *) strchr ((const char *)s1, c);
656 static inline int
657 ufputs (const unsigned char *s, FILE *f)
659 return fputs ((const char *)s, f);
662 #endif /* ! LIBCPP_INTERNAL_H */