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