OSDN Git Service

* internal.h (xnew, xcnew, xnewvec, xcnewvec, xobnew): Remove.
[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, 2004
3    Free Software Foundation, Inc.
4    Written by Per Bothner, 1994-95.
5
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19
20  In other words, you are welcome to use, share and improve this program.
21  You are forbidden to forbid anyone else to use, share and improve
22  what you give them.   Help stamp out software-hoarding!  */
23 #ifndef LIBCPP_CPPLIB_H
24 #define LIBCPP_CPPLIB_H
25
26 #include <sys/types.h>
27 #include "symtab.h"
28 #include "line-map.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 typedef struct cpp_reader cpp_reader;
35 typedef struct cpp_buffer cpp_buffer;
36 typedef struct cpp_options cpp_options;
37 typedef struct cpp_token cpp_token;
38 typedef struct cpp_string cpp_string;
39 typedef struct cpp_hashnode cpp_hashnode;
40 typedef struct cpp_macro cpp_macro;
41 typedef struct cpp_callbacks cpp_callbacks;
42 typedef struct cpp_dir cpp_dir;
43
44 struct answer;
45 struct _cpp_file;
46
47 /* The first three groups, apart from '=', can appear in preprocessor
48    expressions (+= and -= are used to indicate unary + and - resp.).
49    This allows a lookup table to be implemented in _cpp_parse_expr.
50
51    The first group, to CPP_LAST_EQ, can be immediately followed by an
52    '='.  The lexer needs operators ending in '=', like ">>=", to be in
53    the same order as their counterparts without the '=', like ">>".  */
54
55 /* Positions in the table.  */
56 #define CPP_LAST_EQ CPP_MAX
57 #define CPP_FIRST_DIGRAPH CPP_HASH
58 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
59 #define CPP_LAST_CPP_OP CPP_LESS_EQ
60
61 #define TTYPE_TABLE                             \
62   OP(CPP_EQ = 0,        "=")                    \
63   OP(CPP_NOT,           "!")                    \
64   OP(CPP_GREATER,       ">")    /* compare */   \
65   OP(CPP_LESS,          "<")                    \
66   OP(CPP_PLUS,          "+")    /* math */      \
67   OP(CPP_MINUS,         "-")                    \
68   OP(CPP_MULT,          "*")                    \
69   OP(CPP_DIV,           "/")                    \
70   OP(CPP_MOD,           "%")                    \
71   OP(CPP_AND,           "&")    /* bit ops */   \
72   OP(CPP_OR,            "|")                    \
73   OP(CPP_XOR,           "^")                    \
74   OP(CPP_RSHIFT,        ">>")                   \
75   OP(CPP_LSHIFT,        "<<")                   \
76   OP(CPP_MIN,           "<?")   /* extension */ \
77   OP(CPP_MAX,           ">?")                   \
78 \
79   OP(CPP_COMPL,         "~")                    \
80   OP(CPP_AND_AND,       "&&")   /* logical */   \
81   OP(CPP_OR_OR,         "||")                   \
82   OP(CPP_QUERY,         "?")                    \
83   OP(CPP_COLON,         ":")                    \
84   OP(CPP_COMMA,         ",")    /* grouping */  \
85   OP(CPP_OPEN_PAREN,    "(")                    \
86   OP(CPP_CLOSE_PAREN,   ")")                    \
87   TK(CPP_EOF,           SPELL_NONE)             \
88   OP(CPP_EQ_EQ,         "==")   /* compare */   \
89   OP(CPP_NOT_EQ,        "!=")                   \
90   OP(CPP_GREATER_EQ,    ">=")                   \
91   OP(CPP_LESS_EQ,       "<=")                   \
92 \
93   /* These two are unary + / - in preprocessor expressions.  */ \
94   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
95   OP(CPP_MINUS_EQ,      "-=")                   \
96 \
97   OP(CPP_MULT_EQ,       "*=")                   \
98   OP(CPP_DIV_EQ,        "/=")                   \
99   OP(CPP_MOD_EQ,        "%=")                   \
100   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
101   OP(CPP_OR_EQ,         "|=")                   \
102   OP(CPP_XOR_EQ,        "^=")                   \
103   OP(CPP_RSHIFT_EQ,     ">>=")                  \
104   OP(CPP_LSHIFT_EQ,     "<<=")                  \
105   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
106   OP(CPP_MAX_EQ,        ">?=")                  \
107   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
108   OP(CPP_HASH,          "#")    /* digraphs */  \
109   OP(CPP_PASTE,         "##")                   \
110   OP(CPP_OPEN_SQUARE,   "[")                    \
111   OP(CPP_CLOSE_SQUARE,  "]")                    \
112   OP(CPP_OPEN_BRACE,    "{")                    \
113   OP(CPP_CLOSE_BRACE,   "}")                    \
114   /* The remainder of the punctuation.  Order is not significant.  */   \
115   OP(CPP_SEMICOLON,     ";")    /* structure */ \
116   OP(CPP_ELLIPSIS,      "...")                  \
117   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
118   OP(CPP_MINUS_MINUS,   "--")                   \
119   OP(CPP_DEREF,         "->")   /* accessors */ \
120   OP(CPP_DOT,           ".")                    \
121   OP(CPP_SCOPE,         "::")                   \
122   OP(CPP_DEREF_STAR,    "->*")                  \
123   OP(CPP_DOT_STAR,      ".*")                   \
124   OP(CPP_ATSIGN,        "@")  /* used in Objective-C */ \
125 \
126   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
127   TK(CPP_AT_NAME,       SPELL_IDENT)    /* @word - Objective-C */       \
128   TK(CPP_NUMBER,        SPELL_LITERAL)  /* 34_be+ta  */                 \
129 \
130   TK(CPP_CHAR,          SPELL_LITERAL)  /* 'char' */                    \
131   TK(CPP_WCHAR,         SPELL_LITERAL)  /* L'char' */                   \
132   TK(CPP_OTHER,         SPELL_LITERAL)  /* stray punctuation */         \
133 \
134   TK(CPP_STRING,        SPELL_LITERAL)  /* "string" */                  \
135   TK(CPP_WSTRING,       SPELL_LITERAL)  /* L"string" */                 \
136   TK(CPP_OBJC_STRING,   SPELL_LITERAL)  /* @"string" - Objective-C */   \
137   TK(CPP_HEADER_NAME,   SPELL_LITERAL)  /* <stdio.h> in #include */     \
138 \
139   TK(CPP_COMMENT,       SPELL_LITERAL)  /* Only if output comments.  */ \
140                                         /* SPELL_LITERAL happens to DTRT.  */ \
141   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
142   TK(CPP_PADDING,       SPELL_NONE)     /* Whitespace for cpp0.  */
143
144 #define OP(e, s) e,
145 #define TK(e, s) e,
146 enum cpp_ttype
147 {
148   TTYPE_TABLE
149   N_TTYPES
150 };
151 #undef OP
152 #undef TK
153
154 /* C language kind, used when calling cpp_reader_init.  */
155 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
156              CLK_GNUCXX, CLK_CXX98, CLK_ASM};
157
158 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
159 struct cpp_string GTY(())
160 {
161   unsigned int len;
162   const unsigned char *text;
163 };
164
165 /* Flags for the cpp_token structure.  */
166 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
167 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
168 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
169 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
170 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
171 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
172 #define BOL             (1 << 6) /* Token at beginning of line.  */
173
174 /* Specify which field, if any, of the cpp_token union is used.  */
175
176 enum cpp_token_fld_kind {
177   CPP_TOKEN_FLD_NODE,
178   CPP_TOKEN_FLD_SOURCE,
179   CPP_TOKEN_FLD_STR,
180   CPP_TOKEN_FLD_ARG_NO,
181   CPP_TOKEN_FLD_NONE
182 };
183
184 /* A preprocessing token.  This has been carefully packed and should
185    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
186 struct cpp_token GTY(())
187 {
188   source_location src_loc;      /* Location of first char of token.  */
189   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
190   unsigned char flags;          /* flags - see above */
191
192   union cpp_token_u
193   {
194     /* An identifier.  */
195     cpp_hashnode *
196       GTY ((nested_ptr (union tree_node,
197                 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
198                         "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"),
199             tag ("CPP_TOKEN_FLD_NODE")))
200          node;
201          
202     /* Inherit padding from this token.  */
203     cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
204
205     /* A string, or number.  */
206     struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
207
208     /* Argument no. for a CPP_MACRO_ARG.  */
209     unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no;
210   } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
211 };
212
213 /* Say which field is in use.  */
214 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
215
216 /* A type wide enough to hold any multibyte source character.
217    cpplib's character constant interpreter requires an unsigned type.
218    Also, a typedef for the signed equivalent.
219    The width of this type is capped at 32 bits; there do exist targets
220    where wchar_t is 64 bits, but only in a non-default mode, and there
221    would be no meaningful interpretation for a wchar_t value greater
222    than 2^32 anyway -- the widest wide-character encoding around is
223    ISO 10646, which stops at 2^31.  */
224 #if CHAR_BIT * SIZEOF_INT >= 32
225 # define CPPCHAR_SIGNED_T int
226 #elif CHAR_BIT * SIZEOF_LONG >= 32
227 # define CPPCHAR_SIGNED_T long
228 #else
229 # error "Cannot find a least-32-bit signed integer type"
230 #endif
231 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
232 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
233
234 /* Style of header dependencies to generate.  */
235 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
236
237 /* This structure is nested inside struct cpp_reader, and
238    carries all the options visible to the command line.  */
239 struct cpp_options
240 {
241   /* Characters between tab stops.  */
242   unsigned int tabstop;
243
244   /* The language we're preprocessing.  */
245   enum c_lang lang;
246
247   /* Nonzero means use extra default include directories for C++.  */
248   unsigned char cplusplus;
249
250   /* Nonzero means handle cplusplus style comments.  */
251   unsigned char cplusplus_comments;
252
253   /* Nonzero means define __OBJC__, treat @ as a special token, and
254      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
255   unsigned char objc;
256
257   /* Nonzero means don't copy comments into the output file.  */
258   unsigned char discard_comments;
259
260   /* Nonzero means don't copy comments into the output file during
261      macro expansion.  */
262   unsigned char discard_comments_in_macro_exp;
263
264   /* Nonzero means process the ISO trigraph sequences.  */
265   unsigned char trigraphs;
266
267   /* Nonzero means process the ISO digraph sequences.  */
268   unsigned char digraphs;
269
270   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
271   unsigned char extended_numbers;
272
273   /* Nonzero means print names of header files (-H).  */
274   unsigned char print_include_names;
275
276   /* Nonzero means cpp_pedwarn causes a hard error.  */
277   unsigned char pedantic_errors;
278
279   /* Nonzero means don't print warning messages.  */
280   unsigned char inhibit_warnings;
281
282   /* Nonzero means complain about deprecated features.  */
283   unsigned char warn_deprecated;
284
285   /* Nonzero means don't suppress warnings from system headers.  */
286   unsigned char warn_system_headers;
287
288   /* Nonzero means don't print error messages.  Has no option to
289      select it, but can be set by a user of cpplib (e.g. fix-header).  */
290   unsigned char inhibit_errors;
291
292   /* Nonzero means warn if slash-star appears in a comment.  */
293   unsigned char warn_comments;
294
295   /* Nonzero means warn if a user-supplied include directory does not
296      exist.  */
297   unsigned char warn_missing_include_dirs;
298
299   /* Nonzero means warn if there are any trigraphs.  */
300   unsigned char warn_trigraphs;
301
302   /* Nonzero means warn about multicharacter charconsts.  */
303   unsigned char warn_multichar;
304
305   /* Nonzero means warn about various incompatibilities with
306      traditional C.  */
307   unsigned char warn_traditional;
308
309   /* Nonzero means warn about long long numeric constants.  */
310   unsigned char warn_long_long;
311
312   /* Nonzero means warn about text after an #endif (or #else).  */
313   unsigned char warn_endif_labels;
314
315   /* Nonzero means warn about implicit sign changes owing to integer
316      promotions.  */
317   unsigned char warn_num_sign_change;
318
319   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
320      Presumably the usage is protected by the appropriate #ifdef.  */
321   unsigned char warn_variadic_macros;
322
323   /* Nonzero means turn warnings into errors.  */
324   unsigned char warnings_are_errors;
325
326   /* Nonzero means we should look for header.gcc files that remap file
327      names.  */
328   unsigned char remap;
329
330   /* Zero means dollar signs are punctuation.  */
331   unsigned char dollars_in_ident;
332
333   /* True if we should warn about dollars in identifiers or numbers
334      for this translation unit.  */
335   unsigned char warn_dollars;
336
337   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
338   unsigned char warn_undef;
339
340   /* Nonzero means warn of unused macros from the main file.  */
341   unsigned char warn_unused_macros;
342
343   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
344   unsigned char c99;
345
346   /* Nonzero if we are conforming to a specific C or C++ standard.  */
347   unsigned char std;
348
349   /* Nonzero means give all the error messages the ANSI standard requires.  */
350   unsigned char pedantic;
351
352   /* Nonzero means we're looking at already preprocessed code, so don't
353      bother trying to do macro expansion and whatnot.  */
354   unsigned char preprocessed;
355
356   /* Print column number in error messages.  */
357   unsigned char show_column;
358
359   /* Nonzero means handle C++ alternate operator names.  */
360   unsigned char operator_names;
361
362   /* True for traditional preprocessing.  */
363   unsigned char traditional;
364
365   /* Holds the name of the target (execution) character set.  */
366   const char *narrow_charset;
367
368   /* Holds the name of the target wide character set.  */
369   const char *wide_charset;
370
371   /* Holds the name of the input character set.  */
372   const char *input_charset;
373
374   /* True to warn about precompiled header files we couldn't use.  */
375   bool warn_invalid_pch;
376
377   /* True if dependencies should be restored from a precompiled header.  */
378   bool restore_pch_deps;
379
380   /* Dependency generation.  */
381   struct
382   {
383     /* Style of header dependencies to generate.  */
384     enum cpp_deps_style style;
385
386     /* Assume missing files are generated files.  */
387     bool missing_files;
388
389     /* Generate phony targets for each dependency apart from the first
390        one.  */
391     bool phony_targets;
392
393     /* If true, no dependency is generated on the main file.  */
394     bool ignore_main_file;
395   } deps;
396
397   /* Target-specific features set by the front end or client.  */
398
399   /* Precision for target CPP arithmetic, target characters, target
400      ints and target wide characters, respectively.  */
401   size_t precision, char_precision, int_precision, wchar_precision;
402
403   /* True means chars (wide chars) are unsigned.  */
404   bool unsigned_char, unsigned_wchar;
405
406   /* True if the most significant byte in a word has the lowest
407      address in memory.  */
408   bool bytes_big_endian;
409
410   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
411   unsigned char stdc_0_in_system_headers;
412 };
413
414 /* Callback for header lookup for HEADER, which is the name of a
415    source file.  It is used as a method of last resort to find headers
416    that are not otherwise found during the normal include processing.
417    The return value is the malloced name of a header to try and open,
418    if any, or NULL otherwise.  This callback is called only if the
419    header is otherwise unfound.  */
420 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
421
422 /* Call backs to cpplib client.  */
423 struct cpp_callbacks
424 {
425   /* Called when a new line of preprocessed output is started.  */
426   void (*line_change) (cpp_reader *, const cpp_token *, int);
427
428   /* Called when switching to/from a new file.
429      The line_map is for the new file.  It is NULL if there is no new file.
430      (In C this happens when done with <built-in>+<command line> and also
431      when done with a main file.)  This can be used for resource cleanup.  */
432   void (*file_change) (cpp_reader *, const struct line_map *);
433
434   void (*dir_change) (cpp_reader *, const char *);
435   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
436                    const char *, int);
437   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
438   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
439   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
440   void (*def_pragma) (cpp_reader *, unsigned int);
441   int (*valid_pch) (cpp_reader *, const char *, int);
442   void (*read_pch) (cpp_reader *, const char *, int, const char *);
443   missing_header_cb missing_header;
444 };
445
446 /* Chain of directories to look for include files in.  */
447 struct cpp_dir
448 {
449   /* NULL-terminated singly-linked list.  */
450   struct cpp_dir *next;
451
452   /* NAME of the directory, NUL-terminated.  */
453   char *name;
454   unsigned int len;
455
456   /* One if a system header, two if a system header that has extern
457      "C" guards for C++.  */
458   unsigned char sysp;
459
460   /* Mapping of file names for this directory for MS-DOS and related
461      platforms.  A NULL-terminated array of (from, to) pairs.  */
462   const char **name_map;
463
464   /* Routine to construct pathname, given the search path name and the
465      HEADER we are trying to find, return a constructed pathname to
466      try and open.  If this is NULL, the constructed pathname is as
467      constructed by append_file_to_dir.  */
468   char *(*construct) (const char *header, cpp_dir *dir);
469
470   /* The C front end uses these to recognize duplicated
471      directories in the search path.  */
472   ino_t ino;
473   dev_t dev;
474
475   /* Is this a user-supplied directory? */
476   bool user_supplied_p;
477 };
478
479 /* Name under which this program was invoked.  */
480 extern const char *progname;
481
482 /* The structure of a node in the hash table.  The hash table has
483    entries for all identifiers: either macros defined by #define
484    commands (type NT_MACRO), assertions created with #assert
485    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
486    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
487    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
488    identifier that behaves like an operator such as "xor".
489    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
490    diagnostic may be required for this node.  Currently this only
491    applies to __VA_ARGS__ and poisoned identifiers.  */
492
493 /* Hash node flags.  */
494 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
495 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
496 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
497 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
498 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
499 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
500 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
501
502 /* Different flavors of hash node.  */
503 enum node_type
504 {
505   NT_VOID = 0,     /* No definition yet.  */
506   NT_MACRO,        /* A macro of some form.  */
507   NT_ASSERTION     /* Predicate for #assert.  */
508 };
509
510 /* Different flavors of builtin macro.  _Pragma is an operator, but we
511    handle it with the builtin code for efficiency reasons.  */
512 enum builtin_type
513 {
514   BT_SPECLINE = 0,              /* `__LINE__' */
515   BT_DATE,                      /* `__DATE__' */
516   BT_FILE,                      /* `__FILE__' */
517   BT_BASE_FILE,                 /* `__BASE_FILE__' */
518   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
519   BT_TIME,                      /* `__TIME__' */
520   BT_STDC,                      /* `__STDC__' */
521   BT_PRAGMA                     /* `_Pragma' operator */
522 };
523
524 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
525 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
526 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
527 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
528
529 /* Specify which field, if any, of the union is used.  */
530
531 enum {
532   NTV_MACRO,
533   NTV_ANSWER,
534   NTV_BUILTIN,
535   NTV_ARGUMENT,
536   NTV_NONE
537 };
538
539 #define CPP_HASHNODE_VALUE_IDX(HNODE)                           \
540   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT                \
541    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN)     \
542                                ? NTV_BUILTIN : NTV_MACRO)       \
543    : HNODE.type == NT_ASSERTION ? NTV_ANSWER                    \
544    : NTV_NONE)
545
546 /* The common part of an identifier node shared amongst all 3 C front
547    ends.  Also used to store CPP identifiers, which are a superset of
548    identifiers in the grammatical sense.  */
549 struct cpp_hashnode GTY(())
550 {
551   struct ht_identifier ident;
552   unsigned int is_directive : 1;
553   unsigned int directive_index : 7;     /* If is_directive,
554                                            then index into directive table.
555                                            Otherwise, a NODE_OPERATOR.  */
556   unsigned char rid_code;               /* Rid code - for front ends.  */
557   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
558   unsigned char flags;                  /* CPP flags.  */
559
560   union _cpp_hashnode_value
561   {
562     /* If a macro.  */
563     cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
564     /* Answers to an assertion.  */
565     struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
566     /* Code for a builtin macro.  */
567     enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
568     /* Macro argument index.  */
569     unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
570   } GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
571 };
572
573 /* Call this first to get a handle to pass to other functions.
574
575    If you want cpplib to manage its own hashtable, pass in a NULL
576    pointer.  Otherwise you should pass in an initialized hash table
577    that cpplib will share; this technique is used by the C front
578    ends.  */
579 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
580                                       struct line_maps *);
581
582 /* Call this to change the selected language standard (e.g. because of
583    command line options).  */
584 extern void cpp_set_lang (cpp_reader *, enum c_lang);
585
586 /* Set the include paths.  */
587 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
588
589 /* Call these to get pointers to the options, callback, and deps
590    structures for a given reader.  These pointers are good until you
591    call cpp_finish on that reader.  You can either edit the callbacks
592    through the pointer returned from cpp_get_callbacks, or set them
593    with cpp_set_callbacks.  */
594 extern cpp_options *cpp_get_options (cpp_reader *);
595 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
596 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
597 extern struct deps *cpp_get_deps (cpp_reader *);
598
599 /* This function reads the file, but does not start preprocessing.  It
600    returns the name of the original file; this is the same as the
601    input file, except for preprocessed input.  This will generate at
602    least one file change callback, and possibly a line change callback
603    too.  If there was an error opening the file, it returns NULL.  */
604 extern const char *cpp_read_main_file (cpp_reader *, const char *);
605
606 /* Set up built-ins like __FILE__.  */
607 extern void cpp_init_builtins (cpp_reader *, int);
608
609 /* This is called after options have been parsed, and partially
610    processed.  */
611 extern void cpp_post_options (cpp_reader *);
612
613 /* Set up translation to the target character set.  */
614 extern void cpp_init_iconv (cpp_reader *);
615
616 /* Call this to finish preprocessing.  If you requested dependency
617    generation, pass an open stream to write the information to,
618    otherwise NULL.  It is your responsibility to close the stream.
619
620    Returns cpp_errors (pfile).  */
621 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
622
623 /* Call this to release the handle at the end of preprocessing.  Any
624    use of the handle after this function returns is invalid.  Returns
625    cpp_errors (pfile).  */
626 extern void cpp_destroy (cpp_reader *);
627
628 /* Error count.  */
629 extern unsigned int cpp_errors (cpp_reader *);
630
631 extern unsigned int cpp_token_len (const cpp_token *);
632 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
633 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
634                                        unsigned char *);
635 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
636                                  void (*) (cpp_reader *));
637 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
638                             const cpp_token *);
639 extern const cpp_token *cpp_get_token (cpp_reader *);
640 extern const unsigned char *cpp_macro_definition (cpp_reader *,
641                                                   const cpp_hashnode *);
642 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
643
644 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
645 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
646                                           unsigned int *, int *);
647 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
648 extern bool cpp_interpret_string (cpp_reader *,
649                                   const cpp_string *, size_t,
650                                   cpp_string *, bool);
651 extern bool cpp_interpret_string_notranslate (cpp_reader *,
652                                               const cpp_string *, size_t,
653                                               cpp_string *, bool);
654
655 /* Used to register macros and assertions, perhaps from the command line.
656    The text is the same as the command line argument.  */
657 extern void cpp_define (cpp_reader *, const char *);
658 extern void cpp_assert (cpp_reader *, const char *);
659 extern void cpp_undef (cpp_reader *, const char *);
660 extern void cpp_unassert (cpp_reader *, const char *);
661
662 /* Undefine all macros and assertions.  */
663 extern void cpp_undef_all (cpp_reader *);
664
665 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
666                                     size_t, int);
667 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
668
669 /* A preprocessing number.  Code assumes that any unused high bits of
670    the double integer are set to zero.  */
671 typedef unsigned HOST_WIDE_INT cpp_num_part;
672 typedef struct cpp_num cpp_num;
673 struct cpp_num
674 {
675   cpp_num_part high;
676   cpp_num_part low;
677   bool unsignedp;  /* True if value should be treated as unsigned.  */
678   bool overflow;   /* True if the most recent calculation overflowed.  */
679 };
680
681 /* cpplib provides two interfaces for interpretation of preprocessing
682    numbers.
683
684    cpp_classify_number categorizes numeric constants according to
685    their field (integer, floating point, or invalid), radix (decimal,
686    octal, hexadecimal), and type suffixes.  */
687
688 #define CPP_N_CATEGORY  0x000F
689 #define CPP_N_INVALID   0x0000
690 #define CPP_N_INTEGER   0x0001
691 #define CPP_N_FLOATING  0x0002
692
693 #define CPP_N_WIDTH     0x00F0
694 #define CPP_N_SMALL     0x0010  /* int, float.  */
695 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
696 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
697
698 #define CPP_N_RADIX     0x0F00
699 #define CPP_N_DECIMAL   0x0100
700 #define CPP_N_HEX       0x0200
701 #define CPP_N_OCTAL     0x0400
702
703 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
704 #define CPP_N_IMAGINARY 0x2000
705
706 /* Classify a CPP_NUMBER token.  The return value is a combination of
707    the flags from the above sets.  */
708 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
709
710 /* Evaluate a token classified as category CPP_N_INTEGER.  */
711 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
712                                       unsigned int type);
713
714 /* Sign extend a number, with PRECISION significant bits and all
715    others assumed clear, to fill out a cpp_num structure.  */
716 cpp_num cpp_num_sign_extend (cpp_num, size_t);
717
718 /* Diagnostic levels.  To get a diagnostic without associating a
719    position in the translation unit with it, use cpp_error_with_line
720    with a line number of zero.  */
721
722 /* Warning, an error with -Werror.  */
723 #define CPP_DL_WARNING          0x00
724 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
725 #define CPP_DL_WARNING_SYSHDR   0x01
726 /* Warning, an error with -pedantic-errors or -Werror.  */
727 #define CPP_DL_PEDWARN          0x02
728 /* An error.  */
729 #define CPP_DL_ERROR            0x03
730 /* An internal consistency check failed.  Prints "internal error: ",
731    otherwise the same as CPP_DL_ERROR.  */
732 #define CPP_DL_ICE              0x04
733 /* Extracts a diagnostic level from an int.  */
734 #define CPP_DL_EXTRACT(l)       (l & 0xf)
735 /* Nonzero if a diagnostic level is one of the warnings.  */
736 #define CPP_DL_WARNING_P(l)     (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
737                                  && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
738
739 /* N.B. The error-message-printer prototypes have not been nicely
740    formatted because exgettext needs to see 'msgid' on the same line
741    as the name of the function in order to work properly.  Only the
742    string argument gets a name in an effort to keep the lines from
743    getting ridiculously oversized.  */
744
745 /* Output a diagnostic of some kind.  */
746 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
747   ATTRIBUTE_PRINTF_3;
748
749 /* Output a diagnostic with "MSGID: " preceding the
750    error string of errno.  No location is printed.  */
751 extern void cpp_errno (cpp_reader *, int, const char *msgid);
752
753 /* Same as cpp_error, except additionally specifies a position as a
754    (translation unit) physical line and physical column.  If the line is
755    zero, then no location is printed.  */
756 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
757                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
758
759 /* In cpplex.c */
760 extern int cpp_ideq (const cpp_token *, const char *);
761 extern void cpp_output_line (cpp_reader *, FILE *);
762 extern void cpp_output_token (const cpp_token *, FILE *);
763 extern const char *cpp_type2name (enum cpp_ttype);
764 /* Returns the value of an escape sequence, truncated to the correct
765    target precision.  PSTR points to the input pointer, which is just
766    after the backslash.  LIMIT is how much text we have.  WIDE is true
767    if the escape sequence is part of a wide character constant or
768    string literal.  Handles all relevant diagnostics.  */
769 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
770                                    const unsigned char *limit, int wide);
771
772 /* In cpphash.c */
773
774 /* Lookup an identifier in the hashtable.  Puts the identifier in the
775    table if it is not already there.  */
776 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
777                                  unsigned int);
778
779 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
780 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
781
782 /* In cppmacro.c */
783 extern void cpp_scan_nooutput (cpp_reader *);
784 extern int  cpp_sys_macro_p (cpp_reader *);
785 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
786                                         unsigned int);
787
788 /* In cppfiles.c */
789 extern bool cpp_included (cpp_reader *, const char *);
790 extern void cpp_make_system_header (cpp_reader *, int, int);
791 extern bool cpp_push_include (cpp_reader *, const char *);
792 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
793 extern const char *cpp_get_path (struct _cpp_file *);
794 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
795 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
796 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
797 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
798
799 /* In cpppch.c */
800 struct save_macro_data;
801 extern int cpp_save_state (cpp_reader *, FILE *);
802 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
803 extern int cpp_write_pch_state (cpp_reader *, FILE *);
804 extern int cpp_valid_state (cpp_reader *, const char *, int);
805 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
806 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
807                            struct save_macro_data *);
808
809 #ifdef __cplusplus
810 }
811 #endif
812
813 #endif /* ! LIBCPP_CPPLIB_H */