1 /* Definitions for CPP library.
2 Copyright (C) 1995-2021 Free Software Foundation, Inc.
3 Written by Per Bothner, 1994-95.
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
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.
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/>.
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
25 #include <sys/types.h>
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;
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.
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 ">>".
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. */
55 OP(GREATER, ">") /* compare */ \
57 OP(PLUS, "+") /* math */ \
62 OP(AND, "&") /* bit ops */ \
69 OP(AND_AND, "&&") /* logical */ \
73 OP(COMMA, ",") /* grouping */ \
75 OP(CLOSE_PAREN, ")") \
77 OP(EQ_EQ, "==") /* compare */ \
79 OP(GREATER_EQ, ">=") \
81 OP(SPACESHIP, "<=>") \
83 /* These two are unary + / - in preprocessor expressions. */ \
84 OP(PLUS_EQ, "+=") /* math */ \
90 OP(AND_EQ, "&=") /* bit ops */ \
93 OP(RSHIFT_EQ, ">>=") \
94 OP(LSHIFT_EQ, "<<=") \
95 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
96 OP(HASH, "#") /* digraphs */ \
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 */ \
110 OP(DEREF_STAR, "->*") \
112 OP(ATSIGN, "@") /* used in Objective-C */ \
114 TK(NAME, IDENT) /* word */ \
115 TK(AT_NAME, IDENT) /* @word - Objective-C */ \
116 TK(NUMBER, LITERAL) /* 34_be+ta */ \
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 */ \
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 */ \
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 */ \
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. */
151 #define OP(e, s) CPP_ ## e,
152 #define TK(e, s) CPP_ ## e,
158 /* A token type for keywords, as opposed to ordinary identifiers. */
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
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,
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,
179 /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
180 struct GTY(()) cpp_string {
182 const unsigned char *text;
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
193 #define BOL (1 << 6) /* Token at beginning of line. */
194 #define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend,
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. */
202 /* Specify which field, if any, of the cpp_token union is used. */
204 enum cpp_token_fld_kind {
206 CPP_TOKEN_FLD_SOURCE,
208 CPP_TOKEN_FLD_ARG_NO,
209 CPP_TOKEN_FLD_TOKEN_NO,
210 CPP_TOKEN_FLD_PRAGMA,
214 /* A macro argument in the cpp_token union. */
215 struct GTY(()) cpp_macro_arg {
216 /* Argument number. */
218 /* The original spelling of the macro argument token. */
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")))
226 /* An identifier in the cpp_token union. */
227 struct GTY(()) cpp_identifier {
228 /* The canonical (UTF-8) spelling of the identifier. */
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")))
234 /* The original spelling of the identifier. */
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")))
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 {
246 /* Location of first char of token, together with range of full token. */
249 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
250 unsigned short flags; /* flags - see above */
255 struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node;
257 /* Inherit padding from this token. */
258 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
260 /* A string, or number. */
261 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
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;
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;
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;
275 /* Say which field is in use. */
276 extern enum cpp_token_fld_kind cpp_token_val_index (const cpp_token *tok);
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
291 # error "Cannot find a least-32-bit signed integer type"
293 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
294 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
296 /* Style of header dependencies to generate. */
297 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
299 /* The possible normalization levels, from most restrictive to least. */
300 enum cpp_normalize_level {
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. */
314 CMS_none, /* A regular source file. */
315 CMS_header, /* Is a directly-specified header file (eg PCH or
317 CMS_user, /* Search the user INCLUDE path. */
318 CMS_system, /* Search the system INCLUDE path. */
321 /* This structure is nested inside struct cpp_reader, and
322 carries all the options visible to the command line. */
325 /* The language we're preprocessing. */
328 /* Nonzero means use extra default include directories for C++. */
329 unsigned char cplusplus;
331 /* Nonzero means handle cplusplus style comments. */
332 unsigned char cplusplus_comments;
334 /* Nonzero means define __OBJC__, treat @ as a special token, use
335 the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
339 /* Nonzero means don't copy comments into the output file. */
340 unsigned char discard_comments;
342 /* Nonzero means don't copy comments into the output file during
344 unsigned char discard_comments_in_macro_exp;
346 /* Nonzero means process the ISO trigraph sequences. */
347 unsigned char trigraphs;
349 /* Nonzero means process the ISO digraph sequences. */
350 unsigned char digraphs;
352 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
353 unsigned char extended_numbers;
355 /* Nonzero means process u/U prefix literals (UTF-16/32). */
356 unsigned char uliterals;
358 /* Nonzero means process u8 prefixed character literals (UTF-8). */
359 unsigned char utf8_char_literals;
361 /* Nonzero means process r/R raw strings. If this is set, uliterals
362 must be set as well. */
363 unsigned char rliterals;
365 /* Nonzero means print names of header files (-H). */
366 unsigned char print_include_names;
368 /* Nonzero means complain about deprecated features. */
369 unsigned char cpp_warn_deprecated;
371 /* Nonzero means warn if slash-star appears in a comment. */
372 unsigned char warn_comments;
374 /* Nonzero means to warn about __DATA__, __TIME__ and __TIMESTAMP__ usage. */
375 unsigned char warn_date_time;
377 /* Nonzero means warn if a user-supplied include directory does not
379 unsigned char warn_missing_include_dirs;
381 /* Nonzero means warn if there are any trigraphs. */
382 unsigned char warn_trigraphs;
384 /* Nonzero means warn about multicharacter charconsts. */
385 unsigned char warn_multichar;
387 /* Nonzero means warn about various incompatibilities with
389 unsigned char cpp_warn_traditional;
391 /* Nonzero means warn about long long numeric constants. */
392 unsigned char cpp_warn_long_long;
394 /* Nonzero means warn about text after an #endif (or #else). */
395 unsigned char warn_endif_labels;
397 /* Nonzero means warn about implicit sign changes owing to integer
399 unsigned char warn_num_sign_change;
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;
405 /* Nonzero means warn about builtin macros that are redefined or
406 explicitly undefined. */
407 unsigned char warn_builtin_macro_redefined;
409 /* Different -Wimplicit-fallthrough= levels. */
410 unsigned char cpp_warn_implicit_fallthrough;
412 /* Nonzero means we should look for header.gcc files that remap file
416 /* Zero means dollar signs are punctuation. */
417 unsigned char dollars_in_ident;
419 /* Nonzero means UCNs are accepted in identifiers. */
420 unsigned char extended_identifiers;
422 /* True if we should warn about dollars in identifiers or numbers
423 for this translation unit. */
424 unsigned char warn_dollars;
426 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
427 unsigned char warn_undef;
429 /* Nonzero means warn if "defined" is encountered in a place other than
431 unsigned char warn_expansion_to_defined;
433 /* Nonzero means warn of unused macros from the main file. */
434 unsigned char warn_unused_macros;
436 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
439 /* Nonzero if we are conforming to a specific C or C++ standard. */
442 /* Nonzero means give all the error messages the ANSI standard requires. */
443 unsigned char cpp_pedantic;
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;
449 /* Nonzero means we are going to emit debugging logs during
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;
461 /* Nonzero means handle C++ alternate operator names. */
462 unsigned char operator_names;
464 /* Nonzero means warn about use of C++ alternate operator names. */
465 unsigned char warn_cxx_operator_names;
467 /* True for traditional preprocessing. */
468 unsigned char traditional;
470 /* Nonzero for C++ 2011 Standard user-defined literals. */
471 unsigned char user_literals;
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;
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;
481 /* Nonzero means extended identifiers allow the characters specified
483 unsigned char c11_identifiers;
485 /* Nonzero for C++ 2014 Standard binary constants. */
486 unsigned char binary_constants;
488 /* Nonzero for C++ 2014 Standard digit separators. */
489 unsigned char digit_separators;
491 /* Nonzero for C2X decimal floating-point constants. */
492 unsigned char dfp_constants;
494 /* Nonzero for C++20 __VA_OPT__ feature. */
495 unsigned char va_opt;
497 /* Nonzero for the '::' token. */
500 /* Nonzero for the '#elifdef' and '#elifndef' directives. */
501 unsigned char elifdef;
503 /* Nonzero means tokenize C++20 module directives. */
504 unsigned char module_directives;
506 /* Nonzero for C++23 size_t literals. */
507 unsigned char size_t_literals;
509 /* Holds the name of the target (execution) character set. */
510 const char *narrow_charset;
512 /* Holds the name of the target wide character set. */
513 const char *wide_charset;
515 /* Holds the name of the input character set. */
516 const char *input_charset;
518 /* The minimum permitted level of normalization before a warning
519 is generated. See enum cpp_normalize_level. */
522 /* True to warn about precompiled header files we couldn't use. */
523 bool warn_invalid_pch;
525 /* True if dependencies should be restored from a precompiled header. */
526 bool restore_pch_deps;
528 /* True if warn about differences between C90 and C99. */
529 signed char cpp_warn_c90_c99_compat;
531 /* True if warn about differences between C11 and C2X. */
532 signed char cpp_warn_c11_c2x_compat;
534 /* True if warn about differences between C++98 and C++11. */
535 bool cpp_warn_cxx11_compat;
537 /* Dependency generation. */
540 /* Style of header dependencies to generate. */
541 enum cpp_deps_style style;
543 /* Assume missing files are generated files. */
546 /* Generate phony targets for each dependency apart from the first
550 /* Generate dependency info for modules. */
553 /* If true, no dependency is generated on the main file. */
554 bool ignore_main_file;
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;
561 /* Target-specific features set by the front end or client. */
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;
567 /* True means chars (wide chars) are unsigned. */
568 bool unsigned_char, unsigned_wchar;
570 /* True if the most significant byte in a word has the lowest
571 address in memory. */
572 bool bytes_big_endian;
574 /* Nonzero means __STDC__ should have the value 0 in system headers. */
575 unsigned char stdc_0_in_system_headers;
577 /* True disables tokenization outside of preprocessing directives. */
578 bool directives_only;
580 /* True enables canonicalization of system header file paths. */
581 bool canonical_system_headers;
583 /* The maximum depth of the nested #include. */
584 unsigned int max_include_depth;
586 cpp_main_search main_search : 8;
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. */
593 enum cpp_diagnostic_level {
594 /* Warning, an error with -Werror. */
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. */
602 /* An internal consistency check failed. Prints "internal error: ",
603 otherwise the same as CPP_DL_ERROR. */
605 /* An informative note following a warning. */
611 /* Warning reason codes. Use a reason code of CPP_W_NONE for unclassified
612 warnings and diagnostics that are not warnings. */
614 enum cpp_warning_reason {
618 CPP_W_MISSING_INCLUDE_DIRS,
624 CPP_W_NUM_SIGN_CHANGE,
625 CPP_W_VARIADIC_MACROS,
626 CPP_W_BUILTIN_MACRO_REDEFINED,
630 CPP_W_CXX_OPERATOR_NAMES,
633 CPP_W_WARNING_DIRECTIVE,
634 CPP_W_LITERAL_SUFFIX,
635 CPP_W_SIZE_T_LITERALS,
638 CPP_W_C90_C99_COMPAT,
639 CPP_W_C11_C2X_COMPAT,
641 CPP_W_EXPANSION_TO_DEFINED
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 **);
652 /* Call backs to cpplib client. */
655 /* Called when a new line of preprocessed output is started. */
656 void (*line_change) (cpp_reader *, const cpp_token *, int);
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 *);
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;
675 /* Context-sensitive macro support. Returns macro (if any) that should
677 cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
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,
685 const char *, va_list *)
686 ATTRIBUTE_FPTR_PRINTF(5,0);
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 *);
699 /* Callback to identify whether an attribute exists. */
700 int (*has_attribute) (cpp_reader *, bool);
702 /* Callback to determine whether a built-in function is recognized. */
703 int (*has_builtin) (cpp_reader *);
705 /* Callback that can change a user lazy into normal macro. */
706 void (*user_lazy_macro) (cpp_reader *, cpp_macro *, unsigned);
708 /* Callback to handle deferred cpp_macros. */
709 cpp_macro *(*user_deferred_macro) (cpp_reader *, location_t, cpp_hashnode *);
711 /* Callback to parse SOURCE_DATE_EPOCH from environment. */
712 time_t (*get_source_date_epoch) (cpp_reader *);
714 /* Callback for providing suggestions for misspelled directives. */
715 const char *(*get_suggestion) (cpp_reader *, const char *, const char *const *);
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 *,
726 /* Callback for filename remapping in __FILE__ and __BASE_FILE__ macro
728 const char *(*remap_filename) (const char*);
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,
737 #define INO_T_CPP ino_t ino[3]
739 #define INO_T_CPP ino_t ino
742 /* Chain of directories to look for include files in. */
745 /* NULL-terminated singly-linked list. */
746 struct cpp_dir *next;
748 /* NAME of the directory, NUL-terminated. */
752 /* One if a system header, two if a system header that has extern
753 "C" guards for C++. */
756 /* Is this a user-supplied directory? */
757 bool user_supplied_p;
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;
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;
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);
773 /* The C front end uses these to recognize duplicated
774 directories in the search path. */
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). */
786 /* Each macro definition is recorded in a cpp_macro structure.
787 Variadic macros cannot occur with traditional cpp. */
788 struct GTY(()) cpp_macro {
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;
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;
804 /* Definition line number. */
807 /* Number of tokens in body, or bytes for traditional macros. */
808 /* Do we really need 2^32-1 range here? */
811 /* Number of parameters. */
812 unsigned short paramc;
814 /* Non-zero if this is a user-lazy macro, value provided by user. */
817 /* The kind of this macro (ISO, trad or assert) */
820 /* If a function-like macro. */
821 unsigned int fun_like : 1;
823 /* If a variadic macro. */
824 unsigned int variadic : 1;
826 /* If macro defined in system header. */
827 unsigned int syshdr : 1;
829 /* Nonzero if it has been expanded or had its existence tested. */
830 unsigned int used : 1;
832 /* Indicate whether the tokens include extra CPP_PASTE tokens at the
833 end to track invalid redefinitions with consecutive CPP_PASTE
835 unsigned int extra_tokens : 1;
837 /* Imported C++20 macro (from a header unit). */
838 unsigned int imported_p : 1;
840 /* 0 bits spare (32-bit). 32 on 64-bit target. */
844 /* Trailing array of replacement tokens (ISO), or assertion body value. */
845 cpp_token GTY ((tag ("false"), length ("%1.count"))) tokens[1];
847 /* Pointer to replacement text (traditional). See comment at top
848 of cpptrad.c for how traditional function-like macros are
850 const unsigned char *GTY ((tag ("true"))) text;
851 } GTY ((desc ("%1.kind == cmk_traditional"))) exp;
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. */
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. */
872 /* Different flavors of hash node. */
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. */
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
886 BT_SPECLINE = 0, /* `__LINE__' */
887 BT_DATE, /* `__DATE__' */
888 BT_FILE, /* `__FILE__' */
889 BT_BASE_FILE, /* `__BASE_FILE__' */
890 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
891 BT_TIME, /* `__TIME__' */
892 BT_STDC, /* `__STDC__' */
893 BT_PRAGMA, /* `_Pragma' operator */
894 BT_TIMESTAMP, /* `__TIMESTAMP__' */
895 BT_COUNTER, /* `__COUNTER__' */
896 BT_HAS_ATTRIBUTE, /* `__has_attribute(x)' */
897 BT_HAS_STD_ATTRIBUTE, /* `__has_c_attribute(x)' */
898 BT_HAS_BUILTIN, /* `__has_builtin(x)' */
899 BT_HAS_INCLUDE, /* `__has_include(x)' */
900 BT_HAS_INCLUDE_NEXT /* `__has_include_next(x)' */
903 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
904 #define HT_NODE(NODE) (&(NODE)->ident)
905 #define NODE_LEN(NODE) HT_LEN (HT_NODE (NODE))
906 #define NODE_NAME(NODE) HT_STR (HT_NODE (NODE))
908 /* The common part of an identifier node shared amongst all 3 C front
909 ends. Also used to store CPP identifiers, which are a superset of
910 identifiers in the grammatical sense. */
912 union GTY(()) _cpp_hashnode_value {
913 /* Assert (maybe NULL) */
914 cpp_macro * GTY((tag ("NT_VOID"))) answers;
915 /* Macro (maybe NULL) */
916 cpp_macro * GTY((tag ("NT_USER_MACRO"))) macro;
917 /* Code for a builtin macro. */
918 enum cpp_builtin_type GTY ((tag ("NT_BUILTIN_MACRO"))) builtin;
919 /* Macro argument index. */
920 unsigned short GTY ((tag ("NT_MACRO_ARG"))) arg_index;
923 struct GTY(()) cpp_hashnode {
924 struct ht_identifier ident;
925 unsigned int is_directive : 1;
926 unsigned int directive_index : 7; /* If is_directive,
927 then index into directive table.
928 Otherwise, a NODE_OPERATOR. */
929 unsigned int rid_code : 8; /* Rid code - for front ends. */
930 unsigned int flags : 9; /* CPP flags. */
931 ENUM_BITFIELD(node_type) type : 2; /* CPP node type. */
935 /* The deferred cookie is applicable to NT_USER_MACRO or NT_VOID.
936 The latter for when a macro had a prevailing undef.
937 On a 64-bit system there would be 32-bits of padding to the value
938 field. So placing the deferred index here is not costly. */
939 unsigned deferred; /* Deferred cookie */
941 union _cpp_hashnode_value GTY ((desc ("%1.type"))) value;
944 /* A class for iterating through the source locations within a
945 string token (before escapes are interpreted, and before
948 class cpp_string_location_reader {
950 cpp_string_location_reader (location_t src_loc,
951 line_maps *line_table);
953 source_range get_next ();
957 int m_offset_per_column;
960 /* A class for storing the source ranges of all of the characters within
961 a string literal, after escapes are interpreted, and after
964 This is not GTY-marked, as instances are intended to be temporary. */
966 class cpp_substring_ranges
969 cpp_substring_ranges ();
970 ~cpp_substring_ranges ();
972 int get_num_ranges () const { return m_num_ranges; }
973 source_range get_range (int idx) const
975 linemap_assert (idx < m_num_ranges);
976 return m_ranges[idx];
979 void add_range (source_range range);
980 void add_n_ranges (int num, cpp_string_location_reader &loc_reader);
983 source_range *m_ranges;
988 /* Call this first to get a handle to pass to other functions.
990 If you want cpplib to manage its own hashtable, pass in a NULL
991 pointer. Otherwise you should pass in an initialized hash table
992 that cpplib will share; this technique is used by the C front
994 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
997 /* Reset the cpp_reader's line_map. This is only used after reading a
999 extern void cpp_set_line_map (cpp_reader *, class line_maps *);
1001 /* Call this to change the selected language standard (e.g. because of
1002 command line options). */
1003 extern void cpp_set_lang (cpp_reader *, enum c_lang);
1005 /* Set the include paths. */
1006 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
1008 /* Call these to get pointers to the options, callback, and deps
1009 structures for a given reader. These pointers are good until you
1010 call cpp_finish on that reader. You can either edit the callbacks
1011 through the pointer returned from cpp_get_callbacks, or set them
1012 with cpp_set_callbacks. */
1013 extern cpp_options *cpp_get_options (cpp_reader *) ATTRIBUTE_PURE;
1014 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *) ATTRIBUTE_PURE;
1015 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
1016 extern class mkdeps *cpp_get_deps (cpp_reader *) ATTRIBUTE_PURE;
1018 extern const char *cpp_probe_header_unit (cpp_reader *, const char *file,
1019 bool angle_p, location_t);
1021 /* Call these to get name data about the various compile-time
1023 extern const char *cpp_get_narrow_charset_name (cpp_reader *) ATTRIBUTE_PURE;
1024 extern const char *cpp_get_wide_charset_name (cpp_reader *) ATTRIBUTE_PURE;
1026 /* This function reads the file, but does not start preprocessing. It
1027 returns the name of the original file; this is the same as the
1028 input file, except for preprocessed input. This will generate at
1029 least one file change callback, and possibly a line change callback
1030 too. If there was an error opening the file, it returns NULL. */
1031 extern const char *cpp_read_main_file (cpp_reader *, const char *,
1032 bool injecting = false);
1033 extern location_t cpp_main_loc (const cpp_reader *);
1035 /* Adjust for the main file to be an include. */
1036 extern void cpp_retrofit_as_include (cpp_reader *);
1038 /* Set up built-ins with special behavior. Use cpp_init_builtins()
1039 instead unless your know what you are doing. */
1040 extern void cpp_init_special_builtins (cpp_reader *);
1042 /* Set up built-ins like __FILE__. */
1043 extern void cpp_init_builtins (cpp_reader *, int);
1045 /* This is called after options have been parsed, and partially
1047 extern void cpp_post_options (cpp_reader *);
1049 /* Set up translation to the target character set. */
1050 extern void cpp_init_iconv (cpp_reader *);
1052 /* Call this to finish preprocessing. If you requested dependency
1053 generation, pass an open stream to write the information to,
1054 otherwise NULL. It is your responsibility to close the stream. */
1055 extern void cpp_finish (cpp_reader *, FILE *deps_stream);
1057 /* Call this to release the handle at the end of preprocessing. Any
1058 use of the handle after this function returns is invalid. */
1059 extern void cpp_destroy (cpp_reader *);
1061 extern unsigned int cpp_token_len (const cpp_token *);
1062 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
1063 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
1064 unsigned char *, bool);
1065 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
1066 void (*) (cpp_reader *), bool);
1067 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
1068 const char *, unsigned, bool, bool);
1069 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
1071 extern const cpp_token *cpp_get_token (cpp_reader *);
1072 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
1074 inline bool cpp_user_macro_p (const cpp_hashnode *node)
1076 return node->type == NT_USER_MACRO;
1078 inline bool cpp_builtin_macro_p (const cpp_hashnode *node)
1080 return node->type == NT_BUILTIN_MACRO;
1082 inline bool cpp_macro_p (const cpp_hashnode *node)
1084 return node->type & NT_MACRO_MASK;
1086 inline cpp_macro *cpp_set_deferred_macro (cpp_hashnode *node,
1087 cpp_macro *forced = NULL)
1089 cpp_macro *old = node->value.macro;
1091 node->value.macro = forced;
1092 node->type = NT_USER_MACRO;
1093 node->flags &= ~NODE_USED;
1097 cpp_macro *cpp_get_deferred_macro (cpp_reader *, cpp_hashnode *, location_t);
1099 /* Returns true if NODE is a function-like user macro. */
1100 inline bool cpp_fun_like_macro_p (cpp_hashnode *node)
1102 return cpp_user_macro_p (node) && node->value.macro->fun_like;
1105 extern const unsigned char *cpp_macro_definition (cpp_reader *, cpp_hashnode *);
1106 extern const unsigned char *cpp_macro_definition (cpp_reader *, cpp_hashnode *,
1108 inline location_t cpp_macro_definition_location (cpp_hashnode *node)
1110 const cpp_macro *macro = node->value.macro;
1111 return macro ? macro->line : 0;
1113 /* Return an idempotent time stamp (possibly from SOURCE_DATE_EPOCH). */
1114 enum class CPP_time_kind
1116 FIXED = -1, /* Fixed time via source epoch. */
1117 DYNAMIC = -2, /* Dynamic via time(2). */
1118 UNKNOWN = -3 /* Wibbly wobbly, timey wimey. */
1120 extern CPP_time_kind cpp_get_date (cpp_reader *, time_t *);
1122 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
1123 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
1125 /* Evaluate a CPP_*CHAR* token. */
1126 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
1127 unsigned int *, int *);
1128 /* Evaluate a vector of CPP_*STRING* tokens. */
1129 extern bool cpp_interpret_string (cpp_reader *,
1130 const cpp_string *, size_t,
1131 cpp_string *, enum cpp_ttype);
1132 extern const char *cpp_interpret_string_ranges (cpp_reader *pfile,
1133 const cpp_string *from,
1134 cpp_string_location_reader *,
1136 cpp_substring_ranges *out,
1137 enum cpp_ttype type);
1138 extern bool cpp_interpret_string_notranslate (cpp_reader *,
1139 const cpp_string *, size_t,
1140 cpp_string *, enum cpp_ttype);
1142 /* Convert a host character constant to the execution character set. */
1143 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
1145 /* Used to register macros and assertions, perhaps from the command line.
1146 The text is the same as the command line argument. */
1147 extern void cpp_define (cpp_reader *, const char *);
1148 extern void cpp_define_unused (cpp_reader *, const char *);
1149 extern void cpp_define_formatted (cpp_reader *pfile,
1150 const char *fmt, ...) ATTRIBUTE_PRINTF_2;
1151 extern void cpp_define_formatted_unused (cpp_reader *pfile,
1153 ...) ATTRIBUTE_PRINTF_2;
1154 extern void cpp_assert (cpp_reader *, const char *);
1155 extern void cpp_undef (cpp_reader *, const char *);
1156 extern void cpp_unassert (cpp_reader *, const char *);
1158 /* Mark a node as a lazily defined macro. */
1159 extern void cpp_define_lazily (cpp_reader *, cpp_hashnode *node, unsigned N);
1161 /* Undefine all macros and assertions. */
1162 extern void cpp_undef_all (cpp_reader *);
1164 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
1166 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
1168 /* A preprocessing number. Code assumes that any unused high bits of
1169 the double integer are set to zero. */
1171 /* This type has to be equal to unsigned HOST_WIDE_INT, see
1172 gcc/c-family/c-lex.c. */
1173 typedef uint64_t cpp_num_part;
1174 typedef struct cpp_num cpp_num;
1179 bool unsignedp; /* True if value should be treated as unsigned. */
1180 bool overflow; /* True if the most recent calculation overflowed. */
1183 /* cpplib provides two interfaces for interpretation of preprocessing
1186 cpp_classify_number categorizes numeric constants according to
1187 their field (integer, floating point, or invalid), radix (decimal,
1188 octal, hexadecimal), and type suffixes. */
1190 #define CPP_N_CATEGORY 0x000F
1191 #define CPP_N_INVALID 0x0000
1192 #define CPP_N_INTEGER 0x0001
1193 #define CPP_N_FLOATING 0x0002
1195 #define CPP_N_WIDTH 0x00F0
1196 #define CPP_N_SMALL 0x0010 /* int, float, short _Fract/Accum */
1197 #define CPP_N_MEDIUM 0x0020 /* long, double, long _Fract/_Accum. */
1198 #define CPP_N_LARGE 0x0040 /* long long, long double,
1199 long long _Fract/Accum. */
1201 #define CPP_N_WIDTH_MD 0xF0000 /* machine defined. */
1202 #define CPP_N_MD_W 0x10000
1203 #define CPP_N_MD_Q 0x20000
1205 #define CPP_N_RADIX 0x0F00
1206 #define CPP_N_DECIMAL 0x0100
1207 #define CPP_N_HEX 0x0200
1208 #define CPP_N_OCTAL 0x0400
1209 #define CPP_N_BINARY 0x0800
1211 #define CPP_N_UNSIGNED 0x1000 /* Properties. */
1212 #define CPP_N_IMAGINARY 0x2000
1213 #define CPP_N_DFLOAT 0x4000
1214 #define CPP_N_DEFAULT 0x8000
1216 #define CPP_N_FRACT 0x100000 /* Fract types. */
1217 #define CPP_N_ACCUM 0x200000 /* Accum types. */
1218 #define CPP_N_FLOATN 0x400000 /* _FloatN types. */
1219 #define CPP_N_FLOATNX 0x800000 /* _FloatNx types. */
1221 #define CPP_N_USERDEF 0x1000000 /* C++11 user-defined literal. */
1223 #define CPP_N_SIZE_T 0x2000000 /* C++23 size_t literal. */
1225 #define CPP_N_WIDTH_FLOATN_NX 0xF0000000 /* _FloatN / _FloatNx value
1226 of N, divided by 16. */
1227 #define CPP_FLOATN_SHIFT 24
1228 #define CPP_FLOATN_MAX 0xF0
1230 /* Classify a CPP_NUMBER token. The return value is a combination of
1231 the flags from the above sets. */
1232 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *,
1233 const char **, location_t);
1235 /* Return the classification flags for a float suffix. */
1236 extern unsigned int cpp_interpret_float_suffix (cpp_reader *, const char *,
1239 /* Return the classification flags for an int suffix. */
1240 extern unsigned int cpp_interpret_int_suffix (cpp_reader *, const char *,
1243 /* Evaluate a token classified as category CPP_N_INTEGER. */
1244 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
1247 /* Sign extend a number, with PRECISION significant bits and all
1248 others assumed clear, to fill out a cpp_num structure. */
1249 cpp_num cpp_num_sign_extend (cpp_num, size_t);
1251 /* Output a diagnostic of some kind. */
1252 extern bool cpp_error (cpp_reader *, enum cpp_diagnostic_level,
1253 const char *msgid, ...)
1255 extern bool cpp_warning (cpp_reader *, enum cpp_warning_reason,
1256 const char *msgid, ...)
1258 extern bool cpp_pedwarning (cpp_reader *, enum cpp_warning_reason,
1259 const char *msgid, ...)
1261 extern bool cpp_warning_syshdr (cpp_reader *, enum cpp_warning_reason reason,
1262 const char *msgid, ...)
1265 /* Output a diagnostic with "MSGID: " preceding the
1266 error string of errno. No location is printed. */
1267 extern bool cpp_errno (cpp_reader *, enum cpp_diagnostic_level,
1269 /* Similarly, but with "FILENAME: " instead of "MSGID: ", where
1270 the filename is not localized. */
1271 extern bool cpp_errno_filename (cpp_reader *, enum cpp_diagnostic_level,
1272 const char *filename, location_t loc);
1274 /* Same as cpp_error, except additionally specifies a position as a
1275 (translation unit) physical line and physical column. If the line is
1276 zero, then no location is printed. */
1277 extern bool cpp_error_with_line (cpp_reader *, enum cpp_diagnostic_level,
1278 location_t, unsigned,
1279 const char *msgid, ...)
1281 extern bool cpp_warning_with_line (cpp_reader *, enum cpp_warning_reason,
1282 location_t, unsigned,
1283 const char *msgid, ...)
1285 extern bool cpp_pedwarning_with_line (cpp_reader *, enum cpp_warning_reason,
1286 location_t, unsigned,
1287 const char *msgid, ...)
1289 extern bool cpp_warning_with_line_syshdr (cpp_reader *, enum cpp_warning_reason,
1290 location_t, unsigned,
1291 const char *msgid, ...)
1294 extern bool cpp_error_at (cpp_reader * pfile, enum cpp_diagnostic_level,
1295 location_t src_loc, const char *msgid, ...)
1298 extern bool cpp_error_at (cpp_reader * pfile, enum cpp_diagnostic_level,
1299 rich_location *richloc, const char *msgid, ...)
1303 extern int cpp_ideq (const cpp_token *, const char *);
1304 extern void cpp_output_line (cpp_reader *, FILE *);
1305 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
1306 const unsigned char *);
1307 extern const unsigned char *cpp_alloc_token_string
1308 (cpp_reader *, const unsigned char *, unsigned);
1309 extern void cpp_output_token (const cpp_token *, FILE *);
1310 extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
1311 /* Returns the value of an escape sequence, truncated to the correct
1312 target precision. PSTR points to the input pointer, which is just
1313 after the backslash. LIMIT is how much text we have. WIDE is true
1314 if the escape sequence is part of a wide character constant or
1315 string literal. Handles all relevant diagnostics. */
1316 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
1317 const unsigned char *limit, int wide);
1319 /* Structure used to hold a comment block at a given location in the
1324 /* Text of the comment including the terminators. */
1327 /* source location for the given comment. */
1331 /* Structure holding all comments for a given cpp_reader. */
1335 /* table of comment entries. */
1336 cpp_comment *entries;
1338 /* number of actual entries entered in the table. */
1341 /* number of entries allocated currently. */
1343 } cpp_comment_table;
1345 /* Returns the table of comments encountered by the preprocessor. This
1346 table is only populated when pfile->state.save_comments is true. */
1347 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
1351 /* Lookup an identifier in the hashtable. Puts the identifier in the
1352 table if it is not already there. */
1353 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
1356 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
1357 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
1360 extern void cpp_scan_nooutput (cpp_reader *);
1361 extern int cpp_sys_macro_p (cpp_reader *);
1362 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
1364 extern bool cpp_compare_macros (const cpp_macro *macro1,
1365 const cpp_macro *macro2);
1368 extern bool cpp_included (cpp_reader *, const char *);
1369 extern bool cpp_included_before (cpp_reader *, const char *, location_t);
1370 extern void cpp_make_system_header (cpp_reader *, int, int);
1371 extern bool cpp_push_include (cpp_reader *, const char *);
1372 extern bool cpp_push_default_include (cpp_reader *, const char *);
1373 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
1374 extern const char *cpp_get_path (struct _cpp_file *);
1375 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
1376 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
1377 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
1378 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
1379 extern void cpp_clear_file_cache (cpp_reader *);
1382 struct save_macro_data;
1383 extern int cpp_save_state (cpp_reader *, FILE *);
1384 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
1385 extern int cpp_write_pch_state (cpp_reader *, FILE *);
1386 extern int cpp_valid_state (cpp_reader *, const char *, int);
1387 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
1388 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
1389 struct save_macro_data *);
1392 extern void cpp_force_token_locations (cpp_reader *, location_t);
1393 extern void cpp_stop_forcing_token_locations (cpp_reader *);
1401 extern void cpp_directive_only_process (cpp_reader *pfile,
1403 void (*cb) (cpp_reader *,
1408 extern enum cpp_ttype cpp_userdef_string_remove_type
1409 (enum cpp_ttype type);
1410 extern enum cpp_ttype cpp_userdef_string_add_type
1411 (enum cpp_ttype type);
1412 extern enum cpp_ttype cpp_userdef_char_remove_type
1413 (enum cpp_ttype type);
1414 extern enum cpp_ttype cpp_userdef_char_add_type
1415 (enum cpp_ttype type);
1416 extern bool cpp_userdef_string_p
1417 (enum cpp_ttype type);
1418 extern bool cpp_userdef_char_p
1419 (enum cpp_ttype type);
1420 extern const char * cpp_get_userdef_suffix
1421 (const cpp_token *);
1425 /* A class to manage the state while converting a UTF-8 sequence to cppchar_t
1426 and computing the display width one character at a time. */
1427 class cpp_display_width_computation {
1429 cpp_display_width_computation (const char *data, int data_length,
1431 const char *next_byte () const { return m_next; }
1432 int bytes_processed () const { return m_next - m_begin; }
1433 int bytes_left () const { return m_bytes_left; }
1434 bool done () const { return !bytes_left (); }
1435 int display_cols_processed () const { return m_display_cols; }
1437 int process_next_codepoint ();
1438 int advance_display_cols (int n);
1441 const char *const m_begin;
1443 size_t m_bytes_left;
1444 const int m_tabstop;
1448 /* Convenience functions that are simple use cases for class
1449 cpp_display_width_computation. Tab characters will be expanded to spaces
1450 as determined by TABSTOP. */
1451 int cpp_byte_column_to_display_column (const char *data, int data_length,
1452 int column, int tabstop);
1453 inline int cpp_display_width (const char *data, int data_length,
1456 return cpp_byte_column_to_display_column (data, data_length, data_length,
1459 int cpp_display_column_to_byte_column (const char *data, int data_length,
1460 int display_col, int tabstop);
1461 int cpp_wcwidth (cppchar_t c);
1463 #endif /* ! LIBCPP_CPPLIB_H */
projects / platform / upstream / gcc.git / blob