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