* Makefile.tpl: Fix stupid pasto.
[official-gcc.git] / gcc / cpphash.h
blobaa5eec4e9d44018183acfe27d212d0873c9531d2
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)
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 lexing __VA_ARGS__ is valid. */
216 unsigned char va_args_ok;
218 /* Nonzero if lexing poisoned identifiers is valid. */
219 unsigned char poisoned_ok;
221 /* Nonzero to prevent macro expansion. */
222 unsigned char prevent_expansion;
224 /* Nonzero when parsing arguments to a function-like macro. */
225 unsigned char parsing_args;
227 /* Nonzero to skip evaluating part of an expression. */
228 unsigned int skip_eval;
231 /* Special nodes - identifiers with predefined significance. */
232 struct spec_nodes
234 cpp_hashnode *n_defined; /* defined operator */
235 cpp_hashnode *n_true; /* C++ keyword true */
236 cpp_hashnode *n_false; /* C++ keyword false */
237 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
240 typedef struct _cpp_line_note _cpp_line_note;
241 struct _cpp_line_note
243 /* Location in the clean line the note refers to. */
244 const uchar *pos;
246 /* Type of note. The 9 'from' trigraph characters represent those
247 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
248 intervening space, and anything else is invalid. */
249 unsigned int type;
252 /* Represents the contents of a file cpplib has read in. */
253 struct cpp_buffer
255 const uchar *cur; /* Current location. */
256 const uchar *line_base; /* Start of current physical line. */
257 const uchar *next_line; /* Start of to-be-cleaned logical line. */
259 const uchar *buf; /* Entire character buffer. */
260 const uchar *rlimit; /* Writable byte at end of file. */
262 _cpp_line_note *notes; /* Array of notes. */
263 unsigned int cur_note; /* Next note to process. */
264 unsigned int notes_used; /* Number of notes. */
265 unsigned int notes_cap; /* Size of allocated array. */
267 struct cpp_buffer *prev;
269 /* Pointer into the include table; non-NULL if this is a file
270 buffer. Used for include_next and to record control macros. */
271 struct include_file *inc;
273 /* Value of if_stack at start of this file.
274 Used to prohibit unmatched #endif (etc) in an include file. */
275 struct if_stack *if_stack;
277 /* True if we need to get the next clean line. */
278 bool need_line;
280 /* True if we have already warned about C++ comments in this file.
281 The warning happens only for C89 extended mode with -pedantic on,
282 or for -Wtraditional, and only once per file (otherwise it would
283 be far too noisy). */
284 unsigned char warned_cplusplus_comments;
286 /* True if we don't process trigraphs and escaped newlines. True
287 for preprocessed input, command line directives, and _Pragma
288 buffers. */
289 unsigned char from_stage3;
291 /* Nonzero means that the directory to start searching for ""
292 include files has been calculated and stored in "dir" below. */
293 unsigned char search_cached;
295 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
296 true, a CPP_EOF token is then returned. Otherwise, the next
297 token from the enclosing buffer is returned. */
298 bool return_at_eof;
300 /* The directory of the this buffer's file. Its NAME member is not
301 allocated, so we don't need to worry about freeing it. */
302 struct cpp_path dir;
304 /* Used for buffer overlays by cpptrad.c. */
305 const uchar *saved_cur, *saved_rlimit;
308 /* A cpp_reader encapsulates the "state" of a pre-processor run.
309 Applying cpp_get_token repeatedly yields a stream of pre-processor
310 tokens. Usually, there is only one cpp_reader object active. */
311 struct cpp_reader
313 /* Top of buffer stack. */
314 cpp_buffer *buffer;
316 /* Overlaid buffer (can be different after processing #include). */
317 cpp_buffer *overlaid_buffer;
319 /* Lexer state. */
320 struct lexer_state state;
322 /* Source line tracking. */
323 struct line_maps line_maps;
324 const struct line_map *map;
325 unsigned int line;
327 /* The line of the '#' of the current directive. */
328 unsigned int directive_line;
330 /* Memory buffers. */
331 _cpp_buff *a_buff; /* Aligned permanent storage. */
332 _cpp_buff *u_buff; /* Unaligned permanent storage. */
333 _cpp_buff *free_buffs; /* Free buffer chain. */
335 /* Context stack. */
336 struct cpp_context base_context;
337 struct cpp_context *context;
339 /* If in_directive, the directive if known. */
340 const struct directive *directive;
342 /* Search paths for include files. */
343 struct cpp_path *quote_include; /* "" */
344 struct cpp_path *bracket_include; /* <> */
346 /* Multiple include 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 /* Nonzero 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 text. Calculated together if either is requested. */
374 const uchar *date;
375 const uchar *time;
377 /* EOF token, and a token forcing paste avoidance. */
378 cpp_token avoid_paste;
379 cpp_token eof;
381 /* True if we should warn about dollars in identifiers or numbers
382 for this translation unit. */
383 bool warn_dollars;
385 /* Opaque handle to the dependencies of mkdeps.c. */
386 struct deps *deps;
388 /* Obstack holding all macro hash nodes. This never shrinks.
389 See cpphash.c */
390 struct obstack hash_ob;
392 /* Obstack holding buffer and conditional structures. This is a
393 real stack. See cpplib.c. */
394 struct obstack buffer_ob;
396 /* Pragma table - dynamic, because a library user can add to the
397 list of recognized pragmas. */
398 struct pragma_entry *pragmas;
400 /* Call backs. */
401 struct cpp_callbacks cb;
403 /* Identifier hash table. */
404 struct ht *hash_table;
406 /* Expression parser stack. */
407 struct op *op_stack, *op_limit;
409 /* User visible options. */
410 struct cpp_options opts;
412 /* Special nodes - identifiers with predefined significance to the
413 preprocessor. */
414 struct spec_nodes spec_nodes;
416 /* Nonzero means don't look for #include "foo" the source-file
417 directory. */
418 unsigned char quote_ignores_source_dir;
420 /* Whether cpplib owns the hashtable. */
421 unsigned char our_hashtable;
423 /* Traditional preprocessing output buffer (a logical line). */
424 struct
426 uchar *base;
427 uchar *limit;
428 uchar *cur;
429 unsigned int first_line;
430 } out;
432 /* Used to save the original line number during traditional
433 preprocessing. */
434 unsigned int saved_line;
436 /* A saved list of the defined macros, for dependency checking
437 of precompiled headers. */
438 struct cpp_savedstate *savedstate;
441 /* Character classes. Based on the more primitive macros in safe-ctype.h.
442 If the definition of `numchar' looks odd to you, please look up the
443 definition of a pp-number in the C standard [section 6.4.8 of C99].
445 In the unlikely event that characters other than \r and \n enter
446 the set is_vspace, the macro handle_newline() in cpplex.c must be
447 updated. */
448 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
450 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
451 #define is_numchar(x) ISIDNUM(x)
452 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
453 #define is_numstart(x) ISDIGIT(x)
454 #define is_hspace(x) ISBLANK(x)
455 #define is_vspace(x) IS_VSPACE(x)
456 #define is_nvspace(x) IS_NVSPACE(x)
457 #define is_space(x) IS_SPACE_OR_NUL(x)
459 /* This table is constant if it can be initialized at compile time,
460 which is the case if cpp was compiled with GCC >=2.7, or another
461 compiler that supports C99. */
462 #if HAVE_DESIGNATED_INITIALIZERS
463 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
464 #else
465 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
466 #endif
468 /* Macros. */
470 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
471 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
472 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
474 /* In cpperror.c */
475 extern int _cpp_begin_message PARAMS ((cpp_reader *, int,
476 unsigned int, unsigned int));
478 /* In cppmacro.c */
479 extern void _cpp_free_definition PARAMS ((cpp_hashnode *));
480 extern bool _cpp_create_definition PARAMS ((cpp_reader *, cpp_hashnode *));
481 extern void _cpp_pop_context PARAMS ((cpp_reader *));
482 extern void _cpp_push_text_context PARAMS ((cpp_reader *, cpp_hashnode *,
483 const uchar *, size_t));
484 extern bool _cpp_save_parameter PARAMS ((cpp_reader *, cpp_macro *,
485 cpp_hashnode *));
486 extern bool _cpp_arguments_ok PARAMS ((cpp_reader *, cpp_macro *,
487 const cpp_hashnode *,
488 unsigned int));
489 extern const uchar *_cpp_builtin_macro_text PARAMS ((cpp_reader *,
490 cpp_hashnode *));
491 int _cpp_warn_if_unused_macro PARAMS ((cpp_reader *, cpp_hashnode *,
492 void *));
493 /* In cpphash.c */
494 extern void _cpp_init_hashtable PARAMS ((cpp_reader *, hash_table *));
495 extern void _cpp_destroy_hashtable PARAMS ((cpp_reader *));
497 /* In cppfiles.c */
498 extern void _cpp_fake_include PARAMS ((cpp_reader *, const char *));
499 extern void _cpp_never_reread PARAMS ((struct include_file *));
500 extern bool _cpp_read_file PARAMS ((cpp_reader *, const char *));
501 extern bool _cpp_execute_include PARAMS ((cpp_reader *, const char *,
502 int, enum include_type));
503 extern int _cpp_compare_file_date PARAMS ((cpp_reader *, const char *,
504 int));
505 extern void _cpp_report_missing_guards PARAMS ((cpp_reader *));
506 extern void _cpp_init_includes PARAMS ((cpp_reader *));
507 extern void _cpp_cleanup_includes PARAMS ((cpp_reader *));
508 extern void _cpp_pop_file_buffer PARAMS ((cpp_reader *,
509 struct include_file *));
511 /* In cppexp.c */
512 extern bool _cpp_parse_expr PARAMS ((cpp_reader *));
513 extern struct op *_cpp_expand_op_stack PARAMS ((cpp_reader *));
515 /* In cpplex.c */
516 extern void _cpp_process_line_notes PARAMS ((cpp_reader *, int));
517 extern void _cpp_clean_line PARAMS ((cpp_reader *));
518 extern bool _cpp_get_fresh_line PARAMS ((cpp_reader *));
519 extern bool _cpp_skip_block_comment PARAMS ((cpp_reader *));
520 extern cpp_token *_cpp_temp_token PARAMS ((cpp_reader *));
521 extern const cpp_token *_cpp_lex_token PARAMS ((cpp_reader *));
522 extern cpp_token *_cpp_lex_direct PARAMS ((cpp_reader *));
523 extern int _cpp_equiv_tokens PARAMS ((const cpp_token *,
524 const cpp_token *));
525 extern void _cpp_init_tokenrun PARAMS ((tokenrun *, unsigned int));
527 /* In cppinit.c. */
528 extern void _cpp_maybe_push_include_file PARAMS ((cpp_reader *));
530 /* In cpplib.c */
531 extern int _cpp_test_assertion PARAMS ((cpp_reader *, unsigned int *));
532 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
533 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
534 extern char ** _cpp_save_pragma_names PARAMS ((cpp_reader *));
535 extern void _cpp_restore_pragma_names PARAMS ((cpp_reader *, char **));
536 extern void _cpp_do__Pragma PARAMS ((cpp_reader *));
537 extern void _cpp_init_directives PARAMS ((cpp_reader *));
538 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
539 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
540 const char *,
541 unsigned int, unsigned int));
542 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
544 /* In cpptrad.c. */
545 extern bool scan_out_logical_line PARAMS ((cpp_reader *, cpp_macro *));
546 extern bool _cpp_read_logical_line_trad PARAMS ((cpp_reader *));
547 extern void _cpp_overlay_buffer PARAMS ((cpp_reader *pfile, const uchar *,
548 size_t));
549 extern void _cpp_remove_overlay PARAMS ((cpp_reader *));
550 extern bool _cpp_create_trad_definition PARAMS ((cpp_reader *, cpp_macro *));
551 extern bool _cpp_expansions_different_trad PARAMS ((const cpp_macro *,
552 const cpp_macro *));
553 extern uchar *_cpp_copy_replacement_text PARAMS ((const cpp_macro *, uchar *));
554 extern size_t _cpp_replacement_text_len PARAMS ((const cpp_macro *));
556 /* In cppcharset.c. */
557 cppchar_t _cpp_valid_ucn PARAMS ((cpp_reader *, const uchar **,
558 int identifer_p));
560 /* Utility routines and macros. */
561 #define DSC(str) (const uchar *)str, sizeof str - 1
562 #define xnew(T) (T *) xmalloc (sizeof(T))
563 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
564 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
565 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
566 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
568 /* These are inline functions instead of macros so we can get type
569 checking. */
570 static inline int ustrcmp PARAMS ((const uchar *, const uchar *));
571 static inline int ustrncmp PARAMS ((const uchar *, const uchar *,
572 size_t));
573 static inline size_t ustrlen PARAMS ((const uchar *));
574 static inline uchar *uxstrdup PARAMS ((const uchar *));
575 static inline uchar *ustrchr PARAMS ((const uchar *, int));
576 static inline int ufputs PARAMS ((const uchar *, FILE *));
578 static inline int
579 ustrcmp (s1, s2)
580 const uchar *s1, *s2;
582 return strcmp ((const char *)s1, (const char *)s2);
585 static inline int
586 ustrncmp (s1, s2, n)
587 const uchar *s1, *s2;
588 size_t n;
590 return strncmp ((const char *)s1, (const char *)s2, n);
593 static inline size_t
594 ustrlen (s1)
595 const uchar *s1;
597 return strlen ((const char *)s1);
600 static inline uchar *
601 uxstrdup (s1)
602 const uchar *s1;
604 return (uchar *) xstrdup ((const char *)s1);
607 static inline uchar *
608 ustrchr (s1, c)
609 const uchar *s1;
610 int c;
612 return (uchar *) strchr ((const char *)s1, c);
615 static inline int
616 ufputs (s, f)
617 const uchar *s;
618 FILE *f;
620 return fputs ((const char *)s, f);
623 #endif /* ! GCC_CPPHASH_H */