1 /* Part of CPP library.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002
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's called cpphash.h for
21 historical reasons. */
26 #include "hashtable.h"
28 struct directive
; /* Deliberately incomplete. */
29 struct pending_option
;
32 typedef unsigned HOST_WIDE_INT cpp_num_part
;
33 typedef unsigned char uchar
;
34 #define U (const uchar *) /* Intended use: U"string" */
36 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
38 /* Test if a sign is valid within a preprocessing number. */
39 #define VALID_SIGN(c, prevc) \
40 (((c) == '+' || (c) == '-') && \
41 ((prevc) == 'e' || (prevc) == 'E' \
42 || (((prevc) == 'p' || (prevc) == 'P') \
43 && CPP_OPTION (pfile, extended_numbers))))
45 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
46 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
47 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
48 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
50 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
51 efficiency, and partly to limit runaway recursion. */
52 #define CPP_STACK_MAX 200
54 /* Each macro definition is recorded in a cpp_macro structure.
55 Variadic macros cannot occur with traditional cpp. */
58 cpp_hashnode
**params
; /* Parameters, if any. */
61 cpp_token
*tokens
; /* Tokens of replacement list (ISO). */
62 const uchar
*text
; /* Expansion text (traditional). */
64 unsigned int line
; /* Starting line number. */
65 unsigned int count
; /* Number of tokens / bytes in expansion. */
66 unsigned short paramc
; /* Number of parameters. */
67 unsigned int fun_like
: 1; /* If a function-like macro. */
68 unsigned int variadic
: 1; /* If a variadic macro. */
69 unsigned int syshdr
: 1; /* If macro defined in system header. */
72 /* A generic memory buffer, and operations on it. */
73 typedef struct _cpp_buff _cpp_buff
;
76 struct _cpp_buff
*next
;
77 unsigned char *base
, *cur
, *limit
;
80 extern _cpp_buff
*_cpp_get_buff
PARAMS ((cpp_reader
*, size_t));
81 extern void _cpp_release_buff
PARAMS ((cpp_reader
*, _cpp_buff
*));
82 extern void _cpp_extend_buff
PARAMS ((cpp_reader
*, _cpp_buff
**, size_t));
83 extern _cpp_buff
*_cpp_append_extend_buff
PARAMS ((cpp_reader
*, _cpp_buff
*,
85 extern void _cpp_free_buff
PARAMS ((_cpp_buff
*));
86 extern unsigned char *_cpp_aligned_alloc
PARAMS ((cpp_reader
*, size_t));
87 extern unsigned char *_cpp_unaligned_alloc
PARAMS ((cpp_reader
*, size_t));
89 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
90 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
91 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
93 /* List of directories to look for include files in. */
96 struct search_path
*next
;
98 /* NOTE: NAME may not be null terminated for the case of the current
102 /* We use these to tell if the directory mentioned here is a duplicate
103 of an earlier directory on the search path. */
106 /* Non-zero if it is a system include directory. */
108 /* Mapping of file names for this directory. Only used on MS-DOS
109 and related platforms. */
110 struct file_name_map
*name_map
;
113 /* #include types. */
114 enum include_type
{IT_INCLUDE
, IT_INCLUDE_NEXT
, IT_IMPORT
, IT_CMDLINE
};
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
;
126 tokenrun
*next
, *prev
;
127 cpp_token
*base
, *limit
;
130 typedef struct cpp_context cpp_context
;
133 /* Doubly-linked list. */
134 cpp_context
*next
, *prev
;
136 /* Contexts other than the base context are contiguous tokens.
137 e.g. macro expansions, expanded argument tokens. */
141 /* If non-NULL, a buffer used for storage related to this context.
142 When the context is popped, the buffer is released. */
145 /* For a macro context, the macro node, otherwise NULL. */
148 /* True if utoken element is token, else ptoken. */
154 /* Nonzero if first token on line is CPP_HASH. */
155 unsigned char in_directive
;
157 /* True if we are skipping a failed conditional group. */
158 unsigned char skipping
;
160 /* Nonzero if in a directive that takes angle-bracketed headers. */
161 unsigned char angled_headers
;
163 /* Nonzero to save comments. Turned off if discard_comments, and in
164 all directives apart from #define. */
165 unsigned char save_comments
;
167 /* Nonzero if we're mid-comment. */
168 unsigned char lexing_comment
;
170 /* Nonzero if lexing __VA_ARGS__ is valid. */
171 unsigned char va_args_ok
;
173 /* Nonzero if lexing poisoned identifiers is valid. */
174 unsigned char poisoned_ok
;
176 /* Nonzero to prevent macro expansion. */
177 unsigned char prevent_expansion
;
179 /* Nonzero when parsing arguments to a function-like macro. */
180 unsigned char parsing_args
;
182 /* Nonzero to skip evaluating part of an expression. */
183 unsigned int skip_eval
;
186 /* Special nodes - identifiers with predefined significance. */
189 cpp_hashnode
*n_defined
; /* defined operator */
190 cpp_hashnode
*n_true
; /* C++ keyword true */
191 cpp_hashnode
*n_false
; /* C++ keyword false */
192 cpp_hashnode
*n__VA_ARGS__
; /* C99 vararg macros */
195 /* Represents the contents of a file cpplib has read in. */
198 const unsigned char *cur
; /* current position */
199 const unsigned char *backup_to
; /* if peeked character is not wanted */
200 const unsigned char *rlimit
; /* end of valid data */
201 const unsigned char *line_base
; /* start of current line */
203 struct cpp_buffer
*prev
;
205 const unsigned char *buf
; /* Entire character buffer. */
207 /* Pointer into the include table; non-NULL if this is a file
208 buffer. Used for include_next and to record control macros. */
209 struct include_file
*inc
;
211 /* Value of if_stack at start of this file.
212 Used to prohibit unmatched #endif (etc) in an include file. */
213 struct if_stack
*if_stack
;
215 /* Token column position adjustment owing to tabs in whitespace. */
216 unsigned int col_adjust
;
218 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
219 unsigned char saved_flags
;
221 /* Because of the way the lexer works, -Wtrigraphs can sometimes
222 warn twice for the same trigraph. This helps prevent that. */
223 const unsigned char *last_Wtrigraphs
;
225 /* True if we have already warned about C++ comments in this file.
226 The warning happens only for C89 extended mode with -pedantic on,
227 or for -Wtraditional, and only once per file (otherwise it would
228 be far too noisy). */
229 unsigned char warned_cplusplus_comments
;
231 /* True if we don't process trigraphs and escaped newlines. True
232 for preprocessed input, command line directives, and _Pragma
234 unsigned char from_stage3
;
236 /* Nonzero means that the directory to start searching for ""
237 include files has been calculated and stored in "dir" below. */
238 unsigned char search_cached
;
240 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
241 true, a CPP_EOF token is then returned. Otherwise, the next
242 token from the enclosing buffer is returned. */
245 /* The directory of the this buffer's file. Its NAME member is not
246 allocated, so we don't need to worry about freeing it. */
247 struct search_path dir
;
249 /* Used for buffer overlays by cpptrad.c. */
250 const uchar
*saved_cur
, *saved_rlimit
, *saved_line_base
;
253 /* A cpp_reader encapsulates the "state" of a pre-processor run.
254 Applying cpp_get_token repeatedly yields a stream of pre-processor
255 tokens. Usually, there is only one cpp_reader object active. */
258 /* Top of buffer stack. */
262 struct lexer_state state
;
264 /* Source line tracking. */
265 struct line_maps line_maps
;
266 const struct line_map
*map
;
269 /* The line of the '#' of the current directive. */
270 unsigned int directive_line
;
272 /* Memory buffers. */
273 _cpp_buff
*a_buff
; /* Aligned permanent storage. */
274 _cpp_buff
*u_buff
; /* Unaligned permanent storage. */
275 _cpp_buff
*free_buffs
; /* Free buffer chain. */
278 struct cpp_context base_context
;
279 struct cpp_context
*context
;
281 /* If in_directive, the directive if known. */
282 const struct directive
*directive
;
284 /* The next -include-d file; NULL if they all are done. If it
285 points to NULL, the last one is in progress, and
286 _cpp_maybe_push_include_file has yet to restore the line map. */
287 struct pending_option
**next_include_file
;
289 /* Multiple inlcude optimisation. */
290 const cpp_hashnode
*mi_cmacro
;
291 const cpp_hashnode
*mi_ind_cmacro
;
295 cpp_token
*cur_token
;
296 tokenrun base_run
, *cur_run
;
297 unsigned int lookaheads
;
299 /* Non-zero prevents the lexer from re-using the token runs. */
300 unsigned int keep_tokens
;
302 /* Error counter for exit code. */
305 /* Buffer to hold macro definition string. */
306 unsigned char *macro_buffer
;
307 unsigned int macro_buffer_len
;
309 /* Tree of other included files. See cppfiles.c. */
310 struct splay_tree_s
*all_include_files
;
312 /* Current maximum length of directory names in the search path
313 for include files. (Altered as we get more of them.) */
314 unsigned int max_include_len
;
316 /* Date and time tokens. Calculated together if either is requested. */
320 /* EOF token, and a token forcing paste avoidance. */
321 cpp_token avoid_paste
;
324 /* Opaque handle to the dependencies of mkdeps.c. Used by -M etc. */
327 /* Obstack holding all macro hash nodes. This never shrinks.
329 struct obstack hash_ob
;
331 /* Obstack holding buffer and conditional structures. This is a
332 real stack. See cpplib.c. */
333 struct obstack buffer_ob
;
335 /* Pragma table - dynamic, because a library user can add to the
336 list of recognized pragmas. */
337 struct pragma_entry
*pragmas
;
340 struct cpp_callbacks cb
;
342 /* Identifier hash table. */
343 struct ht
*hash_table
;
345 /* Expression parser stack. */
346 struct op
*op_stack
, *op_limit
;
348 /* User visible options. */
349 struct cpp_options opts
;
351 /* Special nodes - identifiers with predefined significance to the
353 struct spec_nodes spec_nodes
;
355 /* Whether to print our version number. Done this way so
356 we don't get it twice for -v -version. */
357 unsigned char print_version
;
359 /* Whether cpplib owns the hashtable. */
360 unsigned char our_hashtable
;
362 /* Traditional preprocessing output buffer. */
363 uchar
*trad_out_base
, *trad_out_limit
;
365 unsigned int trad_line
;
368 /* Character classes. Based on the more primitive macros in safe-ctype.h.
369 If the definition of `numchar' looks odd to you, please look up the
370 definition of a pp-number in the C standard [section 6.4.8 of C99].
372 In the unlikely event that characters other than \r and \n enter
373 the set is_vspace, the macro handle_newline() in cpplex.c must be
375 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
377 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
378 #define is_numchar(x) ISIDNUM(x)
379 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
380 #define is_numstart(x) ISDIGIT(x)
381 #define is_hspace(x) ISBLANK(x)
382 #define is_vspace(x) IS_VSPACE(x)
383 #define is_nvspace(x) IS_NVSPACE(x)
384 #define is_space(x) IS_SPACE_OR_NUL(x)
386 /* This table is constant if it can be initialized at compile time,
387 which is the case if cpp was compiled with GCC >=2.7, or another
388 compiler that supports C99. */
389 #if HAVE_DESIGNATED_INITIALIZERS
390 extern const unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
392 extern unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
397 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
398 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
399 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
400 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
403 extern int _cpp_begin_message
PARAMS ((cpp_reader
*, int,
404 unsigned int, unsigned int));
407 extern void _cpp_free_definition
PARAMS ((cpp_hashnode
*));
408 extern int _cpp_create_definition
PARAMS ((cpp_reader
*, cpp_hashnode
*));
409 extern void _cpp_pop_context
PARAMS ((cpp_reader
*));
412 extern void _cpp_init_hashtable
PARAMS ((cpp_reader
*, hash_table
*));
413 extern void _cpp_destroy_hashtable
PARAMS ((cpp_reader
*));
416 extern void _cpp_fake_include
PARAMS ((cpp_reader
*, const char *));
417 extern void _cpp_never_reread
PARAMS ((struct include_file
*));
418 extern char *_cpp_simplify_pathname
PARAMS ((char *));
419 extern bool _cpp_read_file
PARAMS ((cpp_reader
*, const char *));
420 extern bool _cpp_execute_include
PARAMS ((cpp_reader
*,
423 extern int _cpp_compare_file_date
PARAMS ((cpp_reader
*,
425 extern void _cpp_report_missing_guards
PARAMS ((cpp_reader
*));
426 extern void _cpp_init_includes
PARAMS ((cpp_reader
*));
427 extern void _cpp_cleanup_includes
PARAMS ((cpp_reader
*));
428 extern void _cpp_pop_file_buffer
PARAMS ((cpp_reader
*,
429 struct include_file
*));
432 extern bool _cpp_parse_expr
PARAMS ((cpp_reader
*));
433 extern struct op
*_cpp_expand_op_stack
PARAMS ((cpp_reader
*));
436 extern cpp_token
*_cpp_temp_token
PARAMS ((cpp_reader
*));
437 extern const cpp_token
*_cpp_lex_token
PARAMS ((cpp_reader
*));
438 extern cpp_token
*_cpp_lex_direct
PARAMS ((cpp_reader
*));
439 extern int _cpp_equiv_tokens
PARAMS ((const cpp_token
*,
441 extern void _cpp_init_tokenrun
PARAMS ((tokenrun
*, unsigned int));
444 extern void _cpp_maybe_push_include_file
PARAMS ((cpp_reader
*));
447 extern int _cpp_test_assertion
PARAMS ((cpp_reader
*, unsigned int *));
448 extern int _cpp_handle_directive
PARAMS ((cpp_reader
*, int));
449 extern void _cpp_define_builtin
PARAMS ((cpp_reader
*, const char *));
450 extern void _cpp_do__Pragma
PARAMS ((cpp_reader
*));
451 extern void _cpp_init_directives
PARAMS ((cpp_reader
*));
452 extern void _cpp_init_internal_pragmas
PARAMS ((cpp_reader
*));
453 extern void _cpp_do_file_change
PARAMS ((cpp_reader
*, enum lc_reason
,
455 unsigned int, unsigned int));
456 extern void _cpp_pop_buffer
PARAMS ((cpp_reader
*));
459 extern bool _cpp_read_logical_line_trad
PARAMS ((cpp_reader
*));
460 extern void _cpp_overlay_buffer
PARAMS ((cpp_reader
*pfile
, const uchar
*,
463 /* Utility routines and macros. */
464 #define DSC(str) (const uchar *)str, sizeof str - 1
465 #define xnew(T) (T *) xmalloc (sizeof(T))
466 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
467 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
468 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
469 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
471 /* These are inline functions instead of macros so we can get type
473 static inline int ustrcmp
PARAMS ((const uchar
*, const uchar
*));
474 static inline int ustrncmp
PARAMS ((const uchar
*, const uchar
*,
476 static inline size_t ustrlen
PARAMS ((const uchar
*));
477 static inline uchar
*uxstrdup
PARAMS ((const uchar
*));
478 static inline uchar
*ustrchr
PARAMS ((const uchar
*, int));
479 static inline int ufputs
PARAMS ((const uchar
*, FILE *));
483 const uchar
*s1
, *s2
;
485 return strcmp ((const char *)s1
, (const char *)s2
);
490 const uchar
*s1
, *s2
;
493 return strncmp ((const char *)s1
, (const char *)s2
, n
);
500 return strlen ((const char *)s1
);
503 static inline uchar
*
507 return (uchar
*) xstrdup ((const char *)s1
);
510 static inline uchar
*
515 return (uchar
*) strchr ((const char *)s1
, c
);
523 return fputs ((const char *)s
, f
);
526 #endif /* ! GCC_CPPHASH_H */