(arm_is_longcall_p): Update comment describing this funciton's behaviour.
[official-gcc.git] / libcpp / internal.h
blob53b02f8c94c3b90b3bb295140ff189c9a2158fc0
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
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 should not be used outside
21 cpplib. */
23 #ifndef LIBCPP_INTERNAL_H
24 #define LIBCPP_INTERNAL_H
26 #include "symtab.h"
27 #include "cpp-id-data.h"
29 #if defined HAVE_ICONV_H && defined HAVE_ICONV
30 #include <iconv.h>
31 #else
32 #define HAVE_ICONV 0
33 typedef int iconv_t; /* dummy */
34 #endif
36 struct directive; /* Deliberately incomplete. */
37 struct pending_option;
38 struct op;
39 struct _cpp_strbuf;
41 typedef bool (*convert_f) (iconv_t, const unsigned char *, size_t,
42 struct _cpp_strbuf *);
43 struct cset_converter
45 convert_f func;
46 iconv_t cd;
49 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
51 /* Test if a sign is valid within a preprocessing number. */
52 #define VALID_SIGN(c, prevc) \
53 (((c) == '+' || (c) == '-') && \
54 ((prevc) == 'e' || (prevc) == 'E' \
55 || (((prevc) == 'p' || (prevc) == 'P') \
56 && CPP_OPTION (pfile, extended_numbers))))
58 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
59 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
60 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base)
61 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
63 #define CPP_INCREMENT_LINE(PFILE, COLS_HINT) do { \
64 const struct line_maps *line_table = PFILE->line_table; \
65 const struct line_map *map = &line_table->maps[line_table->used-1]; \
66 unsigned int line = SOURCE_LINE (map, line_table->highest_line); \
67 linemap_line_start (PFILE->line_table, line + 1, COLS_HINT); \
68 } while (0)
70 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
71 efficiency, and partly to limit runaway recursion. */
72 #define CPP_STACK_MAX 200
74 /* Host alignment handling. */
75 struct dummy
77 char c;
78 union
80 double d;
81 int *p;
82 } u;
85 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
86 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
87 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
89 #define _cpp_mark_macro_used(NODE) do { \
90 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
91 (NODE)->value.macro->used = 1; } while (0)
93 /* A generic memory buffer, and operations on it. */
94 typedef struct _cpp_buff _cpp_buff;
95 struct _cpp_buff
97 struct _cpp_buff *next;
98 unsigned char *base, *cur, *limit;
101 extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
102 extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
103 extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
104 extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
105 extern void _cpp_free_buff (_cpp_buff *);
106 extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
107 extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
109 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
110 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
111 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
113 /* #include types. */
114 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
116 union utoken
118 const cpp_token *token;
119 const cpp_token **ptoken;
122 /* A "run" of tokens; part of a chain of runs. */
123 typedef struct tokenrun tokenrun;
124 struct tokenrun
126 tokenrun *next, *prev;
127 cpp_token *base, *limit;
130 /* Accessor macros for struct cpp_context. */
131 #define FIRST(c) ((c)->u.iso.first)
132 #define LAST(c) ((c)->u.iso.last)
133 #define CUR(c) ((c)->u.trad.cur)
134 #define RLIMIT(c) ((c)->u.trad.rlimit)
136 typedef struct cpp_context cpp_context;
137 struct cpp_context
139 /* Doubly-linked list. */
140 cpp_context *next, *prev;
142 union
144 /* For ISO macro expansion. Contexts other than the base context
145 are contiguous tokens. e.g. macro expansions, expanded
146 argument tokens. */
147 struct
149 union utoken first;
150 union utoken last;
151 } iso;
153 /* For traditional macro expansion. */
154 struct
156 const uchar *cur;
157 const uchar *rlimit;
158 } trad;
159 } u;
161 /* If non-NULL, a buffer used for storage related to this context.
162 When the context is popped, the buffer is released. */
163 _cpp_buff *buff;
165 /* For a macro context, the macro node, otherwise NULL. */
166 cpp_hashnode *macro;
168 /* True if utoken element is token, else ptoken. */
169 bool direct_p;
172 struct lexer_state
174 /* Nonzero if first token on line is CPP_HASH. */
175 unsigned char in_directive;
177 /* Nonzero if in a directive that will handle padding tokens itself.
178 #include needs this to avoid problems with computed include and
179 spacing between tokens. */
180 unsigned char directive_wants_padding;
182 /* True if we are skipping a failed conditional group. */
183 unsigned char skipping;
185 /* Nonzero if in a directive that takes angle-bracketed headers. */
186 unsigned char angled_headers;
188 /* Nonzero if in a #if or #elif directive. */
189 unsigned char in_expression;
191 /* Nonzero to save comments. Turned off if discard_comments, and in
192 all directives apart from #define. */
193 unsigned char save_comments;
195 /* Nonzero if lexing __VA_ARGS__ is valid. */
196 unsigned char va_args_ok;
198 /* Nonzero if lexing poisoned identifiers is valid. */
199 unsigned char poisoned_ok;
201 /* Nonzero to prevent macro expansion. */
202 unsigned char prevent_expansion;
204 /* Nonzero when parsing arguments to a function-like macro. */
205 unsigned char parsing_args;
207 /* Nonzero if prevent_expansion is true only because output is
208 being discarded. */
209 unsigned char discarding_output;
211 /* Nonzero to skip evaluating part of an expression. */
212 unsigned int skip_eval;
215 /* Special nodes - identifiers with predefined significance. */
216 struct spec_nodes
218 cpp_hashnode *n_defined; /* defined operator */
219 cpp_hashnode *n_true; /* C++ keyword true */
220 cpp_hashnode *n_false; /* C++ keyword false */
221 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
224 typedef struct _cpp_line_note _cpp_line_note;
225 struct _cpp_line_note
227 /* Location in the clean line the note refers to. */
228 const uchar *pos;
230 /* Type of note. The 9 'from' trigraph characters represent those
231 trigraphs, '\\' an escaped newline, ' ' an escaped newline with
232 intervening space, and anything else is invalid. */
233 unsigned int type;
236 /* Represents the contents of a file cpplib has read in. */
237 struct cpp_buffer
239 const uchar *cur; /* Current location. */
240 const uchar *line_base; /* Start of current physical line. */
241 const uchar *next_line; /* Start of to-be-cleaned logical line. */
243 const uchar *buf; /* Entire character buffer. */
244 const uchar *rlimit; /* Writable byte at end of file. */
246 _cpp_line_note *notes; /* Array of notes. */
247 unsigned int cur_note; /* Next note to process. */
248 unsigned int notes_used; /* Number of notes. */
249 unsigned int notes_cap; /* Size of allocated array. */
251 struct cpp_buffer *prev;
253 /* Pointer into the file table; non-NULL if this is a file buffer.
254 Used for include_next and to record control macros. */
255 struct _cpp_file *file;
257 /* Value of if_stack at start of this file.
258 Used to prohibit unmatched #endif (etc) in an include file. */
259 struct if_stack *if_stack;
261 /* True if we need to get the next clean line. */
262 bool need_line;
264 /* True if we have already warned about C++ comments in this file.
265 The warning happens only for C89 extended mode with -pedantic on,
266 or for -Wtraditional, and only once per file (otherwise it would
267 be far too noisy). */
268 unsigned int warned_cplusplus_comments : 1;
270 /* True if we don't process trigraphs and escaped newlines. True
271 for preprocessed input, command line directives, and _Pragma
272 buffers. */
273 unsigned int from_stage3 : 1;
275 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
276 true, a CPP_EOF token is then returned. Otherwise, the next
277 token from the enclosing buffer is returned. */
278 unsigned int return_at_eof : 1;
280 /* One for a system header, two for a C system header file that therefore
281 needs to be extern "C" protected in C++, and zero otherwise. */
282 unsigned char sysp;
284 /* The directory of the this buffer's file. Its NAME member is not
285 allocated, so we don't need to worry about freeing it. */
286 struct cpp_dir dir;
288 /* Descriptor for converting from the input character set to the
289 source character set. */
290 struct cset_converter input_cset_desc;
293 /* A cpp_reader encapsulates the "state" of a pre-processor run.
294 Applying cpp_get_token repeatedly yields a stream of pre-processor
295 tokens. Usually, there is only one cpp_reader object active. */
296 struct cpp_reader
298 /* Top of buffer stack. */
299 cpp_buffer *buffer;
301 /* Overlaid buffer (can be different after processing #include). */
302 cpp_buffer *overlaid_buffer;
304 /* Lexer state. */
305 struct lexer_state state;
307 /* Source line tracking. */
308 struct line_maps *line_table;
310 /* The line of the '#' of the current directive. */
311 source_location directive_line;
313 /* Memory buffers. */
314 _cpp_buff *a_buff; /* Aligned permanent storage. */
315 _cpp_buff *u_buff; /* Unaligned permanent storage. */
316 _cpp_buff *free_buffs; /* Free buffer chain. */
318 /* Context stack. */
319 struct cpp_context base_context;
320 struct cpp_context *context;
322 /* If in_directive, the directive if known. */
323 const struct directive *directive;
325 /* Search paths for include files. */
326 struct cpp_dir *quote_include; /* "" */
327 struct cpp_dir *bracket_include; /* <> */
328 struct cpp_dir no_search_path; /* No path. */
330 /* Chain of all hashed _cpp_file instances. */
331 struct _cpp_file *all_files;
333 struct _cpp_file *main_file;
335 /* File and directory hash table. */
336 struct htab *file_hash;
337 struct htab *dir_hash;
338 struct file_hash_entry *file_hash_entries;
339 unsigned int file_hash_entries_allocated, file_hash_entries_used;
341 /* Nonzero means don't look for #include "foo" the source-file
342 directory. */
343 bool quote_ignores_source_dir;
345 /* Nonzero if any file has contained #pragma once or #import has
346 been used. */
347 bool seen_once_only;
349 /* Multiple include optimization. */
350 const cpp_hashnode *mi_cmacro;
351 const cpp_hashnode *mi_ind_cmacro;
352 bool mi_valid;
354 /* Lexing. */
355 cpp_token *cur_token;
356 tokenrun base_run, *cur_run;
357 unsigned int lookaheads;
359 /* Nonzero prevents the lexer from re-using the token runs. */
360 unsigned int keep_tokens;
362 /* Error counter for exit code. */
363 unsigned int errors;
365 /* Buffer to hold macro definition string. */
366 unsigned char *macro_buffer;
367 unsigned int macro_buffer_len;
369 /* Descriptor for converting from the source character set to the
370 execution character set. */
371 struct cset_converter narrow_cset_desc;
373 /* Descriptor for converting from the source character set to the
374 wide execution character set. */
375 struct cset_converter wide_cset_desc;
377 /* Date and time text. Calculated together if either is requested. */
378 const uchar *date;
379 const uchar *time;
381 /* EOF token, and a token forcing paste avoidance. */
382 cpp_token avoid_paste;
383 cpp_token eof;
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 to cpplib client. */
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 /* Whether cpplib owns the hashtable. */
417 bool our_hashtable;
419 /* Traditional preprocessing output buffer (a logical line). */
420 struct
422 uchar *base;
423 uchar *limit;
424 uchar *cur;
425 source_location first_line;
426 } out;
428 /* Used for buffer overlays by cpptrad.c. */
429 const uchar *saved_cur, *saved_rlimit, *saved_line_base;
431 /* A saved list of the defined macros, for dependency checking
432 of precompiled headers. */
433 struct cpp_savedstate *savedstate;
436 /* Character classes. Based on the more primitive macros in safe-ctype.h.
437 If the definition of `numchar' looks odd to you, please look up the
438 definition of a pp-number in the C standard [section 6.4.8 of C99].
440 In the unlikely event that characters other than \r and \n enter
441 the set is_vspace, the macro handle_newline() in cpplex.c must be
442 updated. */
443 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
445 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
446 #define is_numchar(x) ISIDNUM(x)
447 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
448 #define is_numstart(x) ISDIGIT(x)
449 #define is_hspace(x) ISBLANK(x)
450 #define is_vspace(x) IS_VSPACE(x)
451 #define is_nvspace(x) IS_NVSPACE(x)
452 #define is_space(x) IS_SPACE_OR_NUL(x)
454 /* This table is constant if it can be initialized at compile time,
455 which is the case if cpp was compiled with GCC >=2.7, or another
456 compiler that supports C99. */
457 #if HAVE_DESIGNATED_INITIALIZERS
458 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
459 #else
460 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
461 #endif
463 /* Macros. */
465 static inline int cpp_in_system_header (cpp_reader *);
466 static inline int
467 cpp_in_system_header (cpp_reader *pfile)
469 return pfile->buffer ? pfile->buffer->sysp : 0;
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 (cpp_reader *, int,
476 source_location, unsigned int);
478 /* In cppmacro.c */
479 extern void _cpp_free_definition (cpp_hashnode *);
480 extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
481 extern void _cpp_pop_context (cpp_reader *);
482 extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
483 const uchar *, size_t);
484 extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
485 extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
486 unsigned int);
487 extern const uchar *_cpp_builtin_macro_text (cpp_reader *, cpp_hashnode *);
488 int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
489 /* In cpphash.c */
490 extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
491 extern void _cpp_destroy_hashtable (cpp_reader *);
493 /* In cppfiles.c */
494 typedef struct _cpp_file _cpp_file;
495 extern _cpp_file *_cpp_find_file (cpp_reader *, const char *fname,
496 cpp_dir *start_dir, bool fake);
497 extern bool _cpp_find_failed (_cpp_file *);
498 extern void _cpp_mark_file_once_only (cpp_reader *, struct _cpp_file *);
499 extern void _cpp_fake_include (cpp_reader *, const char *);
500 extern bool _cpp_stack_file (cpp_reader *, _cpp_file*, bool);
501 extern bool _cpp_stack_include (cpp_reader *, const char *, int,
502 enum include_type);
503 extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
504 extern void _cpp_report_missing_guards (cpp_reader *);
505 extern void _cpp_init_files (cpp_reader *);
506 extern void _cpp_cleanup_files (cpp_reader *);
507 extern void _cpp_pop_file_buffer (cpp_reader *, struct _cpp_file *);
508 extern bool _cpp_save_file_entries (cpp_reader *pfile, FILE *f);
509 extern bool _cpp_read_file_entries (cpp_reader *, FILE *);
511 /* In cppexp.c */
512 extern bool _cpp_parse_expr (cpp_reader *);
513 extern struct op *_cpp_expand_op_stack (cpp_reader *);
515 /* In cpplex.c */
516 extern void _cpp_process_line_notes (cpp_reader *, int);
517 extern void _cpp_clean_line (cpp_reader *);
518 extern bool _cpp_get_fresh_line (cpp_reader *);
519 extern bool _cpp_skip_block_comment (cpp_reader *);
520 extern cpp_token *_cpp_temp_token (cpp_reader *);
521 extern const cpp_token *_cpp_lex_token (cpp_reader *);
522 extern cpp_token *_cpp_lex_direct (cpp_reader *);
523 extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
524 extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
526 /* In cppinit.c. */
527 extern void _cpp_maybe_push_include_file (cpp_reader *);
529 /* In cpplib.c */
530 extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
531 extern int _cpp_handle_directive (cpp_reader *, int);
532 extern void _cpp_define_builtin (cpp_reader *, const char *);
533 extern char ** _cpp_save_pragma_names (cpp_reader *);
534 extern void _cpp_restore_pragma_names (cpp_reader *, char **);
535 extern void _cpp_do__Pragma (cpp_reader *);
536 extern void _cpp_init_directives (cpp_reader *);
537 extern void _cpp_init_internal_pragmas (cpp_reader *);
538 extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
539 unsigned int, unsigned int);
540 extern void _cpp_pop_buffer (cpp_reader *);
542 /* In cpptrad.c. */
543 extern bool _cpp_scan_out_logical_line (cpp_reader *, cpp_macro *);
544 extern bool _cpp_read_logical_line_trad (cpp_reader *);
545 extern void _cpp_overlay_buffer (cpp_reader *pfile, const uchar *, size_t);
546 extern void _cpp_remove_overlay (cpp_reader *);
547 extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
548 extern bool _cpp_expansions_different_trad (const cpp_macro *,
549 const cpp_macro *);
550 extern uchar *_cpp_copy_replacement_text (const cpp_macro *, uchar *);
551 extern size_t _cpp_replacement_text_len (const cpp_macro *);
553 /* In cppcharset.c. */
554 extern cppchar_t _cpp_valid_ucn (cpp_reader *, const uchar **,
555 const uchar *, int);
556 extern void _cpp_destroy_iconv (cpp_reader *);
557 extern uchar *_cpp_convert_input (cpp_reader *, const char *, uchar *,
558 size_t, size_t, off_t *);
559 extern const char *_cpp_default_encoding (void);
561 /* Utility routines and macros. */
562 #define DSC(str) (const uchar *)str, sizeof str - 1
564 /* These are inline functions instead of macros so we can get type
565 checking. */
566 static inline int ustrcmp (const uchar *, const uchar *);
567 static inline int ustrncmp (const uchar *, const uchar *, size_t);
568 static inline size_t ustrlen (const uchar *);
569 static inline uchar *uxstrdup (const uchar *);
570 static inline uchar *ustrchr (const uchar *, int);
571 static inline int ufputs (const uchar *, FILE *);
573 static inline int
574 ustrcmp (const uchar *s1, const uchar *s2)
576 return strcmp ((const char *)s1, (const char *)s2);
579 static inline int
580 ustrncmp (const uchar *s1, const uchar *s2, size_t n)
582 return strncmp ((const char *)s1, (const char *)s2, n);
585 static inline size_t
586 ustrlen (const uchar *s1)
588 return strlen ((const char *)s1);
591 static inline uchar *
592 uxstrdup (const uchar *s1)
594 return (uchar *) xstrdup ((const char *)s1);
597 static inline uchar *
598 ustrchr (const uchar *s1, int c)
600 return (uchar *) strchr ((const char *)s1, c);
603 static inline int
604 ufputs (const uchar *s, FILE *f)
606 return fputs ((const char *)s, f);
609 #endif /* ! LIBCPP_INTERNAL_H */