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. */
25 #include "hashtable.h"
27 struct directive
; /* Deliberately incomplete. */
29 /* Test if a sign is valid within a preprocessing number. */
30 #define VALID_SIGN(c, prevc) \
31 (((c) == '+' || (c) == '-') && \
32 ((prevc) == 'e' || (prevc) == 'E' \
33 || (((prevc) == 'p' || (prevc) == 'P') \
34 && CPP_OPTION (pfile, extended_numbers))))
36 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
37 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
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
, *first
;
70 unsigned char *pos
; /* Current position. */
75 /* List of directories to look for include files in. */
78 struct search_path
*next
;
80 /* NOTE: NAME may not be null terminated for the case of the current
84 /* We use these to tell if the directory mentioned here is a duplicate
85 of an earlier directory on the search path. */
88 /* Non-zero if it is a system include directory. */
90 /* Mapping of file names for this directory. Only used on MS-DOS
91 and related platforms. */
92 struct file_name_map
*name_map
;
96 enum include_type
{IT_INCLUDE
, IT_INCLUDE_NEXT
, IT_IMPORT
, IT_CMDLINE
};
98 typedef struct toklist toklist
;
105 typedef struct cpp_context cpp_context
;
108 /* Doubly-linked list. */
109 cpp_context
*next
, *prev
;
111 /* Contexts other than the base context are contiguous tokens.
112 e.g. macro expansions, expanded argument tokens. */
115 /* For a macro context, these are the macro and its arguments. */
121 /* Nonzero if first token on line is CPP_HASH. */
122 unsigned char in_directive
;
124 /* True if we are skipping a failed conditional group. */
125 unsigned char skipping
;
127 /* Nonzero if in a directive that takes angle-bracketed headers. */
128 unsigned char angled_headers
;
130 /* Nonzero to save comments. Turned off if discard_comments, and in
131 all directives apart from #define. */
132 unsigned char save_comments
;
134 /* Nonzero if we're mid-comment. */
135 unsigned char lexing_comment
;
137 /* Nonzero if lexing __VA_ARGS__ is valid. */
138 unsigned char va_args_ok
;
140 /* Nonzero if lexing poisoned identifiers is valid. */
141 unsigned char poisoned_ok
;
143 /* Nonzero to prevent macro expansion. */
144 unsigned char prevent_expansion
;
146 /* Nonzero when parsing arguments to a function-like macro. */
147 unsigned char parsing_args
;
149 /* Nonzero when in a # NUMBER directive. */
150 unsigned char line_extension
;
153 /* Special nodes - identifiers with predefined significance. */
156 cpp_hashnode
*n_L
; /* L"str" */
157 cpp_hashnode
*n_defined
; /* defined operator */
158 cpp_hashnode
*n_true
; /* C++ keyword true */
159 cpp_hashnode
*n_false
; /* C++ keyword false */
160 cpp_hashnode
*n__Pragma
; /* _Pragma operator */
161 cpp_hashnode
*n__STRICT_ANSI__
; /* STDC_0_IN_SYSTEM_HEADERS */
162 cpp_hashnode
*n__CHAR_UNSIGNED__
; /* plain char is unsigned */
163 cpp_hashnode
*n__VA_ARGS__
; /* C99 vararg macros */
168 const unsigned char *cur
; /* current position */
169 const unsigned char *rlimit
; /* end of valid data */
170 const unsigned char *line_base
; /* start of current line */
171 cppchar_t read_ahead
; /* read ahead character */
172 cppchar_t extra_char
; /* extra read-ahead for long tokens. */
174 struct cpp_reader
*pfile
; /* Owns this buffer. */
175 struct cpp_buffer
*prev
;
177 const unsigned char *buf
; /* entire buffer */
179 /* Pointer into the include table. Used for include_next and
180 to record control macros. */
181 struct include_file
*inc
;
183 /* Value of if_stack at start of this file.
184 Used to prohibit unmatched #endif (etc) in an include file. */
185 struct if_stack
*if_stack
;
187 /* Token column position adjustment owing to tabs in whitespace. */
188 unsigned int col_adjust
;
190 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
191 unsigned char saved_flags
;
193 /* Because of the way the lexer works, -Wtrigraphs can sometimes
194 warn twice for the same trigraph. This helps prevent that. */
195 const unsigned char *last_Wtrigraphs
;
197 /* True if we have already warned about C++ comments in this file.
198 The warning happens only for C89 extended mode with -pedantic on,
199 or for -Wtraditional, and only once per file (otherwise it would
200 be far too noisy). */
201 unsigned char warned_cplusplus_comments
;
203 /* True if we don't process trigraphs and escaped newlines. True
204 for preprocessed input, command line directives, and _Pragma
206 unsigned char from_stage3
;
208 /* Nonzero means that the directory to start searching for ""
209 include files has been calculated and stored in "dir" below. */
210 unsigned char search_cached
;
212 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
213 true, a CPP_EOF token is then returned. Otherwise, the next
214 token from the enclosing buffer is returned. */
218 ENUM_BITFIELD (cpp_buffer_type
) type
: 8;
220 /* The directory of the this buffer's file. Its NAME member is not
221 allocated, so we don't need to worry about freeing it. */
222 struct search_path dir
;
225 /* A cpp_reader encapsulates the "state" of a pre-processor run.
226 Applying cpp_get_token repeatedly yields a stream of pre-processor
227 tokens. Usually, there is only one cpp_reader object active. */
231 /* Top of buffer stack. */
235 struct lexer_state state
;
237 /* Source line tracking. */
238 struct line_maps line_maps
;
239 const struct line_map
*map
;
242 /* The position of the last lexed token and last lexed directive. */
243 cpp_lexer_pos lexer_pos
;
244 cpp_lexer_pos directive_pos
;
245 unsigned int directive_line
;
248 cpp_pool ident_pool
; /* For all identifiers, and permanent
249 numbers and strings. */
250 cpp_pool macro_pool
; /* For macro definitions. Permanent. */
251 cpp_pool argument_pool
; /* For macro arguments. Temporary. */
254 struct cpp_context base_context
;
255 struct cpp_context
*context
;
257 /* If in_directive, the directive if known. */
258 const struct directive
*directive
;
260 /* Multiple inlcude optimisation. */
261 const cpp_hashnode
*mi_cmacro
;
262 const cpp_hashnode
*mi_ind_cmacro
;
265 /* Token lookahead. */
266 struct cpp_lookahead
*la_read
; /* Read from this lookahead. */
267 struct cpp_lookahead
*la_write
; /* Write to this lookahead. */
268 struct cpp_lookahead
*la_unused
; /* Free store. */
269 struct cpp_lookahead
*la_saved
; /* Backup when entering directive. */
271 /* Error counter for exit code. */
274 /* Line and column where a newline was first seen in a string
275 constant (multi-line strings). */
276 cpp_lexer_pos mlstring_pos
;
278 /* Buffer to hold macro definition string. */
279 unsigned char *macro_buffer
;
280 unsigned int macro_buffer_len
;
282 /* Tree of other included files. See cppfiles.c. */
283 struct splay_tree_s
*all_include_files
;
285 /* Current maximum length of directory names in the search path
286 for include files. (Altered as we get more of them.) */
287 unsigned int max_include_len
;
289 /* Date and time tokens. Calculated together if either is requested. */
293 /* Opaque handle to the dependencies of mkdeps.c. Used by -M etc. */
296 /* Obstack holding all macro hash nodes. This never shrinks.
298 struct obstack hash_ob
;
300 /* Obstack holding buffer and conditional structures. This is a
301 real stack. See cpplib.c. */
302 struct obstack buffer_ob
;
304 /* Pragma table - dynamic, because a library user can add to the
305 list of recognized pragmas. */
306 struct pragma_entry
*pragmas
;
309 struct cpp_callbacks cb
;
311 /* Identifier hash table. */
312 struct ht
*hash_table
;
314 /* User visible options. */
315 struct cpp_options opts
;
317 /* Special nodes - identifiers with predefined significance to the
319 struct spec_nodes spec_nodes
;
321 /* Whether to print our version number. Done this way so
322 we don't get it twice for -v -version. */
323 unsigned char print_version
;
325 /* Whether cpplib owns the hashtable. */
326 unsigned char our_hashtable
;
329 /* Character classes. Based on the more primitive macros in safe-ctype.h.
330 If the definition of `numchar' looks odd to you, please look up the
331 definition of a pp-number in the C standard [section 6.4.8 of C99].
333 In the unlikely event that characters other than \r and \n enter
334 the set is_vspace, the macro handle_newline() in cpplex.c must be
336 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
338 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
339 #define is_numchar(x) ISIDNUM(x)
340 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
341 #define is_numstart(x) ISDIGIT(x)
342 #define is_hspace(x) ISBLANK(x)
343 #define is_vspace(x) IS_VSPACE(x)
344 #define is_nvspace(x) IS_NVSPACE(x)
345 #define is_space(x) IS_SPACE_OR_NUL(x)
347 /* This table is constant if it can be initialized at compile time,
348 which is the case if cpp was compiled with GCC >=2.7, or another
349 compiler that supports C99. */
350 #if HAVE_DESIGNATED_INITIALIZERS
351 extern const unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
353 extern unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
358 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
359 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
360 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
361 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
364 enum error_type
{ WARNING
= 0, WARNING_SYSHDR
, PEDWARN
, ERROR
, FATAL
, ICE
};
365 extern int _cpp_begin_message
PARAMS ((cpp_reader
*, enum error_type
,
366 const cpp_lexer_pos
*));
369 extern void _cpp_free_definition
PARAMS ((cpp_hashnode
*));
370 extern int _cpp_create_definition
PARAMS ((cpp_reader
*, cpp_hashnode
*));
371 extern void _cpp_pop_context
PARAMS ((cpp_reader
*));
372 extern void _cpp_free_lookaheads
PARAMS ((cpp_reader
*));
373 extern void _cpp_release_lookahead
PARAMS ((cpp_reader
*));
374 extern void _cpp_push_token
PARAMS ((cpp_reader
*, const cpp_token
*,
375 const cpp_lexer_pos
*));
378 extern void _cpp_init_hashtable
PARAMS ((cpp_reader
*, hash_table
*));
379 extern void _cpp_destroy_hashtable
PARAMS ((cpp_reader
*));
382 extern void _cpp_fake_include
PARAMS ((cpp_reader
*, const char *));
383 extern void _cpp_never_reread
PARAMS ((struct include_file
*));
384 extern char *_cpp_simplify_pathname
PARAMS ((char *));
385 extern bool _cpp_read_file
PARAMS ((cpp_reader
*, const char *));
386 extern bool _cpp_execute_include
PARAMS ((cpp_reader
*,
389 extern int _cpp_compare_file_date
PARAMS ((cpp_reader
*,
391 extern void _cpp_report_missing_guards
PARAMS ((cpp_reader
*));
392 extern void _cpp_init_includes
PARAMS ((cpp_reader
*));
393 extern void _cpp_cleanup_includes
PARAMS ((cpp_reader
*));
394 extern void _cpp_pop_file_buffer
PARAMS ((cpp_reader
*, cpp_buffer
*));
397 extern int _cpp_parse_expr
PARAMS ((cpp_reader
*));
400 extern void _cpp_lex_token
PARAMS ((cpp_reader
*, cpp_token
*));
401 extern int _cpp_equiv_tokens
PARAMS ((const cpp_token
*,
403 extern void _cpp_init_pool
PARAMS ((cpp_pool
*, unsigned int,
404 unsigned int, unsigned int));
405 extern void _cpp_free_pool
PARAMS ((cpp_pool
*));
406 extern unsigned char *_cpp_pool_reserve
PARAMS ((cpp_pool
*, unsigned int));
407 extern unsigned char *_cpp_pool_alloc
PARAMS ((cpp_pool
*, unsigned int));
408 extern unsigned char *_cpp_next_chunk
PARAMS ((cpp_pool
*, unsigned int,
410 extern void _cpp_lock_pool
PARAMS ((cpp_pool
*));
411 extern void _cpp_unlock_pool
PARAMS ((cpp_pool
*));
414 extern bool _cpp_push_next_buffer
PARAMS ((cpp_reader
*));
417 extern int _cpp_test_assertion
PARAMS ((cpp_reader
*, int *));
418 extern int _cpp_handle_directive
PARAMS ((cpp_reader
*, int));
419 extern void _cpp_define_builtin
PARAMS ((cpp_reader
*, const char *));
420 extern void _cpp_do__Pragma
PARAMS ((cpp_reader
*));
421 extern void _cpp_init_directives
PARAMS ((cpp_reader
*));
422 extern void _cpp_init_internal_pragmas
PARAMS ((cpp_reader
*));
423 extern void _cpp_do_file_change
PARAMS ((cpp_reader
*, enum lc_reason
,
425 unsigned int, unsigned int));
426 extern void _cpp_pop_buffer
PARAMS ((cpp_reader
*));
428 /* Utility routines and macros. */
429 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
430 #define xnew(T) (T *) xmalloc (sizeof(T))
431 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
432 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
433 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
434 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
436 /* These are inline functions instead of macros so we can get type
438 typedef unsigned char U_CHAR
;
439 #define U (const U_CHAR *) /* Intended use: U"string" */
441 static inline int ustrcmp
PARAMS ((const U_CHAR
*, const U_CHAR
*));
442 static inline int ustrncmp
PARAMS ((const U_CHAR
*, const U_CHAR
*,
444 static inline size_t ustrlen
PARAMS ((const U_CHAR
*));
445 static inline U_CHAR
*uxstrdup
PARAMS ((const U_CHAR
*));
446 static inline U_CHAR
*ustrchr
PARAMS ((const U_CHAR
*, int));
447 static inline int ufputs
PARAMS ((const U_CHAR
*, FILE *));
451 const U_CHAR
*s1
, *s2
;
453 return strcmp ((const char *)s1
, (const char *)s2
);
458 const U_CHAR
*s1
, *s2
;
461 return strncmp ((const char *)s1
, (const char *)s2
, n
);
468 return strlen ((const char *)s1
);
471 static inline U_CHAR
*
475 return (U_CHAR
*) xstrdup ((const char *)s1
);
478 static inline U_CHAR
*
483 return (U_CHAR
*) strchr ((const char *)s1
, c
);
491 return fputs ((const char *)s
, f
);
494 #endif /* ! GCC_CPPHASH_H */