Merge from mainline
[official-gcc.git] / gcc / cpphash.h
blob98dfb49ca7c377c89e71008d9b5abcec95622862
1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002
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 typedef unsigned char uchar;
33 #define U (const uchar *) /* Intended use: U"string" */
35 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
37 /* Test if a sign is valid within a preprocessing number. */
38 #define VALID_SIGN(c, prevc) \
39 (((c) == '+' || (c) == '-') && \
40 ((prevc) == 'e' || (prevc) == 'E' \
41 || (((prevc) == 'p' || (prevc) == 'P') \
42 && CPP_OPTION (pfile, extended_numbers))))
44 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
45 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
46 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
47 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
49 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
50 efficiency, and partly to limit runaway recursion. */
51 #define CPP_STACK_MAX 200
53 /* Host alignment handling. */
54 struct dummy
56 char c;
57 union
59 double d;
60 int *p;
61 } u;
64 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
65 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
66 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
68 /* Each macro definition is recorded in a cpp_macro structure.
69 Variadic macros cannot occur with traditional cpp. */
70 struct cpp_macro
72 /* Parameters, if any. */
73 cpp_hashnode **params;
75 /* Replacement tokens (ISO) or replacement text (traditional). See
76 comment at top of cpptrad.c for how traditional function-like
77 macros are encoded. */
78 union
80 cpp_token *tokens;
81 const uchar *text;
82 } exp;
84 /* Definition line number. */
85 unsigned int line;
87 /* Number of tokens in expansion, or bytes for traditional macros. */
88 unsigned int count;
90 /* Number of parameters. */
91 unsigned short paramc;
93 /* If a function-like macro. */
94 unsigned int fun_like : 1;
96 /* If a variadic macro. */
97 unsigned int variadic : 1;
99 /* If macro defined in system header. */
100 unsigned int syshdr : 1;
103 /* A generic memory buffer, and operations on it. */
104 typedef struct _cpp_buff _cpp_buff;
105 struct _cpp_buff
107 struct _cpp_buff *next;
108 unsigned char *base, *cur, *limit;
111 extern _cpp_buff *_cpp_get_buff PARAMS ((cpp_reader *, size_t));
112 extern void _cpp_release_buff PARAMS ((cpp_reader *, _cpp_buff *));
113 extern void _cpp_extend_buff PARAMS ((cpp_reader *, _cpp_buff **, size_t));
114 extern _cpp_buff *_cpp_append_extend_buff PARAMS ((cpp_reader *, _cpp_buff *,
115 size_t));
116 extern void _cpp_free_buff PARAMS ((_cpp_buff *));
117 extern unsigned char *_cpp_aligned_alloc PARAMS ((cpp_reader *, size_t));
118 extern unsigned char *_cpp_unaligned_alloc PARAMS ((cpp_reader *, size_t));
120 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
121 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
122 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
124 /* List of directories to look for include files in. */
125 struct search_path
127 struct search_path *next;
129 /* NOTE: NAME may not be null terminated for the case of the current
130 file's directory! */
131 const char *name;
132 unsigned int len;
133 /* We use these to tell if the directory mentioned here is a duplicate
134 of an earlier directory on the search path. */
135 ino_t ino;
136 dev_t dev;
137 /* Non-zero if it is a system include directory. */
138 int sysp;
139 /* Mapping of file names for this directory. Only used on MS-DOS
140 and related platforms. */
141 struct file_name_map *name_map;
144 /* #include types. */
145 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
147 union utoken
149 const cpp_token *token;
150 const cpp_token **ptoken;
153 /* A "run" of tokens; part of a chain of runs. */
154 typedef struct tokenrun tokenrun;
155 struct tokenrun
157 tokenrun *next, *prev;
158 cpp_token *base, *limit;
161 /* Accessor macros for struct cpp_context. */
162 #define FIRST(c) (c->u.iso.first)
163 #define LAST(c) (c->u.iso.last)
164 #define CUR(c) (c->u.trad.cur)
165 #define RLIMIT(c) (c->u.trad.rlimit)
167 typedef struct cpp_context cpp_context;
168 struct cpp_context
170 /* Doubly-linked list. */
171 cpp_context *next, *prev;
173 union
175 /* For ISO macro expansion. Contexts other than the base context
176 are contiguous tokens. e.g. macro expansions, expanded
177 argument tokens. */
178 struct
180 union utoken first;
181 union utoken last;
182 } iso;
184 /* For traditional macro expansion. */
185 struct
187 const uchar *cur;
188 const uchar *rlimit;
189 } trad;
190 } u;
192 /* If non-NULL, a buffer used for storage related to this context.
193 When the context is popped, the buffer is released. */
194 _cpp_buff *buff;
196 /* For a macro context, the macro node, otherwise NULL. */
197 cpp_hashnode *macro;
199 /* True if utoken element is token, else ptoken. */
200 bool direct_p;
203 struct lexer_state
205 /* Nonzero if first token on line is CPP_HASH. */
206 unsigned char in_directive;
208 /* True if we are skipping a failed conditional group. */
209 unsigned char skipping;
211 /* Nonzero if in a directive that takes angle-bracketed headers. */
212 unsigned char angled_headers;
214 /* Nonzero if in a #if or #elif directive. */
215 unsigned char in_expression;
217 /* Nonzero to save comments. Turned off if discard_comments, and in
218 all directives apart from #define. */
219 unsigned char save_comments;
221 /* Nonzero if we're mid-comment. */
222 unsigned char lexing_comment;
224 /* Nonzero if lexing __VA_ARGS__ is valid. */
225 unsigned char va_args_ok;
227 /* Nonzero if lexing poisoned identifiers is valid. */
228 unsigned char poisoned_ok;
230 /* Nonzero to prevent macro expansion. */
231 unsigned char prevent_expansion;
233 /* Nonzero when parsing arguments to a function-like macro. */
234 unsigned char parsing_args;
236 /* Nonzero to skip evaluating part of an expression. */
237 unsigned int skip_eval;
240 /* Special nodes - identifiers with predefined significance. */
241 struct spec_nodes
243 cpp_hashnode *n_defined; /* defined operator */
244 cpp_hashnode *n_true; /* C++ keyword true */
245 cpp_hashnode *n_false; /* C++ keyword false */
246 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
249 /* Represents the contents of a file cpplib has read in. */
250 struct cpp_buffer
252 const unsigned char *cur; /* current position */
253 const unsigned char *backup_to; /* if peeked character is not wanted */
254 const unsigned char *rlimit; /* end of valid data */
255 const unsigned char *line_base; /* start of current line */
257 struct cpp_buffer *prev;
259 const unsigned char *buf; /* Entire character buffer. */
261 /* Pointer into the include table; non-NULL if this is a file
262 buffer. Used for include_next and to record control macros. */
263 struct include_file *inc;
265 /* Value of if_stack at start of this file.
266 Used to prohibit unmatched #endif (etc) in an include file. */
267 struct if_stack *if_stack;
269 /* Token column position adjustment owing to tabs in whitespace. */
270 unsigned int col_adjust;
272 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
273 unsigned char saved_flags;
275 /* Because of the way the lexer works, -Wtrigraphs can sometimes
276 warn twice for the same trigraph. This helps prevent that. */
277 const unsigned char *last_Wtrigraphs;
279 /* True if we have already warned about C++ comments in this file.
280 The warning happens only for C89 extended mode with -pedantic on,
281 or for -Wtraditional, and only once per file (otherwise it would
282 be far too noisy). */
283 unsigned char warned_cplusplus_comments;
285 /* True if we don't process trigraphs and escaped newlines. True
286 for preprocessed input, command line directives, and _Pragma
287 buffers. */
288 unsigned char from_stage3;
290 /* Nonzero means that the directory to start searching for ""
291 include files has been calculated and stored in "dir" below. */
292 unsigned char search_cached;
294 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
295 true, a CPP_EOF token is then returned. Otherwise, the next
296 token from the enclosing buffer is returned. */
297 bool return_at_eof;
299 /* The directory of the this buffer's file. Its NAME member is not
300 allocated, so we don't need to worry about freeing it. */
301 struct search_path dir;
303 /* Used for buffer overlays by cpptrad.c. */
304 const uchar *saved_cur, *saved_rlimit;
307 /* A cpp_reader encapsulates the "state" of a pre-processor run.
308 Applying cpp_get_token repeatedly yields a stream of pre-processor
309 tokens. Usually, there is only one cpp_reader object active. */
310 struct cpp_reader
312 /* Top of buffer stack. */
313 cpp_buffer *buffer;
315 /* Overlaid buffer (can be different after processing #include). */
316 cpp_buffer *overlaid_buffer;
318 /* Lexer state. */
319 struct lexer_state state;
321 /* Source line tracking. */
322 struct line_maps line_maps;
323 const struct line_map *map;
324 unsigned int line;
326 /* The line of the '#' of the current directive. */
327 unsigned int directive_line;
329 /* Memory buffers. */
330 _cpp_buff *a_buff; /* Aligned permanent storage. */
331 _cpp_buff *u_buff; /* Unaligned permanent storage. */
332 _cpp_buff *free_buffs; /* Free buffer chain. */
334 /* Context stack. */
335 struct cpp_context base_context;
336 struct cpp_context *context;
338 /* If in_directive, the directive if known. */
339 const struct directive *directive;
341 /* The next -include-d file; NULL if they all are done. If it
342 points to NULL, the last one is in progress, and
343 _cpp_maybe_push_include_file has yet to restore the line map. */
344 struct pending_option **next_include_file;
346 /* Multiple inlcude optimisation. */
347 const cpp_hashnode *mi_cmacro;
348 const cpp_hashnode *mi_ind_cmacro;
349 bool mi_valid;
351 /* Lexing. */
352 cpp_token *cur_token;
353 tokenrun base_run, *cur_run;
354 unsigned int lookaheads;
356 /* Non-zero prevents the lexer from re-using the token runs. */
357 unsigned int keep_tokens;
359 /* Error counter for exit code. */
360 unsigned int errors;
362 /* Buffer to hold macro definition string. */
363 unsigned char *macro_buffer;
364 unsigned int macro_buffer_len;
366 /* Tree of other included files. See cppfiles.c. */
367 struct splay_tree_s *all_include_files;
369 /* Current maximum length of directory names in the search path
370 for include files. (Altered as we get more of them.) */
371 unsigned int max_include_len;
373 /* Date and time tokens. Calculated together if either is requested. */
374 cpp_token date;
375 cpp_token time;
377 /* EOF token, and a token forcing paste avoidance. */
378 cpp_token avoid_paste;
379 cpp_token eof;
381 /* Opaque handle to the dependencies of mkdeps.c. Used by -M etc. */
382 struct deps *deps;
384 /* Obstack holding all macro hash nodes. This never shrinks.
385 See cpphash.c */
386 struct obstack hash_ob;
388 /* Obstack holding buffer and conditional structures. This is a
389 real stack. See cpplib.c. */
390 struct obstack buffer_ob;
392 /* Pragma table - dynamic, because a library user can add to the
393 list of recognized pragmas. */
394 struct pragma_entry *pragmas;
396 /* Call backs. */
397 struct cpp_callbacks cb;
399 /* Identifier hash table. */
400 struct ht *hash_table;
402 /* Expression parser stack. */
403 struct op *op_stack, *op_limit;
405 /* User visible options. */
406 struct cpp_options opts;
408 /* Special nodes - identifiers with predefined significance to the
409 preprocessor. */
410 struct spec_nodes spec_nodes;
412 /* Whether cpplib owns the hashtable. */
413 unsigned char our_hashtable;
415 /* Traditional preprocessing output buffer (a logical line). */
416 struct
418 uchar *base;
419 uchar *limit;
420 uchar *cur;
421 unsigned int first_line;
422 } out;
424 /* Used to save the original line number during traditional
425 preprocessing. */
426 unsigned int saved_line;
429 /* Character classes. Based on the more primitive macros in safe-ctype.h.
430 If the definition of `numchar' looks odd to you, please look up the
431 definition of a pp-number in the C standard [section 6.4.8 of C99].
433 In the unlikely event that characters other than \r and \n enter
434 the set is_vspace, the macro handle_newline() in cpplex.c must be
435 updated. */
436 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
438 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
439 #define is_numchar(x) ISIDNUM(x)
440 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
441 #define is_numstart(x) ISDIGIT(x)
442 #define is_hspace(x) ISBLANK(x)
443 #define is_vspace(x) IS_VSPACE(x)
444 #define is_nvspace(x) IS_NVSPACE(x)
445 #define is_space(x) IS_SPACE_OR_NUL(x)
447 /* This table is constant if it can be initialized at compile time,
448 which is the case if cpp was compiled with GCC >=2.7, or another
449 compiler that supports C99. */
450 #if HAVE_DESIGNATED_INITIALIZERS
451 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
452 #else
453 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
454 #endif
456 /* Macros. */
458 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
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));
479 /* In cpphash.c */
480 extern void _cpp_init_hashtable PARAMS ((cpp_reader *, hash_table *));
481 extern void _cpp_destroy_hashtable PARAMS ((cpp_reader *));
483 /* In cppfiles.c */
484 extern void _cpp_fake_include PARAMS ((cpp_reader *, const char *));
485 extern void _cpp_never_reread PARAMS ((struct include_file *));
486 extern char *_cpp_simplify_pathname PARAMS ((char *));
487 extern bool _cpp_read_file PARAMS ((cpp_reader *, const char *));
488 extern bool _cpp_execute_include PARAMS ((cpp_reader *,
489 const cpp_token *,
490 enum include_type));
491 extern int _cpp_compare_file_date PARAMS ((cpp_reader *,
492 const cpp_token *));
493 extern void _cpp_report_missing_guards PARAMS ((cpp_reader *));
494 extern void _cpp_init_includes PARAMS ((cpp_reader *));
495 extern void _cpp_cleanup_includes PARAMS ((cpp_reader *));
496 extern void _cpp_pop_file_buffer PARAMS ((cpp_reader *,
497 struct include_file *));
499 /* In cppexp.c */
500 extern bool _cpp_parse_expr PARAMS ((cpp_reader *));
501 extern struct op *_cpp_expand_op_stack PARAMS ((cpp_reader *));
503 /* In cpplex.c */
504 extern cpp_token *_cpp_temp_token PARAMS ((cpp_reader *));
505 extern const cpp_token *_cpp_lex_token PARAMS ((cpp_reader *));
506 extern cpp_token *_cpp_lex_direct PARAMS ((cpp_reader *));
507 extern int _cpp_equiv_tokens PARAMS ((const cpp_token *,
508 const cpp_token *));
509 extern void _cpp_init_tokenrun PARAMS ((tokenrun *, unsigned int));
511 /* In cppinit.c. */
512 extern void _cpp_maybe_push_include_file PARAMS ((cpp_reader *));
514 /* In cpplib.c */
515 extern int _cpp_test_assertion PARAMS ((cpp_reader *, unsigned int *));
516 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
517 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
518 extern void _cpp_do__Pragma PARAMS ((cpp_reader *));
519 extern void _cpp_init_directives PARAMS ((cpp_reader *));
520 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
521 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
522 const char *,
523 unsigned int, unsigned int));
524 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
526 /* In cpptrad.c. */
527 extern bool _cpp_read_logical_line_trad PARAMS ((cpp_reader *));
528 extern void _cpp_overlay_buffer PARAMS ((cpp_reader *pfile, const uchar *,
529 size_t));
530 extern void _cpp_remove_overlay PARAMS ((cpp_reader *));
531 extern void _cpp_set_trad_context PARAMS ((cpp_reader *));
532 extern bool _cpp_create_trad_definition PARAMS ((cpp_reader *, cpp_macro *));
533 extern bool _cpp_expansions_different_trad PARAMS ((const cpp_macro *,
534 const cpp_macro *));
536 /* Utility routines and macros. */
537 #define DSC(str) (const uchar *)str, sizeof str - 1
538 #define xnew(T) (T *) xmalloc (sizeof(T))
539 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
540 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
541 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
542 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
544 /* These are inline functions instead of macros so we can get type
545 checking. */
546 static inline int ustrcmp PARAMS ((const uchar *, const uchar *));
547 static inline int ustrncmp PARAMS ((const uchar *, const uchar *,
548 size_t));
549 static inline size_t ustrlen PARAMS ((const uchar *));
550 static inline uchar *uxstrdup PARAMS ((const uchar *));
551 static inline uchar *ustrchr PARAMS ((const uchar *, int));
552 static inline int ufputs PARAMS ((const uchar *, FILE *));
554 static inline int
555 ustrcmp (s1, s2)
556 const uchar *s1, *s2;
558 return strcmp ((const char *)s1, (const char *)s2);
561 static inline int
562 ustrncmp (s1, s2, n)
563 const uchar *s1, *s2;
564 size_t n;
566 return strncmp ((const char *)s1, (const char *)s2, n);
569 static inline size_t
570 ustrlen (s1)
571 const uchar *s1;
573 return strlen ((const char *)s1);
576 static inline uchar *
577 uxstrdup (s1)
578 const uchar *s1;
580 return (uchar *) xstrdup ((const char *)s1);
583 static inline uchar *
584 ustrchr (s1, c)
585 const uchar *s1;
586 int c;
588 return (uchar *) strchr ((const char *)s1, c);
591 static inline int
592 ufputs (s, f)
593 const uchar *s;
594 FILE *f;
596 return fputs ((const char *)s, f);
599 #endif /* ! GCC_CPPHASH_H */