OSDN Git Service

* ChangeLog: Follow spelling conventions.
[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   /* Nonzero 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   /* Nonzero 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 /* Encapsulates state used to convert a stream of tokens into a text
257    file.  */
258 struct printer
259 {
260   FILE *outf;                   /* Stream to write to.  */
261   const struct line_map *map;   /* Logical to physical line mappings.  */
262   const cpp_token *prev;        /* Previous token.  */
263   const cpp_token *source;      /* Source token for spacing.  */
264   unsigned int line;            /* Line currently being written.  */
265   unsigned char printed;        /* Nonzero if something output at line.  */
266 };
267
268 /* Represents the contents of a file cpplib has read in.  */
269 struct cpp_buffer
270 {
271   const unsigned char *cur;      /* current position */
272   const unsigned char *backup_to; /* if peeked character is not wanted */
273   const unsigned char *rlimit; /* end of valid data */
274   const unsigned char *line_base; /* start of current line */
275
276   struct cpp_buffer *prev;
277
278   const unsigned char *buf;      /* Entire character buffer.  */
279
280   /* Pointer into the include table; non-NULL if this is a file
281      buffer.  Used for include_next and to record control macros.  */
282   struct include_file *inc;
283
284   /* Value of if_stack at start of this file.
285      Used to prohibit unmatched #endif (etc) in an include file.  */
286   struct if_stack *if_stack;
287
288   /* Token column position adjustment owing to tabs in whitespace.  */
289   unsigned int col_adjust;
290
291   /* Contains PREV_WHITE and/or AVOID_LPASTE.  */
292   unsigned char saved_flags;
293
294   /* Because of the way the lexer works, -Wtrigraphs can sometimes
295      warn twice for the same trigraph.  This helps prevent that.  */
296   const unsigned char *last_Wtrigraphs;
297
298   /* True if we have already warned about C++ comments in this file.
299      The warning happens only for C89 extended mode with -pedantic on,
300      or for -Wtraditional, and only once per file (otherwise it would
301      be far too noisy).  */
302   unsigned char warned_cplusplus_comments;
303
304   /* True if we don't process trigraphs and escaped newlines.  True
305      for preprocessed input, command line directives, and _Pragma
306      buffers.  */
307   unsigned char from_stage3;
308
309   /* Nonzero means that the directory to start searching for ""
310      include files has been calculated and stored in "dir" below.  */
311   unsigned char search_cached;
312
313   /* At EOF, a buffer is automatically popped.  If RETURN_AT_EOF is
314      true, a CPP_EOF token is then returned.  Otherwise, the next
315      token from the enclosing buffer is returned.  */
316   bool return_at_eof;
317
318   /* The directory of the this buffer's file.  Its NAME member is not
319      allocated, so we don't need to worry about freeing it.  */
320   struct search_path dir;
321
322   /* Used for buffer overlays by cpptrad.c.  */
323   const uchar *saved_cur, *saved_rlimit;
324 };
325
326 /* A cpp_reader encapsulates the "state" of a pre-processor run.
327    Applying cpp_get_token repeatedly yields a stream of pre-processor
328    tokens.  Usually, there is only one cpp_reader object active.  */
329 struct cpp_reader
330 {
331   /* Top of buffer stack.  */
332   cpp_buffer *buffer;
333
334   /* Overlaid buffer (can be different after processing #include).  */
335   cpp_buffer *overlaid_buffer;
336
337   /* Lexer state.  */
338   struct lexer_state state;
339
340   /* Source line tracking.  */
341   struct line_maps line_maps;
342   const struct line_map *map;
343   unsigned int line;
344
345   /* The line of the '#' of the current directive.  */
346   unsigned int directive_line;
347
348   /* Memory buffers.  */
349   _cpp_buff *a_buff;            /* Aligned permanent storage.  */
350   _cpp_buff *u_buff;            /* Unaligned permanent storage.  */
351   _cpp_buff *free_buffs;        /* Free buffer chain.  */
352
353   /* Context stack.  */
354   struct cpp_context base_context;
355   struct cpp_context *context;
356
357   /* If in_directive, the directive if known.  */
358   const struct directive *directive;
359
360   /* The next -include-d file; NULL if they all are done.  If it
361      points to NULL, the last one is in progress, and
362      _cpp_maybe_push_include_file has yet to restore the line map.  */
363   struct pending_option **next_include_file;
364
365   /* Multiple inlcude optimisation.  */
366   const cpp_hashnode *mi_cmacro;
367   const cpp_hashnode *mi_ind_cmacro;
368   bool mi_valid;
369
370   /* Lexing.  */
371   cpp_token *cur_token;
372   tokenrun base_run, *cur_run;
373   unsigned int lookaheads;
374
375   /* Nonzero prevents the lexer from re-using the token runs.  */
376   unsigned int keep_tokens;
377
378   /* Error counter for exit code.  */
379   unsigned int errors;
380
381   /* Buffer to hold macro definition string.  */
382   unsigned char *macro_buffer;
383   unsigned int macro_buffer_len;
384
385   /* Tree of other included files.  See cppfiles.c.  */
386   struct splay_tree_s *all_include_files;
387
388   /* Current maximum length of directory names in the search path
389      for include files.  (Altered as we get more of them.)  */
390   unsigned int max_include_len;
391
392   /* Macros on or after this line are warned about if unused.  */
393   unsigned int first_unused_line;
394
395   /* Date and time text.  Calculated together if either is requested.  */
396   const uchar *date;
397   const uchar *time;
398
399   /* EOF token, and a token forcing paste avoidance.  */
400   cpp_token avoid_paste;
401   cpp_token eof;
402
403   /* Opaque handle to the dependencies of mkdeps.c.  */
404   struct deps *deps;
405
406   /* Obstack holding all macro hash nodes.  This never shrinks.
407      See cpphash.c */
408   struct obstack hash_ob;
409
410   /* Obstack holding buffer and conditional structures.  This is a
411      real stack.  See cpplib.c.  */
412   struct obstack buffer_ob;
413
414   /* Pragma table - dynamic, because a library user can add to the
415      list of recognized pragmas.  */
416   struct pragma_entry *pragmas;
417
418   /* Call backs.  */
419   struct cpp_callbacks cb;
420
421   /* Identifier hash table.  */
422   struct ht *hash_table;
423
424   /* Expression parser stack.  */
425   struct op *op_stack, *op_limit;
426
427   /* User visible options.  */
428   struct cpp_options opts;
429
430   /* Special nodes - identifiers with predefined significance to the
431      preprocessor.  */
432   struct spec_nodes spec_nodes;
433
434   /* Used when doing preprocessed output.  */
435   struct printer print;
436
437   /* Whether cpplib owns the hashtable.  */
438   unsigned char our_hashtable;
439
440   /* Traditional preprocessing output buffer (a logical line).  */
441   struct
442   {
443     uchar *base;
444     uchar *limit;
445     uchar *cur;
446     unsigned int first_line;
447   } out;
448
449   /* Used to save the original line number during traditional
450      preprocessing.  */
451   unsigned int saved_line;
452 };
453
454 /* Character classes.  Based on the more primitive macros in safe-ctype.h.
455    If the definition of `numchar' looks odd to you, please look up the
456    definition of a pp-number in the C standard [section 6.4.8 of C99].
457
458    In the unlikely event that characters other than \r and \n enter
459    the set is_vspace, the macro handle_newline() in cpplex.c must be
460    updated.  */
461 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
462
463 #define is_idchar(x)    (ISIDNUM(x) || _dollar_ok(x))
464 #define is_numchar(x)   ISIDNUM(x)
465 #define is_idstart(x)   (ISIDST(x) || _dollar_ok(x))
466 #define is_numstart(x)  ISDIGIT(x)
467 #define is_hspace(x)    ISBLANK(x)
468 #define is_vspace(x)    IS_VSPACE(x)
469 #define is_nvspace(x)   IS_NVSPACE(x)
470 #define is_space(x)     IS_SPACE_OR_NUL(x)
471
472 /* This table is constant if it can be initialized at compile time,
473    which is the case if cpp was compiled with GCC >=2.7, or another
474    compiler that supports C99.  */
475 #if HAVE_DESIGNATED_INITIALIZERS
476 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
477 #else
478 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
479 #endif
480
481 /* Macros.  */
482
483 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
484 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
485 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
486
487 /* In cpperror.c  */
488 extern int _cpp_begin_message PARAMS ((cpp_reader *, int,
489                                        unsigned int, unsigned int));
490
491 /* In cppmacro.c */
492 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
493 extern bool _cpp_create_definition      PARAMS ((cpp_reader *, cpp_hashnode *));
494 extern void _cpp_pop_context            PARAMS ((cpp_reader *));
495 extern void _cpp_push_text_context      PARAMS ((cpp_reader *, cpp_hashnode *,
496                                                  const uchar *, size_t));
497 extern bool _cpp_save_parameter         PARAMS ((cpp_reader *, cpp_macro *,
498                                                  cpp_hashnode *));
499 extern bool _cpp_arguments_ok           PARAMS ((cpp_reader *, cpp_macro *,
500                                                  const cpp_hashnode *,
501                                                  unsigned int));
502 extern const uchar *_cpp_builtin_macro_text PARAMS ((cpp_reader *,
503                                                      cpp_hashnode *));
504 int _cpp_warn_if_unused_macro           PARAMS ((cpp_reader *, cpp_hashnode *,
505                                                  void *));
506 /* In cpphash.c */
507 extern void _cpp_init_hashtable         PARAMS ((cpp_reader *, hash_table *));
508 extern void _cpp_destroy_hashtable      PARAMS ((cpp_reader *));
509
510 /* In cppfiles.c */
511 extern void _cpp_fake_include           PARAMS ((cpp_reader *, const char *));
512 extern void _cpp_never_reread           PARAMS ((struct include_file *));
513 extern char *_cpp_simplify_pathname     PARAMS ((char *));
514 extern bool _cpp_read_file              PARAMS ((cpp_reader *, const char *));
515 extern bool _cpp_execute_include        PARAMS ((cpp_reader *,
516                                                  const cpp_token *,
517                                                  enum include_type));
518 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *,
519                                                  const cpp_token *));
520 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
521 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
522 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
523 extern void _cpp_pop_file_buffer        PARAMS ((cpp_reader *,
524                                                  struct include_file *));
525
526 /* In cppexp.c */
527 extern bool _cpp_parse_expr             PARAMS ((cpp_reader *));
528 extern struct op *_cpp_expand_op_stack  PARAMS ((cpp_reader *));
529
530 /* In cpplex.c */
531 extern cpp_token *_cpp_temp_token       PARAMS ((cpp_reader *));
532 extern const cpp_token *_cpp_lex_token  PARAMS ((cpp_reader *));
533 extern cpp_token *_cpp_lex_direct       PARAMS ((cpp_reader *));
534 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
535                                                  const cpp_token *));
536 extern void _cpp_init_tokenrun          PARAMS ((tokenrun *, unsigned int));
537
538 /* In cppinit.c.  */
539 extern void _cpp_maybe_push_include_file PARAMS ((cpp_reader *));
540
541 /* In cpplib.c */
542 extern int _cpp_test_assertion PARAMS ((cpp_reader *, unsigned int *));
543 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
544 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
545 extern void _cpp_do__Pragma     PARAMS ((cpp_reader *));
546 extern void _cpp_init_directives PARAMS ((cpp_reader *));
547 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
548 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
549                                          const char *,
550                                          unsigned int, unsigned int));
551 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
552
553 /* In cpptrad.c.  */
554 extern bool _cpp_read_logical_line_trad PARAMS ((cpp_reader *));
555 extern void _cpp_overlay_buffer PARAMS ((cpp_reader *pfile, const uchar *,
556                                          size_t));
557 extern void _cpp_remove_overlay PARAMS ((cpp_reader *));
558 extern bool _cpp_create_trad_definition PARAMS ((cpp_reader *, cpp_macro *));
559 extern bool _cpp_expansions_different_trad PARAMS ((const cpp_macro *,
560                                                     const cpp_macro *));
561 extern uchar *_cpp_copy_replacement_text PARAMS ((const cpp_macro *, uchar *));
562 extern size_t _cpp_replacement_text_len PARAMS ((const cpp_macro *));
563
564 /* Utility routines and macros.  */
565 #define DSC(str) (const uchar *)str, sizeof str - 1
566 #define xnew(T)         (T *) xmalloc (sizeof(T))
567 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
568 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
569 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
570 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
571
572 /* These are inline functions instead of macros so we can get type
573    checking.  */
574 static inline int ustrcmp       PARAMS ((const uchar *, const uchar *));
575 static inline int ustrncmp      PARAMS ((const uchar *, const uchar *,
576                                          size_t));
577 static inline size_t ustrlen    PARAMS ((const uchar *));
578 static inline uchar *uxstrdup   PARAMS ((const uchar *));
579 static inline uchar *ustrchr    PARAMS ((const uchar *, int));
580 static inline int ufputs        PARAMS ((const uchar *, FILE *));
581
582 static inline int
583 ustrcmp (s1, s2)
584      const uchar *s1, *s2;
585 {
586   return strcmp ((const char *)s1, (const char *)s2);
587 }
588
589 static inline int
590 ustrncmp (s1, s2, n)
591      const uchar *s1, *s2;
592      size_t n;
593 {
594   return strncmp ((const char *)s1, (const char *)s2, n);
595 }
596
597 static inline size_t
598 ustrlen (s1)
599      const uchar *s1;
600 {
601   return strlen ((const char *)s1);
602 }
603
604 static inline uchar *
605 uxstrdup (s1)
606      const uchar *s1;
607 {
608   return (uchar *) xstrdup ((const char *)s1);
609 }
610
611 static inline uchar *
612 ustrchr (s1, c)
613      const uchar *s1;
614      int c;
615 {
616   return (uchar *) strchr ((const char *)s1, c);
617 }
618
619 static inline int
620 ufputs (s, f)
621      const uchar *s;
622      FILE *f;
623 {
624   return fputs ((const char *)s, f);
625 }
626
627 #endif /* ! GCC_CPPHASH_H */