]> git.ipfire.org Git - thirdparty/gcc.git/blob - libcpp/internal.h
* internal.h (HAVE_ICONV): Undefine if we do not have HAVE_ICONV_H
[thirdparty/gcc.git] / libcpp / internal.h
1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 Free Software Foundation, Inc.
4
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.
9
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.
14
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. */
18
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
21 cpplib. */
22
23 #ifndef LIBCPP_INTERNAL_H
24 #define LIBCPP_INTERNAL_H
25
26 #include "symtab.h"
27 #include "cpp-id-data.h"
28
29 #ifndef HAVE_ICONV_H
30 #undef HAVE_ICONV
31 #endif
32
33 #if HAVE_ICONV
34 #include <iconv.h>
35 #else
36 #define HAVE_ICONV 0
37 typedef int iconv_t; /* dummy */
38 #endif
39
40 struct directive; /* Deliberately incomplete. */
41 struct pending_option;
42 struct op;
43 struct _cpp_strbuf;
44
45 typedef bool (*convert_f) (iconv_t, const unsigned char *, size_t,
46 struct _cpp_strbuf *);
47 struct cset_converter
48 {
49 convert_f func;
50 iconv_t cd;
51 };
52
53 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
54
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))))
61
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)
66
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); \
72 } while (0)
73
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
77
78 /* Host alignment handling. */
79 struct dummy
80 {
81 char c;
82 union
83 {
84 double d;
85 int *p;
86 } u;
87 };
88
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)
92
93 #define _cpp_mark_macro_used(NODE) do { \
94 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
95 (NODE)->value.macro->used = 1; } while (0)
96
97 /* A generic memory buffer, and operations on it. */
98 typedef struct _cpp_buff _cpp_buff;
99 struct _cpp_buff
100 {
101 struct _cpp_buff *next;
102 unsigned char *base, *cur, *limit;
103 };
104
105 extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
106 extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
107 extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
108 extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
109 extern void _cpp_free_buff (_cpp_buff *);
110 extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
111 extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
112
113 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
114 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
115 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
116
117 /* #include types. */
118 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
119
120 union utoken
121 {
122 const cpp_token *token;
123 const cpp_token **ptoken;
124 };
125
126 /* A "run" of tokens; part of a chain of runs. */
127 typedef struct tokenrun tokenrun;
128 struct tokenrun
129 {
130 tokenrun *next, *prev;
131 cpp_token *base, *limit;
132 };
133
134 /* Accessor macros for struct cpp_context. */
135 #define FIRST(c) ((c)->u.iso.first)
136 #define LAST(c) ((c)->u.iso.last)
137 #define CUR(c) ((c)->u.trad.cur)
138 #define RLIMIT(c) ((c)->u.trad.rlimit)
139
140 typedef struct cpp_context cpp_context;
141 struct cpp_context
142 {
143 /* Doubly-linked list. */
144 cpp_context *next, *prev;
145
146 union
147 {
148 /* For ISO macro expansion. Contexts other than the base context
149 are contiguous tokens. e.g. macro expansions, expanded
150 argument tokens. */
151 struct
152 {
153 union utoken first;
154 union utoken last;
155 } iso;
156
157 /* For traditional macro expansion. */
158 struct
159 {
160 const uchar *cur;
161 const uchar *rlimit;
162 } trad;
163 } u;
164
165 /* If non-NULL, a buffer used for storage related to this context.
166 When the context is popped, the buffer is released. */
167 _cpp_buff *buff;
168
169 /* For a macro context, the macro node, otherwise NULL. */
170 cpp_hashnode *macro;
171
172 /* True if utoken element is token, else ptoken. */
173 bool direct_p;
174 };
175
176 struct lexer_state
177 {
178 /* Nonzero if first token on line is CPP_HASH. */
179 unsigned char in_directive;
180
181 /* Nonzero if in a directive that will handle padding tokens itself.
182 #include needs this to avoid problems with computed include and
183 spacing between tokens. */
184 unsigned char directive_wants_padding;
185
186 /* True if we are skipping a failed conditional group. */
187 unsigned char skipping;
188
189 /* Nonzero if in a directive that takes angle-bracketed headers. */
190 unsigned char angled_headers;
191
192 /* Nonzero if in a #if or #elif directive. */
193 unsigned char in_expression;
194
195 /* Nonzero to save comments. Turned off if discard_comments, and in
196 all directives apart from #define. */
197 unsigned char save_comments;
198
199 /* Nonzero if lexing __VA_ARGS__ is valid. */
200 unsigned char va_args_ok;
201
202 /* Nonzero if lexing poisoned identifiers is valid. */
203 unsigned char poisoned_ok;
204
205 /* Nonzero to prevent macro expansion. */
206 unsigned char prevent_expansion;
207
208 /* Nonzero when parsing arguments to a function-like macro. */
209 unsigned char parsing_args;
210
211 /* Nonzero if prevent_expansion is true only because output is
212 being discarded. */
213 unsigned char discarding_output;
214
215 /* Nonzero to skip evaluating part of an expression. */
216 unsigned int skip_eval;
217 };
218
219 /* Special nodes - identifiers with predefined significance. */
220 struct spec_nodes
221 {
222 cpp_hashnode *n_defined; /* defined operator */
223 cpp_hashnode *n_true; /* C++ keyword true */
224 cpp_hashnode *n_false; /* C++ keyword false */
225 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
226 };
227
228 typedef struct _cpp_line_note _cpp_line_note;
229 struct _cpp_line_note
230 {
231 /* Location in the clean line the note refers to. */
232 const uchar *pos;
233
234 /* Type of note. The 9 'from' trigraph characters represent those
235 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
236 intervening space, and anything else is invalid. */
237 unsigned int type;
238 };
239
240 /* Represents the contents of a file cpplib has read in. */
241 struct cpp_buffer
242 {
243 const uchar *cur; /* Current location. */
244 const uchar *line_base; /* Start of current physical line. */
245 const uchar *next_line; /* Start of to-be-cleaned logical line. */
246
247 const uchar *buf; /* Entire character buffer. */
248 const uchar *rlimit; /* Writable byte at end of file. */
249
250 _cpp_line_note *notes; /* Array of notes. */
251 unsigned int cur_note; /* Next note to process. */
252 unsigned int notes_used; /* Number of notes. */
253 unsigned int notes_cap; /* Size of allocated array. */
254
255 struct cpp_buffer *prev;
256
257 /* Pointer into the file table; non-NULL if this is a file buffer.
258 Used for include_next and to record control macros. */
259 struct _cpp_file *file;
260
261 /* Value of if_stack at start of this file.
262 Used to prohibit unmatched #endif (etc) in an include file. */
263 struct if_stack *if_stack;
264
265 /* True if we need to get the next clean line. */
266 bool need_line;
267
268 /* True if we have already warned about C++ comments in this file.
269 The warning happens only for C89 extended mode with -pedantic on,
270 or for -Wtraditional, and only once per file (otherwise it would
271 be far too noisy). */
272 unsigned int warned_cplusplus_comments : 1;
273
274 /* True if we don't process trigraphs and escaped newlines. True
275 for preprocessed input, command line directives, and _Pragma
276 buffers. */
277 unsigned int from_stage3 : 1;
278
279 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
280 true, a CPP_EOF token is then returned. Otherwise, the next
281 token from the enclosing buffer is returned. */
282 unsigned int return_at_eof : 1;
283
284 /* One for a system header, two for a C system header file that therefore
285 needs to be extern "C" protected in C++, and zero otherwise. */
286 unsigned char sysp;
287
288 /* The directory of the this buffer's file. Its NAME member is not
289 allocated, so we don't need to worry about freeing it. */
290 struct cpp_dir dir;
291
292 /* Descriptor for converting from the input character set to the
293 source character set. */
294 struct cset_converter input_cset_desc;
295 };
296
297 /* A cpp_reader encapsulates the "state" of a pre-processor run.
298 Applying cpp_get_token repeatedly yields a stream of pre-processor
299 tokens. Usually, there is only one cpp_reader object active. */
300 struct cpp_reader
301 {
302 /* Top of buffer stack. */
303 cpp_buffer *buffer;
304
305 /* Overlaid buffer (can be different after processing #include). */
306 cpp_buffer *overlaid_buffer;
307
308 /* Lexer state. */
309 struct lexer_state state;
310
311 /* Source line tracking. */
312 struct line_maps *line_table;
313
314 /* The line of the '#' of the current directive. */
315 source_location directive_line;
316
317 /* Memory buffers. */
318 _cpp_buff *a_buff; /* Aligned permanent storage. */
319 _cpp_buff *u_buff; /* Unaligned permanent storage. */
320 _cpp_buff *free_buffs; /* Free buffer chain. */
321
322 /* Context stack. */
323 struct cpp_context base_context;
324 struct cpp_context *context;
325
326 /* If in_directive, the directive if known. */
327 const struct directive *directive;
328
329 /* Token generated while handling a directive, if any. */
330 cpp_token directive_result;
331
332 /* Search paths for include files. */
333 struct cpp_dir *quote_include; /* "" */
334 struct cpp_dir *bracket_include; /* <> */
335 struct cpp_dir no_search_path; /* No path. */
336
337 /* Chain of all hashed _cpp_file instances. */
338 struct _cpp_file *all_files;
339
340 struct _cpp_file *main_file;
341
342 /* File and directory hash table. */
343 struct htab *file_hash;
344 struct htab *dir_hash;
345 struct file_hash_entry *file_hash_entries;
346 unsigned int file_hash_entries_allocated, file_hash_entries_used;
347
348 /* Nonzero means don't look for #include "foo" the source-file
349 directory. */
350 bool quote_ignores_source_dir;
351
352 /* Nonzero if any file has contained #pragma once or #import has
353 been used. */
354 bool seen_once_only;
355
356 /* Multiple include optimization. */
357 const cpp_hashnode *mi_cmacro;
358 const cpp_hashnode *mi_ind_cmacro;
359 bool mi_valid;
360
361 /* Lexing. */
362 cpp_token *cur_token;
363 tokenrun base_run, *cur_run;
364 unsigned int lookaheads;
365
366 /* Nonzero prevents the lexer from re-using the token runs. */
367 unsigned int keep_tokens;
368
369 /* Error counter for exit code. */
370 unsigned int errors;
371
372 /* Buffer to hold macro definition string. */
373 unsigned char *macro_buffer;
374 unsigned int macro_buffer_len;
375
376 /* Descriptor for converting from the source character set to the
377 execution character set. */
378 struct cset_converter narrow_cset_desc;
379
380 /* Descriptor for converting from the source character set to the
381 wide execution character set. */
382 struct cset_converter wide_cset_desc;
383
384 /* Date and time text. Calculated together if either is requested. */
385 const uchar *date;
386 const uchar *time;
387
388 /* EOF token, and a token forcing paste avoidance. */
389 cpp_token avoid_paste;
390 cpp_token eof;
391
392 /* Opaque handle to the dependencies of mkdeps.c. */
393 struct deps *deps;
394
395 /* Obstack holding all macro hash nodes. This never shrinks.
396 See cpphash.c */
397 struct obstack hash_ob;
398
399 /* Obstack holding buffer and conditional structures. This is a
400 real stack. See cpplib.c. */
401 struct obstack buffer_ob;
402
403 /* Pragma table - dynamic, because a library user can add to the
404 list of recognized pragmas. */
405 struct pragma_entry *pragmas;
406
407 /* Call backs to cpplib client. */
408 struct cpp_callbacks cb;
409
410 /* Identifier hash table. */
411 struct ht *hash_table;
412
413 /* Expression parser stack. */
414 struct op *op_stack, *op_limit;
415
416 /* User visible options. */
417 struct cpp_options opts;
418
419 /* Special nodes - identifiers with predefined significance to the
420 preprocessor. */
421 struct spec_nodes spec_nodes;
422
423 /* Whether cpplib owns the hashtable. */
424 bool our_hashtable;
425
426 /* Traditional preprocessing output buffer (a logical line). */
427 struct
428 {
429 uchar *base;
430 uchar *limit;
431 uchar *cur;
432 source_location first_line;
433 } out;
434
435 /* Used for buffer overlays by cpptrad.c. */
436 const uchar *saved_cur, *saved_rlimit, *saved_line_base;
437
438 /* A saved list of the defined macros, for dependency checking
439 of precompiled headers. */
440 struct cpp_savedstate *savedstate;
441 };
442
443 /* Character classes. Based on the more primitive macros in safe-ctype.h.
444 If the definition of `numchar' looks odd to you, please look up the
445 definition of a pp-number in the C standard [section 6.4.8 of C99].
446
447 In the unlikely event that characters other than \r and \n enter
448 the set is_vspace, the macro handle_newline() in cpplex.c must be
449 updated. */
450 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
451
452 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
453 #define is_numchar(x) ISIDNUM(x)
454 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
455 #define is_numstart(x) ISDIGIT(x)
456 #define is_hspace(x) ISBLANK(x)
457 #define is_vspace(x) IS_VSPACE(x)
458 #define is_nvspace(x) IS_NVSPACE(x)
459 #define is_space(x) IS_SPACE_OR_NUL(x)
460
461 /* This table is constant if it can be initialized at compile time,
462 which is the case if cpp was compiled with GCC >=2.7, or another
463 compiler that supports C99. */
464 #if HAVE_DESIGNATED_INITIALIZERS
465 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
466 #else
467 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
468 #endif
469
470 /* Macros. */
471
472 static inline int cpp_in_system_header (cpp_reader *);
473 static inline int
474 cpp_in_system_header (cpp_reader *pfile)
475 {
476 return pfile->buffer ? pfile->buffer->sysp : 0;
477 }
478 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
479 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
480
481 /* In cpperror.c */
482 extern int _cpp_begin_message (cpp_reader *, int,
483 source_location, unsigned int);
484
485 /* In cppmacro.c */
486 extern void _cpp_free_definition (cpp_hashnode *);
487 extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
488 extern void _cpp_pop_context (cpp_reader *);
489 extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
490 const uchar *, size_t);
491 extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
492 extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
493 unsigned int);
494 extern const uchar *_cpp_builtin_macro_text (cpp_reader *, cpp_hashnode *);
495 int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
496 /* In cpphash.c */
497 extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
498 extern void _cpp_destroy_hashtable (cpp_reader *);
499
500 /* In cppfiles.c */
501 typedef struct _cpp_file _cpp_file;
502 extern _cpp_file *_cpp_find_file (cpp_reader *, const char *fname,
503 cpp_dir *start_dir, bool fake);
504 extern bool _cpp_find_failed (_cpp_file *);
505 extern void _cpp_mark_file_once_only (cpp_reader *, struct _cpp_file *);
506 extern void _cpp_fake_include (cpp_reader *, const char *);
507 extern bool _cpp_stack_file (cpp_reader *, _cpp_file*, bool);
508 extern bool _cpp_stack_include (cpp_reader *, const char *, int,
509 enum include_type);
510 extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
511 extern void _cpp_report_missing_guards (cpp_reader *);
512 extern void _cpp_init_files (cpp_reader *);
513 extern void _cpp_cleanup_files (cpp_reader *);
514 extern void _cpp_pop_file_buffer (cpp_reader *, struct _cpp_file *);
515 extern bool _cpp_save_file_entries (cpp_reader *pfile, FILE *f);
516 extern bool _cpp_read_file_entries (cpp_reader *, FILE *);
517
518 /* In cppexp.c */
519 extern bool _cpp_parse_expr (cpp_reader *);
520 extern struct op *_cpp_expand_op_stack (cpp_reader *);
521
522 /* In cpplex.c */
523 extern void _cpp_process_line_notes (cpp_reader *, int);
524 extern void _cpp_clean_line (cpp_reader *);
525 extern bool _cpp_get_fresh_line (cpp_reader *);
526 extern bool _cpp_skip_block_comment (cpp_reader *);
527 extern cpp_token *_cpp_temp_token (cpp_reader *);
528 extern const cpp_token *_cpp_lex_token (cpp_reader *);
529 extern cpp_token *_cpp_lex_direct (cpp_reader *);
530 extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
531 extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
532
533 /* In cppinit.c. */
534 extern void _cpp_maybe_push_include_file (cpp_reader *);
535
536 /* In cpplib.c */
537 extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
538 extern int _cpp_handle_directive (cpp_reader *, int);
539 extern void _cpp_define_builtin (cpp_reader *, const char *);
540 extern char ** _cpp_save_pragma_names (cpp_reader *);
541 extern void _cpp_restore_pragma_names (cpp_reader *, char **);
542 extern void _cpp_do__Pragma (cpp_reader *);
543 extern void _cpp_init_directives (cpp_reader *);
544 extern void _cpp_init_internal_pragmas (cpp_reader *);
545 extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
546 unsigned int, unsigned int);
547 extern void _cpp_pop_buffer (cpp_reader *);
548
549 /* In cpptrad.c. */
550 extern bool _cpp_scan_out_logical_line (cpp_reader *, cpp_macro *);
551 extern bool _cpp_read_logical_line_trad (cpp_reader *);
552 extern void _cpp_overlay_buffer (cpp_reader *pfile, const uchar *, size_t);
553 extern void _cpp_remove_overlay (cpp_reader *);
554 extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
555 extern bool _cpp_expansions_different_trad (const cpp_macro *,
556 const cpp_macro *);
557 extern uchar *_cpp_copy_replacement_text (const cpp_macro *, uchar *);
558 extern size_t _cpp_replacement_text_len (const cpp_macro *);
559
560 /* In cppcharset.c. */
561 extern cppchar_t _cpp_valid_ucn (cpp_reader *, const uchar **,
562 const uchar *, int);
563 extern void _cpp_destroy_iconv (cpp_reader *);
564 extern uchar *_cpp_convert_input (cpp_reader *, const char *, uchar *,
565 size_t, size_t, off_t *);
566 extern const char *_cpp_default_encoding (void);
567
568 /* Utility routines and macros. */
569 #define DSC(str) (const uchar *)str, sizeof str - 1
570
571 /* These are inline functions instead of macros so we can get type
572 checking. */
573 static inline int ustrcmp (const uchar *, const uchar *);
574 static inline int ustrncmp (const uchar *, const uchar *, size_t);
575 static inline size_t ustrlen (const uchar *);
576 static inline uchar *uxstrdup (const uchar *);
577 static inline uchar *ustrchr (const uchar *, int);
578 static inline int ufputs (const uchar *, FILE *);
579
580 static inline int
581 ustrcmp (const uchar *s1, const uchar *s2)
582 {
583 return strcmp ((const char *)s1, (const char *)s2);
584 }
585
586 static inline int
587 ustrncmp (const uchar *s1, const uchar *s2, size_t n)
588 {
589 return strncmp ((const char *)s1, (const char *)s2, n);
590 }
591
592 static inline size_t
593 ustrlen (const uchar *s1)
594 {
595 return strlen ((const char *)s1);
596 }
597
598 static inline uchar *
599 uxstrdup (const uchar *s1)
600 {
601 return (uchar *) xstrdup ((const char *)s1);
602 }
603
604 static inline uchar *
605 ustrchr (const uchar *s1, int c)
606 {
607 return (uchar *) strchr ((const char *)s1, c);
608 }
609
610 static inline int
611 ufputs (const uchar *s, FILE *f)
612 {
613 return fputs ((const char *)s, f);
614 }
615
616 #endif /* ! LIBCPP_INTERNAL_H */