OSDN Git Service

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