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
;
33 typedef unsigned char uchar
;
35 #define U (const uchar *) /* Intended use: U"string" */
37 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
39 /* Test if a sign is valid within a preprocessing number. */
40 #define VALID_SIGN(c, prevc) \
41 (((c) == '+' || (c) == '-') && \
42 ((prevc) == 'e' || (prevc) == 'E' \
43 || (((prevc) == 'p' || (prevc) == 'P') \
44 && CPP_OPTION (pfile, extended_numbers))))
46 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
47 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
48 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
49 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
51 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
52 efficiency, and partly to limit runaway recursion. */
53 #define CPP_STACK_MAX 200
55 /* Host alignment handling. */
66 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
67 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
68 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
70 /* Each macro definition is recorded in a cpp_macro structure.
71 Variadic macros cannot occur with traditional cpp. */
74 /* Parameters, if any. */
75 cpp_hashnode
**params
;
77 /* Replacement tokens (ISO) or replacement text (traditional). See
78 comment at top of cpptrad.c for how traditional function-like
79 macros are encoded. */
86 /* Definition line number. */
89 /* Number of tokens in expansion, or bytes for traditional macros. */
92 /* Number of parameters. */
93 unsigned short paramc
;
95 /* If a function-like macro. */
96 unsigned int fun_like
: 1;
98 /* If a variadic macro. */
99 unsigned int variadic
: 1;
101 /* If macro defined in system header. */
102 unsigned int syshdr
: 1;
104 /* Nonzero if it has been expanded or had its existence tested. */
105 unsigned int used
: 1;
108 #define _cpp_mark_macro_used(NODE) do { \
109 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
110 (NODE)->value.macro->used = 1; } while (0)
112 /* A generic memory buffer, and operations on it. */
113 typedef struct _cpp_buff _cpp_buff
;
116 struct _cpp_buff
*next
;
117 unsigned char *base
, *cur
, *limit
;
120 extern _cpp_buff
*_cpp_get_buff
PARAMS ((cpp_reader
*, size_t));
121 extern void _cpp_release_buff
PARAMS ((cpp_reader
*, _cpp_buff
*));
122 extern void _cpp_extend_buff
PARAMS ((cpp_reader
*, _cpp_buff
**, size_t));
123 extern _cpp_buff
*_cpp_append_extend_buff
PARAMS ((cpp_reader
*, _cpp_buff
*,
125 extern void _cpp_free_buff
PARAMS ((_cpp_buff
*));
126 extern unsigned char *_cpp_aligned_alloc
PARAMS ((cpp_reader
*, size_t));
127 extern unsigned char *_cpp_unaligned_alloc
PARAMS ((cpp_reader
*, size_t));
129 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
130 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
131 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
133 /* List of directories to look for include files in. */
136 struct search_path
*next
;
138 /* NOTE: NAME may not be null terminated for the case of the current
142 /* We use these to tell if the directory mentioned here is a duplicate
143 of an earlier directory on the search path. */
146 /* Nonzero if it is a system include directory. */
148 /* Mapping of file names for this directory. Only used on MS-DOS
149 and related platforms. */
150 struct file_name_map
*name_map
;
153 /* #include types. */
154 enum include_type
{IT_INCLUDE
, IT_INCLUDE_NEXT
, IT_IMPORT
, IT_CMDLINE
};
158 const cpp_token
*token
;
159 const cpp_token
**ptoken
;
162 /* A "run" of tokens; part of a chain of runs. */
163 typedef struct tokenrun tokenrun
;
166 tokenrun
*next
, *prev
;
167 cpp_token
*base
, *limit
;
170 /* Accessor macros for struct cpp_context. */
171 #define FIRST(c) ((c)->u.iso.first)
172 #define LAST(c) ((c)->u.iso.last)
173 #define CUR(c) ((c)->u.trad.cur)
174 #define RLIMIT(c) ((c)->u.trad.rlimit)
176 typedef struct cpp_context cpp_context
;
179 /* Doubly-linked list. */
180 cpp_context
*next
, *prev
;
184 /* For ISO macro expansion. Contexts other than the base context
185 are contiguous tokens. e.g. macro expansions, expanded
193 /* For traditional macro expansion. */
201 /* If non-NULL, a buffer used for storage related to this context.
202 When the context is popped, the buffer is released. */
205 /* For a macro context, the macro node, otherwise NULL. */
208 /* True if utoken element is token, else ptoken. */
214 /* Nonzero if first token on line is CPP_HASH. */
215 unsigned char in_directive
;
217 /* True if we are skipping a failed conditional group. */
218 unsigned char skipping
;
220 /* Nonzero if in a directive that takes angle-bracketed headers. */
221 unsigned char angled_headers
;
223 /* Nonzero if in a #if or #elif directive. */
224 unsigned char in_expression
;
226 /* Nonzero to save comments. Turned off if discard_comments, and in
227 all directives apart from #define. */
228 unsigned char save_comments
;
230 /* Nonzero if we're mid-comment. */
231 unsigned char lexing_comment
;
233 /* Nonzero if lexing __VA_ARGS__ is valid. */
234 unsigned char va_args_ok
;
236 /* Nonzero if lexing poisoned identifiers is valid. */
237 unsigned char poisoned_ok
;
239 /* Nonzero to prevent macro expansion. */
240 unsigned char prevent_expansion
;
242 /* Nonzero when parsing arguments to a function-like macro. */
243 unsigned char parsing_args
;
245 /* Nonzero to skip evaluating part of an expression. */
246 unsigned int skip_eval
;
249 /* Special nodes - identifiers with predefined significance. */
252 cpp_hashnode
*n_defined
; /* defined operator */
253 cpp_hashnode
*n_true
; /* C++ keyword true */
254 cpp_hashnode
*n_false
; /* C++ keyword false */
255 cpp_hashnode
*n__VA_ARGS__
; /* C99 vararg macros */
258 /* Encapsulates state used to convert a stream of tokens into a text
262 FILE *outf
; /* Stream to write to. */
263 const struct line_map
*map
; /* Logical to physical line mappings. */
264 const cpp_token
*prev
; /* Previous token. */
265 const cpp_token
*source
; /* Source token for spacing. */
266 unsigned int line
; /* Line currently being written. */
267 unsigned char printed
; /* Nonzero if something output at line. */
270 /* Represents the contents of a file cpplib has read in. */
273 const unsigned char *cur
; /* current position */
274 const unsigned char *backup_to
; /* if peeked character is not wanted */
275 const unsigned char *rlimit
; /* end of valid data */
276 const unsigned char *line_base
; /* start of current line */
278 struct cpp_buffer
*prev
;
280 const unsigned char *buf
; /* Entire character buffer. */
282 /* Pointer into the include table; non-NULL if this is a file
283 buffer. Used for include_next and to record control macros. */
284 struct include_file
*inc
;
286 /* Value of if_stack at start of this file.
287 Used to prohibit unmatched #endif (etc) in an include file. */
288 struct if_stack
*if_stack
;
290 /* Token column position adjustment owing to tabs in whitespace. */
291 unsigned int col_adjust
;
293 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
294 unsigned char saved_flags
;
296 /* Because of the way the lexer works, -Wtrigraphs can sometimes
297 warn twice for the same trigraph. This helps prevent that. */
298 const unsigned char *last_Wtrigraphs
;
300 /* True if we have already warned about C++ comments in this file.
301 The warning happens only for C89 extended mode with -pedantic on,
302 or for -Wtraditional, and only once per file (otherwise it would
303 be far too noisy). */
304 unsigned char warned_cplusplus_comments
;
306 /* True if we don't process trigraphs and escaped newlines. True
307 for preprocessed input, command line directives, and _Pragma
309 unsigned char from_stage3
;
311 /* Nonzero means that the directory to start searching for ""
312 include files has been calculated and stored in "dir" below. */
313 unsigned char search_cached
;
315 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
316 true, a CPP_EOF token is then returned. Otherwise, the next
317 token from the enclosing buffer is returned. */
320 /* The directory of the this buffer's file. Its NAME member is not
321 allocated, so we don't need to worry about freeing it. */
322 struct search_path dir
;
324 /* Used for buffer overlays by cpptrad.c. */
325 const uchar
*saved_cur
, *saved_rlimit
;
328 /* A cpp_reader encapsulates the "state" of a pre-processor run.
329 Applying cpp_get_token repeatedly yields a stream of pre-processor
330 tokens. Usually, there is only one cpp_reader object active. */
333 /* Top of buffer stack. */
336 /* Overlaid buffer (can be different after processing #include). */
337 cpp_buffer
*overlaid_buffer
;
340 struct lexer_state state
;
342 /* Source line tracking. */
343 struct line_maps line_maps
;
344 const struct line_map
*map
;
347 /* The line of the '#' of the current directive. */
348 unsigned int directive_line
;
350 /* Memory buffers. */
351 _cpp_buff
*a_buff
; /* Aligned permanent storage. */
352 _cpp_buff
*u_buff
; /* Unaligned permanent storage. */
353 _cpp_buff
*free_buffs
; /* Free buffer chain. */
356 struct cpp_context base_context
;
357 struct cpp_context
*context
;
359 /* If in_directive, the directive if known. */
360 const struct directive
*directive
;
362 /* The next -include-d file; NULL if they all are done. If it
363 points to NULL, the last one is in progress, and
364 _cpp_maybe_push_include_file has yet to restore the line map. */
365 struct pending_option
**next_include_file
;
367 /* Multiple include optimisation. */
368 const cpp_hashnode
*mi_cmacro
;
369 const cpp_hashnode
*mi_ind_cmacro
;
373 cpp_token
*cur_token
;
374 tokenrun base_run
, *cur_run
;
375 unsigned int lookaheads
;
377 /* Nonzero prevents the lexer from re-using the token runs. */
378 unsigned int keep_tokens
;
380 /* Error counter for exit code. */
383 /* Buffer to hold macro definition string. */
384 unsigned char *macro_buffer
;
385 unsigned int macro_buffer_len
;
387 /* Tree of other included files. See cppfiles.c. */
388 struct splay_tree_s
*all_include_files
;
390 /* Current maximum length of directory names in the search path
391 for include files. (Altered as we get more of them.) */
392 unsigned int max_include_len
;
394 /* Macros on or after this line are warned about if unused. */
395 unsigned int first_unused_line
;
397 /* Date and time text. Calculated together if either is requested. */
401 /* EOF token, and a token forcing paste avoidance. */
402 cpp_token avoid_paste
;
405 /* Opaque handle to the dependencies of mkdeps.c. */
408 /* Obstack holding all macro hash nodes. This never shrinks.
410 struct obstack hash_ob
;
412 /* Obstack holding buffer and conditional structures. This is a
413 real stack. See cpplib.c. */
414 struct obstack buffer_ob
;
416 /* Pragma table - dynamic, because a library user can add to the
417 list of recognized pragmas. */
418 struct pragma_entry
*pragmas
;
421 struct cpp_callbacks cb
;
423 /* Identifier hash table. */
424 struct ht
*hash_table
;
426 /* Expression parser stack. */
427 struct op
*op_stack
, *op_limit
;
429 /* User visible options. */
430 struct cpp_options opts
;
432 /* Special nodes - identifiers with predefined significance to the
434 struct spec_nodes spec_nodes
;
436 /* Used when doing preprocessed output. */
437 struct printer print
;
439 /* Whether cpplib owns the hashtable. */
440 unsigned char our_hashtable
;
442 /* Traditional preprocessing output buffer (a logical line). */
448 unsigned int first_line
;
451 /* Used to save the original line number during traditional
453 unsigned int saved_line
;
455 /* A saved list of the defined macros, for dependency checking
456 of precompiled headers. */
457 struct cpp_savedstate
*savedstate
;
460 /* Character classes. Based on the more primitive macros in safe-ctype.h.
461 If the definition of `numchar' looks odd to you, please look up the
462 definition of a pp-number in the C standard [section 6.4.8 of C99].
464 In the unlikely event that characters other than \r and \n enter
465 the set is_vspace, the macro handle_newline() in cpplex.c must be
467 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
469 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
470 #define is_numchar(x) ISIDNUM(x)
471 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
472 #define is_numstart(x) ISDIGIT(x)
473 #define is_hspace(x) ISBLANK(x)
474 #define is_vspace(x) IS_VSPACE(x)
475 #define is_nvspace(x) IS_NVSPACE(x)
476 #define is_space(x) IS_SPACE_OR_NUL(x)
478 /* This table is constant if it can be initialized at compile time,
479 which is the case if cpp was compiled with GCC >=2.7, or another
480 compiler that supports C99. */
481 #if HAVE_DESIGNATED_INITIALIZERS
482 extern const unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
484 extern unsigned char _cpp_trigraph_map
[UCHAR_MAX
+ 1];
489 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
490 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
491 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
494 extern int _cpp_begin_message
PARAMS ((cpp_reader
*, int,
495 unsigned int, unsigned int));
498 extern void _cpp_free_definition
PARAMS ((cpp_hashnode
*));
499 extern bool _cpp_create_definition
PARAMS ((cpp_reader
*, cpp_hashnode
*));
500 extern void _cpp_pop_context
PARAMS ((cpp_reader
*));
501 extern void _cpp_push_text_context
PARAMS ((cpp_reader
*, cpp_hashnode
*,
502 const uchar
*, size_t));
503 extern bool _cpp_save_parameter
PARAMS ((cpp_reader
*, cpp_macro
*,
505 extern bool _cpp_arguments_ok
PARAMS ((cpp_reader
*, cpp_macro
*,
506 const cpp_hashnode
*,
508 extern const uchar
*_cpp_builtin_macro_text
PARAMS ((cpp_reader
*,
510 int _cpp_warn_if_unused_macro
PARAMS ((cpp_reader
*, cpp_hashnode
*,
513 extern void _cpp_init_hashtable
PARAMS ((cpp_reader
*, hash_table
*));
514 extern void _cpp_destroy_hashtable
PARAMS ((cpp_reader
*));
517 extern void _cpp_fake_include
PARAMS ((cpp_reader
*, const char *));
518 extern void _cpp_never_reread
PARAMS ((struct include_file
*));
519 extern char *_cpp_simplify_pathname
PARAMS ((char *));
520 extern bool _cpp_read_file
PARAMS ((cpp_reader
*, const char *));
521 extern bool _cpp_execute_include
PARAMS ((cpp_reader
*,
524 extern int _cpp_compare_file_date
PARAMS ((cpp_reader
*,
526 extern void _cpp_report_missing_guards
PARAMS ((cpp_reader
*));
527 extern void _cpp_init_includes
PARAMS ((cpp_reader
*));
528 extern void _cpp_cleanup_includes
PARAMS ((cpp_reader
*));
529 extern void _cpp_pop_file_buffer
PARAMS ((cpp_reader
*,
530 struct include_file
*));
533 extern bool _cpp_parse_expr
PARAMS ((cpp_reader
*));
534 extern struct op
*_cpp_expand_op_stack
PARAMS ((cpp_reader
*));
537 extern cpp_token
*_cpp_temp_token
PARAMS ((cpp_reader
*));
538 extern const cpp_token
*_cpp_lex_token
PARAMS ((cpp_reader
*));
539 extern cpp_token
*_cpp_lex_direct
PARAMS ((cpp_reader
*));
540 extern int _cpp_equiv_tokens
PARAMS ((const cpp_token
*,
542 extern void _cpp_init_tokenrun
PARAMS ((tokenrun
*, unsigned int));
545 extern void _cpp_maybe_push_include_file
PARAMS ((cpp_reader
*));
548 extern int _cpp_test_assertion
PARAMS ((cpp_reader
*, unsigned int *));
549 extern int _cpp_handle_directive
PARAMS ((cpp_reader
*, int));
550 extern void _cpp_define_builtin
PARAMS ((cpp_reader
*, const char *));
551 extern char ** _cpp_save_pragma_names
PARAMS ((cpp_reader
*));
552 extern void _cpp_restore_pragma_names
PARAMS ((cpp_reader
*, char **));
553 extern void _cpp_do__Pragma
PARAMS ((cpp_reader
*));
554 extern void _cpp_init_directives
PARAMS ((cpp_reader
*));
555 extern void _cpp_init_internal_pragmas
PARAMS ((cpp_reader
*));
556 extern void _cpp_do_file_change
PARAMS ((cpp_reader
*, enum lc_reason
,
558 unsigned int, unsigned int));
559 extern void _cpp_pop_buffer
PARAMS ((cpp_reader
*));
562 extern bool _cpp_read_logical_line_trad
PARAMS ((cpp_reader
*));
563 extern void _cpp_overlay_buffer
PARAMS ((cpp_reader
*pfile
, const uchar
*,
565 extern void _cpp_remove_overlay
PARAMS ((cpp_reader
*));
566 extern bool _cpp_create_trad_definition
PARAMS ((cpp_reader
*, cpp_macro
*));
567 extern bool _cpp_expansions_different_trad
PARAMS ((const cpp_macro
*,
569 extern uchar
*_cpp_copy_replacement_text
PARAMS ((const cpp_macro
*, uchar
*));
570 extern size_t _cpp_replacement_text_len
PARAMS ((const cpp_macro
*));
572 /* Utility routines and macros. */
573 #define DSC(str) (const uchar *)str, sizeof str - 1
574 #define xnew(T) (T *) xmalloc (sizeof(T))
575 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
576 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
577 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
578 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
580 /* These are inline functions instead of macros so we can get type
582 static inline int ustrcmp
PARAMS ((const uchar
*, const uchar
*));
583 static inline int ustrncmp
PARAMS ((const uchar
*, const uchar
*,
585 static inline size_t ustrlen
PARAMS ((const uchar
*));
586 static inline uchar
*uxstrdup
PARAMS ((const uchar
*));
587 static inline uchar
*ustrchr
PARAMS ((const uchar
*, int));
588 static inline int ufputs
PARAMS ((const uchar
*, FILE *));
592 const uchar
*s1
, *s2
;
594 return strcmp ((const char *)s1
, (const char *)s2
);
599 const uchar
*s1
, *s2
;
602 return strncmp ((const char *)s1
, (const char *)s2
, n
);
609 return strlen ((const char *)s1
);
612 static inline uchar
*
616 return (uchar
*) xstrdup ((const char *)s1
);
619 static inline uchar
*
624 return (uchar
*) strchr ((const char *)s1
, c
);
632 return fputs ((const char *)s
, f
);
635 #endif /* ! GCC_CPPHASH_H */