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 /* Test if a X or x is valid within a preprocessing number. */
47 #define VALID_HEX(c, prevc) \
48 (((c) == 'X' || (c) == 'x') && (prevc) == '0')
50 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
51 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
52 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
53 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
55 /* Maximum nesting of cpp_buffers. We use a static limit, partly for
56 efficiency, and partly to limit runaway recursion. */
57 #define CPP_STACK_MAX 200
59 /* Host alignment handling. */
70 #define DEFAULT_ALIGNMENT offsetof (struct dummy, u)
71 #define CPP_ALIGN2(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
72 #define CPP_ALIGN(size) CPP_ALIGN2 (size, DEFAULT_ALIGNMENT)
74 /* Each macro definition is recorded in a cpp_macro structure.
75 Variadic macros cannot occur with traditional cpp. */
78 /* Parameters, if any. */
79 cpp_hashnode **params;
81 /* Replacement tokens (ISO) or replacement text (traditional). See
82 comment at top of cpptrad.c for how traditional function-like
83 macros are encoded. */
90 /* Definition line number. */
93 /* Number of tokens in expansion, or bytes for traditional macros. */
96 /* Number of parameters. */
97 unsigned short paramc;
99 /* If a function-like macro. */
100 unsigned int fun_like : 1;
102 /* If a variadic macro. */
103 unsigned int variadic : 1;
105 /* If macro defined in system header. */
106 unsigned int syshdr : 1;
108 /* Nonzero if it has been expanded or had its existence tested. */
109 unsigned int used : 1;
112 #define _cpp_mark_macro_used(NODE) do { \
113 if ((NODE)->type == NT_MACRO && !((NODE)->flags & NODE_BUILTIN)) \
114 (NODE)->value.macro->used = 1; } while (0)
116 /* A generic memory buffer, and operations on it. */
117 typedef struct _cpp_buff _cpp_buff;
120 struct _cpp_buff *next;
121 unsigned char *base, *cur, *limit;
124 extern _cpp_buff *_cpp_get_buff PARAMS ((cpp_reader *, size_t));
125 extern void _cpp_release_buff PARAMS ((cpp_reader *, _cpp_buff *));
126 extern void _cpp_extend_buff PARAMS ((cpp_reader *, _cpp_buff **, size_t));
127 extern _cpp_buff *_cpp_append_extend_buff PARAMS ((cpp_reader *, _cpp_buff *,
129 extern void _cpp_free_buff PARAMS ((_cpp_buff *));
130 extern unsigned char *_cpp_aligned_alloc PARAMS ((cpp_reader *, size_t));
131 extern unsigned char *_cpp_unaligned_alloc PARAMS ((cpp_reader *, size_t));
133 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
134 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
135 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
137 /* List of directories to look for include files in. */
140 struct search_path *next;
142 /* NOTE: NAME may not be null terminated for the case of the current
146 /* We use these to tell if the directory mentioned here is a duplicate
147 of an earlier directory on the search path. */
150 /* Nonzero if it is a system include directory. */
152 /* Mapping of file names for this directory. Only used on MS-DOS
153 and related platforms. */
154 struct file_name_map *name_map;
157 /* #include types. */
158 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
162 const cpp_token *token;
163 const cpp_token **ptoken;
166 /* A "run" of tokens; part of a chain of runs. */
167 typedef struct tokenrun tokenrun;
170 tokenrun *next, *prev;
171 cpp_token *base, *limit;
174 /* Accessor macros for struct cpp_context. */
175 #define FIRST(c) ((c)->u.iso.first)
176 #define LAST(c) ((c)->u.iso.last)
177 #define CUR(c) ((c)->u.trad.cur)
178 #define RLIMIT(c) ((c)->u.trad.rlimit)
180 typedef struct cpp_context cpp_context;
183 /* Doubly-linked list. */
184 cpp_context *next, *prev;
188 /* For ISO macro expansion. Contexts other than the base context
189 are contiguous tokens. e.g. macro expansions, expanded
197 /* For traditional macro expansion. */
205 /* If non-NULL, a buffer used for storage related to this context.
206 When the context is popped, the buffer is released. */
209 /* For a macro context, the macro node, otherwise NULL. */
212 /* True if utoken element is token, else ptoken. */
218 /* Nonzero if first token on line is CPP_HASH. */
219 unsigned char in_directive;
221 /* Nonzero if in a directive that will handle padding tokens itself.
222 #include needs this to avoid problems with computed include and
223 spacing between tokens. */
224 unsigned char directive_wants_padding;
226 /* True if we are skipping a failed conditional group. */
227 unsigned char skipping;
229 /* Nonzero if in a directive that takes angle-bracketed headers. */
230 unsigned char angled_headers;
232 /* Nonzero if in a #if or #elif directive. */
233 unsigned char in_expression;
235 /* Nonzero to save comments. Turned off if discard_comments, and in
236 all directives apart from #define. */
237 unsigned char save_comments;
239 /* Nonzero if we're mid-comment. */
240 unsigned char lexing_comment;
242 /* Nonzero if lexing __VA_ARGS__ is valid. */
243 unsigned char va_args_ok;
245 /* Nonzero if lexing poisoned identifiers is valid. */
246 unsigned char poisoned_ok;
248 /* Nonzero to prevent macro expansion. */
249 unsigned char prevent_expansion;
251 /* Nonzero when parsing arguments to a function-like macro. */
252 unsigned char parsing_args;
254 /* Nonzero to skip evaluating part of an expression. */
255 unsigned int skip_eval;
258 /* Special nodes - identifiers with predefined significance. */
261 cpp_hashnode *n_defined; /* defined operator */
262 cpp_hashnode *n_true; /* C++ keyword true */
263 cpp_hashnode *n_false; /* C++ keyword false */
264 cpp_hashnode *n__VA_ARGS__; /* C99 vararg macros */
265 /* SDCC _asm specific */
266 cpp_hashnode *n__asm; /* _asm ... _endasm ; */
269 /* Encapsulates state used to convert a stream of tokens into a text
273 FILE *outf; /* Stream to write to. */
274 const struct line_map *map; /* Logical to physical line mappings. */
275 const cpp_token *prev; /* Previous token. */
276 const cpp_token *source; /* Source token for spacing. */
277 unsigned int line; /* Line currently being written. */
278 unsigned char printed; /* Nonzero if something output at line. */
281 /* Represents the contents of a file cpplib has read in. */
284 const unsigned char *cur; /* current position */
285 const unsigned char *backup_to; /* if peeked character is not wanted */
286 const unsigned char *rlimit; /* end of valid data */
287 const unsigned char *line_base; /* start of current line */
289 struct cpp_buffer *prev;
291 const unsigned char *buf; /* Entire character buffer. */
293 /* Pointer into the include table; non-NULL if this is a file
294 buffer. Used for include_next and to record control macros. */
295 struct include_file *inc;
297 /* Value of if_stack at start of this file.
298 Used to prohibit unmatched #endif (etc) in an include file. */
299 struct if_stack *if_stack;
301 /* Token column position adjustment owing to tabs in whitespace. */
302 unsigned int col_adjust;
304 /* Contains PREV_WHITE and/or AVOID_LPASTE. */
305 unsigned char saved_flags;
307 /* Because of the way the lexer works, -Wtrigraphs can sometimes
308 warn twice for the same trigraph. This helps prevent that. */
309 const unsigned char *last_Wtrigraphs;
311 /* True if we have already warned about C++ comments in this file.
312 The warning happens only for C89 extended mode with -pedantic on,
313 or for -Wtraditional, and only once per file (otherwise it would
314 be far too noisy). */
315 unsigned char warned_cplusplus_comments;
317 /* True if we don't process trigraphs and escaped newlines. True
318 for preprocessed input, command line directives, and _Pragma
320 unsigned char from_stage3;
322 /* Nonzero means that the directory to start searching for ""
323 include files has been calculated and stored in "dir" below. */
324 unsigned char search_cached;
326 /* At EOF, a buffer is automatically popped. If RETURN_AT_EOF is
327 true, a CPP_EOF token is then returned. Otherwise, the next
328 token from the enclosing buffer is returned. */
331 /* The directory of the this buffer's file. Its NAME member is not
332 allocated, so we don't need to worry about freeing it. */
333 struct search_path dir;
335 /* Used for buffer overlays by cpptrad.c. */
336 const uchar *saved_cur, *saved_rlimit;
339 /* A cpp_reader encapsulates the "state" of a pre-processor run.
340 Applying cpp_get_token repeatedly yields a stream of pre-processor
341 tokens. Usually, there is only one cpp_reader object active. */
344 /* Top of buffer stack. */
347 /* Overlaid buffer (can be different after processing #include). */
348 cpp_buffer *overlaid_buffer;
351 struct lexer_state state;
353 /* Source line tracking. */
354 struct line_maps line_maps;
355 const struct line_map *map;
358 /* The line of the '#' of the current directive. */
359 unsigned int directive_line;
361 /* Memory buffers. */
362 _cpp_buff *a_buff; /* Aligned permanent storage. */
363 _cpp_buff *u_buff; /* Unaligned permanent storage. */
364 _cpp_buff *free_buffs; /* Free buffer chain. */
367 struct cpp_context base_context;
368 struct cpp_context *context;
370 /* If in_directive, the directive if known. */
371 const struct directive *directive;
373 /* The next -include-d file; NULL if they all are done. If it
374 points to NULL, the last one is in progress, and
375 _cpp_maybe_push_include_file has yet to restore the line map. */
376 struct pending_option **next_include_file;
378 /* Multiple inlcude optimisation. */
379 const cpp_hashnode *mi_cmacro;
380 const cpp_hashnode *mi_ind_cmacro;
384 cpp_token *cur_token;
385 tokenrun base_run, *cur_run;
386 unsigned int lookaheads;
388 /* Nonzero prevents the lexer from re-using the token runs. */
389 unsigned int keep_tokens;
391 /* Error counter for exit code. */
394 /* Buffer to hold macro definition string. */
395 unsigned char *macro_buffer;
396 unsigned int macro_buffer_len;
398 /* Tree of other included files. See cppfiles.c. */
399 struct splay_tree_s *all_include_files;
401 /* Current maximum length of directory names in the search path
402 for include files. (Altered as we get more of them.) */
403 unsigned int max_include_len;
405 /* Macros on or after this line are warned about if unused. */
406 unsigned int first_unused_line;
408 /* Date and time text. Calculated together if either is requested. */
412 /* EOF token, and a token forcing paste avoidance. */
413 cpp_token avoid_paste;
416 /* Opaque handle to the dependencies of mkdeps.c. */
419 /* Obstack holding all macro hash nodes. This never shrinks.
421 struct obstack hash_ob;
423 /* Obstack holding buffer and conditional structures. This is a
424 real stack. See cpplib.c. */
425 struct obstack buffer_ob;
427 /* Pragma table - dynamic, because a library user can add to the
428 list of recognized pragmas. */
429 struct pragma_entry *pragmas;
432 struct cpp_callbacks cb;
434 /* Identifier hash table. */
435 struct ht *hash_table;
437 /* Expression parser stack. */
438 struct op *op_stack, *op_limit;
440 /* User visible options. */
441 struct cpp_options opts;
443 /* Special nodes - identifiers with predefined significance to the
445 struct spec_nodes spec_nodes;
447 /* Used when doing preprocessed output. */
448 struct printer print;
450 /* Whether to print our version number. Done this way so
451 we don't get it twice for -v -version. */
452 unsigned char print_version;
454 /* Whether cpplib owns the hashtable. */
455 unsigned char our_hashtable;
457 /* Traditional preprocessing output buffer (a logical line). */
463 unsigned int first_line;
466 /* Used to save the original line number during traditional
468 unsigned int saved_line;
471 /* Character classes. Based on the more primitive macros in safe-ctype.h.
472 If the definition of `numchar' looks odd to you, please look up the
473 definition of a pp-number in the C standard [section 6.4.8 of C99].
475 In the unlikely event that characters other than \r and \n enter
476 the set is_vspace, the macro handle_newline() in cpplex.c must be
478 #define _dollar_ok(x) ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
480 #define is_idchar(x) (ISIDNUM(x) || _dollar_ok(x))
481 #define is_numchar(x) ISIDNUM(x)
482 #define is_idstart(x) (ISIDST(x) || _dollar_ok(x))
483 #define is_numstart(x) ISDIGIT(x)
484 #define is_hspace(x) ISBLANK(x)
485 #define is_vspace(x) IS_VSPACE(x)
486 #define is_nvspace(x) IS_NVSPACE(x)
487 #define is_space(x) IS_SPACE_OR_NUL(x)
489 /* This table is constant if it can be initialized at compile time,
490 which is the case if cpp was compiled with GCC >=2.7, or another
491 compiler that supports C99. */
492 #if HAVE_DESIGNATED_INITIALIZERS
493 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
495 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
500 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
501 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
502 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
505 extern int _cpp_begin_message PARAMS ((cpp_reader *, int,
506 unsigned int, unsigned int));
509 extern void _cpp_free_definition PARAMS ((cpp_hashnode *));
510 extern bool _cpp_create_definition PARAMS ((cpp_reader *, cpp_hashnode *));
511 extern void _cpp_pop_context PARAMS ((cpp_reader *));
512 extern void _cpp_push_text_context PARAMS ((cpp_reader *, cpp_hashnode *,
513 const uchar *, size_t));
514 extern bool _cpp_save_parameter PARAMS ((cpp_reader *, cpp_macro *,
516 extern bool _cpp_arguments_ok PARAMS ((cpp_reader *, cpp_macro *,
517 const cpp_hashnode *,
519 extern const uchar *_cpp_builtin_macro_text PARAMS ((cpp_reader *,
521 int _cpp_warn_if_unused_macro PARAMS ((cpp_reader *, cpp_hashnode *,
524 extern void _cpp_init_hashtable PARAMS ((cpp_reader *, hash_table *));
525 extern void _cpp_destroy_hashtable PARAMS ((cpp_reader *));
528 extern void _cpp_fake_include PARAMS ((cpp_reader *, const char *));
529 extern void _cpp_never_reread PARAMS ((struct include_file *));
530 extern char *_cpp_simplify_pathname PARAMS ((char *));
531 extern bool _cpp_read_file PARAMS ((cpp_reader *, const char *));
532 extern bool _cpp_execute_include PARAMS ((cpp_reader *,
535 extern int _cpp_compare_file_date PARAMS ((cpp_reader *,
537 extern void _cpp_report_missing_guards PARAMS ((cpp_reader *));
538 extern void _cpp_init_includes PARAMS ((cpp_reader *));
539 extern void _cpp_cleanup_includes PARAMS ((cpp_reader *));
540 extern void _cpp_pop_file_buffer PARAMS ((cpp_reader *,
541 struct include_file *));
544 extern bool _cpp_parse_expr PARAMS ((cpp_reader *));
545 extern struct op *_cpp_expand_op_stack PARAMS ((cpp_reader *));
548 extern cpp_token *_cpp_temp_token PARAMS ((cpp_reader *));
549 extern const cpp_token *_cpp_lex_token PARAMS ((cpp_reader *));
550 extern cpp_token *_cpp_lex_direct PARAMS ((cpp_reader *));
551 extern int _cpp_equiv_tokens PARAMS ((const cpp_token *,
553 extern void _cpp_init_tokenrun PARAMS ((tokenrun *, unsigned int));
556 extern void _cpp_maybe_push_include_file PARAMS ((cpp_reader *));
559 extern int _cpp_test_assertion PARAMS ((cpp_reader *, unsigned int *));
560 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
561 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
562 extern void _cpp_do__Pragma PARAMS ((cpp_reader *));
563 extern void _cpp_init_directives PARAMS ((cpp_reader *));
564 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
565 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
567 unsigned int, unsigned int));
568 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
571 extern bool _cpp_read_logical_line_trad PARAMS ((cpp_reader *));
572 extern void _cpp_overlay_buffer PARAMS ((cpp_reader *pfile, const uchar *,
574 extern void _cpp_remove_overlay PARAMS ((cpp_reader *));
575 extern bool _cpp_create_trad_definition PARAMS ((cpp_reader *, cpp_macro *));
576 extern bool _cpp_expansions_different_trad PARAMS ((const cpp_macro *,
578 extern uchar *_cpp_copy_replacement_text PARAMS ((const cpp_macro *, uchar *));
579 extern size_t _cpp_replacement_text_len PARAMS ((const cpp_macro *));
581 /* Utility routines and macros. */
582 #define DSC(str) (const uchar *)str, sizeof str - 1
583 #define xnew(T) (T *) xmalloc (sizeof(T))
584 #define xcnew(T) (T *) xcalloc (1, sizeof(T))
585 #define xnewvec(T, N) (T *) xmalloc (sizeof(T) * (N))
586 #define xcnewvec(T, N) (T *) xcalloc (N, sizeof(T))
587 #define xobnew(O, T) (T *) obstack_alloc (O, sizeof(T))
589 /* These are inline functions instead of macros so we can get type
591 static inline int ustrcmp PARAMS ((const uchar *, const uchar *));
592 static inline int ustrncmp PARAMS ((const uchar *, const uchar *,
594 static inline size_t ustrlen PARAMS ((const uchar *));
595 static inline uchar *uxstrdup PARAMS ((const uchar *));
596 static inline uchar *ustrchr PARAMS ((const uchar *, int));
597 static inline int ufputs PARAMS ((const uchar *, FILE *));
601 const uchar *s1, *s2;
603 return strcmp ((const char *)s1, (const char *)s2);
608 const uchar *s1, *s2;
611 return strncmp ((const char *)s1, (const char *)s2, n);
618 return strlen ((const char *)s1);
621 static inline uchar *
625 return (uchar *) xstrdup ((const char *)s1);
628 static inline uchar *
633 return (uchar *) strchr ((const char *)s1, c);
641 return fputs ((const char *)s, f);
644 #endif /* ! GCC_CPPHASH_H */