2003-04-11 Eric Christopher <echristo@redhat.com>
[official-gcc.git] / gcc / cpphash.h
blobbc0d099599bfc3e2efed4099ac62197f2b6539ce
1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003
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, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
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. */
23 #ifndef GCC_CPPHASH_H
24 #define GCC_CPPHASH_H
26 #include "hashtable.h"
28 struct directive; /* Deliberately incomplete. */
29 struct pending_option;
30 struct op;
32 #ifndef HAVE_UCHAR
33 typedef unsigned char uchar;
34 #endif
35 #define U (const uchar *) /* Intended use: U"string" */
37 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
39 /* Test if a sign is valid within a preprocessing number. */
40 #define VALID_SIGN(c, prevc) \
41 (((c) == '+' || (c) == '-') && \
42 ((prevc) == 'e' || (prevc) == 'E' \
43 || (((prevc) == 'p' || (prevc) == 'P') \
44 && CPP_OPTION (pfile, extended_numbers))))
46 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
47 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
48 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
49 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
51 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
52 efficiency, and partly to limit runaway recursion. */
53 #define CPP_STACK_MAX 200
55 /* Host alignment handling. */
56 struct dummy
58 char c;
59 union
61 double d;
62 int *p;
63 } u;
66 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
67 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
68 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
70 /* Each macro definition is recorded in a cpp_macro structure.
71 Variadic macros cannot occur with traditional cpp. */
72 struct cpp_macro
74 /* Parameters, if any. */
75 cpp_hashnode **params;
77 /* Replacement tokens (ISO) or replacement text (traditional). See
78 comment at top of cpptrad.c for how traditional function-like
79 macros are encoded. */
80 union
82 cpp_token *tokens;
83 const uchar *text;
84 } exp;
86 /* Definition line number. */
87 unsigned int line;
89 /* Number of tokens in expansion, or bytes for traditional macros. */
90 unsigned int count;
92 /* Number of parameters. */
93 unsigned short paramc;
95 /* If a function-like macro. */
96 unsigned int fun_like : 1;
98 /* If a variadic macro. */
99 unsigned int variadic : 1;
101 /* If macro defined in system header. */
102 unsigned int syshdr : 1;
104 /* Nonzero if it has been expanded or had its existence tested. */
105 unsigned int used : 1;
108 #define _cpp_mark_macro_used(NODE) do { \
109 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
110 (NODE)->value.macro->used = 1; } while (0)
112 /* A generic memory buffer, and operations on it. */
113 typedef struct _cpp_buff _cpp_buff;
114 struct _cpp_buff
116 struct _cpp_buff *next;
117 unsigned char *base, *cur, *limit;
120 extern _cpp_buff *_cpp_get_buff PARAMS ((cpp_reader *, size_t));
121 extern void _cpp_release_buff PARAMS ((cpp_reader *, _cpp_buff *));
122 extern void _cpp_extend_buff PARAMS ((cpp_reader *, _cpp_buff **, size_t));
123 extern _cpp_buff *_cpp_append_extend_buff PARAMS ((cpp_reader *, _cpp_buff *,
124 size_t));
125 extern void _cpp_free_buff PARAMS ((_cpp_buff *));
126 extern unsigned char *_cpp_aligned_alloc PARAMS ((cpp_reader *, size_t));
127 extern unsigned char *_cpp_unaligned_alloc PARAMS ((cpp_reader *, size_t));
129 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
130 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
131 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
133 /* #include types. */
134 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
136 union utoken
138 const cpp_token *token;
139 const cpp_token **ptoken;
142 /* A "run" of tokens; part of a chain of runs. */
143 typedef struct tokenrun tokenrun;
144 struct tokenrun
146 tokenrun *next, *prev;
147 cpp_token *base, *limit;
150 /* Accessor macros for struct cpp_context. */
151 #define FIRST(c) ((c)->u.iso.first)
152 #define LAST(c) ((c)->u.iso.last)
153 #define CUR(c) ((c)->u.trad.cur)
154 #define RLIMIT(c) ((c)->u.trad.rlimit)
156 typedef struct cpp_context cpp_context;
157 struct cpp_context
159 /* Doubly-linked list. */
160 cpp_context *next, *prev;
162 union
164 /* For ISO macro expansion. Contexts other than the base context
165 are contiguous tokens. e.g. macro expansions, expanded
166 argument tokens. */
167 struct
169 union utoken first;
170 union utoken last;
171 } iso;
173 /* For traditional macro expansion. */
174 struct
176 const uchar *cur;
177 const uchar *rlimit;
178 } trad;
179 } u;
181 /* If non-NULL, a buffer used for storage related to this context.
182 When the context is popped, the buffer is released. */
183 _cpp_buff *buff;
185 /* For a macro context, the macro node, otherwise NULL. */
186 cpp_hashnode *macro;
188 /* True if utoken element is token, else ptoken. */
189 bool direct_p;
192 struct lexer_state
194 /* Nonzero if first token on line is CPP_HASH. */
195 unsigned char in_directive;
197 /* Nonzero if in a directive that will handle padding tokens itself.
198 #include needs this to avoid problems with computed include and
199 spacing between tokens. */
200 unsigned char directive_wants_padding;
202 /* True if we are skipping a failed conditional group. */
203 unsigned char skipping;
205 /* Nonzero if in a directive that takes angle-bracketed headers. */
206 unsigned char angled_headers;
208 /* Nonzero if in a #if or #elif directive. */
209 unsigned char in_expression;
211 /* Nonzero to save comments. Turned off if discard_comments, and in
212 all directives apart from #define. */
213 unsigned char save_comments;
215 /* Nonzero if we're mid-comment. */
216 unsigned char lexing_comment;
218 /* Nonzero if lexing __VA_ARGS__ is valid. */
219 unsigned char va_args_ok;
221 /* Nonzero if lexing poisoned identifiers is valid. */
222 unsigned char poisoned_ok;
224 /* Nonzero to prevent macro expansion. */
225 unsigned char prevent_expansion;
227 /* Nonzero when parsing arguments to a function-like macro. */
228 unsigned char parsing_args;
230 /* Nonzero to skip evaluating part of an expression. */
231 unsigned int skip_eval;
234 /* Special nodes - identifiers with predefined significance. */
235 struct spec_nodes
237 cpp_hashnode *n_defined; /* defined operator */
238 cpp_hashnode *n_true; /* C++ keyword true */
239 cpp_hashnode *n_false; /* C++ keyword false */
240 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
243 /* Represents the contents of a file cpplib has read in. */
244 struct cpp_buffer
246 const unsigned char *cur; /* current position */
247 const unsigned char *backup_to; /* if peeked character is not wanted */
248 const unsigned char *rlimit; /* end of valid data */
249 const unsigned char *line_base; /* start of current line */
251 struct cpp_buffer *prev;
253 const unsigned char *buf; /* Entire character buffer. */
255 /* Pointer into the include table; non-NULL if this is a file
256 buffer. Used for include_next and to record control macros. */
257 struct include_file *inc;
259 /* Value of if_stack at start of this file.
260 Used to prohibit unmatched #endif (etc) in an include file. */
261 struct if_stack *if_stack;
263 /* Token column position adjustment owing to tabs in whitespace. */
264 unsigned int col_adjust;
266 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
267 unsigned char saved_flags;
269 /* Because of the way the lexer works, -Wtrigraphs can sometimes
270 warn twice for the same trigraph. This helps prevent that. */
271 const unsigned char *last_Wtrigraphs;
273 /* True if we have already warned about C++ comments in this file.
274 The warning happens only for C89 extended mode with -pedantic on,
275 or for -Wtraditional, and only once per file (otherwise it would
276 be far too noisy). */
277 unsigned char warned_cplusplus_comments;
279 /* True if we don't process trigraphs and escaped newlines. True
280 for preprocessed input, command line directives, and _Pragma
281 buffers. */
282 unsigned char from_stage3;
284 /* Nonzero means that the directory to start searching for ""
285 include files has been calculated and stored in "dir" below. */
286 unsigned char search_cached;
288 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
289 true, a CPP_EOF token is then returned. Otherwise, the next
290 token from the enclosing buffer is returned. */
291 bool return_at_eof;
293 /* The directory of the this buffer's file. Its NAME member is not
294 allocated, so we don't need to worry about freeing it. */
295 struct cpp_path dir;
297 /* Used for buffer overlays by cpptrad.c. */
298 const uchar *saved_cur, *saved_rlimit;
301 /* A cpp_reader encapsulates the "state" of a pre-processor run.
302 Applying cpp_get_token repeatedly yields a stream of pre-processor
303 tokens. Usually, there is only one cpp_reader object active. */
304 struct cpp_reader
306 /* Top of buffer stack. */
307 cpp_buffer *buffer;
309 /* Overlaid buffer (can be different after processing #include). */
310 cpp_buffer *overlaid_buffer;
312 /* Lexer state. */
313 struct lexer_state state;
315 /* Source line tracking. */
316 struct line_maps line_maps;
317 const struct line_map *map;
318 unsigned int line;
320 /* The line of the '#' of the current directive. */
321 unsigned int 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 /* Search paths for include files. */
336 struct cpp_path *quote_include; /* "" */
337 struct cpp_path *bracket_include; /* <> */
339 /* Multiple include optimisation. */
340 const cpp_hashnode *mi_cmacro;
341 const cpp_hashnode *mi_ind_cmacro;
342 bool mi_valid;
344 /* Lexing. */
345 cpp_token *cur_token;
346 tokenrun base_run, *cur_run;
347 unsigned int lookaheads;
349 /* Nonzero prevents the lexer from re-using the token runs. */
350 unsigned int keep_tokens;
352 /* Error counter for exit code. */
353 unsigned int errors;
355 /* Buffer to hold macro definition string. */
356 unsigned char *macro_buffer;
357 unsigned int macro_buffer_len;
359 /* Tree of other included files. See cppfiles.c. */
360 struct splay_tree_s *all_include_files;
362 /* Current maximum length of directory names in the search path
363 for include files. (Altered as we get more of them.) */
364 unsigned int max_include_len;
366 /* Date and time text. Calculated together if either is requested. */
367 const uchar *date;
368 const uchar *time;
370 /* EOF token, and a token forcing paste avoidance. */
371 cpp_token avoid_paste;
372 cpp_token eof;
374 /* Opaque handle to the dependencies of mkdeps.c. */
375 struct deps *deps;
377 /* Obstack holding all macro hash nodes. This never shrinks.
378 See cpphash.c */
379 struct obstack hash_ob;
381 /* Obstack holding buffer and conditional structures. This is a
382 real stack. See cpplib.c. */
383 struct obstack buffer_ob;
385 /* Pragma table - dynamic, because a library user can add to the
386 list of recognized pragmas. */
387 struct pragma_entry *pragmas;
389 /* Call backs. */
390 struct cpp_callbacks cb;
392 /* Identifier hash table. */
393 struct ht *hash_table;
395 /* Expression parser stack. */
396 struct op *op_stack, *op_limit;
398 /* User visible options. */
399 struct cpp_options opts;
401 /* Special nodes - identifiers with predefined significance to the
402 preprocessor. */
403 struct spec_nodes spec_nodes;
405 /* Nonzero means don't look for #include "foo" the source-file
406 directory. */
407 unsigned char quote_ignores_source_dir;
409 /* Whether cpplib owns the hashtable. */
410 unsigned char our_hashtable;
412 /* Traditional preprocessing output buffer (a logical line). */
413 struct
415 uchar *base;
416 uchar *limit;
417 uchar *cur;
418 unsigned int first_line;
419 } out;
421 /* Used to save the original line number during traditional
422 preprocessing. */
423 unsigned int saved_line;
425 /* A saved list of the defined macros, for dependency checking
426 of precompiled headers. */
427 struct cpp_savedstate *savedstate;
430 /* Character classes. Based on the more primitive macros in safe-ctype.h.
431 If the definition of `numchar' looks odd to you, please look up the
432 definition of a pp-number in the C standard [section 6.4.8 of C99].
434 In the unlikely event that characters other than \r and \n enter
435 the set is_vspace, the macro handle_newline() in cpplex.c must be
436 updated. */
437 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
439 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
440 #define is_numchar(x) ISIDNUM(x)
441 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
442 #define is_numstart(x) ISDIGIT(x)
443 #define is_hspace(x) ISBLANK(x)
444 #define is_vspace(x) IS_VSPACE(x)
445 #define is_nvspace(x) IS_NVSPACE(x)
446 #define is_space(x) IS_SPACE_OR_NUL(x)
448 /* This table is constant if it can be initialized at compile time,
449 which is the case if cpp was compiled with GCC >=2.7, or another
450 compiler that supports C99. */
451 #if HAVE_DESIGNATED_INITIALIZERS
452 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
453 #else
454 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
455 #endif
457 /* Macros. */
459 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
460 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
461 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
463 /* In cpperror.c */
464 extern int _cpp_begin_message PARAMS ((cpp_reader *, int,
465 unsigned int, unsigned int));
467 /* In cppmacro.c */
468 extern void _cpp_free_definition PARAMS ((cpp_hashnode *));
469 extern bool _cpp_create_definition PARAMS ((cpp_reader *, cpp_hashnode *));
470 extern void _cpp_pop_context PARAMS ((cpp_reader *));
471 extern void _cpp_push_text_context PARAMS ((cpp_reader *, cpp_hashnode *,
472 const uchar *, size_t));
473 extern bool _cpp_save_parameter PARAMS ((cpp_reader *, cpp_macro *,
474 cpp_hashnode *));
475 extern bool _cpp_arguments_ok PARAMS ((cpp_reader *, cpp_macro *,
476 const cpp_hashnode *,
477 unsigned int));
478 extern const uchar *_cpp_builtin_macro_text PARAMS ((cpp_reader *,
479 cpp_hashnode *));
480 int _cpp_warn_if_unused_macro PARAMS ((cpp_reader *, cpp_hashnode *,
481 void *));
482 /* In cpphash.c */
483 extern void _cpp_init_hashtable PARAMS ((cpp_reader *, hash_table *));
484 extern void _cpp_destroy_hashtable PARAMS ((cpp_reader *));
486 /* In cppfiles.c */
487 extern void _cpp_fake_include PARAMS ((cpp_reader *, const char *));
488 extern void _cpp_never_reread PARAMS ((struct include_file *));
489 extern bool _cpp_read_file PARAMS ((cpp_reader *, const char *));
490 extern bool _cpp_execute_include PARAMS ((cpp_reader *,
491 const cpp_token *,
492 enum include_type));
493 extern int _cpp_compare_file_date PARAMS ((cpp_reader *,
494 const cpp_token *));
495 extern void _cpp_report_missing_guards PARAMS ((cpp_reader *));
496 extern void _cpp_init_includes PARAMS ((cpp_reader *));
497 extern void _cpp_cleanup_includes PARAMS ((cpp_reader *));
498 extern void _cpp_pop_file_buffer PARAMS ((cpp_reader *,
499 struct include_file *));
501 /* In cppexp.c */
502 extern bool _cpp_parse_expr PARAMS ((cpp_reader *));
503 extern struct op *_cpp_expand_op_stack PARAMS ((cpp_reader *));
505 /* In cpplex.c */
506 extern cpp_token *_cpp_temp_token PARAMS ((cpp_reader *));
507 extern const cpp_token *_cpp_lex_token PARAMS ((cpp_reader *));
508 extern cpp_token *_cpp_lex_direct PARAMS ((cpp_reader *));
509 extern int _cpp_equiv_tokens PARAMS ((const cpp_token *,
510 const cpp_token *));
511 extern void _cpp_init_tokenrun PARAMS ((tokenrun *, unsigned int));
512 extern void _cpp_init_mbchar PARAMS ((void));
514 /* In cppinit.c. */
515 extern void _cpp_maybe_push_include_file PARAMS ((cpp_reader *));
517 /* In cpplib.c */
518 extern int _cpp_test_assertion PARAMS ((cpp_reader *, unsigned int *));
519 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
520 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
521 extern char ** _cpp_save_pragma_names PARAMS ((cpp_reader *));
522 extern void _cpp_restore_pragma_names PARAMS ((cpp_reader *, char **));
523 extern void _cpp_do__Pragma PARAMS ((cpp_reader *));
524 extern void _cpp_init_directives PARAMS ((cpp_reader *));
525 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
526 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
527 const char *,
528 unsigned int, unsigned int));
529 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
531 /* In cpptrad.c. */
532 extern bool _cpp_read_logical_line_trad PARAMS ((cpp_reader *));
533 extern void _cpp_overlay_buffer PARAMS ((cpp_reader *pfile, const uchar *,
534 size_t));
535 extern void _cpp_remove_overlay PARAMS ((cpp_reader *));
536 extern bool _cpp_create_trad_definition PARAMS ((cpp_reader *, cpp_macro *));
537 extern bool _cpp_expansions_different_trad PARAMS ((const cpp_macro *,
538 const cpp_macro *));
539 extern uchar *_cpp_copy_replacement_text PARAMS ((const cpp_macro *, uchar *));
540 extern size_t _cpp_replacement_text_len PARAMS ((const cpp_macro *));
542 /* Utility routines and macros. */
543 #define DSC(str) (const uchar *)str, sizeof str - 1
544 #define xnew(T) (T *) xmalloc (sizeof(T))
545 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
546 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
547 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
548 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
550 /* These are inline functions instead of macros so we can get type
551 checking. */
552 static inline int ustrcmp PARAMS ((const uchar *, const uchar *));
553 static inline int ustrncmp PARAMS ((const uchar *, const uchar *,
554 size_t));
555 static inline size_t ustrlen PARAMS ((const uchar *));
556 static inline uchar *uxstrdup PARAMS ((const uchar *));
557 static inline uchar *ustrchr PARAMS ((const uchar *, int));
558 static inline int ufputs PARAMS ((const uchar *, FILE *));
560 static inline int
561 ustrcmp (s1, s2)
562 const uchar *s1, *s2;
564 return strcmp ((const char *)s1, (const char *)s2);
567 static inline int
568 ustrncmp (s1, s2, n)
569 const uchar *s1, *s2;
570 size_t n;
572 return strncmp ((const char *)s1, (const char *)s2, n);
575 static inline size_t
576 ustrlen (s1)
577 const uchar *s1;
579 return strlen ((const char *)s1);
582 static inline uchar *
583 uxstrdup (s1)
584 const uchar *s1;
586 return (uchar *) xstrdup ((const char *)s1);
589 static inline uchar *
590 ustrchr (s1, c)
591 const uchar *s1;
592 int c;
594 return (uchar *) strchr ((const char *)s1, c);
597 static inline int
598 ufputs (s, f)
599 const uchar *s;
600 FILE *f;
602 return fputs ((const char *)s, f);
605 #endif /* ! GCC_CPPHASH_H */