OSDN Git Service

* libcpp/include/cpplib.h (INO_T_CPP): New macro.
[pf3gnuchains/gcc-fork.git] / libcpp / include / cpplib.h
1 /* Definitions for CPP library.
2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
3    2004, 2005, 2007, 2008, 2009
4    Free Software Foundation, Inc.
5    Written by Per Bothner, 1994-95.
6
7 This program is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option) any
10 later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; see the file COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.
20
21  In other words, you are welcome to use, share and improve this program.
22  You are forbidden to forbid anyone else to use, share and improve
23  what you give them.   Help stamp out software-hoarding!  */
24 #ifndef LIBCPP_CPPLIB_H
25 #define LIBCPP_CPPLIB_H
26
27 #include <sys/types.h>
28 #include "symtab.h"
29 #include "line-map.h"
30
31 typedef struct cpp_reader cpp_reader;
32 typedef struct cpp_buffer cpp_buffer;
33 typedef struct cpp_options cpp_options;
34 typedef struct cpp_token cpp_token;
35 typedef struct cpp_string cpp_string;
36 typedef struct cpp_hashnode cpp_hashnode;
37 typedef struct cpp_macro cpp_macro;
38 typedef struct cpp_callbacks cpp_callbacks;
39 typedef struct cpp_dir cpp_dir;
40
41 struct answer;
42 struct _cpp_file;
43
44 /* The first three groups, apart from '=', can appear in preprocessor
45    expressions (+= and -= are used to indicate unary + and - resp.).
46    This allows a lookup table to be implemented in _cpp_parse_expr.
47
48    The first group, to CPP_LAST_EQ, can be immediately followed by an
49    '='.  The lexer needs operators ending in '=', like ">>=", to be in
50    the same order as their counterparts without the '=', like ">>".
51
52    See the cpp_operator table optab in expr.c if you change the order or
53    add or remove anything in the first group.  */
54
55 #define TTYPE_TABLE                                                     \
56   OP(EQ,                "=")                                            \
57   OP(NOT,               "!")                                            \
58   OP(GREATER,           ">")    /* compare */                           \
59   OP(LESS,              "<")                                            \
60   OP(PLUS,              "+")    /* math */                              \
61   OP(MINUS,             "-")                                            \
62   OP(MULT,              "*")                                            \
63   OP(DIV,               "/")                                            \
64   OP(MOD,               "%")                                            \
65   OP(AND,               "&")    /* bit ops */                           \
66   OP(OR,                "|")                                            \
67   OP(XOR,               "^")                                            \
68   OP(RSHIFT,            ">>")                                           \
69   OP(LSHIFT,            "<<")                                           \
70                                                                         \
71   OP(COMPL,             "~")                                            \
72   OP(AND_AND,           "&&")   /* logical */                           \
73   OP(OR_OR,             "||")                                           \
74   OP(QUERY,             "?")                                            \
75   OP(COLON,             ":")                                            \
76   OP(COMMA,             ",")    /* grouping */                          \
77   OP(OPEN_PAREN,        "(")                                            \
78   OP(CLOSE_PAREN,       ")")                                            \
79   TK(EOF,               NONE)                                           \
80   OP(EQ_EQ,             "==")   /* compare */                           \
81   OP(NOT_EQ,            "!=")                                           \
82   OP(GREATER_EQ,        ">=")                                           \
83   OP(LESS_EQ,           "<=")                                           \
84                                                                         \
85   /* These two are unary + / - in preprocessor expressions.  */         \
86   OP(PLUS_EQ,           "+=")   /* math */                              \
87   OP(MINUS_EQ,          "-=")                                           \
88                                                                         \
89   OP(MULT_EQ,           "*=")                                           \
90   OP(DIV_EQ,            "/=")                                           \
91   OP(MOD_EQ,            "%=")                                           \
92   OP(AND_EQ,            "&=")   /* bit ops */                           \
93   OP(OR_EQ,             "|=")                                           \
94   OP(XOR_EQ,            "^=")                                           \
95   OP(RSHIFT_EQ,         ">>=")                                          \
96   OP(LSHIFT_EQ,         "<<=")                                          \
97   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */           \
98   OP(HASH,              "#")    /* digraphs */                          \
99   OP(PASTE,             "##")                                           \
100   OP(OPEN_SQUARE,       "[")                                            \
101   OP(CLOSE_SQUARE,      "]")                                            \
102   OP(OPEN_BRACE,        "{")                                            \
103   OP(CLOSE_BRACE,       "}")                                            \
104   /* The remainder of the punctuation.  Order is not significant.  */   \
105   OP(SEMICOLON,         ";")    /* structure */                         \
106   OP(ELLIPSIS,          "...")                                          \
107   OP(PLUS_PLUS,         "++")   /* increment */                         \
108   OP(MINUS_MINUS,       "--")                                           \
109   OP(DEREF,             "->")   /* accessors */                         \
110   OP(DOT,               ".")                                            \
111   OP(SCOPE,             "::")                                           \
112   OP(DEREF_STAR,        "->*")                                          \
113   OP(DOT_STAR,          ".*")                                           \
114   OP(ATSIGN,            "@")  /* used in Objective-C */                 \
115                                                                         \
116   TK(NAME,              IDENT)   /* word */                             \
117   TK(AT_NAME,           IDENT)   /* @word - Objective-C */              \
118   TK(NUMBER,            LITERAL) /* 34_be+ta  */                        \
119                                                                         \
120   TK(CHAR,              LITERAL) /* 'char' */                           \
121   TK(WCHAR,             LITERAL) /* L'char' */                          \
122   TK(CHAR16,            LITERAL) /* u'char' */                          \
123   TK(CHAR32,            LITERAL) /* U'char' */                          \
124   TK(OTHER,             LITERAL) /* stray punctuation */                \
125                                                                         \
126   TK(STRING,            LITERAL) /* "string" */                         \
127   TK(WSTRING,           LITERAL) /* L"string" */                        \
128   TK(STRING16,          LITERAL) /* u"string" */                        \
129   TK(STRING32,          LITERAL) /* U"string" */                        \
130   TK(OBJC_STRING,       LITERAL) /* @"string" - Objective-C */          \
131   TK(HEADER_NAME,       LITERAL) /* <stdio.h> in #include */            \
132                                                                         \
133   TK(COMMENT,           LITERAL) /* Only if output comments.  */        \
134                                  /* SPELL_LITERAL happens to DTRT.  */  \
135   TK(MACRO_ARG,         NONE)    /* Macro argument.  */                 \
136   TK(PRAGMA,            NONE)    /* Only for deferred pragmas.  */      \
137   TK(PRAGMA_EOL,        NONE)    /* End-of-line for deferred pragmas.  */ \
138   TK(PADDING,           NONE)    /* Whitespace for -E.  */
139
140 #define OP(e, s) CPP_ ## e,
141 #define TK(e, s) CPP_ ## e,
142 enum cpp_ttype
143 {
144   TTYPE_TABLE
145   N_TTYPES,
146
147   /* Positions in the table.  */
148   CPP_LAST_EQ        = CPP_LSHIFT,
149   CPP_FIRST_DIGRAPH  = CPP_HASH,
150   CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
151   CPP_LAST_CPP_OP    = CPP_LESS_EQ
152 };
153 #undef OP
154 #undef TK
155
156 /* C language kind, used when calling cpp_create_reader.  */
157 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
158              CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX0X, CLK_CXX0X, CLK_ASM};
159
160 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
161 struct GTY(()) cpp_string {
162   unsigned int len;
163   const unsigned char *text;
164 };
165
166 /* Flags for the cpp_token structure.  */
167 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
168 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
169 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
170 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
171 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
172 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
173 #define BOL             (1 << 6) /* Token at beginning of line.  */
174 #define PURE_ZERO       (1 << 7) /* Single 0 digit, used by the C++ frontend,
175                                     set in c-lex.c.  */
176 #define SP_DIGRAPH      (1 << 8) /* # or ## token was a digraph.  */
177 #define SP_PREV_WHITE   (1 << 9) /* If whitespace before a ##
178                                     operator, or before this token
179                                     after a # operator.  */
180
181 /* Specify which field, if any, of the cpp_token union is used.  */
182
183 enum cpp_token_fld_kind {
184   CPP_TOKEN_FLD_NODE,
185   CPP_TOKEN_FLD_SOURCE,
186   CPP_TOKEN_FLD_STR,
187   CPP_TOKEN_FLD_ARG_NO,
188   CPP_TOKEN_FLD_TOKEN_NO,
189   CPP_TOKEN_FLD_PRAGMA,
190   CPP_TOKEN_FLD_NONE
191 };
192
193 /* A macro argument in the cpp_token union.  */
194 struct GTY(()) cpp_macro_arg {
195   /* Argument number.  */
196   unsigned int arg_no;
197 };
198
199 /* An identifier in the cpp_token union.  */
200 struct GTY(()) cpp_identifier {
201   /* The canonical (UTF-8) spelling of the identifier.  */
202   cpp_hashnode *
203     GTY ((nested_ptr (union tree_node,
204                 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
205                         "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
206        node;
207 };
208
209 /* A preprocessing token.  This has been carefully packed and should
210    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
211 struct GTY(()) cpp_token {
212   source_location src_loc;      /* Location of first char of token.  */
213   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
214   unsigned short flags;         /* flags - see above */
215
216   union cpp_token_u
217   {
218     /* An identifier.  */
219     struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node;
220          
221     /* Inherit padding from this token.  */
222     cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
223
224     /* A string, or number.  */
225     struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
226
227     /* Argument no. for a CPP_MACRO_ARG.  */
228     struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg;
229
230     /* Original token no. for a CPP_PASTE (from a sequence of
231        consecutive paste tokens in a macro expansion).  */
232     unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no;
233
234     /* Caller-supplied identifier for a CPP_PRAGMA.  */
235     unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
236   } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
237 };
238
239 /* Say which field is in use.  */
240 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
241
242 /* A type wide enough to hold any multibyte source character.
243    cpplib's character constant interpreter requires an unsigned type.
244    Also, a typedef for the signed equivalent.
245    The width of this type is capped at 32 bits; there do exist targets
246    where wchar_t is 64 bits, but only in a non-default mode, and there
247    would be no meaningful interpretation for a wchar_t value greater
248    than 2^32 anyway -- the widest wide-character encoding around is
249    ISO 10646, which stops at 2^31.  */
250 #if CHAR_BIT * SIZEOF_INT >= 32
251 # define CPPCHAR_SIGNED_T int
252 #elif CHAR_BIT * SIZEOF_LONG >= 32
253 # define CPPCHAR_SIGNED_T long
254 #else
255 # error "Cannot find a least-32-bit signed integer type"
256 #endif
257 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
258 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
259
260 /* Style of header dependencies to generate.  */
261 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
262
263 /* The possible normalization levels, from most restrictive to least.  */
264 enum cpp_normalize_level {
265   /* In NFKC.  */
266   normalized_KC = 0,
267   /* In NFC.  */
268   normalized_C,
269   /* In NFC, except for subsequences where being in NFC would make
270      the identifier invalid.  */
271   normalized_identifier_C,
272   /* Not normalized at all.  */
273   normalized_none
274 };
275
276 /* This structure is nested inside struct cpp_reader, and
277    carries all the options visible to the command line.  */
278 struct cpp_options
279 {
280   /* Characters between tab stops.  */
281   unsigned int tabstop;
282
283   /* The language we're preprocessing.  */
284   enum c_lang lang;
285
286   /* Nonzero means use extra default include directories for C++.  */
287   unsigned char cplusplus;
288
289   /* Nonzero means handle cplusplus style comments.  */
290   unsigned char cplusplus_comments;
291
292   /* Nonzero means define __OBJC__, treat @ as a special token, use
293      the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
294      "#import".  */
295   unsigned char objc;
296
297   /* Nonzero means don't copy comments into the output file.  */
298   unsigned char discard_comments;
299
300   /* Nonzero means don't copy comments into the output file during
301      macro expansion.  */
302   unsigned char discard_comments_in_macro_exp;
303
304   /* Nonzero means process the ISO trigraph sequences.  */
305   unsigned char trigraphs;
306
307   /* Nonzero means process the ISO digraph sequences.  */
308   unsigned char digraphs;
309
310   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
311   unsigned char extended_numbers;
312
313   /* Nonzero means process u/U prefix literals (UTF-16/32).  */
314   unsigned char uliterals;
315
316   /* Nonzero means print names of header files (-H).  */
317   unsigned char print_include_names;
318
319   /* Nonzero means complain about deprecated features.  */
320   unsigned char warn_deprecated;
321
322   /* Nonzero means warn if slash-star appears in a comment.  */
323   unsigned char warn_comments;
324
325   /* Nonzero means warn if a user-supplied include directory does not
326      exist.  */
327   unsigned char warn_missing_include_dirs;
328
329   /* Nonzero means warn if there are any trigraphs.  */
330   unsigned char warn_trigraphs;
331
332   /* Nonzero means warn about multicharacter charconsts.  */
333   unsigned char warn_multichar;
334
335   /* Nonzero means warn about various incompatibilities with
336      traditional C.  */
337   unsigned char warn_traditional;
338
339   /* Nonzero means warn about long long numeric constants.  */
340   unsigned char warn_long_long;
341
342   /* Nonzero means warn about text after an #endif (or #else).  */
343   unsigned char warn_endif_labels;
344
345   /* Nonzero means warn about implicit sign changes owing to integer
346      promotions.  */
347   unsigned char warn_num_sign_change;
348
349   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
350      Presumably the usage is protected by the appropriate #ifdef.  */
351   unsigned char warn_variadic_macros;
352
353   /* Nonzero means warn about builtin macros that are redefined or
354      explicitly undefined.  */
355   unsigned char warn_builtin_macro_redefined;
356
357   /* Nonzero means we should look for header.gcc files that remap file
358      names.  */
359   unsigned char remap;
360
361   /* Zero means dollar signs are punctuation.  */
362   unsigned char dollars_in_ident;
363
364   /* Nonzero means UCNs are accepted in identifiers.  */
365   unsigned char extended_identifiers;
366
367   /* True if we should warn about dollars in identifiers or numbers
368      for this translation unit.  */
369   unsigned char warn_dollars;
370
371   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
372   unsigned char warn_undef;
373
374   /* Nonzero means warn of unused macros from the main file.  */
375   unsigned char warn_unused_macros;
376
377   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
378   unsigned char c99;
379
380   /* Nonzero if we are conforming to a specific C or C++ standard.  */
381   unsigned char std;
382
383   /* Nonzero means give all the error messages the ANSI standard requires.  */
384   unsigned char pedantic;
385
386   /* Nonzero means we're looking at already preprocessed code, so don't
387      bother trying to do macro expansion and whatnot.  */
388   unsigned char preprocessed;
389
390   /* Print column number in error messages.  */
391   unsigned char show_column;
392
393   /* Nonzero means handle C++ alternate operator names.  */
394   unsigned char operator_names;
395
396   /* Nonzero means warn about use of C++ alternate operator names.  */
397   unsigned char warn_cxx_operator_names;
398
399   /* True for traditional preprocessing.  */
400   unsigned char traditional;
401
402   /* Holds the name of the target (execution) character set.  */
403   const char *narrow_charset;
404
405   /* Holds the name of the target wide character set.  */
406   const char *wide_charset;
407
408   /* Holds the name of the input character set.  */
409   const char *input_charset;
410
411   /* The minimum permitted level of normalization before a warning
412      is generated.  */
413   enum cpp_normalize_level warn_normalize;
414
415   /* True to warn about precompiled header files we couldn't use.  */
416   bool warn_invalid_pch;
417
418   /* True if dependencies should be restored from a precompiled header.  */
419   bool restore_pch_deps;
420
421   /* Dependency generation.  */
422   struct
423   {
424     /* Style of header dependencies to generate.  */
425     enum cpp_deps_style style;
426
427     /* Assume missing files are generated files.  */
428     bool missing_files;
429
430     /* Generate phony targets for each dependency apart from the first
431        one.  */
432     bool phony_targets;
433
434     /* If true, no dependency is generated on the main file.  */
435     bool ignore_main_file;
436   } deps;
437
438   /* Target-specific features set by the front end or client.  */
439
440   /* Precision for target CPP arithmetic, target characters, target
441      ints and target wide characters, respectively.  */
442   size_t precision, char_precision, int_precision, wchar_precision;
443
444   /* True means chars (wide chars) are unsigned.  */
445   bool unsigned_char, unsigned_wchar;
446
447   /* True if the most significant byte in a word has the lowest
448      address in memory.  */
449   bool bytes_big_endian;
450
451   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
452   unsigned char stdc_0_in_system_headers;
453
454   /* True disables tokenization outside of preprocessing directives. */
455   bool directives_only;
456 };
457
458 /* Callback for header lookup for HEADER, which is the name of a
459    source file.  It is used as a method of last resort to find headers
460    that are not otherwise found during the normal include processing.
461    The return value is the malloced name of a header to try and open,
462    if any, or NULL otherwise.  This callback is called only if the
463    header is otherwise unfound.  */
464 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
465
466 /* Call backs to cpplib client.  */
467 struct cpp_callbacks
468 {
469   /* Called when a new line of preprocessed output is started.  */
470   void (*line_change) (cpp_reader *, const cpp_token *, int);
471
472   /* Called when switching to/from a new file.
473      The line_map is for the new file.  It is NULL if there is no new file.
474      (In C this happens when done with <built-in>+<command line> and also
475      when done with a main file.)  This can be used for resource cleanup.  */
476   void (*file_change) (cpp_reader *, const struct line_map *);
477
478   void (*dir_change) (cpp_reader *, const char *);
479   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
480                    const char *, int, const cpp_token **);
481   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
482   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
483   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
484   void (*def_pragma) (cpp_reader *, unsigned int);
485   int (*valid_pch) (cpp_reader *, const char *, int);
486   void (*read_pch) (cpp_reader *, const char *, int, const char *);
487   missing_header_cb missing_header;
488
489   /* Context-sensitive macro support.  Returns macro (if any) that should
490      be expanded.  */
491   cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
492
493   /* Called to emit a diagnostic.  This callback receives the
494      translated message.  */
495   bool (*error) (cpp_reader *, int, source_location, unsigned int,
496                  const char *, va_list *)
497        ATTRIBUTE_FPTR_PRINTF(5,0);
498
499   /* Callbacks for when a macro is expanded, or tested (whether
500      defined or not at the time) in #ifdef, #ifndef or "defined".  */
501   void (*used_define) (cpp_reader *, unsigned int, cpp_hashnode *);
502   void (*used_undef) (cpp_reader *, unsigned int, cpp_hashnode *);
503   /* Called before #define and #undef or other macro definition
504      changes are processed.  */
505   void (*before_define) (cpp_reader *);
506 };
507
508 #ifdef VMS
509 #define INO_T_CPP ino_t ino[3]
510 #else
511 #define INO_T_CPP ino_t ino
512 #endif
513
514 /* Chain of directories to look for include files in.  */
515 struct cpp_dir
516 {
517   /* NULL-terminated singly-linked list.  */
518   struct cpp_dir *next;
519
520   /* NAME of the directory, NUL-terminated.  */
521   char *name;
522   unsigned int len;
523
524   /* One if a system header, two if a system header that has extern
525      "C" guards for C++.  */
526   unsigned char sysp;
527
528   /* Is this a user-supplied directory? */
529   bool user_supplied_p;
530
531   /* The canonicalized NAME as determined by lrealpath.  This field 
532      is only used by hosts that lack reliable inode numbers.  */
533   char *canonical_name;
534
535   /* Mapping of file names for this directory for MS-DOS and related
536      platforms.  A NULL-terminated array of (from, to) pairs.  */
537   const char **name_map;
538
539   /* Routine to construct pathname, given the search path name and the
540      HEADER we are trying to find, return a constructed pathname to
541      try and open.  If this is NULL, the constructed pathname is as
542      constructed by append_file_to_dir.  */
543   char *(*construct) (const char *header, cpp_dir *dir);
544
545   /* The C front end uses these to recognize duplicated
546      directories in the search path.  */
547   INO_T_CPP;
548   dev_t dev;
549 };
550
551 /* The structure of a node in the hash table.  The hash table has
552    entries for all identifiers: either macros defined by #define
553    commands (type NT_MACRO), assertions created with #assert
554    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
555    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
556    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
557    identifier that behaves like an operator such as "xor".
558    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
559    diagnostic may be required for this node.  Currently this only
560    applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat
561    warnings about NODE_OPERATOR.  */
562
563 /* Hash node flags.  */
564 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
565 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
566 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
567 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
568 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
569 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
570 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
571 #define NODE_USED       (1 << 7)        /* Dumped with -dU.  */
572 #define NODE_CONDITIONAL (1 << 8)       /* Conditional macro */
573 #define NODE_WARN_OPERATOR (1 << 9)     /* Warn about C++ named operator.  */
574
575 /* Different flavors of hash node.  */
576 enum node_type
577 {
578   NT_VOID = 0,     /* No definition yet.  */
579   NT_MACRO,        /* A macro of some form.  */
580   NT_ASSERTION     /* Predicate for #assert.  */
581 };
582
583 /* Different flavors of builtin macro.  _Pragma is an operator, but we
584    handle it with the builtin code for efficiency reasons.  */
585 enum cpp_builtin_type
586 {
587   BT_SPECLINE = 0,              /* `__LINE__' */
588   BT_DATE,                      /* `__DATE__' */
589   BT_FILE,                      /* `__FILE__' */
590   BT_BASE_FILE,                 /* `__BASE_FILE__' */
591   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
592   BT_TIME,                      /* `__TIME__' */
593   BT_STDC,                      /* `__STDC__' */
594   BT_PRAGMA,                    /* `_Pragma' operator */
595   BT_TIMESTAMP,                 /* `__TIMESTAMP__' */
596   BT_COUNTER                    /* `__COUNTER__' */
597 };
598
599 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
600 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
601 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
602 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
603
604 /* Specify which field, if any, of the union is used.  */
605
606 enum {
607   NTV_MACRO,
608   NTV_ANSWER,
609   NTV_BUILTIN,
610   NTV_ARGUMENT,
611   NTV_NONE
612 };
613
614 #define CPP_HASHNODE_VALUE_IDX(HNODE)                           \
615   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT                \
616    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN)     \
617                                ? NTV_BUILTIN : NTV_MACRO)       \
618    : HNODE.type == NT_ASSERTION ? NTV_ANSWER                    \
619    : NTV_NONE)
620
621 /* The common part of an identifier node shared amongst all 3 C front
622    ends.  Also used to store CPP identifiers, which are a superset of
623    identifiers in the grammatical sense.  */
624
625 union GTY(()) _cpp_hashnode_value {
626   /* If a macro.  */
627   cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
628   /* Answers to an assertion.  */
629   struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
630   /* Code for a builtin macro.  */
631   enum cpp_builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
632   /* Macro argument index.  */
633   unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
634 };
635
636 struct GTY(()) cpp_hashnode {
637   struct ht_identifier ident;
638   unsigned int is_directive : 1;
639   unsigned int directive_index : 7;     /* If is_directive,
640                                            then index into directive table.
641                                            Otherwise, a NODE_OPERATOR.  */
642   unsigned char rid_code;               /* Rid code - for front ends.  */
643   ENUM_BITFIELD(node_type) type : 6;    /* CPP node type.  */
644   unsigned int flags : 10;              /* CPP flags.  */
645
646   union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
647 };
648
649 /* Call this first to get a handle to pass to other functions.
650
651    If you want cpplib to manage its own hashtable, pass in a NULL
652    pointer.  Otherwise you should pass in an initialized hash table
653    that cpplib will share; this technique is used by the C front
654    ends.  */
655 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
656                                       struct line_maps *);
657
658 /* Reset the cpp_reader's line_map.  This is only used after reading a
659    PCH file.  */
660 extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
661
662 /* Call this to change the selected language standard (e.g. because of
663    command line options).  */
664 extern void cpp_set_lang (cpp_reader *, enum c_lang);
665
666 /* Set the include paths.  */
667 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
668
669 /* Call these to get pointers to the options, callback, and deps
670    structures for a given reader.  These pointers are good until you
671    call cpp_finish on that reader.  You can either edit the callbacks
672    through the pointer returned from cpp_get_callbacks, or set them
673    with cpp_set_callbacks.  */
674 extern cpp_options *cpp_get_options (cpp_reader *);
675 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
676 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
677 extern struct deps *cpp_get_deps (cpp_reader *);
678
679 /* This function reads the file, but does not start preprocessing.  It
680    returns the name of the original file; this is the same as the
681    input file, except for preprocessed input.  This will generate at
682    least one file change callback, and possibly a line change callback
683    too.  If there was an error opening the file, it returns NULL.  */
684 extern const char *cpp_read_main_file (cpp_reader *, const char *);
685
686 /* Set up built-ins with special behavior.  Use cpp_init_builtins()
687    instead unless your know what you are doing.  */
688 extern void cpp_init_special_builtins (cpp_reader *);
689
690 /* Set up built-ins like __FILE__.  */
691 extern void cpp_init_builtins (cpp_reader *, int);
692
693 /* This is called after options have been parsed, and partially
694    processed.  */
695 extern void cpp_post_options (cpp_reader *);
696
697 /* Set up translation to the target character set.  */
698 extern void cpp_init_iconv (cpp_reader *);
699
700 /* Call this to finish preprocessing.  If you requested dependency
701    generation, pass an open stream to write the information to,
702    otherwise NULL.  It is your responsibility to close the stream.  */
703 extern void cpp_finish (cpp_reader *, FILE *deps_stream);
704
705 /* Call this to release the handle at the end of preprocessing.  Any
706    use of the handle after this function returns is invalid.  */
707 extern void cpp_destroy (cpp_reader *);
708
709 extern unsigned int cpp_token_len (const cpp_token *);
710 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
711 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
712                                        unsigned char *, bool);
713 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
714                                  void (*) (cpp_reader *), bool);
715 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
716                                           const char *, unsigned, bool, bool);
717 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
718                             const cpp_token *);
719 extern const cpp_token *cpp_get_token (cpp_reader *);
720 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
721                                                      source_location *);
722 extern const unsigned char *cpp_macro_definition (cpp_reader *,
723                                                   const cpp_hashnode *);
724 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
725 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
726
727 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
728 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
729                                           unsigned int *, int *);
730 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
731 extern bool cpp_interpret_string (cpp_reader *,
732                                   const cpp_string *, size_t,
733                                   cpp_string *, enum cpp_ttype);
734 extern bool cpp_interpret_string_notranslate (cpp_reader *,
735                                               const cpp_string *, size_t,
736                                               cpp_string *, enum cpp_ttype);
737
738 /* Convert a host character constant to the execution character set.  */
739 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
740
741 /* Used to register macros and assertions, perhaps from the command line.
742    The text is the same as the command line argument.  */
743 extern void cpp_define (cpp_reader *, const char *);
744 extern void cpp_define_formatted (cpp_reader *pfile, 
745                                   const char *fmt, ...) ATTRIBUTE_PRINTF_2;
746 extern void cpp_assert (cpp_reader *, const char *);
747 extern void cpp_undef (cpp_reader *, const char *);
748 extern void cpp_unassert (cpp_reader *, const char *);
749
750 extern cpp_macro *cpp_push_definition (cpp_reader *, const char *);
751 extern void cpp_pop_definition (cpp_reader *, const char *, cpp_macro *);
752
753 /* Undefine all macros and assertions.  */
754 extern void cpp_undef_all (cpp_reader *);
755
756 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
757                                     size_t, int);
758 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
759
760 /* A preprocessing number.  Code assumes that any unused high bits of
761    the double integer are set to zero.  */
762 typedef unsigned HOST_WIDE_INT cpp_num_part;
763 typedef struct cpp_num cpp_num;
764 struct cpp_num
765 {
766   cpp_num_part high;
767   cpp_num_part low;
768   bool unsignedp;  /* True if value should be treated as unsigned.  */
769   bool overflow;   /* True if the most recent calculation overflowed.  */
770 };
771
772 /* cpplib provides two interfaces for interpretation of preprocessing
773    numbers.
774
775    cpp_classify_number categorizes numeric constants according to
776    their field (integer, floating point, or invalid), radix (decimal,
777    octal, hexadecimal), and type suffixes.  */
778
779 #define CPP_N_CATEGORY  0x000F
780 #define CPP_N_INVALID   0x0000
781 #define CPP_N_INTEGER   0x0001
782 #define CPP_N_FLOATING  0x0002
783
784 #define CPP_N_WIDTH     0x00F0
785 #define CPP_N_SMALL     0x0010  /* int, float, shrot _Fract/Accum  */
786 #define CPP_N_MEDIUM    0x0020  /* long, double, long _Fract/_Accum.  */
787 #define CPP_N_LARGE     0x0040  /* long long, long double,
788                                    long long _Fract/Accum.  */
789
790 #define CPP_N_WIDTH_MD  0xF0000 /* machine defined.  */
791 #define CPP_N_MD_W      0x10000
792 #define CPP_N_MD_Q      0x20000
793
794 #define CPP_N_RADIX     0x0F00
795 #define CPP_N_DECIMAL   0x0100
796 #define CPP_N_HEX       0x0200
797 #define CPP_N_OCTAL     0x0400
798 #define CPP_N_BINARY    0x0800
799
800 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
801 #define CPP_N_IMAGINARY 0x2000
802 #define CPP_N_DFLOAT    0x4000
803 #define CPP_N_DEFAULT   0x8000
804
805 #define CPP_N_FRACT     0x100000 /* Fract types.  */
806 #define CPP_N_ACCUM     0x200000 /* Accum types.  */
807
808 /* Classify a CPP_NUMBER token.  The return value is a combination of
809    the flags from the above sets.  */
810 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
811
812 /* Evaluate a token classified as category CPP_N_INTEGER.  */
813 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
814                                       unsigned int type);
815
816 /* Sign extend a number, with PRECISION significant bits and all
817    others assumed clear, to fill out a cpp_num structure.  */
818 cpp_num cpp_num_sign_extend (cpp_num, size_t);
819
820 /* Diagnostic levels.  To get a diagnostic without associating a
821    position in the translation unit with it, use cpp_error_with_line
822    with a line number of zero.  */
823
824 /* Warning, an error with -Werror.  */
825 #define CPP_DL_WARNING          0x00
826 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
827 #define CPP_DL_WARNING_SYSHDR   0x01
828 /* Warning, an error with -pedantic-errors or -Werror.  */
829 #define CPP_DL_PEDWARN          0x02
830 /* An error.  */
831 #define CPP_DL_ERROR            0x03
832 /* An internal consistency check failed.  Prints "internal error: ",
833    otherwise the same as CPP_DL_ERROR.  */
834 #define CPP_DL_ICE              0x04
835 /* An informative note following a warning.  */
836 #define CPP_DL_NOTE             0x05
837 /* A fatal error.  */
838 #define CPP_DL_FATAL            0x06
839
840 /* Output a diagnostic of some kind.  */
841 extern bool cpp_error (cpp_reader *, int, const char *msgid, ...)
842   ATTRIBUTE_PRINTF_3;
843
844 /* Output a diagnostic with "MSGID: " preceding the
845    error string of errno.  No location is printed.  */
846 extern bool cpp_errno (cpp_reader *, int, const char *msgid);
847
848 /* Same as cpp_error, except additionally specifies a position as a
849    (translation unit) physical line and physical column.  If the line is
850    zero, then no location is printed.  */
851 extern bool cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
852                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
853
854 /* In lex.c */
855 extern int cpp_ideq (const cpp_token *, const char *);
856 extern void cpp_output_line (cpp_reader *, FILE *);
857 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
858                                                  const unsigned char *);
859 extern void cpp_output_token (const cpp_token *, FILE *);
860 extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
861 /* Returns the value of an escape sequence, truncated to the correct
862    target precision.  PSTR points to the input pointer, which is just
863    after the backslash.  LIMIT is how much text we have.  WIDE is true
864    if the escape sequence is part of a wide character constant or
865    string literal.  Handles all relevant diagnostics.  */
866 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
867                                    const unsigned char *limit, int wide);
868
869 /* Structure used to hold a comment block at a given location in the
870    source code.  */
871
872 typedef struct
873 {
874   /* Text of the comment including the terminators.  */
875   char *comment;
876
877   /* source location for the given comment.  */
878   source_location sloc;
879 } cpp_comment;
880
881 /* Structure holding all comments for a given cpp_reader.  */
882
883 typedef struct
884 {
885   /* table of comment entries.  */
886   cpp_comment *entries;
887
888   /* number of actual entries entered in the table.  */
889   int count;
890
891   /* number of entries allocated currently.  */
892   int allocated;
893 } cpp_comment_table;
894
895 /* Returns the table of comments encountered by the preprocessor. This
896    table is only populated when pfile->state.save_comments is true. */
897 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
898
899 /* In hash.c */
900
901 /* Lookup an identifier in the hashtable.  Puts the identifier in the
902    table if it is not already there.  */
903 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
904                                  unsigned int);
905
906 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
907 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
908
909 /* In macro.c */
910 extern void cpp_scan_nooutput (cpp_reader *);
911 extern int  cpp_sys_macro_p (cpp_reader *);
912 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
913                                         unsigned int);
914
915 /* In files.c */
916 extern bool cpp_included (cpp_reader *, const char *);
917 extern bool cpp_included_before (cpp_reader *, const char *, source_location);
918 extern void cpp_make_system_header (cpp_reader *, int, int);
919 extern bool cpp_push_include (cpp_reader *, const char *);
920 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
921 extern const char *cpp_get_path (struct _cpp_file *);
922 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
923 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
924 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
925 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
926 extern void cpp_clear_file_cache (cpp_reader *);
927
928 /* In pch.c */
929 struct save_macro_data;
930 extern int cpp_save_state (cpp_reader *, FILE *);
931 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
932 extern int cpp_write_pch_state (cpp_reader *, FILE *);
933 extern int cpp_valid_state (cpp_reader *, const char *, int);
934 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
935 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
936                            struct save_macro_data *);
937
938 #endif /* ! LIBCPP_CPPLIB_H */