1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
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 should not be used outside
23 #ifndef LIBCPP_INTERNAL_H
24 #define LIBCPP_INTERNAL_H
28 #if defined HAVE_ICONV_H && defined HAVE_ICONV
32 typedef int iconv_t; /* dummy */
35 struct directive; /* Deliberately incomplete. */
36 struct pending_option;
40 typedef bool (*convert_f) (iconv_t, const unsigned char *, size_t,
41 struct _cpp_strbuf *);
49 typedef unsigned char uchar;
51 #define U (const uchar *) /* Intended use: U"string" */
53 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
55 /* Test if a sign is valid within a preprocessing number. */
56 #define VALID_SIGN(c, prevc) \
57 (((c) == '+' || (c) == '-') && \
58 ((prevc) == 'e' || (prevc) == 'E' \
59 || (((prevc) == 'p' || (prevc) == 'P') \
60 && CPP_OPTION (pfile, extended_numbers))))
62 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
63 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
64 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base)
65 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
67 #define CPP_INCREMENT_LINE(PFILE, COLS_HINT) do { \
68 const struct line_maps *line_table = PFILE->line_table; \
69 const struct line_map *map = &line_table->maps[line_table->used-1]; \
70 unsigned int line = SOURCE_LINE (map, line_table->highest_line); \
71 linemap_line_start (PFILE->line_table, line + 1, COLS_HINT); \
74 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
75 efficiency, and partly to limit runaway recursion. */
76 #define CPP_STACK_MAX 200
78 /* Host alignment handling. */
89 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
90 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
91 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
93 /* Each macro definition is recorded in a cpp_macro structure.
94 Variadic macros cannot occur with traditional cpp. */
97 /* Parameters, if any. */
98 cpp_hashnode **params;
100 /* Replacement tokens (ISO) or replacement text (traditional). See
101 comment at top of cpptrad.c for how traditional function-like
102 macros are encoded. */
109 /* Definition line number. */
112 /* Number of tokens in expansion, or bytes for traditional macros. */
115 /* Number of parameters. */
116 unsigned short paramc;
118 /* If a function-like macro. */
119 unsigned int fun_like : 1;
121 /* If a variadic macro. */
122 unsigned int variadic : 1;
124 /* If macro defined in system header. */
125 unsigned int syshdr : 1;
127 /* Nonzero if it has been expanded or had its existence tested. */
128 unsigned int used : 1;
131 #define _cpp_mark_macro_used(NODE) do { \
132 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
133 (NODE)->value.macro->used = 1; } while (0)
135 /* A generic memory buffer, and operations on it. */
136 typedef struct _cpp_buff _cpp_buff;
139 struct _cpp_buff *next;
140 unsigned char *base, *cur, *limit;
143 extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
144 extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
145 extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
146 extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
147 extern void _cpp_free_buff (_cpp_buff *);
148 extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
149 extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
151 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
152 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
153 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
155 /* #include types. */
156 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
160 const cpp_token *token;
161 const cpp_token **ptoken;
164 /* A "run" of tokens; part of a chain of runs. */
165 typedef struct tokenrun tokenrun;
168 tokenrun *next, *prev;
169 cpp_token *base, *limit;
172 /* Accessor macros for struct cpp_context. */
173 #define FIRST(c) ((c)->u.iso.first)
174 #define LAST(c) ((c)->u.iso.last)
175 #define CUR(c) ((c)->u.trad.cur)
176 #define RLIMIT(c) ((c)->u.trad.rlimit)
178 typedef struct cpp_context cpp_context;
181 /* Doubly-linked list. */
182 cpp_context *next, *prev;
186 /* For ISO macro expansion. Contexts other than the base context
187 are contiguous tokens. e.g. macro expansions, expanded
195 /* For traditional macro expansion. */
203 /* If non-NULL, a buffer used for storage related to this context.
204 When the context is popped, the buffer is released. */
207 /* For a macro context, the macro node, otherwise NULL. */
210 /* True if utoken element is token, else ptoken. */
216 /* Nonzero if first token on line is CPP_HASH. */
217 unsigned char in_directive;
219 /* Nonzero if in a directive that will handle padding tokens itself.
220 #include needs this to avoid problems with computed include and
221 spacing between tokens. */
222 unsigned char directive_wants_padding;
224 /* True if we are skipping a failed conditional group. */
225 unsigned char skipping;
227 /* Nonzero if in a directive that takes angle-bracketed headers. */
228 unsigned char angled_headers;
230 /* Nonzero if in a #if or #elif directive. */
231 unsigned char in_expression;
233 /* Nonzero to save comments. Turned off if discard_comments, and in
234 all directives apart from #define. */
235 unsigned char save_comments;
237 /* Nonzero if lexing __VA_ARGS__ is valid. */
238 unsigned char va_args_ok;
240 /* Nonzero if lexing poisoned identifiers is valid. */
241 unsigned char poisoned_ok;
243 /* Nonzero to prevent macro expansion. */
244 unsigned char prevent_expansion;
246 /* Nonzero when parsing arguments to a function-like macro. */
247 unsigned char parsing_args;
249 /* Nonzero if prevent_expansion is true only because output is
251 unsigned char discarding_output;
253 /* Nonzero to skip evaluating part of an expression. */
254 unsigned int skip_eval;
257 /* Special nodes - identifiers with predefined significance. */
260 cpp_hashnode *n_defined; /* defined operator */
261 cpp_hashnode *n_true; /* C++ keyword true */
262 cpp_hashnode *n_false; /* C++ keyword false */
263 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
266 typedef struct _cpp_line_note _cpp_line_note;
267 struct _cpp_line_note
269 /* Location in the clean line the note refers to. */
272 /* Type of note. The 9 'from' trigraph characters represent those
273 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
274 intervening space, and anything else is invalid. */
278 /* Represents the contents of a file cpplib has read in. */
281 const uchar *cur; /* Current location. */
282 const uchar *line_base; /* Start of current physical line. */
283 const uchar *next_line; /* Start of to-be-cleaned logical line. */
285 const uchar *buf; /* Entire character buffer. */
286 const uchar *rlimit; /* Writable byte at end of file. */
288 _cpp_line_note *notes; /* Array of notes. */
289 unsigned int cur_note; /* Next note to process. */
290 unsigned int notes_used; /* Number of notes. */
291 unsigned int notes_cap; /* Size of allocated array. */
293 struct cpp_buffer *prev;
295 /* Pointer into the file table; non-NULL if this is a file buffer.
296 Used for include_next and to record control macros. */
297 struct _cpp_file *file;
299 /* Value of if_stack at start of this file.
300 Used to prohibit unmatched #endif (etc) in an include file. */
301 struct if_stack *if_stack;
303 /* True if we need to get the next clean line. */
306 /* True if we have already warned about C++ comments in this file.
307 The warning happens only for C89 extended mode with -pedantic on,
308 or for -Wtraditional, and only once per file (otherwise it would
309 be far too noisy). */
310 unsigned int warned_cplusplus_comments : 1;
312 /* True if we don't process trigraphs and escaped newlines. True
313 for preprocessed input, command line directives, and _Pragma
315 unsigned int from_stage3 : 1;
317 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
318 true, a CPP_EOF token is then returned. Otherwise, the next
319 token from the enclosing buffer is returned. */
320 unsigned int return_at_eof : 1;
322 /* One for a system header, two for a C system header file that therefore
323 needs to be extern "C" protected in C++, and zero otherwise. */
326 /* The directory of the this buffer's file. Its NAME member is not
327 allocated, so we don't need to worry about freeing it. */
330 /* Descriptor for converting from the input character set to the
331 source character set. */
332 struct cset_converter input_cset_desc;
335 /* A cpp_reader encapsulates the "state" of a pre-processor run.
336 Applying cpp_get_token repeatedly yields a stream of pre-processor
337 tokens. Usually, there is only one cpp_reader object active. */
340 /* Top of buffer stack. */
343 /* Overlaid buffer (can be different after processing #include). */
344 cpp_buffer *overlaid_buffer;
347 struct lexer_state state;
349 /* Source line tracking. */
350 struct line_maps *line_table;
352 /* The line of the '#' of the current directive. */
353 fileline directive_line;
355 /* Memory buffers. */
356 _cpp_buff *a_buff; /* Aligned permanent storage. */
357 _cpp_buff *u_buff; /* Unaligned permanent storage. */
358 _cpp_buff *free_buffs; /* Free buffer chain. */
361 struct cpp_context base_context;
362 struct cpp_context *context;
364 /* If in_directive, the directive if known. */
365 const struct directive *directive;
367 /* Search paths for include files. */
368 struct cpp_dir *quote_include; /* "" */
369 struct cpp_dir *bracket_include; /* <> */
370 struct cpp_dir no_search_path; /* No path. */
372 /* Chain of all hashed _cpp_file instances. */
373 struct _cpp_file *all_files;
375 struct _cpp_file *main_file;
377 /* File and directory hash table. */
378 struct htab *file_hash;
379 struct file_hash_entry *file_hash_entries;
380 unsigned int file_hash_entries_allocated, file_hash_entries_used;
382 /* Nonzero means don't look for #include "foo" the source-file
384 bool quote_ignores_source_dir;
386 /* Nonzero if any file has contained #pragma once or #import has
390 /* Multiple include optimization. */
391 const cpp_hashnode *mi_cmacro;
392 const cpp_hashnode *mi_ind_cmacro;
396 cpp_token *cur_token;
397 tokenrun base_run, *cur_run;
398 unsigned int lookaheads;
400 /* Nonzero prevents the lexer from re-using the token runs. */
401 unsigned int keep_tokens;
403 /* Error counter for exit code. */
406 /* Buffer to hold macro definition string. */
407 unsigned char *macro_buffer;
408 unsigned int macro_buffer_len;
410 /* Descriptor for converting from the source character set to the
411 execution character set. */
412 struct cset_converter narrow_cset_desc;
414 /* Descriptor for converting from the source character set to the
415 wide execution character set. */
416 struct cset_converter wide_cset_desc;
418 /* Date and time text. Calculated together if either is requested. */
422 /* EOF token, and a token forcing paste avoidance. */
423 cpp_token avoid_paste;
426 /* Opaque handle to the dependencies of mkdeps.c. */
429 /* Obstack holding all macro hash nodes. This never shrinks.
431 struct obstack hash_ob;
433 /* Obstack holding buffer and conditional structures. This is a
434 real stack. See cpplib.c. */
435 struct obstack buffer_ob;
437 /* Pragma table - dynamic, because a library user can add to the
438 list of recognized pragmas. */
439 struct pragma_entry *pragmas;
441 /* Call backs to cpplib client. */
442 struct cpp_callbacks cb;
444 /* Identifier hash table. */
445 struct ht *hash_table;
447 /* Expression parser stack. */
448 struct op *op_stack, *op_limit;
450 /* User visible options. */
451 struct cpp_options opts;
453 /* Special nodes - identifiers with predefined significance to the
455 struct spec_nodes spec_nodes;
457 /* Whether cpplib owns the hashtable. */
460 /* Traditional preprocessing output buffer (a logical line). */
469 /* Used for buffer overlays by cpptrad.c. */
470 const uchar *saved_cur, *saved_rlimit, *saved_line_base;
472 /* A saved list of the defined macros, for dependency checking
473 of precompiled headers. */
474 struct cpp_savedstate *savedstate;
477 /* Character classes. Based on the more primitive macros in safe-ctype.h.
478 If the definition of `numchar' looks odd to you, please look up the
479 definition of a pp-number in the C standard [section 6.4.8 of C99].
481 In the unlikely event that characters other than \r and \n enter
482 the set is_vspace, the macro handle_newline() in cpplex.c must be
484 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
486 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
487 #define is_numchar(x) ISIDNUM(x)
488 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
489 #define is_numstart(x) ISDIGIT(x)
490 #define is_hspace(x) ISBLANK(x)
491 #define is_vspace(x) IS_VSPACE(x)
492 #define is_nvspace(x) IS_NVSPACE(x)
493 #define is_space(x) IS_SPACE_OR_NUL(x)
495 /* This table is constant if it can be initialized at compile time,
496 which is the case if cpp was compiled with GCC >=2.7, or another
497 compiler that supports C99. */
498 #if HAVE_DESIGNATED_INITIALIZERS
499 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
501 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
506 static inline int cpp_in_system_header (cpp_reader *);
508 cpp_in_system_header (cpp_reader *pfile)
510 return pfile->buffer ? pfile->buffer->sysp : 0;
512 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
513 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
516 extern int _cpp_begin_message (cpp_reader *, int,
517 source_location, unsigned int);
520 extern void _cpp_free_definition (cpp_hashnode *);
521 extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
522 extern void _cpp_pop_context (cpp_reader *);
523 extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
524 const uchar *, size_t);
525 extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
526 extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
528 extern const uchar *_cpp_builtin_macro_text (cpp_reader *, cpp_hashnode *);
529 int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
531 extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
532 extern void _cpp_destroy_hashtable (cpp_reader *);
535 typedef struct _cpp_file _cpp_file;
536 extern _cpp_file *_cpp_find_file (cpp_reader *, const char *fname,
537 cpp_dir *start_dir, bool fake);
538 extern bool _cpp_find_failed (_cpp_file *);
539 extern void _cpp_mark_file_once_only (cpp_reader *, struct _cpp_file *);
540 extern void _cpp_fake_include (cpp_reader *, const char *);
541 extern bool _cpp_stack_file (cpp_reader *, _cpp_file*, bool);
542 extern bool _cpp_stack_include (cpp_reader *, const char *, int,
544 extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
545 extern void _cpp_report_missing_guards (cpp_reader *);
546 extern void _cpp_init_files (cpp_reader *);
547 extern void _cpp_cleanup_files (cpp_reader *);
548 extern void _cpp_pop_file_buffer (cpp_reader *, struct _cpp_file *);
549 extern bool _cpp_save_file_entries (cpp_reader *pfile, FILE *f);
550 extern bool _cpp_read_file_entries (cpp_reader *, FILE *);
553 extern bool _cpp_parse_expr (cpp_reader *);
554 extern struct op *_cpp_expand_op_stack (cpp_reader *);
557 extern void _cpp_process_line_notes (cpp_reader *, int);
558 extern void _cpp_clean_line (cpp_reader *);
559 extern bool _cpp_get_fresh_line (cpp_reader *);
560 extern bool _cpp_skip_block_comment (cpp_reader *);
561 extern cpp_token *_cpp_temp_token (cpp_reader *);
562 extern const cpp_token *_cpp_lex_token (cpp_reader *);
563 extern cpp_token *_cpp_lex_direct (cpp_reader *);
564 extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
565 extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
568 extern void _cpp_maybe_push_include_file (cpp_reader *);
571 extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
572 extern int _cpp_handle_directive (cpp_reader *, int);
573 extern void _cpp_define_builtin (cpp_reader *, const char *);
574 extern char ** _cpp_save_pragma_names (cpp_reader *);
575 extern void _cpp_restore_pragma_names (cpp_reader *, char **);
576 extern void _cpp_do__Pragma (cpp_reader *);
577 extern void _cpp_init_directives (cpp_reader *);
578 extern void _cpp_init_internal_pragmas (cpp_reader *);
579 extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
580 unsigned int, unsigned int);
581 extern void _cpp_pop_buffer (cpp_reader *);
584 extern bool _cpp_scan_out_logical_line (cpp_reader *, cpp_macro *);
585 extern bool _cpp_read_logical_line_trad (cpp_reader *);
586 extern void _cpp_overlay_buffer (cpp_reader *pfile, const uchar *, size_t);
587 extern void _cpp_remove_overlay (cpp_reader *);
588 extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
589 extern bool _cpp_expansions_different_trad (const cpp_macro *,
591 extern uchar *_cpp_copy_replacement_text (const cpp_macro *, uchar *);
592 extern size_t _cpp_replacement_text_len (const cpp_macro *);
594 /* In cppcharset.c. */
595 extern cppchar_t _cpp_valid_ucn (cpp_reader *, const uchar **,
597 extern void _cpp_destroy_iconv (cpp_reader *);
598 extern uchar *_cpp_convert_input (cpp_reader *, const char *, uchar *,
599 size_t, size_t, off_t *);
600 extern const char *_cpp_default_encoding (void);
602 /* Utility routines and macros. */
603 #define DSC(str) (const uchar *)str, sizeof str - 1
604 #define xnew(T) (T *) xmalloc (sizeof(T))
605 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
606 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
607 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
608 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
610 /* These are inline functions instead of macros so we can get type
612 static inline int ustrcmp (const uchar *, const uchar *);
613 static inline int ustrncmp (const uchar *, const uchar *, size_t);
614 static inline size_t ustrlen (const uchar *);
615 static inline uchar *uxstrdup (const uchar *);
616 static inline uchar *ustrchr (const uchar *, int);
617 static inline int ufputs (const uchar *, FILE *);
620 ustrcmp (const uchar *s1, const uchar *s2)
622 return strcmp ((const char *)s1, (const char *)s2);
626 ustrncmp (const uchar *s1, const uchar *s2, size_t n)
628 return strncmp ((const char *)s1, (const char *)s2, n);
632 ustrlen (const uchar *s1)
634 return strlen ((const char *)s1);
637 static inline uchar *
638 uxstrdup (const uchar *s1)
640 return (uchar *) xstrdup ((const char *)s1);
643 static inline uchar *
644 ustrchr (const uchar *s1, int c)
646 return (uchar *) strchr ((const char *)s1, c);
650 ufputs (const uchar *s, FILE *f)
652 return fputs ((const char *)s, f);
655 #endif /* ! LIBCPP_INTERNAL_H */