xref: /netbsd-src/external/gpl3/gcc.old/dist/libcpp/include/cpplib.h (revision ede781334f5dc56e6b74c3945d364b5b98850996)
1 /* Definitions for CPP library.
2    Copyright (C) 1995-2017 Free Software Foundation, Inc.
3    Written by Per Bothner, 1994-95.
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 3, 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; see the file COPYING3.  If not see
17 <http://www.gnu.org/licenses/>.
18 
19  In other words, you are welcome to use, share and improve this program.
20  You are forbidden to forbid anyone else to use, share and improve
21  what you give them.   Help stamp out software-hoarding!  */
22 #ifndef LIBCPP_CPPLIB_H
23 #define LIBCPP_CPPLIB_H
24 
25 #include <sys/types.h>
26 #include "symtab.h"
27 #include "line-map.h"
28 
29 typedef struct cpp_reader cpp_reader;
30 typedef struct cpp_buffer cpp_buffer;
31 typedef struct cpp_options cpp_options;
32 typedef struct cpp_token cpp_token;
33 typedef struct cpp_string cpp_string;
34 typedef struct cpp_hashnode cpp_hashnode;
35 typedef struct cpp_macro cpp_macro;
36 typedef struct cpp_callbacks cpp_callbacks;
37 typedef struct cpp_dir cpp_dir;
38 
39 struct answer;
40 struct _cpp_file;
41 
42 /* The first three groups, apart from '=', can appear in preprocessor
43    expressions (+= and -= are used to indicate unary + and - resp.).
44    This allows a lookup table to be implemented in _cpp_parse_expr.
45 
46    The first group, to CPP_LAST_EQ, can be immediately followed by an
47    '='.  The lexer needs operators ending in '=', like ">>=", to be in
48    the same order as their counterparts without the '=', like ">>".
49 
50    See the cpp_operator table optab in expr.c if you change the order or
51    add or remove anything in the first group.  */
52 
53 #define TTYPE_TABLE							\
54   OP(EQ,		"=")						\
55   OP(NOT,		"!")						\
56   OP(GREATER,		">")	/* compare */				\
57   OP(LESS,		"<")						\
58   OP(PLUS,		"+")	/* math */				\
59   OP(MINUS,		"-")						\
60   OP(MULT,		"*")						\
61   OP(DIV,		"/")						\
62   OP(MOD,		"%")						\
63   OP(AND,		"&")	/* bit ops */				\
64   OP(OR,		"|")						\
65   OP(XOR,		"^")						\
66   OP(RSHIFT,		">>")						\
67   OP(LSHIFT,		"<<")						\
68 									\
69   OP(COMPL,		"~")						\
70   OP(AND_AND,		"&&")	/* logical */				\
71   OP(OR_OR,		"||")						\
72   OP(QUERY,		"?")						\
73   OP(COLON,		":")						\
74   OP(COMMA,		",")	/* grouping */				\
75   OP(OPEN_PAREN,	"(")						\
76   OP(CLOSE_PAREN,	")")						\
77   TK(EOF,		NONE)						\
78   OP(EQ_EQ,		"==")	/* compare */				\
79   OP(NOT_EQ,		"!=")						\
80   OP(GREATER_EQ,	">=")						\
81   OP(LESS_EQ,		"<=")						\
82 									\
83   /* These two are unary + / - in preprocessor expressions.  */		\
84   OP(PLUS_EQ,		"+=")	/* math */				\
85   OP(MINUS_EQ,		"-=")						\
86 									\
87   OP(MULT_EQ,		"*=")						\
88   OP(DIV_EQ,		"/=")						\
89   OP(MOD_EQ,		"%=")						\
90   OP(AND_EQ,		"&=")	/* bit ops */				\
91   OP(OR_EQ,		"|=")						\
92   OP(XOR_EQ,		"^=")						\
93   OP(RSHIFT_EQ,		">>=")						\
94   OP(LSHIFT_EQ,		"<<=")						\
95   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */		\
96   OP(HASH,		"#")	/* digraphs */				\
97   OP(PASTE,		"##")						\
98   OP(OPEN_SQUARE,	"[")						\
99   OP(CLOSE_SQUARE,	"]")						\
100   OP(OPEN_BRACE,	"{")						\
101   OP(CLOSE_BRACE,	"}")						\
102   /* The remainder of the punctuation.	Order is not significant.  */	\
103   OP(SEMICOLON,		";")	/* structure */				\
104   OP(ELLIPSIS,		"...")						\
105   OP(PLUS_PLUS,		"++")	/* increment */				\
106   OP(MINUS_MINUS,	"--")						\
107   OP(DEREF,		"->")	/* accessors */				\
108   OP(DOT,		".")						\
109   OP(SCOPE,		"::")						\
110   OP(DEREF_STAR,	"->*")						\
111   OP(DOT_STAR,		".*")						\
112   OP(ATSIGN,		"@")  /* used in Objective-C */			\
113 									\
114   TK(NAME,		IDENT)	 /* word */				\
115   TK(AT_NAME,		IDENT)	 /* @word - Objective-C */		\
116   TK(NUMBER,		LITERAL) /* 34_be+ta  */			\
117 									\
118   TK(CHAR,		LITERAL) /* 'char' */				\
119   TK(WCHAR,		LITERAL) /* L'char' */				\
120   TK(CHAR16,		LITERAL) /* u'char' */				\
121   TK(CHAR32,		LITERAL) /* U'char' */				\
122   TK(UTF8CHAR,		LITERAL) /* u8'char' */				\
123   TK(OTHER,		LITERAL) /* stray punctuation */		\
124 									\
125   TK(STRING,		LITERAL) /* "string" */				\
126   TK(WSTRING,		LITERAL) /* L"string" */			\
127   TK(STRING16,		LITERAL) /* u"string" */			\
128   TK(STRING32,		LITERAL) /* U"string" */			\
129   TK(UTF8STRING,	LITERAL) /* u8"string" */			\
130   TK(OBJC_STRING,	LITERAL) /* @"string" - Objective-C */		\
131   TK(HEADER_NAME,	LITERAL) /* <stdio.h> in #include */		\
132 									\
133   TK(CHAR_USERDEF,	LITERAL) /* 'char'_suffix - C++-0x */		\
134   TK(WCHAR_USERDEF,	LITERAL) /* L'char'_suffix - C++-0x */		\
135   TK(CHAR16_USERDEF,	LITERAL) /* u'char'_suffix - C++-0x */		\
136   TK(CHAR32_USERDEF,	LITERAL) /* U'char'_suffix - C++-0x */		\
137   TK(UTF8CHAR_USERDEF,	LITERAL) /* u8'char'_suffix - C++-0x */		\
138   TK(STRING_USERDEF,	LITERAL) /* "string"_suffix - C++-0x */		\
139   TK(WSTRING_USERDEF,	LITERAL) /* L"string"_suffix - C++-0x */	\
140   TK(STRING16_USERDEF,	LITERAL) /* u"string"_suffix - C++-0x */	\
141   TK(STRING32_USERDEF,	LITERAL) /* U"string"_suffix - C++-0x */	\
142   TK(UTF8STRING_USERDEF,LITERAL) /* u8"string"_suffix - C++-0x */	\
143 									\
144   TK(COMMENT,		LITERAL) /* Only if output comments.  */	\
145 				 /* SPELL_LITERAL happens to DTRT.  */	\
146   TK(MACRO_ARG,		NONE)	 /* Macro argument.  */			\
147   TK(PRAGMA,		NONE)	 /* Only for deferred pragmas.  */	\
148   TK(PRAGMA_EOL,	NONE)	 /* End-of-line for deferred pragmas.  */ \
149   TK(PADDING,		NONE)	 /* Whitespace for -E.	*/
150 
151 #define OP(e, s) CPP_ ## e,
152 #define TK(e, s) CPP_ ## e,
153 enum cpp_ttype
154 {
155   TTYPE_TABLE
156   N_TTYPES,
157 
158   /* A token type for keywords, as opposed to ordinary identifiers.  */
159   CPP_KEYWORD,
160 
161   /* Positions in the table.  */
162   CPP_LAST_EQ        = CPP_LSHIFT,
163   CPP_FIRST_DIGRAPH  = CPP_HASH,
164   CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
165   CPP_LAST_CPP_OP    = CPP_LESS_EQ
166 };
167 #undef OP
168 #undef TK
169 
170 /* C language kind, used when calling cpp_create_reader.  */
171 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_GNUC11,
172 	     CLK_STDC89, CLK_STDC94, CLK_STDC99, CLK_STDC11,
173 	     CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX11, CLK_CXX11,
174 	     CLK_GNUCXX14, CLK_CXX14, CLK_GNUCXX1Z, CLK_CXX1Z, CLK_ASM};
175 
176 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
177 struct GTY(()) cpp_string {
178   unsigned int len;
179   const unsigned char *text;
180 };
181 
182 /* Flags for the cpp_token structure.  */
183 #define PREV_WHITE	(1 << 0) /* If whitespace before this token.  */
184 #define DIGRAPH		(1 << 1) /* If it was a digraph.  */
185 #define STRINGIFY_ARG	(1 << 2) /* If macro argument to be stringified.  */
186 #define PASTE_LEFT	(1 << 3) /* If on LHS of a ## operator.  */
187 #define NAMED_OP	(1 << 4) /* C++ named operators.  */
188 #define PREV_FALLTHROUGH (1 << 5) /* On a token preceeded by FALLTHROUGH
189 				     comment.  */
190 #define BOL		(1 << 6) /* Token at beginning of line.  */
191 #define PURE_ZERO	(1 << 7) /* Single 0 digit, used by the C++ frontend,
192 				    set in c-lex.c.  */
193 #define SP_DIGRAPH	(1 << 8) /* # or ## token was a digraph.  */
194 #define SP_PREV_WHITE	(1 << 9) /* If whitespace before a ##
195 				    operator, or before this token
196 				    after a # operator.  */
197 #define NO_EXPAND	(1 << 10) /* Do not macro-expand this token.  */
198 
199 /* Specify which field, if any, of the cpp_token union is used.  */
200 
201 enum cpp_token_fld_kind {
202   CPP_TOKEN_FLD_NODE,
203   CPP_TOKEN_FLD_SOURCE,
204   CPP_TOKEN_FLD_STR,
205   CPP_TOKEN_FLD_ARG_NO,
206   CPP_TOKEN_FLD_TOKEN_NO,
207   CPP_TOKEN_FLD_PRAGMA,
208   CPP_TOKEN_FLD_NONE
209 };
210 
211 /* A macro argument in the cpp_token union.  */
212 struct GTY(()) cpp_macro_arg {
213   /* Argument number.  */
214   unsigned int arg_no;
215   /* The original spelling of the macro argument token.  */
216   cpp_hashnode *
217     GTY ((nested_ptr (union tree_node,
218 		"%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
219 			"%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
220        spelling;
221 };
222 
223 /* An identifier in the cpp_token union.  */
224 struct GTY(()) cpp_identifier {
225   /* The canonical (UTF-8) spelling of the identifier.  */
226   cpp_hashnode *
227     GTY ((nested_ptr (union tree_node,
228 		"%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
229 			"%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
230        node;
231   /* The original spelling of the identifier.  */
232   cpp_hashnode *
233     GTY ((nested_ptr (union tree_node,
234 		"%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
235 			"%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
236        spelling;
237 };
238 
239 /* A preprocessing token.  This has been carefully packed and should
240    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
241 struct GTY(()) cpp_token {
242   source_location src_loc;	/* Location of first char of token,
243 				   together with range of full token.  */
244   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
245   unsigned short flags;		/* flags - see above */
246 
247   union cpp_token_u
248   {
249     /* An identifier.  */
250     struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node;
251 
252     /* Inherit padding from this token.  */
253     cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
254 
255     /* A string, or number.  */
256     struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
257 
258     /* Argument no. (and original spelling) for a CPP_MACRO_ARG.  */
259     struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg;
260 
261     /* Original token no. for a CPP_PASTE (from a sequence of
262        consecutive paste tokens in a macro expansion).  */
263     unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no;
264 
265     /* Caller-supplied identifier for a CPP_PRAGMA.  */
266     unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
267   } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
268 };
269 
270 /* Say which field is in use.  */
271 extern enum cpp_token_fld_kind cpp_token_val_index (const cpp_token *tok);
272 
273 /* A type wide enough to hold any multibyte source character.
274    cpplib's character constant interpreter requires an unsigned type.
275    Also, a typedef for the signed equivalent.
276    The width of this type is capped at 32 bits; there do exist targets
277    where wchar_t is 64 bits, but only in a non-default mode, and there
278    would be no meaningful interpretation for a wchar_t value greater
279    than 2^32 anyway -- the widest wide-character encoding around is
280    ISO 10646, which stops at 2^31.  */
281 #if CHAR_BIT * SIZEOF_INT >= 32
282 # define CPPCHAR_SIGNED_T int
283 #elif CHAR_BIT * SIZEOF_LONG >= 32
284 # define CPPCHAR_SIGNED_T long
285 #else
286 # error "Cannot find a least-32-bit signed integer type"
287 #endif
288 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
289 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
290 
291 /* Style of header dependencies to generate.  */
292 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
293 
294 /* The possible normalization levels, from most restrictive to least.  */
295 enum cpp_normalize_level {
296   /* In NFKC.  */
297   normalized_KC = 0,
298   /* In NFC.  */
299   normalized_C,
300   /* In NFC, except for subsequences where being in NFC would make
301      the identifier invalid.  */
302   normalized_identifier_C,
303   /* Not normalized at all.  */
304   normalized_none
305 };
306 
307 /* This structure is nested inside struct cpp_reader, and
308    carries all the options visible to the command line.  */
309 struct cpp_options
310 {
311   /* Characters between tab stops.  */
312   unsigned int tabstop;
313 
314   /* The language we're preprocessing.  */
315   enum c_lang lang;
316 
317   /* Nonzero means use extra default include directories for C++.  */
318   unsigned char cplusplus;
319 
320   /* Nonzero means handle cplusplus style comments.  */
321   unsigned char cplusplus_comments;
322 
323   /* Nonzero means define __OBJC__, treat @ as a special token, use
324      the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
325      "#import".  */
326   unsigned char objc;
327 
328   /* Nonzero means don't copy comments into the output file.  */
329   unsigned char discard_comments;
330 
331   /* Nonzero means don't copy comments into the output file during
332      macro expansion.  */
333   unsigned char discard_comments_in_macro_exp;
334 
335   /* Nonzero means process the ISO trigraph sequences.  */
336   unsigned char trigraphs;
337 
338   /* Nonzero means process the ISO digraph sequences.  */
339   unsigned char digraphs;
340 
341   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
342   unsigned char extended_numbers;
343 
344   /* Nonzero means process u/U prefix literals (UTF-16/32).  */
345   unsigned char uliterals;
346 
347   /* Nonzero means process u8 prefixed character literals (UTF-8).  */
348   unsigned char utf8_char_literals;
349 
350   /* Nonzero means process r/R raw strings.  If this is set, uliterals
351      must be set as well.  */
352   unsigned char rliterals;
353 
354   /* Nonzero means print names of header files (-H).  */
355   unsigned char print_include_names;
356 
357   /* Nonzero means complain about deprecated features.  */
358   unsigned char cpp_warn_deprecated;
359 
360   /* Nonzero means warn if slash-star appears in a comment.  */
361   unsigned char warn_comments;
362 
363   /* Nonzero means to warn about __DATA__, __TIME__ and __TIMESTAMP__ usage.   */
364   unsigned char warn_date_time;
365 
366   /* Nonzero means warn if a user-supplied include directory does not
367      exist.  */
368   unsigned char warn_missing_include_dirs;
369 
370   /* Nonzero means warn if there are any trigraphs.  */
371   unsigned char warn_trigraphs;
372 
373   /* Nonzero means warn about multicharacter charconsts.  */
374   unsigned char warn_multichar;
375 
376   /* Nonzero means warn about various incompatibilities with
377      traditional C.  */
378   unsigned char cpp_warn_traditional;
379 
380   /* Nonzero means warn about long long numeric constants.  */
381   unsigned char cpp_warn_long_long;
382 
383   /* Nonzero means warn about text after an #endif (or #else).  */
384   unsigned char warn_endif_labels;
385 
386   /* Nonzero means warn about implicit sign changes owing to integer
387      promotions.  */
388   unsigned char warn_num_sign_change;
389 
390   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
391      Presumably the usage is protected by the appropriate #ifdef.  */
392   unsigned char warn_variadic_macros;
393 
394   /* Nonzero means warn about builtin macros that are redefined or
395      explicitly undefined.  */
396   unsigned char warn_builtin_macro_redefined;
397 
398   /* Different -Wimplicit-fallthrough= levels.  */
399   unsigned char cpp_warn_implicit_fallthrough;
400 
401   /* Nonzero means we should look for header.gcc files that remap file
402      names.  */
403   unsigned char remap;
404 
405   /* Zero means dollar signs are punctuation.  */
406   unsigned char dollars_in_ident;
407 
408   /* Nonzero means UCNs are accepted in identifiers.  */
409   unsigned char extended_identifiers;
410 
411   /* True if we should warn about dollars in identifiers or numbers
412      for this translation unit.  */
413   unsigned char warn_dollars;
414 
415   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
416   unsigned char warn_undef;
417 
418   /* Nonzero means warn if "defined" is encountered in a place other than
419      an #if.  */
420   unsigned char warn_expansion_to_defined;
421 
422   /* Nonzero means warn of unused macros from the main file.  */
423   unsigned char warn_unused_macros;
424 
425   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
426   unsigned char c99;
427 
428   /* Nonzero if we are conforming to a specific C or C++ standard.  */
429   unsigned char std;
430 
431   /* Nonzero means give all the error messages the ANSI standard requires.  */
432   unsigned char cpp_pedantic;
433 
434   /* Nonzero means we're looking at already preprocessed code, so don't
435      bother trying to do macro expansion and whatnot.  */
436   unsigned char preprocessed;
437 
438   /* Nonzero means we are going to emit debugging logs during
439      preprocessing.  */
440   unsigned char debug;
441 
442   /* Nonzero means we are tracking locations of tokens involved in
443      macro expansion. 1 Means we track the location in degraded mode
444      where we do not track locations of tokens resulting from the
445      expansion of arguments of function-like macro.  2 Means we do
446      track all macro expansions. This last option is the one that
447      consumes the highest amount of memory.  */
448   unsigned char track_macro_expansion;
449 
450   /* Nonzero means handle C++ alternate operator names.  */
451   unsigned char operator_names;
452 
453   /* Nonzero means warn about use of C++ alternate operator names.  */
454   unsigned char warn_cxx_operator_names;
455 
456   /* True for traditional preprocessing.  */
457   unsigned char traditional;
458 
459   /* Nonzero for C++ 2011 Standard user-defined literals.  */
460   unsigned char user_literals;
461 
462   /* Nonzero means warn when a string or character literal is followed by a
463      ud-suffix which does not beging with an underscore.  */
464   unsigned char warn_literal_suffix;
465 
466   /* Nonzero means interpret imaginary, fixed-point, or other gnu extension
467      literal number suffixes as user-defined literal number suffixes.  */
468   unsigned char ext_numeric_literals;
469 
470   /* Nonzero means extended identifiers allow the characters specified
471      in C11 and C++11.  */
472   unsigned char c11_identifiers;
473 
474   /* Nonzero for C++ 2014 Standard binary constants.  */
475   unsigned char binary_constants;
476 
477   /* Nonzero for C++ 2014 Standard digit separators.  */
478   unsigned char digit_separators;
479 
480   /* Holds the name of the target (execution) character set.  */
481   const char *narrow_charset;
482 
483   /* Holds the name of the target wide character set.  */
484   const char *wide_charset;
485 
486   /* Holds the name of the input character set.  */
487   const char *input_charset;
488 
489   /* The minimum permitted level of normalization before a warning
490      is generated.  See enum cpp_normalize_level.  */
491   int warn_normalize;
492 
493   /* True to warn about precompiled header files we couldn't use.  */
494   bool warn_invalid_pch;
495 
496   /* True if dependencies should be restored from a precompiled header.  */
497   bool restore_pch_deps;
498 
499   /* True if warn about differences between C90 and C99.  */
500   signed char cpp_warn_c90_c99_compat;
501 
502   /* True if warn about differences between C++98 and C++11.  */
503   bool cpp_warn_cxx11_compat;
504 
505   /* Dependency generation.  */
506   struct
507   {
508     /* Style of header dependencies to generate.  */
509     enum cpp_deps_style style;
510 
511     /* Assume missing files are generated files.  */
512     bool missing_files;
513 
514     /* Generate phony targets for each dependency apart from the first
515        one.  */
516     bool phony_targets;
517 
518     /* If true, no dependency is generated on the main file.  */
519     bool ignore_main_file;
520 
521     /* If true, intend to use the preprocessor output (e.g., for compilation)
522        in addition to the dependency info.  */
523     bool need_preprocessor_output;
524   } deps;
525 
526   /* Target-specific features set by the front end or client.  */
527 
528   /* Precision for target CPP arithmetic, target characters, target
529      ints and target wide characters, respectively.  */
530   size_t precision, char_precision, int_precision, wchar_precision;
531 
532   /* True means chars (wide chars) are unsigned.  */
533   bool unsigned_char, unsigned_wchar;
534 
535   /* True if the most significant byte in a word has the lowest
536      address in memory.  */
537   bool bytes_big_endian;
538 
539   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
540   unsigned char stdc_0_in_system_headers;
541 
542   /* True disables tokenization outside of preprocessing directives. */
543   bool directives_only;
544 
545   /* True enables canonicalization of system header file paths. */
546   bool canonical_system_headers;
547 };
548 
549 /* Callback for header lookup for HEADER, which is the name of a
550    source file.  It is used as a method of last resort to find headers
551    that are not otherwise found during the normal include processing.
552    The return value is the malloced name of a header to try and open,
553    if any, or NULL otherwise.  This callback is called only if the
554    header is otherwise unfound.  */
555 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
556 
557 /* Call backs to cpplib client.  */
558 struct cpp_callbacks
559 {
560   /* Called when a new line of preprocessed output is started.  */
561   void (*line_change) (cpp_reader *, const cpp_token *, int);
562 
563   /* Called when switching to/from a new file.
564      The line_map is for the new file.  It is NULL if there is no new file.
565      (In C this happens when done with <built-in>+<command line> and also
566      when done with a main file.)  This can be used for resource cleanup.  */
567   void (*file_change) (cpp_reader *, const line_map_ordinary *);
568 
569   void (*dir_change) (cpp_reader *, const char *);
570   void (*include) (cpp_reader *, source_location, const unsigned char *,
571 		   const char *, int, const cpp_token **);
572   void (*define) (cpp_reader *, source_location, cpp_hashnode *);
573   void (*undef) (cpp_reader *, source_location, cpp_hashnode *);
574   void (*ident) (cpp_reader *, source_location, const cpp_string *);
575   void (*def_pragma) (cpp_reader *, source_location);
576   int (*valid_pch) (cpp_reader *, const char *, int);
577   void (*read_pch) (cpp_reader *, const char *, int, const char *);
578   missing_header_cb missing_header;
579 
580   /* Context-sensitive macro support.  Returns macro (if any) that should
581      be expanded.  */
582   cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
583 
584   /* Called to emit a diagnostic.  This callback receives the
585      translated message.  */
586   bool (*error) (cpp_reader *, int, int, rich_location *,
587 		 const char *, va_list *)
588        ATTRIBUTE_FPTR_PRINTF(5,0);
589 
590   /* Callbacks for when a macro is expanded, or tested (whether
591      defined or not at the time) in #ifdef, #ifndef or "defined".  */
592   void (*used_define) (cpp_reader *, source_location, cpp_hashnode *);
593   void (*used_undef) (cpp_reader *, source_location, cpp_hashnode *);
594   /* Called before #define and #undef or other macro definition
595      changes are processed.  */
596   void (*before_define) (cpp_reader *);
597   /* Called whenever a macro is expanded or tested.
598      Second argument is the location of the start of the current expansion.  */
599   void (*used) (cpp_reader *, source_location, cpp_hashnode *);
600 
601   /* Callback to identify whether an attribute exists.  */
602   int (*has_attribute) (cpp_reader *);
603 
604   /* Callback that can change a user builtin into normal macro.  */
605   bool (*user_builtin_macro) (cpp_reader *, cpp_hashnode *);
606 
607   /* Callback to parse SOURCE_DATE_EPOCH from environment.  */
608   time_t (*get_source_date_epoch) (cpp_reader *);
609 
610   /* Callback for providing suggestions for misspelled directives.  */
611   const char *(*get_suggestion) (cpp_reader *, const char *, const char *const *);
612 };
613 
614 #ifdef VMS
615 #define INO_T_CPP ino_t ino[3]
616 #else
617 #define INO_T_CPP ino_t ino
618 #endif
619 
620 /* Chain of directories to look for include files in.  */
621 struct cpp_dir
622 {
623   /* NULL-terminated singly-linked list.  */
624   struct cpp_dir *next;
625 
626   /* NAME of the directory, NUL-terminated.  */
627   char *name;
628   unsigned int len;
629 
630   /* One if a system header, two if a system header that has extern
631      "C" guards for C++.  */
632   unsigned char sysp;
633 
634   /* Is this a user-supplied directory? */
635   bool user_supplied_p;
636 
637   /* The canonicalized NAME as determined by lrealpath.  This field
638      is only used by hosts that lack reliable inode numbers.  */
639   char *canonical_name;
640 
641   /* Mapping of file names for this directory for MS-DOS and related
642      platforms.  A NULL-terminated array of (from, to) pairs.  */
643   const char **name_map;
644 
645   /* Routine to construct pathname, given the search path name and the
646      HEADER we are trying to find, return a constructed pathname to
647      try and open.  If this is NULL, the constructed pathname is as
648      constructed by append_file_to_dir.  */
649   char *(*construct) (const char *header, cpp_dir *dir);
650 
651   /* The C front end uses these to recognize duplicated
652      directories in the search path.  */
653   INO_T_CPP;
654   dev_t dev;
655 };
656 
657 /* The structure of a node in the hash table.  The hash table has
658    entries for all identifiers: either macros defined by #define
659    commands (type NT_MACRO), assertions created with #assert
660    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
661    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
662    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
663    identifier that behaves like an operator such as "xor".
664    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
665    diagnostic may be required for this node.  Currently this only
666    applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat
667    warnings about NODE_OPERATOR.  */
668 
669 /* Hash node flags.  */
670 #define NODE_OPERATOR	(1 << 0)	/* C++ named operator.  */
671 #define NODE_POISONED	(1 << 1)	/* Poisoned identifier.  */
672 #define NODE_BUILTIN	(1 << 2)	/* Builtin macro.  */
673 #define NODE_DIAGNOSTIC (1 << 3)	/* Possible diagnostic when lexed.  */
674 #define NODE_WARN	(1 << 4)	/* Warn if redefined or undefined.  */
675 #define NODE_DISABLED	(1 << 5)	/* A disabled macro.  */
676 #define NODE_MACRO_ARG	(1 << 6)	/* Used during #define processing.  */
677 #define NODE_USED	(1 << 7)	/* Dumped with -dU.  */
678 #define NODE_CONDITIONAL (1 << 8)	/* Conditional macro */
679 #define NODE_WARN_OPERATOR (1 << 9)	/* Warn about C++ named operator.  */
680 
681 /* Different flavors of hash node.  */
682 enum node_type
683 {
684   NT_VOID = 0,	   /* No definition yet.  */
685   NT_MACRO,	   /* A macro of some form.  */
686   NT_ASSERTION	   /* Predicate for #assert.  */
687 };
688 
689 /* Different flavors of builtin macro.  _Pragma is an operator, but we
690    handle it with the builtin code for efficiency reasons.  */
691 enum cpp_builtin_type
692 {
693   BT_SPECLINE = 0,		/* `__LINE__' */
694   BT_DATE,			/* `__DATE__' */
695   BT_FILE,			/* `__FILE__' */
696   BT_BASE_FILE,			/* `__BASE_FILE__' */
697   BT_INCLUDE_LEVEL,		/* `__INCLUDE_LEVEL__' */
698   BT_TIME,			/* `__TIME__' */
699   BT_STDC,			/* `__STDC__' */
700   BT_PRAGMA,			/* `_Pragma' operator */
701   BT_TIMESTAMP,			/* `__TIMESTAMP__' */
702   BT_COUNTER,			/* `__COUNTER__' */
703   BT_HAS_ATTRIBUTE,		/* `__has_attribute__(x)' */
704   BT_FIRST_USER,		/* User defined builtin macros.  */
705   BT_LAST_USER = BT_FIRST_USER + 63
706 };
707 
708 #define CPP_HASHNODE(HNODE)	((cpp_hashnode *) (HNODE))
709 #define HT_NODE(NODE)		((ht_identifier *) (NODE))
710 #define NODE_LEN(NODE)		HT_LEN (&(NODE)->ident)
711 #define NODE_NAME(NODE)		HT_STR (&(NODE)->ident)
712 
713 /* Specify which field, if any, of the union is used.  */
714 
715 enum {
716   NTV_MACRO,
717   NTV_ANSWER,
718   NTV_BUILTIN,
719   NTV_ARGUMENT,
720   NTV_NONE
721 };
722 
723 #define CPP_HASHNODE_VALUE_IDX(HNODE)				\
724   ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT		\
725    : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) 	\
726 			       ? NTV_BUILTIN : NTV_MACRO)	\
727    : HNODE.type == NT_ASSERTION ? NTV_ANSWER			\
728    : NTV_NONE)
729 
730 /* The common part of an identifier node shared amongst all 3 C front
731    ends.  Also used to store CPP identifiers, which are a superset of
732    identifiers in the grammatical sense.  */
733 
734 union GTY(()) _cpp_hashnode_value {
735   /* If a macro.  */
736   cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
737   /* Answers to an assertion.  */
738   struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
739   /* Code for a builtin macro.  */
740   enum cpp_builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
741   /* Macro argument index.  */
742   unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
743 };
744 
745 struct GTY(()) cpp_hashnode {
746   struct ht_identifier ident;
747   unsigned int is_directive : 1;
748   unsigned int directive_index : 7;	/* If is_directive,
749 					   then index into directive table.
750 					   Otherwise, a NODE_OPERATOR.  */
751   unsigned char rid_code;		/* Rid code - for front ends.  */
752   ENUM_BITFIELD(node_type) type : 6;	/* CPP node type.  */
753   unsigned int flags : 10;		/* CPP flags.  */
754 
755   union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
756 };
757 
758 /* A class for iterating through the source locations within a
759    string token (before escapes are interpreted, and before
760    concatenation).  */
761 
762 class cpp_string_location_reader {
763  public:
764   cpp_string_location_reader (source_location src_loc,
765 			      line_maps *line_table);
766 
767   source_range get_next ();
768 
769  private:
770   source_location m_loc;
771   int m_offset_per_column;
772   line_maps *m_line_table;
773 };
774 
775 /* A class for storing the source ranges of all of the characters within
776    a string literal, after escapes are interpreted, and after
777    concatenation.
778 
779    This is not GTY-marked, as instances are intended to be temporary.  */
780 
781 class cpp_substring_ranges
782 {
783  public:
784   cpp_substring_ranges ();
785   ~cpp_substring_ranges ();
786 
787   int get_num_ranges () const { return m_num_ranges; }
788   source_range get_range (int idx) const
789   {
790     linemap_assert (idx < m_num_ranges);
791     return m_ranges[idx];
792   }
793 
794   void add_range (source_range range);
795   void add_n_ranges (int num, cpp_string_location_reader &loc_reader);
796 
797  private:
798   source_range *m_ranges;
799   int m_num_ranges;
800   int m_alloc_ranges;
801 };
802 
803 /* Call this first to get a handle to pass to other functions.
804 
805    If you want cpplib to manage its own hashtable, pass in a NULL
806    pointer.  Otherwise you should pass in an initialized hash table
807    that cpplib will share; this technique is used by the C front
808    ends.  */
809 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
810 				      struct line_maps *);
811 
812 /* Reset the cpp_reader's line_map.  This is only used after reading a
813    PCH file.  */
814 extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
815 
816 /* Call this to change the selected language standard (e.g. because of
817    command line options).  */
818 extern void cpp_set_lang (cpp_reader *, enum c_lang);
819 
820 /* Set the include paths.  */
821 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
822 
823 /* Provide src:dst pair for __FILE__ remapping.  */
824 extern void add_cpp_remap_path (const char *);
825 
826 /* Call these to get pointers to the options, callback, and deps
827    structures for a given reader.  These pointers are good until you
828    call cpp_finish on that reader.  You can either edit the callbacks
829    through the pointer returned from cpp_get_callbacks, or set them
830    with cpp_set_callbacks.  */
831 extern cpp_options *cpp_get_options (cpp_reader *);
832 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
833 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
834 extern struct deps *cpp_get_deps (cpp_reader *);
835 
836 /* This function reads the file, but does not start preprocessing.  It
837    returns the name of the original file; this is the same as the
838    input file, except for preprocessed input.  This will generate at
839    least one file change callback, and possibly a line change callback
840    too.  If there was an error opening the file, it returns NULL.  */
841 extern const char *cpp_read_main_file (cpp_reader *, const char *);
842 
843 /* Set up built-ins with special behavior.  Use cpp_init_builtins()
844    instead unless your know what you are doing.  */
845 extern void cpp_init_special_builtins (cpp_reader *);
846 
847 /* Set up built-ins like __FILE__.  */
848 extern void cpp_init_builtins (cpp_reader *, int);
849 
850 /* This is called after options have been parsed, and partially
851    processed.  */
852 extern void cpp_post_options (cpp_reader *);
853 
854 /* Set up translation to the target character set.  */
855 extern void cpp_init_iconv (cpp_reader *);
856 
857 /* Call this to finish preprocessing.  If you requested dependency
858    generation, pass an open stream to write the information to,
859    otherwise NULL.  It is your responsibility to close the stream.  */
860 extern void cpp_finish (cpp_reader *, FILE *deps_stream);
861 
862 /* Call this to release the handle at the end of preprocessing.  Any
863    use of the handle after this function returns is invalid.  */
864 extern void cpp_destroy (cpp_reader *);
865 
866 extern unsigned int cpp_token_len (const cpp_token *);
867 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
868 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
869 				       unsigned char *, bool);
870 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
871 				 void (*) (cpp_reader *), bool);
872 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
873 					  const char *, unsigned, bool, bool);
874 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
875 			    const cpp_token *);
876 extern const cpp_token *cpp_get_token (cpp_reader *);
877 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
878 						     source_location *);
879 extern bool cpp_fun_like_macro_p (cpp_hashnode *);
880 extern const unsigned char *cpp_macro_definition (cpp_reader *,
881 						  cpp_hashnode *);
882 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
883 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
884 
885 /* Evaluate a CPP_*CHAR* token.  */
886 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
887 					  unsigned int *, int *);
888 /* Evaluate a vector of CPP_*STRING* tokens.  */
889 extern bool cpp_interpret_string (cpp_reader *,
890 				  const cpp_string *, size_t,
891 				  cpp_string *, enum cpp_ttype);
892 extern const char *cpp_interpret_string_ranges (cpp_reader *pfile,
893 						const cpp_string *from,
894 						cpp_string_location_reader *,
895 						size_t count,
896 						cpp_substring_ranges *out,
897 						enum cpp_ttype type);
898 extern bool cpp_interpret_string_notranslate (cpp_reader *,
899 					      const cpp_string *, size_t,
900 					      cpp_string *, enum cpp_ttype);
901 
902 /* Convert a host character constant to the execution character set.  */
903 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
904 
905 /* Used to register macros and assertions, perhaps from the command line.
906    The text is the same as the command line argument.  */
907 extern void cpp_define (cpp_reader *, const char *);
908 extern void cpp_define_formatted (cpp_reader *pfile,
909 				  const char *fmt, ...) ATTRIBUTE_PRINTF_2;
910 extern void cpp_assert (cpp_reader *, const char *);
911 extern void cpp_undef (cpp_reader *, const char *);
912 extern void cpp_unassert (cpp_reader *, const char *);
913 
914 /* Undefine all macros and assertions.  */
915 extern void cpp_undef_all (cpp_reader *);
916 
917 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
918 				    size_t, int);
919 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
920 
921 /* A preprocessing number.  Code assumes that any unused high bits of
922    the double integer are set to zero.  */
923 
924 /* This type has to be equal to unsigned HOST_WIDE_INT, see
925    gcc/c-family/c-lex.c.  */
926 typedef uint64_t cpp_num_part;
927 typedef struct cpp_num cpp_num;
928 struct cpp_num
929 {
930   cpp_num_part high;
931   cpp_num_part low;
932   bool unsignedp;  /* True if value should be treated as unsigned.  */
933   bool overflow;   /* True if the most recent calculation overflowed.  */
934 };
935 
936 /* cpplib provides two interfaces for interpretation of preprocessing
937    numbers.
938 
939    cpp_classify_number categorizes numeric constants according to
940    their field (integer, floating point, or invalid), radix (decimal,
941    octal, hexadecimal), and type suffixes.  */
942 
943 #define CPP_N_CATEGORY  0x000F
944 #define CPP_N_INVALID	0x0000
945 #define CPP_N_INTEGER	0x0001
946 #define CPP_N_FLOATING	0x0002
947 
948 #define CPP_N_WIDTH	0x00F0
949 #define CPP_N_SMALL	0x0010	/* int, float, short _Fract/Accum  */
950 #define CPP_N_MEDIUM	0x0020	/* long, double, long _Fract/_Accum.  */
951 #define CPP_N_LARGE	0x0040	/* long long, long double,
952 				   long long _Fract/Accum.  */
953 
954 #define CPP_N_WIDTH_MD	0xF0000	/* machine defined.  */
955 #define CPP_N_MD_W	0x10000
956 #define CPP_N_MD_Q	0x20000
957 
958 #define CPP_N_RADIX	0x0F00
959 #define CPP_N_DECIMAL	0x0100
960 #define CPP_N_HEX	0x0200
961 #define CPP_N_OCTAL	0x0400
962 #define CPP_N_BINARY	0x0800
963 
964 #define CPP_N_UNSIGNED	0x1000	/* Properties.  */
965 #define CPP_N_IMAGINARY	0x2000
966 #define CPP_N_DFLOAT	0x4000
967 #define CPP_N_DEFAULT	0x8000
968 
969 #define CPP_N_FRACT	0x100000 /* Fract types.  */
970 #define CPP_N_ACCUM	0x200000 /* Accum types.  */
971 #define CPP_N_FLOATN	0x400000 /* _FloatN types.  */
972 #define CPP_N_FLOATNX	0x800000 /* _FloatNx types.  */
973 
974 #define CPP_N_USERDEF	0x1000000 /* C++0x user-defined literal.  */
975 
976 #define CPP_N_WIDTH_FLOATN_NX	0xF0000000 /* _FloatN / _FloatNx value
977 					      of N, divided by 16.  */
978 #define CPP_FLOATN_SHIFT	24
979 #define CPP_FLOATN_MAX	0xF0
980 
981 /* Classify a CPP_NUMBER token.  The return value is a combination of
982    the flags from the above sets.  */
983 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *,
984 				     const char **, source_location);
985 
986 /* Return the classification flags for a float suffix.  */
987 extern unsigned int cpp_interpret_float_suffix (cpp_reader *, const char *,
988 						size_t);
989 
990 /* Return the classification flags for an int suffix.  */
991 extern unsigned int cpp_interpret_int_suffix (cpp_reader *, const char *,
992 					      size_t);
993 
994 /* Evaluate a token classified as category CPP_N_INTEGER.  */
995 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
996 				      unsigned int);
997 
998 /* Sign extend a number, with PRECISION significant bits and all
999    others assumed clear, to fill out a cpp_num structure.  */
1000 cpp_num cpp_num_sign_extend (cpp_num, size_t);
1001 
1002 /* Diagnostic levels.  To get a diagnostic without associating a
1003    position in the translation unit with it, use cpp_error_with_line
1004    with a line number of zero.  */
1005 
1006 enum {
1007   /* Warning, an error with -Werror.  */
1008   CPP_DL_WARNING = 0,
1009   /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
1010   CPP_DL_WARNING_SYSHDR,
1011   /* Warning, an error with -pedantic-errors or -Werror.  */
1012   CPP_DL_PEDWARN,
1013   /* An error.  */
1014   CPP_DL_ERROR,
1015   /* An internal consistency check failed.  Prints "internal error: ",
1016      otherwise the same as CPP_DL_ERROR.  */
1017   CPP_DL_ICE,
1018   /* An informative note following a warning.  */
1019   CPP_DL_NOTE,
1020   /* A fatal error.  */
1021   CPP_DL_FATAL
1022 };
1023 
1024 /* Warning reason codes. Use a reason code of zero for unclassified warnings
1025    and errors that are not warnings.  */
1026 enum {
1027   CPP_W_NONE = 0,
1028   CPP_W_DEPRECATED,
1029   CPP_W_COMMENTS,
1030   CPP_W_MISSING_INCLUDE_DIRS,
1031   CPP_W_TRIGRAPHS,
1032   CPP_W_MULTICHAR,
1033   CPP_W_TRADITIONAL,
1034   CPP_W_LONG_LONG,
1035   CPP_W_ENDIF_LABELS,
1036   CPP_W_NUM_SIGN_CHANGE,
1037   CPP_W_VARIADIC_MACROS,
1038   CPP_W_BUILTIN_MACRO_REDEFINED,
1039   CPP_W_DOLLARS,
1040   CPP_W_UNDEF,
1041   CPP_W_UNUSED_MACROS,
1042   CPP_W_CXX_OPERATOR_NAMES,
1043   CPP_W_NORMALIZE,
1044   CPP_W_INVALID_PCH,
1045   CPP_W_WARNING_DIRECTIVE,
1046   CPP_W_LITERAL_SUFFIX,
1047   CPP_W_DATE_TIME,
1048   CPP_W_PEDANTIC,
1049   CPP_W_C90_C99_COMPAT,
1050   CPP_W_CXX11_COMPAT,
1051   CPP_W_EXPANSION_TO_DEFINED
1052 };
1053 
1054 /* Output a diagnostic of some kind.  */
1055 extern bool cpp_error (cpp_reader *, int, const char *msgid, ...)
1056   ATTRIBUTE_PRINTF_3;
1057 extern bool cpp_warning (cpp_reader *, int, const char *msgid, ...)
1058   ATTRIBUTE_PRINTF_3;
1059 extern bool cpp_pedwarning (cpp_reader *, int, const char *msgid, ...)
1060   ATTRIBUTE_PRINTF_3;
1061 extern bool cpp_warning_syshdr (cpp_reader *, int, const char *msgid, ...)
1062   ATTRIBUTE_PRINTF_3;
1063 
1064 /* Output a diagnostic with "MSGID: " preceding the
1065    error string of errno.  No location is printed.  */
1066 extern bool cpp_errno (cpp_reader *, int, const char *msgid);
1067 /* Similarly, but with "FILENAME: " instead of "MSGID: ", where
1068    the filename is not localized.  */
1069 extern bool cpp_errno_filename (cpp_reader *, int, const char *filename,
1070 				source_location loc);
1071 
1072 /* Same as cpp_error, except additionally specifies a position as a
1073    (translation unit) physical line and physical column.  If the line is
1074    zero, then no location is printed.  */
1075 extern bool cpp_error_with_line (cpp_reader *, int, source_location,
1076                                  unsigned, const char *msgid, ...)
1077   ATTRIBUTE_PRINTF_5;
1078 extern bool cpp_warning_with_line (cpp_reader *, int, source_location,
1079                                    unsigned, const char *msgid, ...)
1080   ATTRIBUTE_PRINTF_5;
1081 extern bool cpp_pedwarning_with_line (cpp_reader *, int, source_location,
1082                                       unsigned, const char *msgid, ...)
1083   ATTRIBUTE_PRINTF_5;
1084 extern bool cpp_warning_with_line_syshdr (cpp_reader *, int, source_location,
1085                                           unsigned, const char *msgid, ...)
1086   ATTRIBUTE_PRINTF_5;
1087 
1088 extern bool cpp_error_at (cpp_reader * pfile, int level,
1089 			  source_location src_loc, const char *msgid, ...)
1090   ATTRIBUTE_PRINTF_4;
1091 
1092 extern bool cpp_error_at_richloc (cpp_reader * pfile, int level,
1093 				  rich_location *richloc, const char *msgid,
1094 				  ...)
1095   ATTRIBUTE_PRINTF_4;
1096 
1097 /* In lex.c */
1098 extern int cpp_ideq (const cpp_token *, const char *);
1099 extern void cpp_output_line (cpp_reader *, FILE *);
1100 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
1101 						 const unsigned char *);
1102 extern void cpp_output_token (const cpp_token *, FILE *);
1103 extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
1104 /* Returns the value of an escape sequence, truncated to the correct
1105    target precision.  PSTR points to the input pointer, which is just
1106    after the backslash.  LIMIT is how much text we have.  WIDE is true
1107    if the escape sequence is part of a wide character constant or
1108    string literal.  Handles all relevant diagnostics.  */
1109 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
1110 				   const unsigned char *limit, int wide);
1111 
1112 /* Structure used to hold a comment block at a given location in the
1113    source code.  */
1114 
1115 typedef struct
1116 {
1117   /* Text of the comment including the terminators.  */
1118   char *comment;
1119 
1120   /* source location for the given comment.  */
1121   source_location sloc;
1122 } cpp_comment;
1123 
1124 /* Structure holding all comments for a given cpp_reader.  */
1125 
1126 typedef struct
1127 {
1128   /* table of comment entries.  */
1129   cpp_comment *entries;
1130 
1131   /* number of actual entries entered in the table.  */
1132   int count;
1133 
1134   /* number of entries allocated currently.  */
1135   int allocated;
1136 } cpp_comment_table;
1137 
1138 /* Returns the table of comments encountered by the preprocessor. This
1139    table is only populated when pfile->state.save_comments is true. */
1140 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
1141 
1142 /* In hash.c */
1143 
1144 /* Lookup an identifier in the hashtable.  Puts the identifier in the
1145    table if it is not already there.  */
1146 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
1147 				 unsigned int);
1148 
1149 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
1150 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
1151 
1152 /* In macro.c */
1153 extern void cpp_scan_nooutput (cpp_reader *);
1154 extern int  cpp_sys_macro_p (cpp_reader *);
1155 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
1156 					unsigned int);
1157 
1158 /* In files.c */
1159 extern bool cpp_included (cpp_reader *, const char *);
1160 extern bool cpp_included_before (cpp_reader *, const char *, source_location);
1161 extern void cpp_make_system_header (cpp_reader *, int, int);
1162 extern bool cpp_push_include (cpp_reader *, const char *);
1163 extern bool cpp_push_default_include (cpp_reader *, const char *);
1164 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
1165 extern const char *cpp_get_path (struct _cpp_file *);
1166 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
1167 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
1168 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
1169 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
1170 extern void cpp_clear_file_cache (cpp_reader *);
1171 
1172 /* In pch.c */
1173 struct save_macro_data;
1174 extern int cpp_save_state (cpp_reader *, FILE *);
1175 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
1176 extern int cpp_write_pch_state (cpp_reader *, FILE *);
1177 extern int cpp_valid_state (cpp_reader *, const char *, int);
1178 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
1179 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
1180 			   struct save_macro_data *);
1181 
1182 /* In lex.c */
1183 extern void cpp_force_token_locations (cpp_reader *, source_location *);
1184 extern void cpp_stop_forcing_token_locations (cpp_reader *);
1185 
1186 /* In expr.c */
1187 extern enum cpp_ttype cpp_userdef_string_remove_type
1188   (enum cpp_ttype type);
1189 extern enum cpp_ttype cpp_userdef_string_add_type
1190   (enum cpp_ttype type);
1191 extern enum cpp_ttype cpp_userdef_char_remove_type
1192   (enum cpp_ttype type);
1193 extern enum cpp_ttype cpp_userdef_char_add_type
1194   (enum cpp_ttype type);
1195 extern bool cpp_userdef_string_p
1196   (enum cpp_ttype type);
1197 extern bool cpp_userdef_char_p
1198   (enum cpp_ttype type);
1199 extern const char * cpp_get_userdef_suffix
1200   (const cpp_token *);
1201 
1202 #endif /* ! LIBCPP_CPPLIB_H */
1203