Bring in a trimmed down gcc-3.4-20040618.
[dragonfly.git] / contrib / gcc-3.4 / gcc / cpphash.h
CommitLineData
003757ed
MD
1/* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 Free Software Foundation, Inc.
4
5This program is free software; you can redistribute it and/or modify it
6under the terms of the GNU General Public License as published by the
7Free Software Foundation; either version 2, or (at your option) any
8later version.
9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program; if not, write to the Free Software
17Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18
19/* This header defines all the internal data structures and functions
20 that need to be visible across files. It's called cpphash.h for
21 historical reasons. */
22
23#ifndef GCC_CPPHASH_H
24#define GCC_CPPHASH_H
25
26#include "hashtable.h"
27
28#if defined HAVE_ICONV_H && defined HAVE_ICONV
29#include <iconv.h>
30#else
31#define HAVE_ICONV 0
32typedef int iconv_t; /* dummy */
33#endif
34
35struct directive; /* Deliberately incomplete. */
36struct pending_option;
37struct op;
38struct _cpp_strbuf;
39
40typedef bool (*convert_f) (iconv_t, const unsigned char *, size_t,
41 struct _cpp_strbuf *);
42struct cset_converter
43{
44 convert_f func;
45 iconv_t cd;
46};
47
48#ifndef HAVE_UCHAR
49typedef unsigned char uchar;
50#endif
51#define U (const uchar *) /* Intended use: U"string" */
52
53#define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
54
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))))
61
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)
66
67/* Maximum nesting of cpp_buffers. We use a static limit, partly for
68 efficiency, and partly to limit runaway recursion. */
69#define CPP_STACK_MAX 200
70
71/* Host alignment handling. */
72struct dummy
73{
74 char c;
75 union
76 {
77 double d;
78 int *p;
79 } u;
80};
81
82#define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
83#define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
84#define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
85
86/* Each macro definition is recorded in a cpp_macro structure.
87 Variadic macros cannot occur with traditional cpp. */
88struct cpp_macro
89{
90 /* Parameters, if any. */
91 cpp_hashnode **params;
92
93 /* Replacement tokens (ISO) or replacement text (traditional). See
94 comment at top of cpptrad.c for how traditional function-like
95 macros are encoded. */
96 union
97 {
98 cpp_token *tokens;
99 const uchar *text;
100 } exp;
101
102 /* Definition line number. */
103 fileline line;
104
105 /* Number of tokens in expansion, or bytes for traditional macros. */
106 unsigned int count;
107
108 /* Number of parameters. */
109 unsigned short paramc;
110
111 /* If a function-like macro. */
112 unsigned int fun_like : 1;
113
114 /* If a variadic macro. */
115 unsigned int variadic : 1;
116
117 /* If macro defined in system header. */
118 unsigned int syshdr : 1;
119
120 /* Nonzero if it has been expanded or had its existence tested. */
121 unsigned int used : 1;
122};
123
124#define _cpp_mark_macro_used(NODE) do { \
125 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
126 (NODE)->value.macro->used = 1; } while (0)
127
128/* A generic memory buffer, and operations on it. */
129typedef struct _cpp_buff _cpp_buff;
130struct _cpp_buff
131{
132 struct _cpp_buff *next;
133 unsigned char *base, *cur, *limit;
134};
135
136extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
137extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
138extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
139extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
140extern void _cpp_free_buff (_cpp_buff *);
141extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
142extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
143
144#define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
145#define BUFF_FRONT(BUFF) ((BUFF)->cur)
146#define BUFF_LIMIT(BUFF) ((BUFF)->limit)
147
148/* #include types. */
149enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
150
151union utoken
152{
153 const cpp_token *token;
154 const cpp_token **ptoken;
155};
156
157/* A "run" of tokens; part of a chain of runs. */
158typedef struct tokenrun tokenrun;
159struct tokenrun
160{
161 tokenrun *next, *prev;
162 cpp_token *base, *limit;
163};
164
165/* Accessor macros for struct cpp_context. */
166#define FIRST(c) ((c)->u.iso.first)
167#define LAST(c) ((c)->u.iso.last)
168#define CUR(c) ((c)->u.trad.cur)
169#define RLIMIT(c) ((c)->u.trad.rlimit)
170
171typedef struct cpp_context cpp_context;
172struct cpp_context
173{
174 /* Doubly-linked list. */
175 cpp_context *next, *prev;
176
177 union
178 {
179 /* For ISO macro expansion. Contexts other than the base context
180 are contiguous tokens. e.g. macro expansions, expanded
181 argument tokens. */
182 struct
183 {
184 union utoken first;
185 union utoken last;
186 } iso;
187
188 /* For traditional macro expansion. */
189 struct
190 {
191 const uchar *cur;
192 const uchar *rlimit;
193 } trad;
194 } u;
195
196 /* If non-NULL, a buffer used for storage related to this context.
197 When the context is popped, the buffer is released. */
198 _cpp_buff *buff;
199
200 /* For a macro context, the macro node, otherwise NULL. */
201 cpp_hashnode *macro;
202
203 /* True if utoken element is token, else ptoken. */
204 bool direct_p;
205};
206
207struct lexer_state
208{
209 /* Nonzero if first token on line is CPP_HASH. */
210 unsigned char in_directive;
211
212 /* Nonzero if in a directive that will handle padding tokens itself.
213 #include needs this to avoid problems with computed include and
214 spacing between tokens. */
215 unsigned char directive_wants_padding;
216
217 /* True if we are skipping a failed conditional group. */
218 unsigned char skipping;
219
220 /* Nonzero if in a directive that takes angle-bracketed headers. */
221 unsigned char angled_headers;
222
223 /* Nonzero if in a #if or #elif directive. */
224 unsigned char in_expression;
225
226 /* Nonzero to save comments. Turned off if discard_comments, and in
227 all directives apart from #define. */
228 unsigned char save_comments;
229
230 /* Nonzero if lexing __VA_ARGS__ is valid. */
231 unsigned char va_args_ok;
232
233 /* Nonzero if lexing poisoned identifiers is valid. */
234 unsigned char poisoned_ok;
235
236 /* Nonzero to prevent macro expansion. */
237 unsigned char prevent_expansion;
238
239 /* Nonzero when parsing arguments to a function-like macro. */
240 unsigned char parsing_args;
241
242 /* Nonzero to skip evaluating part of an expression. */
243 unsigned int skip_eval;
244};
245
246/* Special nodes - identifiers with predefined significance. */
247struct spec_nodes
248{
249 cpp_hashnode *n_defined; /* defined operator */
250 cpp_hashnode *n_true; /* C++ keyword true */
251 cpp_hashnode *n_false; /* C++ keyword false */
252 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
253};
254
255typedef struct _cpp_line_note _cpp_line_note;
256struct _cpp_line_note
257{
258 /* Location in the clean line the note refers to. */
259 const uchar *pos;
260
261 /* Type of note. The 9 'from' trigraph characters represent those
262 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
263 intervening space, and anything else is invalid. */
264 unsigned int type;
265};
266
267/* Represents the contents of a file cpplib has read in. */
268struct cpp_buffer
269{
270 const uchar *cur; /* Current location. */
271 const uchar *line_base; /* Start of current physical line. */
272 const uchar *next_line; /* Start of to-be-cleaned logical line. */
273
274 const uchar *buf; /* Entire character buffer. */
275 const uchar *rlimit; /* Writable byte at end of file. */
276
277 _cpp_line_note *notes; /* Array of notes. */
278 unsigned int cur_note; /* Next note to process. */
279 unsigned int notes_used; /* Number of notes. */
280 unsigned int notes_cap; /* Size of allocated array. */
281
282 struct cpp_buffer *prev;
283
284 /* Pointer into the file table; non-NULL if this is a file buffer.
285 Used for include_next and to record control macros. */
286 struct _cpp_file *file;
287
288 /* Value of if_stack at start of this file.
289 Used to prohibit unmatched #endif (etc) in an include file. */
290 struct if_stack *if_stack;
291
292 /* True if we need to get the next clean line. */
293 bool need_line;
294
295 /* True if we have already warned about C++ comments in this file.
296 The warning happens only for C89 extended mode with -pedantic on,
297 or for -Wtraditional, and only once per file (otherwise it would
298 be far too noisy). */
299 unsigned char warned_cplusplus_comments;
300
301 /* True if we don't process trigraphs and escaped newlines. True
302 for preprocessed input, command line directives, and _Pragma
303 buffers. */
304 unsigned char from_stage3;
305
306 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
307 true, a CPP_EOF token is then returned. Otherwise, the next
308 token from the enclosing buffer is returned. */
309 unsigned int return_at_eof : 1;
310
311 /* The directory of the this buffer's file. Its NAME member is not
312 allocated, so we don't need to worry about freeing it. */
313 struct cpp_dir dir;
314
315 /* Used for buffer overlays by cpptrad.c. */
316 const uchar *saved_cur, *saved_rlimit;
317};
318
319/* A cpp_reader encapsulates the "state" of a pre-processor run.
320 Applying cpp_get_token repeatedly yields a stream of pre-processor
321 tokens. Usually, there is only one cpp_reader object active. */
322struct cpp_reader
323{
324 /* Top of buffer stack. */
325 cpp_buffer *buffer;
326
327 /* Overlaid buffer (can be different after processing #include). */
328 cpp_buffer *overlaid_buffer;
329
330 /* Lexer state. */
331 struct lexer_state state;
332
333 /* Source line tracking. */
334 struct line_maps line_maps;
335 const struct line_map *map;
336 fileline line;
337
338 /* The line of the '#' of the current directive. */
339 fileline directive_line;
340
341 /* Memory buffers. */
342 _cpp_buff *a_buff; /* Aligned permanent storage. */
343 _cpp_buff *u_buff; /* Unaligned permanent storage. */
344 _cpp_buff *free_buffs; /* Free buffer chain. */
345
346 /* Context stack. */
347 struct cpp_context base_context;
348 struct cpp_context *context;
349
350 /* If in_directive, the directive if known. */
351 const struct directive *directive;
352
353 /* Search paths for include files. */
354 struct cpp_dir *quote_include; /* "" */
355 struct cpp_dir *bracket_include; /* <> */
356 struct cpp_dir no_search_path; /* No path. */
357
358 /* Chain of all hashed _cpp_file instances. */
359 struct _cpp_file *all_files;
360
361 struct _cpp_file *main_file;
362
363 /* File and directory hash table. */
364 struct htab *file_hash;
365 struct file_hash_entry *file_hash_entries;
366 unsigned int file_hash_entries_allocated, file_hash_entries_used;
367
368 /* Nonzero means don't look for #include "foo" the source-file
369 directory. */
370 bool quote_ignores_source_dir;
371
372 /* Nonzero if any file has contained #pragma once or #import has
373 been used. */
374 bool seen_once_only;
375
376 /* Multiple include optimization. */
377 const cpp_hashnode *mi_cmacro;
378 const cpp_hashnode *mi_ind_cmacro;
379 bool mi_valid;
380
381 /* Lexing. */
382 cpp_token *cur_token;
383 tokenrun base_run, *cur_run;
384 unsigned int lookaheads;
385
386 /* Nonzero prevents the lexer from re-using the token runs. */
387 unsigned int keep_tokens;
388
389 /* Error counter for exit code. */
390 unsigned int errors;
391
392 /* Buffer to hold macro definition string. */
393 unsigned char *macro_buffer;
394 unsigned int macro_buffer_len;
395
396 /* Descriptor for converting from the source character set to the
397 execution character set. */
398 struct cset_converter narrow_cset_desc;
399
400 /* Descriptor for converting from the source character set to the
401 wide execution character set. */
402 struct cset_converter wide_cset_desc;
403
404 /* Date and time text. Calculated together if either is requested. */
405 const uchar *date;
406 const uchar *time;
407
408 /* EOF token, and a token forcing paste avoidance. */
409 cpp_token avoid_paste;
410 cpp_token eof;
411
412 /* Opaque handle to the dependencies of mkdeps.c. */
413 struct deps *deps;
414
415 /* Obstack holding all macro hash nodes. This never shrinks.
416 See cpphash.c */
417 struct obstack hash_ob;
418
419 /* Obstack holding buffer and conditional structures. This is a
420 real stack. See cpplib.c. */
421 struct obstack buffer_ob;
422
423 /* Pragma table - dynamic, because a library user can add to the
424 list of recognized pragmas. */
425 struct pragma_entry *pragmas;
426
427 /* Call backs to cpplib client. */
428 struct cpp_callbacks cb;
429
430 /* Identifier hash table. */
431 struct ht *hash_table;
432
433 /* Expression parser stack. */
434 struct op *op_stack, *op_limit;
435
436 /* User visible options. */
437 struct cpp_options opts;
438
439 /* Special nodes - identifiers with predefined significance to the
440 preprocessor. */
441 struct spec_nodes spec_nodes;
442
443 /* Whether cpplib owns the hashtable. */
444 bool our_hashtable;
445
446 /* Traditional preprocessing output buffer (a logical line). */
447 struct
448 {
449 uchar *base;
450 uchar *limit;
451 uchar *cur;
452 fileline first_line;
453 } out;
454
455 /* Used to save the original line number during traditional
456 preprocessing. */
457 unsigned int saved_line;
458
459 /* A saved list of the defined macros, for dependency checking
460 of precompiled headers. */
461 struct cpp_savedstate *savedstate;
462};
463
464/* Character classes. Based on the more primitive macros in safe-ctype.h.
465 If the definition of `numchar' looks odd to you, please look up the
466 definition of a pp-number in the C standard [section 6.4.8 of C99].
467
468 In the unlikely event that characters other than \r and \n enter
469 the set is_vspace, the macro handle_newline() in cpplex.c must be
470 updated. */
471#define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
472
473#define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
474#define is_numchar(x) ISIDNUM(x)
475#define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
476#define is_numstart(x) ISDIGIT(x)
477#define is_hspace(x) ISBLANK(x)
478#define is_vspace(x) IS_VSPACE(x)
479#define is_nvspace(x) IS_NVSPACE(x)
480#define is_space(x) IS_SPACE_OR_NUL(x)
481
482/* This table is constant if it can be initialized at compile time,
483 which is the case if cpp was compiled with GCC >=2.7, or another
484 compiler that supports C99. */
485#if HAVE_DESIGNATED_INITIALIZERS
486extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
487#else
488extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
489#endif
490
491/* Macros. */
492
493#define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
494#define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
495#define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
496
497/* In cpperror.c */
498extern int _cpp_begin_message (cpp_reader *, int, fileline, unsigned int);
499
500/* In cppmacro.c */
501extern void _cpp_free_definition (cpp_hashnode *);
502extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
503extern void _cpp_pop_context (cpp_reader *);
504extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
505 const uchar *, size_t);
506extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
507extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
508 unsigned int);
509extern const uchar *_cpp_builtin_macro_text (cpp_reader *, cpp_hashnode *);
510int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
511/* In cpphash.c */
512extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
513extern void _cpp_destroy_hashtable (cpp_reader *);
514
515/* In cppfiles.c */
516typedef struct _cpp_file _cpp_file;
517extern _cpp_file *_cpp_find_file (cpp_reader *, const char *fname,
518 cpp_dir *start_dir, bool fake);
519extern bool _cpp_find_failed (_cpp_file *);
520extern void _cpp_mark_file_once_only (cpp_reader *, struct _cpp_file *);
521extern void _cpp_fake_include (cpp_reader *, const char *);
522extern bool _cpp_stack_file (cpp_reader *, _cpp_file*, bool);
523extern bool _cpp_stack_include (cpp_reader *, const char *, int,
524 enum include_type);
525extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
526extern void _cpp_report_missing_guards (cpp_reader *);
527extern void _cpp_init_files (cpp_reader *);
528extern void _cpp_cleanup_files (cpp_reader *);
529extern void _cpp_pop_file_buffer (cpp_reader *, struct _cpp_file *);
530
531/* In cppexp.c */
532extern bool _cpp_parse_expr (cpp_reader *);
533extern struct op *_cpp_expand_op_stack (cpp_reader *);
534
535/* In cpplex.c */
536extern void _cpp_process_line_notes (cpp_reader *, int);
537extern void _cpp_clean_line (cpp_reader *);
538extern bool _cpp_get_fresh_line (cpp_reader *);
539extern bool _cpp_skip_block_comment (cpp_reader *);
540extern cpp_token *_cpp_temp_token (cpp_reader *);
541extern const cpp_token *_cpp_lex_token (cpp_reader *);
542extern cpp_token *_cpp_lex_direct (cpp_reader *);
543extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
544extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
545
546/* In cppinit.c. */
547extern void _cpp_maybe_push_include_file (cpp_reader *);
548
549/* In cpplib.c */
550extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
551extern int _cpp_handle_directive (cpp_reader *, int);
552extern void _cpp_define_builtin (cpp_reader *, const char *);
553extern char ** _cpp_save_pragma_names (cpp_reader *);
554extern void _cpp_restore_pragma_names (cpp_reader *, char **);
555extern void _cpp_do__Pragma (cpp_reader *);
556extern void _cpp_init_directives (cpp_reader *);
557extern void _cpp_init_internal_pragmas (cpp_reader *);
558extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
559 unsigned int, unsigned int);
560extern void _cpp_pop_buffer (cpp_reader *);
561
562/* In cpptrad.c. */
563extern bool _cpp_scan_out_logical_line (cpp_reader *, cpp_macro *);
564extern bool _cpp_read_logical_line_trad (cpp_reader *);
565extern void _cpp_overlay_buffer (cpp_reader *pfile, const uchar *, size_t);
566extern void _cpp_remove_overlay (cpp_reader *);
567extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
568extern bool _cpp_expansions_different_trad (const cpp_macro *,
569 const cpp_macro *);
570extern uchar *_cpp_copy_replacement_text (const cpp_macro *, uchar *);
571extern size_t _cpp_replacement_text_len (const cpp_macro *);
572
573/* In cppcharset.c. */
574extern cppchar_t _cpp_valid_ucn (cpp_reader *, const uchar **,
575 const uchar *, int);
576extern void _cpp_destroy_iconv (cpp_reader *);
577extern bool _cpp_interpret_string_notranslate (cpp_reader *,
578 const cpp_string *,
579 cpp_string *);
580extern uchar *_cpp_convert_input (cpp_reader *, const char *, uchar *,
581 size_t, size_t, off_t *);
582extern const char *_cpp_default_encoding (void);
583
584
585/* Utility routines and macros. */
586#define DSC(str) (const uchar *)str, sizeof str - 1
587#define xnew(T) (T *) xmalloc (sizeof(T))
588#define xcnew(T) (T *) xcalloc (1, sizeof(T))
589#define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
590#define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
591#define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
592
593/* These are inline functions instead of macros so we can get type
594 checking. */
595static inline int ustrcmp (const uchar *, const uchar *);
596static inline int ustrncmp (const uchar *, const uchar *, size_t);
597static inline size_t ustrlen (const uchar *);
598static inline uchar *uxstrdup (const uchar *);
599static inline uchar *ustrchr (const uchar *, int);
600static inline int ufputs (const uchar *, FILE *);
601
602static inline int
603ustrcmp (const uchar *s1, const uchar *s2)
604{
605 return strcmp ((const char *)s1, (const char *)s2);
606}
607
608static inline int
609ustrncmp (const uchar *s1, const uchar *s2, size_t n)
610{
611 return strncmp ((const char *)s1, (const char *)s2, n);
612}
613
614static inline size_t
615ustrlen (const uchar *s1)
616{
617 return strlen ((const char *)s1);
618}
619
620static inline uchar *
621uxstrdup (const uchar *s1)
622{
623 return (uchar *) xstrdup ((const char *)s1);
624}
625
626static inline uchar *
627ustrchr (const uchar *s1, int c)
628{
629 return (uchar *) strchr ((const char *)s1, c);
630}
631
632static inline int
633ufputs (const uchar *s, FILE *f)
634{
635 return fputs ((const char *)s, f);
636}
637
638#endif /* ! GCC_CPPHASH_H */