OSDN Git Service

* sh.h (ROUND_TYPE_ALIGN): Remove.
[pf3gnuchains/gcc-fork.git] / gcc / cpphash.h
1 /* Part of CPP library.
2    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003
3    Free Software Foundation, Inc.
4
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
8 later version.
9
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.
14
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.  */
18
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.  */
22
23 #ifndef GCC_CPPHASH_H
24 #define GCC_CPPHASH_H
25
26 #include "hashtable.h"
27
28 struct directive;               /* Deliberately incomplete.  */
29 struct pending_option;
30 struct op;
31
32 #ifndef HAVE_UCHAR
33 typedef unsigned char uchar;
34 #endif
35 #define U (const uchar *)  /* Intended use: U"string" */
36
37 #define BITS_PER_CPPCHAR_T (CHAR_BIT * sizeof (cppchar_t))
38
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))))
45
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)
49 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
50
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
54
55 /* Host alignment handling.  */
56 struct dummy
57 {
58   char c;
59   union
60   {
61     double d;
62     int *p;
63   } u;
64 };
65
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)
69
70 /* Each macro definition is recorded in a cpp_macro structure.
71    Variadic macros cannot occur with traditional cpp.  */
72 struct cpp_macro
73 {
74   /* Parameters, if any.  */
75   cpp_hashnode **params;
76
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.  */
80   union
81   {
82     cpp_token *tokens;
83     const uchar *text;
84   } exp;
85
86   /* Definition line number.  */
87   unsigned int line;
88
89   /* Number of tokens in expansion, or bytes for traditional macros.  */
90   unsigned int count;
91
92   /* Number of parameters.  */
93   unsigned short paramc;
94
95   /* If a function-like macro.  */
96   unsigned int fun_like : 1;
97
98   /* If a variadic macro.  */
99   unsigned int variadic : 1;
100
101   /* If macro defined in system header.  */
102   unsigned int syshdr   : 1;
103
104   /* Nonzero if it has been expanded or had its existence tested.  */
105   unsigned int used     : 1;
106 };
107
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)
111
112 /* A generic memory buffer, and operations on it.  */
113 typedef struct _cpp_buff _cpp_buff;
114 struct _cpp_buff
115 {
116   struct _cpp_buff *next;
117   unsigned char *base, *cur, *limit;
118 };
119
120 extern _cpp_buff *_cpp_get_buff (cpp_reader *, size_t);
121 extern void _cpp_release_buff (cpp_reader *, _cpp_buff *);
122 extern void _cpp_extend_buff (cpp_reader *, _cpp_buff **, size_t);
123 extern _cpp_buff *_cpp_append_extend_buff (cpp_reader *, _cpp_buff *, size_t);
124 extern void _cpp_free_buff (_cpp_buff *);
125 extern unsigned char *_cpp_aligned_alloc (cpp_reader *, size_t);
126 extern unsigned char *_cpp_unaligned_alloc (cpp_reader *, size_t);
127
128 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
129 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
130 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
131
132 /* #include types.  */
133 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
134
135 union utoken
136 {
137   const cpp_token *token;
138   const cpp_token **ptoken;
139 };
140
141 /* A "run" of tokens; part of a chain of runs.  */
142 typedef struct tokenrun tokenrun;
143 struct tokenrun
144 {
145   tokenrun *next, *prev;
146   cpp_token *base, *limit;
147 };
148
149 /* Accessor macros for struct cpp_context.  */
150 #define FIRST(c) ((c)->u.iso.first)
151 #define LAST(c) ((c)->u.iso.last)
152 #define CUR(c) ((c)->u.trad.cur)
153 #define RLIMIT(c) ((c)->u.trad.rlimit)
154
155 typedef struct cpp_context cpp_context;
156 struct cpp_context
157 {
158   /* Doubly-linked list.  */
159   cpp_context *next, *prev;
160
161   union
162   {
163     /* For ISO macro expansion.  Contexts other than the base context
164        are contiguous tokens.  e.g. macro expansions, expanded
165        argument tokens.  */
166     struct
167     {
168       union utoken first;
169       union utoken last;
170     } iso;
171
172     /* For traditional macro expansion.  */
173     struct
174     {
175       const uchar *cur;
176       const uchar *rlimit;
177     } trad;
178   } u;
179
180   /* If non-NULL, a buffer used for storage related to this context.
181      When the context is popped, the buffer is released.  */
182   _cpp_buff *buff;
183
184   /* For a macro context, the macro node, otherwise NULL.  */
185   cpp_hashnode *macro;
186
187   /* True if utoken element is token, else ptoken.  */
188   bool direct_p;
189 };
190
191 struct lexer_state
192 {
193   /* Nonzero if first token on line is CPP_HASH.  */
194   unsigned char in_directive;
195
196   /* Nonzero if in a directive that will handle padding tokens itself.
197      #include needs this to avoid problems with computed include and
198      spacing between tokens.  */
199   unsigned char directive_wants_padding;
200
201   /* True if we are skipping a failed conditional group.  */
202   unsigned char skipping;
203
204   /* Nonzero if in a directive that takes angle-bracketed headers.  */
205   unsigned char angled_headers;
206
207   /* Nonzero if in a #if or #elif directive.  */
208   unsigned char in_expression;
209
210   /* Nonzero to save comments.  Turned off if discard_comments, and in
211      all directives apart from #define.  */
212   unsigned char save_comments;
213
214   /* Nonzero if lexing __VA_ARGS__ is valid.  */
215   unsigned char va_args_ok;
216
217   /* Nonzero if lexing poisoned identifiers is valid.  */
218   unsigned char poisoned_ok;
219
220   /* Nonzero to prevent macro expansion.  */
221   unsigned char prevent_expansion;
222
223   /* Nonzero when parsing arguments to a function-like macro.  */
224   unsigned char parsing_args;
225
226   /* Nonzero to skip evaluating part of an expression.  */
227   unsigned int skip_eval;
228 };
229
230 /* Special nodes - identifiers with predefined significance.  */
231 struct spec_nodes
232 {
233   cpp_hashnode *n_defined;              /* defined operator */
234   cpp_hashnode *n_true;                 /* C++ keyword true */
235   cpp_hashnode *n_false;                /* C++ keyword false */
236   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
237 };
238
239 typedef struct _cpp_line_note _cpp_line_note;
240 struct _cpp_line_note
241 {
242   /* Location in the clean line the note refers to.  */
243   const uchar *pos;
244
245   /* Type of note.  The 9 'from' trigraph characters represent those
246      trigraphs, '\\' an escaped newline, ' ' an escaped newline with
247      intervening space, and anything else is invalid.  */
248   unsigned int type;
249 };
250
251 /* Represents the contents of a file cpplib has read in.  */
252 struct cpp_buffer
253 {
254   const uchar *cur;             /* Current location.  */
255   const uchar *line_base;       /* Start of current physical line.  */
256   const uchar *next_line;       /* Start of to-be-cleaned logical line.  */
257   
258   const uchar *buf;             /* Entire character buffer.  */
259   const uchar *rlimit;          /* Writable byte at end of file.  */
260
261   _cpp_line_note *notes;        /* Array of notes.  */
262   unsigned int cur_note;        /* Next note to process.  */
263   unsigned int notes_used;      /* Number of notes.  */
264   unsigned int notes_cap;       /* Size of allocated array.  */
265
266   struct cpp_buffer *prev;
267
268   /* Pointer into the include table; non-NULL if this is a file
269      buffer.  Used for include_next and to record control macros.  */
270   struct include_file *inc;
271
272   /* Value of if_stack at start of this file.
273      Used to prohibit unmatched #endif (etc) in an include file.  */
274   struct if_stack *if_stack;
275
276   /* True if we need to get the next clean line.  */
277   bool need_line;
278
279   /* True if we have already warned about C++ comments in this file.
280      The warning happens only for C89 extended mode with -pedantic on,
281      or for -Wtraditional, and only once per file (otherwise it would
282      be far too noisy).  */
283   unsigned char warned_cplusplus_comments;
284
285   /* True if we don't process trigraphs and escaped newlines.  True
286      for preprocessed input, command line directives, and _Pragma
287      buffers.  */
288   unsigned char from_stage3;
289
290   /* Nonzero means that the directory to start searching for ""
291      include files has been calculated and stored in "dir" below.  */
292   unsigned char search_cached;
293
294   /* At EOF, a buffer is automatically popped.  If RETURN_AT_EOF is
295      true, a CPP_EOF token is then returned.  Otherwise, the next
296      token from the enclosing buffer is returned.  */
297   bool return_at_eof;
298
299   /* The directory of the this buffer's file.  Its NAME member is not
300      allocated, so we don't need to worry about freeing it.  */
301   struct cpp_path dir;
302
303   /* Used for buffer overlays by cpptrad.c.  */
304   const uchar *saved_cur, *saved_rlimit;
305 };
306
307 /* A cpp_reader encapsulates the "state" of a pre-processor run.
308    Applying cpp_get_token repeatedly yields a stream of pre-processor
309    tokens.  Usually, there is only one cpp_reader object active.  */
310 struct cpp_reader
311 {
312   /* Top of buffer stack.  */
313   cpp_buffer *buffer;
314
315   /* Overlaid buffer (can be different after processing #include).  */
316   cpp_buffer *overlaid_buffer;
317
318   /* Lexer state.  */
319   struct lexer_state state;
320
321   /* Source line tracking.  */
322   struct line_maps line_maps;
323   const struct line_map *map;
324   unsigned int line;
325
326   /* The line of the '#' of the current directive.  */
327   unsigned int directive_line;
328
329   /* Memory buffers.  */
330   _cpp_buff *a_buff;            /* Aligned permanent storage.  */
331   _cpp_buff *u_buff;            /* Unaligned permanent storage.  */
332   _cpp_buff *free_buffs;        /* Free buffer chain.  */
333
334   /* Context stack.  */
335   struct cpp_context base_context;
336   struct cpp_context *context;
337
338   /* If in_directive, the directive if known.  */
339   const struct directive *directive;
340
341   /* Search paths for include files.  */
342   struct cpp_path *quote_include;       /* "" */
343   struct cpp_path *bracket_include;     /* <> */
344
345   /* Multiple include optimization.  */
346   const cpp_hashnode *mi_cmacro;
347   const cpp_hashnode *mi_ind_cmacro;
348   bool mi_valid;
349
350   /* Lexing.  */
351   cpp_token *cur_token;
352   tokenrun base_run, *cur_run;
353   unsigned int lookaheads;
354
355   /* Nonzero prevents the lexer from re-using the token runs.  */
356   unsigned int keep_tokens;
357
358   /* Error counter for exit code.  */
359   unsigned int errors;
360
361   /* Buffer to hold macro definition string.  */
362   unsigned char *macro_buffer;
363   unsigned int macro_buffer_len;
364
365   /* Tree of other included files.  See cppfiles.c.  */
366   struct splay_tree_s *all_include_files;
367
368   /* Current maximum length of directory names in the search path
369      for include files.  (Altered as we get more of them.)  */
370   unsigned int max_include_len;
371
372   /* Date and time text.  Calculated together if either is requested.  */
373   const uchar *date;
374   const uchar *time;
375
376   /* EOF token, and a token forcing paste avoidance.  */
377   cpp_token avoid_paste;
378   cpp_token eof;
379
380   /* Opaque handle to the dependencies of mkdeps.c.  */
381   struct deps *deps;
382
383   /* Obstack holding all macro hash nodes.  This never shrinks.
384      See cpphash.c */
385   struct obstack hash_ob;
386
387   /* Obstack holding buffer and conditional structures.  This is a
388      real stack.  See cpplib.c.  */
389   struct obstack buffer_ob;
390
391   /* Pragma table - dynamic, because a library user can add to the
392      list of recognized pragmas.  */
393   struct pragma_entry *pragmas;
394
395   /* Call backs.  */
396   struct cpp_callbacks cb;
397
398   /* Identifier hash table.  */
399   struct ht *hash_table;
400
401   /* Expression parser stack.  */
402   struct op *op_stack, *op_limit;
403
404   /* User visible options.  */
405   struct cpp_options opts;
406
407   /* Special nodes - identifiers with predefined significance to the
408      preprocessor.  */
409   struct spec_nodes spec_nodes;
410
411   /* Nonzero means don't look for #include "foo" the source-file
412      directory.  */
413   unsigned char quote_ignores_source_dir;
414
415   /* Whether cpplib owns the hashtable.  */
416   unsigned char our_hashtable;
417
418   /* Traditional preprocessing output buffer (a logical line).  */
419   struct
420   {
421     uchar *base;
422     uchar *limit;
423     uchar *cur;
424     unsigned int first_line;
425   } out;
426
427   /* Used to save the original line number during traditional
428      preprocessing.  */
429   unsigned int saved_line;
430
431   /* A saved list of the defined macros, for dependency checking
432      of precompiled headers.  */
433   struct cpp_savedstate *savedstate;
434 };
435
436 /* Character classes.  Based on the more primitive macros in safe-ctype.h.
437    If the definition of `numchar' looks odd to you, please look up the
438    definition of a pp-number in the C standard [section 6.4.8 of C99].
439
440    In the unlikely event that characters other than \r and \n enter
441    the set is_vspace, the macro handle_newline() in cpplex.c must be
442    updated.  */
443 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
444
445 #define is_idchar(x)    (ISIDNUM(x) || _dollar_ok(x))
446 #define is_numchar(x)   ISIDNUM(x)
447 #define is_idstart(x)   (ISIDST(x) || _dollar_ok(x))
448 #define is_numstart(x)  ISDIGIT(x)
449 #define is_hspace(x)    ISBLANK(x)
450 #define is_vspace(x)    IS_VSPACE(x)
451 #define is_nvspace(x)   IS_NVSPACE(x)
452 #define is_space(x)     IS_SPACE_OR_NUL(x)
453
454 /* This table is constant if it can be initialized at compile time,
455    which is the case if cpp was compiled with GCC >=2.7, or another
456    compiler that supports C99.  */
457 #if HAVE_DESIGNATED_INITIALIZERS
458 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
459 #else
460 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
461 #endif
462
463 /* Macros.  */
464
465 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
466 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
467 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
468
469 /* In cpperror.c  */
470 extern int _cpp_begin_message (cpp_reader *, int, unsigned int, unsigned int);
471
472 /* In cppmacro.c */
473 extern void _cpp_free_definition (cpp_hashnode *);
474 extern bool _cpp_create_definition (cpp_reader *, cpp_hashnode *);
475 extern void _cpp_pop_context (cpp_reader *);
476 extern void _cpp_push_text_context (cpp_reader *, cpp_hashnode *,
477                                     const uchar *, size_t);
478 extern bool _cpp_save_parameter (cpp_reader *, cpp_macro *, cpp_hashnode *);
479 extern bool _cpp_arguments_ok (cpp_reader *, cpp_macro *, const cpp_hashnode *,
480                                unsigned int);
481 extern const uchar *_cpp_builtin_macro_text (cpp_reader *, cpp_hashnode *);
482 int _cpp_warn_if_unused_macro (cpp_reader *, cpp_hashnode *, void *);
483 /* In cpphash.c */
484 extern void _cpp_init_hashtable (cpp_reader *, hash_table *);
485 extern void _cpp_destroy_hashtable (cpp_reader *);
486
487 /* In cppfiles.c */
488 extern void _cpp_fake_include (cpp_reader *, const char *);
489 extern void _cpp_never_reread (struct include_file *);
490 extern bool _cpp_read_file (cpp_reader *, const char *);
491 extern bool _cpp_execute_include (cpp_reader *, const char *, int,
492                                   enum include_type);
493 extern int _cpp_compare_file_date (cpp_reader *, const char *, int);
494 extern void _cpp_report_missing_guards (cpp_reader *);
495 extern void _cpp_init_includes (cpp_reader *);
496 extern void _cpp_cleanup_includes (cpp_reader *);
497 extern void _cpp_pop_file_buffer (cpp_reader *, struct include_file *);
498
499 /* In cppexp.c */
500 extern bool _cpp_parse_expr (cpp_reader *);
501 extern struct op *_cpp_expand_op_stack (cpp_reader *);
502
503 /* In cpplex.c */
504 extern void _cpp_process_line_notes (cpp_reader *, int);
505 extern void _cpp_clean_line (cpp_reader *);
506 extern bool _cpp_get_fresh_line (cpp_reader *);
507 extern bool _cpp_skip_block_comment (cpp_reader *);
508 extern cpp_token *_cpp_temp_token (cpp_reader *);
509 extern const cpp_token *_cpp_lex_token (cpp_reader *);
510 extern cpp_token *_cpp_lex_direct (cpp_reader *);
511 extern int _cpp_equiv_tokens (const cpp_token *, const cpp_token *);
512 extern void _cpp_init_tokenrun (tokenrun *, unsigned int);
513
514 /* In cppinit.c.  */
515 extern void _cpp_maybe_push_include_file (cpp_reader *);
516
517 /* In cpplib.c */
518 extern int _cpp_test_assertion (cpp_reader *, unsigned int *);
519 extern int _cpp_handle_directive (cpp_reader *, int);
520 extern void _cpp_define_builtin (cpp_reader *, const char *);
521 extern char ** _cpp_save_pragma_names (cpp_reader *);
522 extern void _cpp_restore_pragma_names (cpp_reader *, char **);
523 extern void _cpp_do__Pragma (cpp_reader *);
524 extern void _cpp_init_directives (cpp_reader *);
525 extern void _cpp_init_internal_pragmas (cpp_reader *);
526 extern void _cpp_do_file_change (cpp_reader *, enum lc_reason, const char *,
527                                  unsigned int, unsigned int);
528 extern void _cpp_pop_buffer (cpp_reader *);
529
530 /* In cpptrad.c.  */
531 extern bool scan_out_logical_line (cpp_reader *, cpp_macro *);
532 extern bool _cpp_read_logical_line_trad (cpp_reader *);
533 extern void _cpp_overlay_buffer (cpp_reader *pfile, const uchar *, size_t);
534 extern void _cpp_remove_overlay (cpp_reader *);
535 extern bool _cpp_create_trad_definition (cpp_reader *, cpp_macro *);
536 extern bool _cpp_expansions_different_trad (const cpp_macro *,
537                                             const cpp_macro *);
538 extern uchar *_cpp_copy_replacement_text (const cpp_macro *, uchar *);
539 extern size_t _cpp_replacement_text_len (const cpp_macro *);
540
541 /* In cppcharset.c.  */
542 cppchar_t _cpp_valid_ucn (cpp_reader *, const uchar **, int identifer_p);
543
544 /* Utility routines and macros.  */
545 #define DSC(str) (const uchar *)str, sizeof str - 1
546 #define xnew(T)         (T *) xmalloc (sizeof(T))
547 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
548 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
549 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
550 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
551
552 /* These are inline functions instead of macros so we can get type
553    checking.  */
554 static inline int ustrcmp (const uchar *, const uchar *);
555 static inline int ustrncmp (const uchar *, const uchar *, size_t);
556 static inline size_t ustrlen (const uchar *);
557 static inline uchar *uxstrdup (const uchar *);
558 static inline uchar *ustrchr (const uchar *, int);
559 static inline int ufputs (const uchar *, FILE *);
560
561 static inline int
562 ustrcmp (const uchar *s1, const uchar *s2)
563 {
564   return strcmp ((const char *)s1, (const char *)s2);
565 }
566
567 static inline int
568 ustrncmp (const uchar *s1, const uchar *s2, size_t n)
569 {
570   return strncmp ((const char *)s1, (const char *)s2, n);
571 }
572
573 static inline size_t
574 ustrlen (const uchar *s1)
575 {
576   return strlen ((const char *)s1);
577 }
578
579 static inline uchar *
580 uxstrdup (const uchar *s1)
581 {
582   return (uchar *) xstrdup ((const char *)s1);
583 }
584
585 static inline uchar *
586 ustrchr (const uchar *s1, int c)
587 {
588   return (uchar *) strchr ((const char *)s1, c);
589 }
590
591 static inline int
592 ufputs (const uchar *s, FILE *f)
593 {
594   return fputs ((const char *)s, f);
595 }
596
597 #endif /* ! GCC_CPPHASH_H */