1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* This header defines all the internal data structures and functions
19 that need to be visible across files. It's called cpphash.h for
20 historical reasons. */
22 #ifndef __GCC_CPPHASH__
23 #define __GCC_CPPHASH__
25 struct directive
; /* These are deliberately incomplete. */
28 /* Test if a sign is valid within a preprocessing number. */
29 #define VALID_SIGN(c, prevc) \
30 (((c) == '+' || (c) == '-') && \
31 ((prevc) == 'e' || (prevc) == 'E' \
32 || (((prevc) == 'p' || (prevc) == 'P') \
33 && CPP_OPTION (pfile, extended_numbers))))
35 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
36 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
37 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
38 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
39 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
41 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
42 efficiency, and partly to limit runaway recursion. */
43 #define CPP_STACK_MAX 200
46 #define POOL_ALIGN(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
47 #define POOL_FRONT(p) ((p)->cur->front)
48 #define POOL_LIMIT(p) ((p)->cur->limit)
49 #define POOL_BASE(p) ((p)->cur->base)
50 #define POOL_SIZE(p) ((p)->cur->limit - (p)->cur->base)
51 #define POOL_ROOM(p) ((p)->cur->limit - (p)->cur->front)
52 #define POOL_USED(p) ((p)->cur->front - (p)->cur->base)
53 #define POOL_COMMIT(p, len) do {\
54 ((p)->cur->front += POOL_ALIGN (len, (p)->align));\
55 if ((p)->cur->front > (p)->cur->limit) abort ();} while (0)
57 typedef struct cpp_chunk cpp_chunk
;
66 typedef struct cpp_pool cpp_pool
;
69 struct cpp_chunk
*cur
, *locked
;
70 unsigned char *pos
; /* Current position. */
75 /* List of directories to look for include files in. */
78 struct file_name_list
*next
;
79 struct file_name_list
*alloc
; /* for the cache of
80 current directory entries */
83 /* We use these to tell if the directory mentioned here is a duplicate
84 of an earlier directory on the search path. */
87 /* If the following is nonzero, it is a C-language system include
90 /* Mapping of file names for this directory.
91 Only used on MS-DOS and related platforms. */
92 struct file_name_map
*name_map
;
95 /* Multiple-include optimisation. */
96 enum mi_state
{MI_FAILED
= 0, MI_OUTSIDE
};
97 enum mi_ind
{MI_IND_NONE
= 0, MI_IND_NOT
};
99 typedef struct toklist toklist
;
106 typedef struct cpp_context cpp_context
;
109 /* Doubly-linked list. */
110 cpp_context
*next
, *prev
;
112 /* Contexts other than the base context are contiguous tokens.
113 e.g. macro expansions, expanded argument tokens. */
116 /* For a macro context, these are the macro and its arguments. */
122 /* Nonzero if first token on line is CPP_HASH. */
123 unsigned char in_directive
;
125 /* Nonzero if in a directive that takes angle-bracketed headers. */
126 unsigned char angled_headers
;
128 /* Nonzero to save comments. Turned off if discard_comments, and in
129 all directives apart from #define. */
130 unsigned char save_comments
;
132 /* If nonzero the next token is at the beginning of the line. */
133 unsigned char next_bol
;
135 /* Nonzero if we're mid-comment. */
136 unsigned char lexing_comment
;
138 /* Nonzero if lexing __VA_ARGS__ is valid. */
139 unsigned char va_args_ok
;
141 /* Nonzero if lexing poisoned identifiers is valid. */
142 unsigned char poisoned_ok
;
144 /* Nonzero to prevent macro expansion. */
145 unsigned char prevent_expansion
;
147 /* Nonzero when parsing arguments to a function-like macro. */
148 unsigned char parsing_args
;
150 /* Nonzero when in a # NUMBER directive. */
151 unsigned char line_extension
;
154 /* Special nodes - identifiers with predefined significance. */
157 cpp_hashnode
*n_L
; /* L"str" */
158 cpp_hashnode
*n_defined
; /* defined operator */
159 cpp_hashnode
*n_true
; /* C++ keyword true */
160 cpp_hashnode
*n_false
; /* C++ keyword false */
161 cpp_hashnode
*n__Pragma
; /* _Pragma operator */
162 cpp_hashnode
*n__STRICT_ANSI__
; /* STDC_0_IN_SYSTEM_HEADERS */
163 cpp_hashnode
*n__CHAR_UNSIGNED__
; /* plain char is unsigned */
164 cpp_hashnode
*n__VA_ARGS__
; /* C99 vararg macros */
169 const unsigned char *cur
; /* current position */
170 const unsigned char *rlimit
; /* end of valid data */
171 const unsigned char *line_base
; /* start of current line */
172 cppchar_t read_ahead
; /* read ahead character */
173 cppchar_t extra_char
; /* extra read-ahead for long tokens. */
175 struct cpp_reader
*pfile
; /* Owns this buffer. */
176 struct cpp_buffer
*prev
;
178 const unsigned char *buf
; /* entire buffer */
180 /* Filename specified with #line command. */
181 const char *nominal_fname
;
183 /* Actual directory of this file, used only for "" includes */
184 struct file_name_list
*actual_dir
;
186 /* Pointer into the include table. Used for include_next and
187 to record control macros. */
188 struct include_file
*inc
;
190 /* Value of if_stack at start of this file.
191 Used to prohibit unmatched #endif (etc) in an include file. */
192 struct if_stack
*if_stack
;
194 /* Token column position adjustment owing to tabs in whitespace. */
195 unsigned int col_adjust
;
197 /* Line number at line_base (above). */
200 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
201 unsigned char saved_flags
;
203 /* Because of the way the lexer works, -Wtrigraphs can sometimes
204 warn twice for the same trigraph. This helps prevent that. */
205 const unsigned char *last_Wtrigraphs
;
207 /* True if we have already warned about C++ comments in this file.
208 The warning happens only for C89 extended mode with -pedantic on,
209 or for -Wtraditional, and only once per file (otherwise it would
210 be far too noisy). */
211 unsigned char warned_cplusplus_comments
;
213 /* True if we don't process trigraphs and escaped newlines. True
214 for preprocessed input, command line directives, and _Pragma
216 unsigned char from_stage3
;
218 /* Temporary storage for pfile->skipping whilst in a directive. */
219 unsigned char was_skipping
;
221 /* 1 = system header file, 2 = C system header file used for C++. */
224 /* Nonzero means we have printed (while error reporting) a list of
225 containing files that matches the current status. */
226 unsigned char include_stack_listed
;
229 ENUM_BITFIELD (cpp_buffer_type
) type
: 8;
232 /* A cpp_reader encapsulates the "state" of a pre-processor run.
233 Applying cpp_get_token repeatedly yields a stream of pre-processor
234 tokens. Usually, there is only one cpp_reader object active. */
238 /* Top of buffer stack. */
242 struct lexer_state state
;
244 /* The position of the last lexed token and last lexed directive. */
245 cpp_lexer_pos lexer_pos
;
246 cpp_lexer_pos directive_pos
;
249 cpp_pool ident_pool
; /* For all identifiers, and permanent
250 numbers and strings. */
251 cpp_pool macro_pool
; /* For macro definitions. Permanent. */
252 cpp_pool argument_pool
; /* For macro arguments. Temporary. */
255 struct cpp_context base_context
;
256 struct cpp_context
*context
;
258 /* If in_directive, the directive if known. */
259 const struct directive
*directive
;
261 /* Multiple inlcude optimisation. */
262 enum mi_state mi_state
;
263 enum mi_ind mi_if_not_defined
;
264 unsigned int mi_lexed
;
265 const cpp_hashnode
*mi_cmacro
;
266 const cpp_hashnode
*mi_ind_cmacro
;
268 /* Token lookahead. */
269 struct cpp_lookahead
*la_read
; /* Read from this lookahead. */
270 struct cpp_lookahead
*la_write
; /* Write to this lookahead. */
271 struct cpp_lookahead
*la_unused
; /* Free store. */
272 struct cpp_lookahead
*la_saved
; /* Backup when entering directive. */
274 /* Error counter for exit code. */
277 /* Line and column where a newline was first seen in a string
278 constant (multi-line strings). */
279 cpp_lexer_pos mlstring_pos
;
281 /* Buffer to hold macro definition string. */
282 unsigned char *macro_buffer
;
283 unsigned int macro_buffer_len
;
285 /* Current depth in #include directives that use <...>. */
286 unsigned int system_include_depth
;
288 /* Current depth of buffer stack. */
289 unsigned int buffer_stack_depth
;
291 /* Current depth in #include directives. */
292 unsigned int include_depth
;
294 /* Hash table of macros and assertions. See cpphash.c. */
295 struct htab
*hashtab
;
297 /* Tree of other included files. See cppfiles.c. */
298 struct splay_tree_s
*all_include_files
;
300 /* Chain of `actual directory' file_name_list entries, for ""
302 struct file_name_list
*actual_dirs
;
304 /* Current maximum length of directory names in the search path
305 for include files. (Altered as we get more of them.) */
306 unsigned int max_include_len
;
308 /* Date and time tokens. Calculated together if either is requested. */
312 /* Opaque handle to the dependencies of mkdeps.c. Used by -M etc. */
315 /* Obstack holding all macro hash nodes. This never shrinks.
317 struct obstack
*hash_ob
;
319 /* Obstack holding buffer and conditional structures. This is a
320 real stack. See cpplib.c */
321 struct obstack
*buffer_ob
;
323 /* Pragma table - dynamic, because a library user can add to the
324 list of recognized pragmas. */
325 struct pragma_entry
*pragmas
;
328 struct cpp_callbacks cb
;
330 /* User visible options. */
331 struct cpp_options opts
;
333 /* Special nodes - identifiers with predefined significance to the
335 struct spec_nodes spec_nodes
;
337 /* We're printed a warning recommending against using #import. */
338 unsigned char import_warning
;
340 /* True after cpp_start_read completes. Used to inhibit some
341 warnings while parsing the command line. */
342 unsigned char done_initializing
;
344 /* True if we are skipping a failed conditional group. */
345 unsigned char skipping
;
348 /* Character classes. Based on the more primitive macros in safe-ctype.h.
349 If the definition of `numchar' looks odd to you, please look up the
350 definition of a pp-number in the C standard [section 6.4.8 of C99].
352 In the unlikely event that characters other than \r and \n enter
353 the set is_vspace, the macro handle_newline() in cpplex.c must be
355 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
357 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
358 #define is_numchar(x) ISIDNUM(x)
359 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
360 #define is_numstart(x) ISDIGIT(x)
361 #define is_hspace(x) ISBLANK(x)
362 #define is_vspace(x) IS_VSPACE(x)
363 #define is_nvspace(x) IS_NVSPACE(x)
364 #define is_space(x) IS_SPACE_OR_NUL(x)
366 /* This table is constant if it can be initialized at compile time,
367 which is the case if cpp was compiled with GCC >=2.7, or another
368 compiler that supports C99. */
369 #if HAVE_DESIGNATED_INITIALIZERS
370 extern const unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
372 extern unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
377 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->prev)
378 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
379 #define CPP_IN_SYSTEM_HEADER(PFILE) \
380 (CPP_BUFFER (PFILE) && CPP_BUFFER (PFILE)->sysp)
381 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
382 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
384 /* Hash step. The hash calculation is duplicated in cpp_lookup and
386 #define HASHSTEP(r, c) ((r) * 67 + (c - 113));
389 enum error_type
{ WARNING
= 0, PEDWARN
, ERROR
, FATAL
, ICE
};
390 extern int _cpp_begin_message
PARAMS ((cpp_reader
*, enum error_type
,
391 const char *, const cpp_lexer_pos
*));
394 extern void _cpp_free_definition
PARAMS ((cpp_hashnode
*));
395 extern int _cpp_create_definition
PARAMS ((cpp_reader
*, cpp_hashnode
*));
396 extern void _cpp_pop_context
PARAMS ((cpp_reader
*));
397 extern void _cpp_free_lookaheads
PARAMS ((cpp_reader
*));
398 extern void _cpp_release_lookahead
PARAMS ((cpp_reader
*));
399 extern void _cpp_push_token
PARAMS ((cpp_reader
*, const cpp_token
*,
400 const cpp_lexer_pos
*));
403 extern void _cpp_init_hashtable
PARAMS ((cpp_reader
*));
404 extern void _cpp_cleanup_hashtable
PARAMS ((cpp_reader
*));
405 extern cpp_hashnode
*_cpp_lookup_with_hash
PARAMS ((cpp_reader
*, size_t,
409 extern void _cpp_fake_include
PARAMS ((cpp_reader
*, const char *));
410 extern void _cpp_never_reread
PARAMS ((struct include_file
*));
411 extern void _cpp_simplify_pathname
PARAMS ((char *));
412 extern int _cpp_read_file
PARAMS ((cpp_reader
*, const char *));
413 extern void _cpp_execute_include
PARAMS ((cpp_reader
*,
414 const cpp_token
*, int, int));
415 extern int _cpp_compare_file_date
PARAMS ((cpp_reader
*,
417 extern void _cpp_report_missing_guards
PARAMS ((cpp_reader
*));
418 extern void _cpp_init_includes
PARAMS ((cpp_reader
*));
419 extern void _cpp_cleanup_includes
PARAMS ((cpp_reader
*));
420 extern void _cpp_pop_file_buffer
PARAMS ((cpp_reader
*, cpp_buffer
*));
423 extern int _cpp_parse_expr
PARAMS ((cpp_reader
*));
426 extern void _cpp_lex_token
PARAMS ((cpp_reader
*, cpp_token
*));
427 extern int _cpp_equiv_tokens
PARAMS ((const cpp_token
*,
429 extern void _cpp_init_pool
PARAMS ((cpp_pool
*, unsigned int,
430 unsigned int, unsigned int));
431 extern void _cpp_free_pool
PARAMS ((cpp_pool
*));
432 extern unsigned char *_cpp_pool_reserve
PARAMS ((cpp_pool
*, unsigned int));
433 extern unsigned char *_cpp_pool_alloc
PARAMS ((cpp_pool
*, unsigned int));
434 extern unsigned char *_cpp_next_chunk
PARAMS ((cpp_pool
*, unsigned int,
436 extern void _cpp_lock_pool
PARAMS ((cpp_pool
*));
437 extern void _cpp_unlock_pool
PARAMS ((cpp_pool
*));
440 extern int _cpp_test_assertion
PARAMS ((cpp_reader
*, int *));
441 extern int _cpp_handle_directive
PARAMS ((cpp_reader
*, int));
442 extern void _cpp_define_builtin
PARAMS ((cpp_reader
*, const char *));
443 extern void _cpp_do__Pragma
PARAMS ((cpp_reader
*));
444 extern void _cpp_init_stacks
PARAMS ((cpp_reader
*));
445 extern void _cpp_cleanup_stacks
PARAMS ((cpp_reader
*));
446 extern void _cpp_init_internal_pragmas
PARAMS ((cpp_reader
*));
447 extern void _cpp_do_file_change
PARAMS ((cpp_reader
*, enum cpp_fc_reason
,
448 const char *, unsigned int));
450 /* Utility routines and macros. */
451 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
452 #define xnew(T) (T *) xmalloc (sizeof(T))
453 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
454 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
455 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
456 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
458 /* These are inline functions instead of macros so we can get type
460 typedef unsigned char U_CHAR
;
461 #define U (const U_CHAR *) /* Intended use: U"string" */
463 static inline int ustrcmp
PARAMS ((const U_CHAR
*, const U_CHAR
*));
464 static inline int ustrncmp
PARAMS ((const U_CHAR
*, const U_CHAR
*,
466 static inline size_t ustrlen
PARAMS ((const U_CHAR
*));
467 static inline U_CHAR
*uxstrdup
PARAMS ((const U_CHAR
*));
468 static inline U_CHAR
*ustrchr
PARAMS ((const U_CHAR
*, int));
469 static inline int ufputs
PARAMS ((const U_CHAR
*, FILE *));
473 const U_CHAR
*s1
, *s2
;
475 return strcmp ((const char *)s1
, (const char *)s2
);
480 const U_CHAR
*s1
, *s2
;
483 return strncmp ((const char *)s1
, (const char *)s2
, n
);
490 return strlen ((const char *)s1
);
493 static inline U_CHAR
*
497 return (U_CHAR
*) xstrdup ((const char *)s1
);
500 static inline U_CHAR
*
505 return (U_CHAR
*) strchr ((const char *)s1
, c
);
513 return fputs ((const char *)s
, f
);