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"
33 typedef int iconv_t; /* dummy */
36 struct directive; /* Deliberately incomplete. */
37 struct pending_option;
42 typedef bool (*convert_f) (iconv_t, const unsigned char *, size_t,
51 typedef unsigned char uchar;
53 #define U (const uchar *) /* Intended use: U"string" */
55 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
57 /* Test if a sign is valid within a preprocessing number. */
58 #define VALID_SIGN(c, prevc) \
59 (((c) == '+' || (c) == '-') && \
60 ((prevc) == 'e' || (prevc) == 'E' \
61 || (((prevc) == 'p' || (prevc) == 'P') \
62 && CPP_OPTION (pfile, extended_numbers))))
64 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
65 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
66 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base)
67 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
69 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
70 efficiency, and partly to limit runaway recursion. */
71 #define CPP_STACK_MAX 200
73 /* Host alignment handling. */
84 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
85 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
86 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
88 /* Each macro definition is recorded in a cpp_macro structure.
89 Variadic macros cannot occur with traditional cpp. */
92 /* Parameters, if any. */
93 cpp_hashnode **params;
95 /* Replacement tokens (ISO) or replacement text (traditional). See
96 comment at top of cpptrad.c for how traditional function-like
97 macros are encoded. */
104 /* Definition line number. */
107 /* Number of tokens in expansion, or bytes for traditional macros. */
110 /* Number of parameters. */
111 unsigned short paramc;
113 /* If a function-like macro. */
114 unsigned int fun_like : 1;
116 /* If a variadic macro. */
117 unsigned int variadic : 1;
119 /* If macro defined in system header. */
120 unsigned int syshdr : 1;
122 /* Nonzero if it has been expanded or had its existence tested. */
123 unsigned int used : 1;
126 #define _cpp_mark_macro_used(NODE) do { \
127 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
128 (NODE)->value.macro->used = 1; } while (0)
130 /* A generic memory buffer, and operations on it. */
131 typedef struct _cpp_buff _cpp_buff;
134 struct _cpp_buff *next;
135 unsigned char *base, *cur, *limit;
138 extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
139 extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
140 extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
141 extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
142 extern void _cpp_free_buff (_cpp_buff *);
143 extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
144 extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
146 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
147 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
148 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
150 /* #include types. */
151 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
155 const cpp_token *token;
156 const cpp_token **ptoken;
159 /* A "run" of tokens; part of a chain of runs. */
160 typedef struct tokenrun tokenrun;
163 tokenrun *next, *prev;
164 cpp_token *base, *limit;
167 /* Accessor macros for struct cpp_context. */
168 #define FIRST(c) ((c)->u.iso.first)
169 #define LAST(c) ((c)->u.iso.last)
170 #define CUR(c) ((c)->u.trad.cur)
171 #define RLIMIT(c) ((c)->u.trad.rlimit)
173 typedef struct cpp_context cpp_context;
176 /* Doubly-linked list. */
177 cpp_context *next, *prev;
181 /* For ISO macro expansion. Contexts other than the base context
182 are contiguous tokens. e.g. macro expansions, expanded
190 /* For traditional macro expansion. */
198 /* If non-NULL, a buffer used for storage related to this context.
199 When the context is popped, the buffer is released. */
202 /* For a macro context, the macro node, otherwise NULL. */
205 /* True if utoken element is token, else ptoken. */
211 /* Nonzero if first token on line is CPP_HASH. */
212 unsigned char in_directive;
214 /* Nonzero if in a directive that will handle padding tokens itself.
215 #include needs this to avoid problems with computed include and
216 spacing between tokens. */
217 unsigned char directive_wants_padding;
219 /* True if we are skipping a failed conditional group. */
220 unsigned char skipping;
222 /* Nonzero if in a directive that takes angle-bracketed headers. */
223 unsigned char angled_headers;
225 /* Nonzero if in a #if or #elif directive. */
226 unsigned char in_expression;
228 /* Nonzero to save comments. Turned off if discard_comments, and in
229 all directives apart from #define. */
230 unsigned char save_comments;
232 /* Nonzero if lexing __VA_ARGS__ is valid. */
233 unsigned char va_args_ok;
235 /* Nonzero if lexing poisoned identifiers is valid. */
236 unsigned char poisoned_ok;
238 /* Nonzero to prevent macro expansion. */
239 unsigned char prevent_expansion;
241 /* Nonzero when parsing arguments to a function-like macro. */
242 unsigned char parsing_args;
244 /* Nonzero to skip evaluating part of an expression. */
245 unsigned int skip_eval;
248 /* Special nodes - identifiers with predefined significance. */
251 cpp_hashnode *n_defined; /* defined operator */
252 cpp_hashnode *n_true; /* C++ keyword true */
253 cpp_hashnode *n_false; /* C++ keyword false */
254 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
257 typedef struct _cpp_line_note _cpp_line_note;
258 struct _cpp_line_note
260 /* Location in the clean line the note refers to. */
263 /* Type of note. The 9 'from' trigraph characters represent those
264 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
265 intervening space, and anything else is invalid. */
269 /* Represents the contents of a file cpplib has read in. */
272 const uchar *cur; /* Current location. */
273 const uchar *line_base; /* Start of current physical line. */
274 const uchar *next_line; /* Start of to-be-cleaned logical line. */
276 const uchar *buf; /* Entire character buffer. */
277 const uchar *rlimit; /* Writable byte at end of file. */
279 _cpp_line_note *notes; /* Array of notes. */
280 unsigned int cur_note; /* Next note to process. */
281 unsigned int notes_used; /* Number of notes. */
282 unsigned int notes_cap; /* Size of allocated array. */
284 struct cpp_buffer *prev;
286 /* Pointer into the file table; non-NULL if this is a file buffer.
287 Used for include_next and to record control macros. */
288 struct _cpp_file *file;
290 /* Value of if_stack at start of this file.
291 Used to prohibit unmatched #endif (etc) in an include file. */
292 struct if_stack *if_stack;
294 /* True if we need to get the next clean line. */
297 /* True if we have already warned about C++ comments in this file.
298 The warning happens only for C89 extended mode with -pedantic on,
299 or for -Wtraditional, and only once per file (otherwise it would
300 be far too noisy). */
301 unsigned char warned_cplusplus_comments;
303 /* True if we don't process trigraphs and escaped newlines. True
304 for preprocessed input, command line directives, and _Pragma
306 unsigned char from_stage3;
308 /* Nonzero means that the directory to start searching for ""
309 include files has been calculated and stored in "dir" below. */
310 unsigned char search_cached;
312 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
313 true, a CPP_EOF token is then returned. Otherwise, the next
314 token from the enclosing buffer is returned. */
317 /* The directory of the this buffer's file. Its NAME member is not
318 allocated, so we don't need to worry about freeing it. */
321 /* Used for buffer overlays by cpptrad.c. */
322 const uchar *saved_cur, *saved_rlimit;
325 /* A cpp_reader encapsulates the "state" of a pre-processor run.
326 Applying cpp_get_token repeatedly yields a stream of pre-processor
327 tokens. Usually, there is only one cpp_reader object active. */
330 /* Top of buffer stack. */
333 /* Overlaid buffer (can be different after processing #include). */
334 cpp_buffer *overlaid_buffer;
337 struct lexer_state state;
339 /* Source line tracking. */
340 struct line_maps line_maps;
341 const struct line_map *map;
344 /* The line of the '#' of the current directive. */
345 unsigned int directive_line;
347 /* Memory buffers. */
348 _cpp_buff *a_buff; /* Aligned permanent storage. */
349 _cpp_buff *u_buff; /* Unaligned permanent storage. */
350 _cpp_buff *free_buffs; /* Free buffer chain. */
353 struct cpp_context base_context;
354 struct cpp_context *context;
356 /* If in_directive, the directive if known. */
357 const struct directive *directive;
359 /* Search paths for include files. */
360 struct cpp_dir *quote_include; /* "" */
361 struct cpp_dir *bracket_include; /* <> */
362 struct cpp_dir no_search_path; /* No path. */
364 /* Chain of files that were #import-ed or contain #pragma once. */
365 struct _cpp_file *once_only_files;
367 /* File and directory hash table. */
369 struct file_hash_entry *file_hash_entries;
370 unsigned int file_hash_entries_allocated, file_hash_entries_used;
372 /* Nonzero means don't look for #include "foo" the source-file
374 bool quote_ignores_source_dir;
376 /* Non-zero if any file has contained #pragma once. */
377 bool saw_pragma_once;
379 /* Multiple include optimization. */
380 const cpp_hashnode *mi_cmacro;
381 const cpp_hashnode *mi_ind_cmacro;
385 cpp_token *cur_token;
386 tokenrun base_run, *cur_run;
387 unsigned int lookaheads;
389 /* Nonzero prevents the lexer from re-using the token runs. */
390 unsigned int keep_tokens;
392 /* Error counter for exit code. */
395 /* Buffer to hold macro definition string. */
396 unsigned char *macro_buffer;
397 unsigned int macro_buffer_len;
399 /* Descriptor for converting from the source character set to the
400 execution character set. */
401 struct cset_converter narrow_cset_desc;
403 /* Descriptor for converting from the source character set to the
404 wide execution character set. */
405 struct cset_converter wide_cset_desc;
407 /* Date and time text. Calculated together if either is requested. */
411 /* EOF token, and a token forcing paste avoidance. */
412 cpp_token avoid_paste;
415 /* Opaque handle to the dependencies of mkdeps.c. */
418 /* Obstack holding all macro hash nodes. This never shrinks.
420 struct obstack hash_ob;
422 /* Obstack holding buffer and conditional structures. This is a
423 real stack. See cpplib.c. */
424 struct obstack buffer_ob;
426 /* Pragma table - dynamic, because a library user can add to the
427 list of recognized pragmas. */
428 struct pragma_entry *pragmas;
430 /* Call backs to cpplib client. */
431 struct cpp_callbacks cb;
433 /* Identifier hash table. */
434 struct ht *hash_table;
436 /* Expression parser stack. */
437 struct op *op_stack, *op_limit;
439 /* User visible options. */
440 struct cpp_options opts;
442 /* Special nodes - identifiers with predefined significance to the
444 struct spec_nodes spec_nodes;
446 /* Whether cpplib owns the hashtable. */
449 /* Traditional preprocessing output buffer (a logical line). */
455 unsigned int first_line;
458 /* Used to save the original line number during traditional
460 unsigned int saved_line;
462 /* A saved list of the defined macros, for dependency checking
463 of precompiled headers. */
464 struct cpp_savedstate *savedstate;
467 /* Character classes. Based on the more primitive macros in safe-ctype.h.
468 If the definition of `numchar' looks odd to you, please look up the
469 definition of a pp-number in the C standard [section 6.4.8 of C99].
471 In the unlikely event that characters other than \r and \n enter
472 the set is_vspace, the macro handle_newline() in cpplex.c must be
474 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
476 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
477 #define is_numchar(x) ISIDNUM(x)
478 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
479 #define is_numstart(x) ISDIGIT(x)
480 #define is_hspace(x) ISBLANK(x)
481 #define is_vspace(x) IS_VSPACE(x)
482 #define is_nvspace(x) IS_NVSPACE(x)
483 #define is_space(x) IS_SPACE_OR_NUL(x)
485 /* This table is constant if it can be initialized at compile time,
486 which is the case if cpp was compiled with GCC >=2.7, or another
487 compiler that supports C99. */
488 #if HAVE_DESIGNATED_INITIALIZERS
489 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
491 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
496 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
497 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
498 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
501 extern int _cpp_begin_message (cpp_reader *, int, unsigned int, unsigned int);
504 extern void _cpp_free_definition (cpp_hashnode *);
505 extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
506 extern void _cpp_pop_context (cpp_reader *);
507 extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
508 const uchar *, size_t);
509 extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
510 extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
512 extern const uchar *_cpp_builtin_macro_text (cpp_reader *, cpp_hashnode *);
513 int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
515 extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
516 extern void _cpp_destroy_hashtable (cpp_reader *);
519 extern void _cpp_mark_file_once_only (cpp_reader *, struct _cpp_file *, bool);
520 extern void _cpp_fake_include (cpp_reader *, const char *);
521 extern bool _cpp_stack_file (cpp_reader *, const char *);
522 extern bool _cpp_stack_include (cpp_reader *, const char *, int,
524 extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
525 extern void _cpp_report_missing_guards (cpp_reader *);
526 extern void _cpp_init_files (cpp_reader *);
527 extern void _cpp_cleanup_files (cpp_reader *);
528 extern void _cpp_pop_file_buffer (cpp_reader *, struct _cpp_file *);
531 extern bool _cpp_parse_expr (cpp_reader *);
532 extern struct op *_cpp_expand_op_stack (cpp_reader *);
535 extern void _cpp_process_line_notes (cpp_reader *, int);
536 extern void _cpp_clean_line (cpp_reader *);
537 extern bool _cpp_get_fresh_line (cpp_reader *);
538 extern bool _cpp_skip_block_comment (cpp_reader *);
539 extern cpp_token *_cpp_temp_token (cpp_reader *);
540 extern const cpp_token *_cpp_lex_token (cpp_reader *);
541 extern cpp_token *_cpp_lex_direct (cpp_reader *);
542 extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
543 extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
546 extern void _cpp_maybe_push_include_file (cpp_reader *);
549 extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
550 extern int _cpp_handle_directive (cpp_reader *, int);
551 extern void _cpp_define_builtin (cpp_reader *, const char *);
552 extern char ** _cpp_save_pragma_names (cpp_reader *);
553 extern void _cpp_restore_pragma_names (cpp_reader *, char **);
554 extern void _cpp_do__Pragma (cpp_reader *);
555 extern void _cpp_init_directives (cpp_reader *);
556 extern void _cpp_init_internal_pragmas (cpp_reader *);
557 extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
558 unsigned int, unsigned int);
559 extern void _cpp_pop_buffer (cpp_reader *);
562 extern bool _cpp_scan_out_logical_line (cpp_reader *, cpp_macro *);
563 extern bool _cpp_read_logical_line_trad (cpp_reader *);
564 extern void _cpp_overlay_buffer (cpp_reader *pfile, const uchar *, size_t);
565 extern void _cpp_remove_overlay (cpp_reader *);
566 extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
567 extern bool _cpp_expansions_different_trad (const cpp_macro *,
569 extern uchar *_cpp_copy_replacement_text (const cpp_macro *, uchar *);
570 extern size_t _cpp_replacement_text_len (const cpp_macro *);
572 /* In cppcharset.c. */
573 extern cppchar_t _cpp_valid_ucn (cpp_reader *, const uchar **,
575 extern void _cpp_destroy_iconv (cpp_reader *);
576 extern bool _cpp_interpret_string_notranslate (cpp_reader *, const cpp_string *,
579 /* Utility routines and macros. */
580 #define DSC(str) (const uchar *)str, sizeof str - 1
581 #define xnew(T) (T *) xmalloc (sizeof(T))
582 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
583 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
584 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
585 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
587 /* These are inline functions instead of macros so we can get type
589 static inline int ustrcmp (const uchar *, const uchar *);
590 static inline int ustrncmp (const uchar *, const uchar *, size_t);
591 static inline size_t ustrlen (const uchar *);
592 static inline uchar *uxstrdup (const uchar *);
593 static inline uchar *ustrchr (const uchar *, int);
594 static inline int ufputs (const uchar *, FILE *);
597 ustrcmp (const uchar *s1, const uchar *s2)
599 return strcmp ((const char *)s1, (const char *)s2);
603 ustrncmp (const uchar *s1, const uchar *s2, size_t n)
605 return strncmp ((const char *)s1, (const char *)s2, n);
609 ustrlen (const uchar *s1)
611 return strlen ((const char *)s1);
614 static inline uchar *
615 uxstrdup (const uchar *s1)
617 return (uchar *) xstrdup ((const char *)s1);
620 static inline uchar *
621 ustrchr (const uchar *s1, int c)
623 return (uchar *) strchr ((const char *)s1, c);
627 ufputs (const uchar *s, FILE *f)
629 return fputs ((const char *)s, f);
632 #endif /* ! GCC_CPPHASH_H */