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
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. */
26 #include "hashtable.h"
32 typedef int iconv_t
; /* dummy */
35 struct directive
; /* Deliberately incomplete. */
36 struct pending_option
;
40 typedef unsigned char uchar
;
42 #define U (const uchar *) /* Intended use: U"string" */
44 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
46 /* Test if a sign is valid within a preprocessing number. */
47 #define VALID_SIGN(c, prevc) \
48 (((c) == '+' || (c) == '-') && \
49 ((prevc) == 'e' || (prevc) == 'E' \
50 || (((prevc) == 'p' || (prevc) == 'P') \
51 && CPP_OPTION (pfile, extended_numbers))))
53 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
54 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
55 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base)
56 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
58 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
59 efficiency, and partly to limit runaway recursion. */
60 #define CPP_STACK_MAX 200
62 /* Host alignment handling. */
73 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
74 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
75 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
77 /* Each macro definition is recorded in a cpp_macro structure.
78 Variadic macros cannot occur with traditional cpp. */
81 /* Parameters, if any. */
82 cpp_hashnode
**params
;
84 /* Replacement tokens (ISO) or replacement text (traditional). See
85 comment at top of cpptrad.c for how traditional function-like
86 macros are encoded. */
93 /* Definition line number. */
96 /* Number of tokens in expansion, or bytes for traditional macros. */
99 /* Number of parameters. */
100 unsigned short paramc
;
102 /* If a function-like macro. */
103 unsigned int fun_like
: 1;
105 /* If a variadic macro. */
106 unsigned int variadic
: 1;
108 /* If macro defined in system header. */
109 unsigned int syshdr
: 1;
111 /* Nonzero if it has been expanded or had its existence tested. */
112 unsigned int used
: 1;
115 #define _cpp_mark_macro_used(NODE) do { \
116 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
117 (NODE)->value.macro->used = 1; } while (0)
119 /* A generic memory buffer, and operations on it. */
120 typedef struct _cpp_buff _cpp_buff
;
123 struct _cpp_buff
*next
;
124 unsigned char *base
, *cur
, *limit
;
127 extern _cpp_buff
*_cpp_get_buff (cpp_reader
*, size_t);
128 extern void _cpp_release_buff (cpp_reader
*, _cpp_buff
*);
129 extern void _cpp_extend_buff (cpp_reader
*, _cpp_buff
**, size_t);
130 extern _cpp_buff
*_cpp_append_extend_buff (cpp_reader
*, _cpp_buff
*, size_t);
131 extern void _cpp_free_buff (_cpp_buff
*);
132 extern unsigned char *_cpp_aligned_alloc (cpp_reader
*, size_t);
133 extern unsigned char *_cpp_unaligned_alloc (cpp_reader
*, size_t);
135 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
136 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
137 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
139 /* #include types. */
140 enum include_type
{IT_INCLUDE
, IT_INCLUDE_NEXT
, IT_IMPORT
, IT_CMDLINE
};
144 const cpp_token
*token
;
145 const cpp_token
**ptoken
;
148 /* A "run" of tokens; part of a chain of runs. */
149 typedef struct tokenrun tokenrun
;
152 tokenrun
*next
, *prev
;
153 cpp_token
*base
, *limit
;
156 /* Accessor macros for struct cpp_context. */
157 #define FIRST(c) ((c)->u.iso.first)
158 #define LAST(c) ((c)->u.iso.last)
159 #define CUR(c) ((c)->u.trad.cur)
160 #define RLIMIT(c) ((c)->u.trad.rlimit)
162 typedef struct cpp_context cpp_context
;
165 /* Doubly-linked list. */
166 cpp_context
*next
, *prev
;
170 /* For ISO macro expansion. Contexts other than the base context
171 are contiguous tokens. e.g. macro expansions, expanded
179 /* For traditional macro expansion. */
187 /* If non-NULL, a buffer used for storage related to this context.
188 When the context is popped, the buffer is released. */
191 /* For a macro context, the macro node, otherwise NULL. */
194 /* True if utoken element is token, else ptoken. */
200 /* Nonzero if first token on line is CPP_HASH. */
201 unsigned char in_directive
;
203 /* Nonzero if in a directive that will handle padding tokens itself.
204 #include needs this to avoid problems with computed include and
205 spacing between tokens. */
206 unsigned char directive_wants_padding
;
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 lexing __VA_ARGS__ is valid. */
222 unsigned char va_args_ok
;
224 /* Nonzero if lexing poisoned identifiers is valid. */
225 unsigned char poisoned_ok
;
227 /* Nonzero to prevent macro expansion. */
228 unsigned char prevent_expansion
;
230 /* Nonzero when parsing arguments to a function-like macro. */
231 unsigned char parsing_args
;
233 /* Nonzero to skip evaluating part of an expression. */
234 unsigned int skip_eval
;
237 /* Special nodes - identifiers with predefined significance. */
240 cpp_hashnode
*n_defined
; /* defined operator */
241 cpp_hashnode
*n_true
; /* C++ keyword true */
242 cpp_hashnode
*n_false
; /* C++ keyword false */
243 cpp_hashnode
*n__VA_ARGS__
; /* C99 vararg macros */
246 typedef struct _cpp_line_note _cpp_line_note
;
247 struct _cpp_line_note
249 /* Location in the clean line the note refers to. */
252 /* Type of note. The 9 'from' trigraph characters represent those
253 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
254 intervening space, and anything else is invalid. */
258 /* Represents the contents of a file cpplib has read in. */
261 const uchar
*cur
; /* Current location. */
262 const uchar
*line_base
; /* Start of current physical line. */
263 const uchar
*next_line
; /* Start of to-be-cleaned logical line. */
265 const uchar
*buf
; /* Entire character buffer. */
266 const uchar
*rlimit
; /* Writable byte at end of file. */
268 _cpp_line_note
*notes
; /* Array of notes. */
269 unsigned int cur_note
; /* Next note to process. */
270 unsigned int notes_used
; /* Number of notes. */
271 unsigned int notes_cap
; /* Size of allocated array. */
273 struct cpp_buffer
*prev
;
275 /* Pointer into the include table; non-NULL if this is a file
276 buffer. Used for include_next and to record control macros. */
277 struct include_file
*inc
;
279 /* Value of if_stack at start of this file.
280 Used to prohibit unmatched #endif (etc) in an include file. */
281 struct if_stack
*if_stack
;
283 /* True if we need to get the next clean line. */
286 /* True if we have already warned about C++ comments in this file.
287 The warning happens only for C89 extended mode with -pedantic on,
288 or for -Wtraditional, and only once per file (otherwise it would
289 be far too noisy). */
290 unsigned char warned_cplusplus_comments
;
292 /* True if we don't process trigraphs and escaped newlines. True
293 for preprocessed input, command line directives, and _Pragma
295 unsigned char from_stage3
;
297 /* Nonzero means that the directory to start searching for ""
298 include files has been calculated and stored in "dir" below. */
299 unsigned char search_cached
;
301 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
302 true, a CPP_EOF token is then returned. Otherwise, the next
303 token from the enclosing buffer is returned. */
306 /* The directory of the this buffer's file. Its NAME member is not
307 allocated, so we don't need to worry about freeing it. */
310 /* Used for buffer overlays by cpptrad.c. */
311 const uchar
*saved_cur
, *saved_rlimit
;
314 /* A cpp_reader encapsulates the "state" of a pre-processor run.
315 Applying cpp_get_token repeatedly yields a stream of pre-processor
316 tokens. Usually, there is only one cpp_reader object active. */
319 /* Top of buffer stack. */
322 /* Overlaid buffer (can be different after processing #include). */
323 cpp_buffer
*overlaid_buffer
;
326 struct lexer_state state
;
328 /* Source line tracking. */
329 struct line_maps line_maps
;
330 const struct line_map
*map
;
333 /* The line of the '#' of the current directive. */
334 unsigned int directive_line
;
336 /* Memory buffers. */
337 _cpp_buff
*a_buff
; /* Aligned permanent storage. */
338 _cpp_buff
*u_buff
; /* Unaligned permanent storage. */
339 _cpp_buff
*free_buffs
; /* Free buffer chain. */
342 struct cpp_context base_context
;
343 struct cpp_context
*context
;
345 /* If in_directive, the directive if known. */
346 const struct directive
*directive
;
348 /* Search paths for include files. */
349 struct cpp_path
*quote_include
; /* "" */
350 struct cpp_path
*bracket_include
; /* <> */
352 /* Multiple include optimization. */
353 const cpp_hashnode
*mi_cmacro
;
354 const cpp_hashnode
*mi_ind_cmacro
;
358 cpp_token
*cur_token
;
359 tokenrun base_run
, *cur_run
;
360 unsigned int lookaheads
;
362 /* Nonzero prevents the lexer from re-using the token runs. */
363 unsigned int keep_tokens
;
365 /* Error counter for exit code. */
368 /* Buffer to hold macro definition string. */
369 unsigned char *macro_buffer
;
370 unsigned int macro_buffer_len
;
372 /* Iconv descriptor for converting from the source character set
373 to the execution character set. (iconv_t)-1 for no conversion. */
374 iconv_t narrow_cset_desc
;
376 /* Iconv descriptor for converting from the execution character set
377 to the wide execution character set. (iconv_t)-1 for no conversion
378 other than zero-extending each character to the width of wchar_t. */
379 iconv_t wide_cset_desc
;
381 /* Tree of other included files. See cppfiles.c. */
382 struct splay_tree_s
*all_include_files
;
384 /* Current maximum length of directory names in the search path
385 for include files. (Altered as we get more of them.) */
386 unsigned int max_include_len
;
388 /* Date and time text. Calculated together if either is requested. */
392 /* EOF token, and a token forcing paste avoidance. */
393 cpp_token avoid_paste
;
396 /* Opaque handle to the dependencies of mkdeps.c. */
399 /* Obstack holding all macro hash nodes. This never shrinks.
401 struct obstack hash_ob
;
403 /* Obstack holding buffer and conditional structures. This is a
404 real stack. See cpplib.c. */
405 struct obstack buffer_ob
;
407 /* Pragma table - dynamic, because a library user can add to the
408 list of recognized pragmas. */
409 struct pragma_entry
*pragmas
;
411 /* Call backs to cpplib client. */
412 struct cpp_callbacks cb
;
414 /* Identifier hash table. */
415 struct ht
*hash_table
;
417 /* Expression parser stack. */
418 struct op
*op_stack
, *op_limit
;
420 /* User visible options. */
421 struct cpp_options opts
;
423 /* Special nodes - identifiers with predefined significance to the
425 struct spec_nodes spec_nodes
;
427 /* Nonzero means don't look for #include "foo" the source-file
429 unsigned char quote_ignores_source_dir
;
431 /* Whether cpplib owns the hashtable. */
432 unsigned char our_hashtable
;
434 /* Traditional preprocessing output buffer (a logical line). */
440 unsigned int first_line
;
443 /* Used to save the original line number during traditional
445 unsigned int saved_line
;
447 /* A saved list of the defined macros, for dependency checking
448 of precompiled headers. */
449 struct cpp_savedstate
*savedstate
;
452 /* Character classes. Based on the more primitive macros in safe-ctype.h.
453 If the definition of `numchar' looks odd to you, please look up the
454 definition of a pp-number in the C standard [section 6.4.8 of C99].
456 In the unlikely event that characters other than \r and \n enter
457 the set is_vspace, the macro handle_newline() in cpplex.c must be
459 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
461 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
462 #define is_numchar(x) ISIDNUM(x)
463 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
464 #define is_numstart(x) ISDIGIT(x)
465 #define is_hspace(x) ISBLANK(x)
466 #define is_vspace(x) IS_VSPACE(x)
467 #define is_nvspace(x) IS_NVSPACE(x)
468 #define is_space(x) IS_SPACE_OR_NUL(x)
470 /* This table is constant if it can be initialized at compile time,
471 which is the case if cpp was compiled with GCC >=2.7, or another
472 compiler that supports C99. */
473 #if HAVE_DESIGNATED_INITIALIZERS
474 extern const unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
476 extern unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
481 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
482 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
483 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
486 extern int _cpp_begin_message (cpp_reader
*, int, unsigned int, unsigned int);
489 extern void _cpp_free_definition (cpp_hashnode
*);
490 extern bool _cpp_create_definition (cpp_reader
*, cpp_hashnode
*);
491 extern void _cpp_pop_context (cpp_reader
*);
492 extern void _cpp_push_text_context (cpp_reader
*, cpp_hashnode
*,
493 const uchar
*, size_t);
494 extern bool _cpp_save_parameter (cpp_reader
*, cpp_macro
*, cpp_hashnode
*);
495 extern bool _cpp_arguments_ok (cpp_reader
*, cpp_macro
*, const cpp_hashnode
*,
497 extern const uchar
*_cpp_builtin_macro_text (cpp_reader
*, cpp_hashnode
*);
498 int _cpp_warn_if_unused_macro (cpp_reader
*, cpp_hashnode
*, void *);
500 extern void _cpp_init_hashtable (cpp_reader
*, hash_table
*);
501 extern void _cpp_destroy_hashtable (cpp_reader
*);
504 extern void _cpp_fake_include (cpp_reader
*, const char *);
505 extern void _cpp_never_reread (struct include_file
*);
506 extern bool _cpp_read_file (cpp_reader
*, const char *);
507 extern bool _cpp_execute_include (cpp_reader
*, const char *, int,
509 extern int _cpp_compare_file_date (cpp_reader
*, const char *, int);
510 extern void _cpp_report_missing_guards (cpp_reader
*);
511 extern void _cpp_init_includes (cpp_reader
*);
512 extern void _cpp_cleanup_includes (cpp_reader
*);
513 extern void _cpp_pop_file_buffer (cpp_reader
*, struct include_file
*);
516 extern bool _cpp_parse_expr (cpp_reader
*);
517 extern struct op
*_cpp_expand_op_stack (cpp_reader
*);
520 extern void _cpp_process_line_notes (cpp_reader
*, int);
521 extern void _cpp_clean_line (cpp_reader
*);
522 extern bool _cpp_get_fresh_line (cpp_reader
*);
523 extern bool _cpp_skip_block_comment (cpp_reader
*);
524 extern cpp_token
*_cpp_temp_token (cpp_reader
*);
525 extern const cpp_token
*_cpp_lex_token (cpp_reader
*);
526 extern cpp_token
*_cpp_lex_direct (cpp_reader
*);
527 extern int _cpp_equiv_tokens (const cpp_token
*, const cpp_token
*);
528 extern void _cpp_init_tokenrun (tokenrun
*, unsigned int);
531 extern void _cpp_maybe_push_include_file (cpp_reader
*);
534 extern int _cpp_test_assertion (cpp_reader
*, unsigned int *);
535 extern int _cpp_handle_directive (cpp_reader
*, int);
536 extern void _cpp_define_builtin (cpp_reader
*, const char *);
537 extern char ** _cpp_save_pragma_names (cpp_reader
*);
538 extern void _cpp_restore_pragma_names (cpp_reader
*, char **);
539 extern void _cpp_do__Pragma (cpp_reader
*);
540 extern void _cpp_init_directives (cpp_reader
*);
541 extern void _cpp_init_internal_pragmas (cpp_reader
*);
542 extern void _cpp_do_file_change (cpp_reader
*, enum lc_reason
, const char *,
543 unsigned int, unsigned int);
544 extern void _cpp_pop_buffer (cpp_reader
*);
547 extern bool scan_out_logical_line (cpp_reader
*, cpp_macro
*);
548 extern bool _cpp_read_logical_line_trad (cpp_reader
*);
549 extern void _cpp_overlay_buffer (cpp_reader
*pfile
, const uchar
*, size_t);
550 extern void _cpp_remove_overlay (cpp_reader
*);
551 extern bool _cpp_create_trad_definition (cpp_reader
*, cpp_macro
*);
552 extern bool _cpp_expansions_different_trad (const cpp_macro
*,
554 extern uchar
*_cpp_copy_replacement_text (const cpp_macro
*, uchar
*);
555 extern size_t _cpp_replacement_text_len (const cpp_macro
*);
557 /* In cppcharset.c. */
558 cppchar_t
_cpp_valid_ucn (cpp_reader
*, const uchar
**, const uchar
*, int);
559 void _cpp_destroy_iconv (cpp_reader
*);
561 /* Utility routines and macros. */
562 #define DSC(str) (const uchar *)str, sizeof str - 1
563 #define xnew(T) (T *) xmalloc (sizeof(T))
564 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
565 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
566 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
567 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
569 /* These are inline functions instead of macros so we can get type
571 static inline int ustrcmp (const uchar
*, const uchar
*);
572 static inline int ustrncmp (const uchar
*, const uchar
*, size_t);
573 static inline size_t ustrlen (const uchar
*);
574 static inline uchar
*uxstrdup (const uchar
*);
575 static inline uchar
*ustrchr (const uchar
*, int);
576 static inline int ufputs (const uchar
*, FILE *);
579 ustrcmp (const uchar
*s1
, const uchar
*s2
)
581 return strcmp ((const char *)s1
, (const char *)s2
);
585 ustrncmp (const uchar
*s1
, const uchar
*s2
, size_t n
)
587 return strncmp ((const char *)s1
, (const char *)s2
, n
);
591 ustrlen (const uchar
*s1
)
593 return strlen ((const char *)s1
);
596 static inline uchar
*
597 uxstrdup (const uchar
*s1
)
599 return (uchar
*) xstrdup ((const char *)s1
);
602 static inline uchar
*
603 ustrchr (const uchar
*s1
, int c
)
605 return (uchar
*) strchr ((const char *)s1
, c
);
609 ufputs (const uchar
*s
, FILE *f
)
611 return fputs ((const char *)s
, f
);
614 #endif /* ! GCC_CPPHASH_H */