]>
Commit | Line | Data |
---|---|---|
7f2935c7 | 1 | /* Definitions for CPP library. |
6441eb6d | 2 | Copyright (C) 1995-2025 Free Software Foundation, Inc. |
7f2935c7 PB |
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 | |
748086b7 | 7 | Free Software Foundation; either version 3, or (at your option) any |
7f2935c7 PB |
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 | |
748086b7 JJ |
16 | along with this program; see the file COPYING3. If not see |
17 | <http://www.gnu.org/licenses/>. | |
7f2935c7 PB |
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! */ | |
4f4e53dd PB |
22 | #ifndef LIBCPP_CPPLIB_H |
23 | #define LIBCPP_CPPLIB_H | |
7f2935c7 PB |
24 | |
25 | #include <sys/types.h> | |
4f4e53dd | 26 | #include "symtab.h" |
d82fc108 | 27 | #include "line-map.h" |
7f2935c7 | 28 | |
7f2935c7 PB |
29 | typedef struct cpp_reader cpp_reader; |
30 | typedef struct cpp_buffer cpp_buffer; | |
31 | typedef struct cpp_options cpp_options; | |
1368ee70 | 32 | typedef struct cpp_token cpp_token; |
bfb9dc7f | 33 | typedef struct cpp_string cpp_string; |
a50882dc | 34 | typedef struct cpp_hashnode cpp_hashnode; |
93c80368 | 35 | typedef struct cpp_macro cpp_macro; |
7e96d768 | 36 | typedef struct cpp_callbacks cpp_callbacks; |
8f9b4009 | 37 | typedef struct cpp_dir cpp_dir; |
93c80368 | 38 | |
94d1613b | 39 | struct _cpp_file; |
c5a04734 | 40 | |
78d132d7 DM |
41 | class rich_location; |
42 | ||
f8b954fc NB |
43 | /* The first three groups, apart from '=', can appear in preprocessor |
44 | expressions (+= and -= are used to indicate unary + and - resp.). | |
45 | This allows a lookup table to be implemented in _cpp_parse_expr. | |
c5a04734 ZW |
46 | |
47 | The first group, to CPP_LAST_EQ, can be immediately followed by an | |
48 | '='. The lexer needs operators ending in '=', like ">>=", to be in | |
b52dbbf8 SE |
49 | the same order as their counterparts without the '=', like ">>". |
50 | ||
e53b6e56 | 51 | See the cpp_operator table optab in expr.cc if you change the order or |
b52dbbf8 | 52 | add or remove anything in the first group. */ |
c5a04734 | 53 | |
21b11495 ZW |
54 | #define TTYPE_TABLE \ |
55 | OP(EQ, "=") \ | |
56 | OP(NOT, "!") \ | |
57 | OP(GREATER, ">") /* compare */ \ | |
58 | OP(LESS, "<") \ | |
59 | OP(PLUS, "+") /* math */ \ | |
60 | OP(MINUS, "-") \ | |
61 | OP(MULT, "*") \ | |
62 | OP(DIV, "/") \ | |
63 | OP(MOD, "%") \ | |
64 | OP(AND, "&") /* bit ops */ \ | |
65 | OP(OR, "|") \ | |
66 | OP(XOR, "^") \ | |
67 | OP(RSHIFT, ">>") \ | |
68 | OP(LSHIFT, "<<") \ | |
21b11495 ZW |
69 | \ |
70 | OP(COMPL, "~") \ | |
71 | OP(AND_AND, "&&") /* logical */ \ | |
72 | OP(OR_OR, "||") \ | |
73 | OP(QUERY, "?") \ | |
74 | OP(COLON, ":") \ | |
75 | OP(COMMA, ",") /* grouping */ \ | |
76 | OP(OPEN_PAREN, "(") \ | |
77 | OP(CLOSE_PAREN, ")") \ | |
78 | TK(EOF, NONE) \ | |
79 | OP(EQ_EQ, "==") /* compare */ \ | |
80 | OP(NOT_EQ, "!=") \ | |
81 | OP(GREATER_EQ, ">=") \ | |
82 | OP(LESS_EQ, "<=") \ | |
b7689b96 | 83 | OP(SPACESHIP, "<=>") \ |
21b11495 ZW |
84 | \ |
85 | /* These two are unary + / - in preprocessor expressions. */ \ | |
86 | OP(PLUS_EQ, "+=") /* math */ \ | |
87 | OP(MINUS_EQ, "-=") \ | |
88 | \ | |
89 | OP(MULT_EQ, "*=") \ | |
90 | OP(DIV_EQ, "/=") \ | |
91 | OP(MOD_EQ, "%=") \ | |
92 | OP(AND_EQ, "&=") /* bit ops */ \ | |
93 | OP(OR_EQ, "|=") \ | |
94 | OP(XOR_EQ, "^=") \ | |
95 | OP(RSHIFT_EQ, ">>=") \ | |
96 | OP(LSHIFT_EQ, "<<=") \ | |
21b11495 ZW |
97 | /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \ |
98 | OP(HASH, "#") /* digraphs */ \ | |
99 | OP(PASTE, "##") \ | |
100 | OP(OPEN_SQUARE, "[") \ | |
101 | OP(CLOSE_SQUARE, "]") \ | |
102 | OP(OPEN_BRACE, "{") \ | |
103 | OP(CLOSE_BRACE, "}") \ | |
104 | /* The remainder of the punctuation. Order is not significant. */ \ | |
105 | OP(SEMICOLON, ";") /* structure */ \ | |
106 | OP(ELLIPSIS, "...") \ | |
107 | OP(PLUS_PLUS, "++") /* increment */ \ | |
108 | OP(MINUS_MINUS, "--") \ | |
109 | OP(DEREF, "->") /* accessors */ \ | |
110 | OP(DOT, ".") \ | |
111 | OP(SCOPE, "::") \ | |
112 | OP(DEREF_STAR, "->*") \ | |
113 | OP(DOT_STAR, ".*") \ | |
114 | OP(ATSIGN, "@") /* used in Objective-C */ \ | |
115 | \ | |
116 | TK(NAME, IDENT) /* word */ \ | |
117 | TK(AT_NAME, IDENT) /* @word - Objective-C */ \ | |
118 | TK(NUMBER, LITERAL) /* 34_be+ta */ \ | |
119 | \ | |
120 | TK(CHAR, LITERAL) /* 'char' */ \ | |
121 | TK(WCHAR, LITERAL) /* L'char' */ \ | |
b6baa67d KVH |
122 | TK(CHAR16, LITERAL) /* u'char' */ \ |
123 | TK(CHAR32, LITERAL) /* U'char' */ \ | |
fe95b036 | 124 | TK(UTF8CHAR, LITERAL) /* u8'char' */ \ |
21b11495 ZW |
125 | TK(OTHER, LITERAL) /* stray punctuation */ \ |
126 | \ | |
127 | TK(STRING, LITERAL) /* "string" */ \ | |
128 | TK(WSTRING, LITERAL) /* L"string" */ \ | |
b6baa67d KVH |
129 | TK(STRING16, LITERAL) /* u"string" */ \ |
130 | TK(STRING32, LITERAL) /* U"string" */ \ | |
2c6e3f55 | 131 | TK(UTF8STRING, LITERAL) /* u8"string" */ \ |
21b11495 ZW |
132 | TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \ |
133 | TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \ | |
1c585664 | 134 | TK(UNEVAL_STRING, LITERAL) /* unevaluated "string" - C++26 */ \ |
21b11495 | 135 | \ |
1c585664 JJ |
136 | TK(CHAR_USERDEF, LITERAL) /* 'char'_suffix - C++11 */ \ |
137 | TK(WCHAR_USERDEF, LITERAL) /* L'char'_suffix - C++11 */ \ | |
138 | TK(CHAR16_USERDEF, LITERAL) /* u'char'_suffix - C++11 */ \ | |
139 | TK(CHAR32_USERDEF, LITERAL) /* U'char'_suffix - C++11 */ \ | |
140 | TK(UTF8CHAR_USERDEF, LITERAL) /* u8'char'_suffix - C++11 */ \ | |
141 | TK(STRING_USERDEF, LITERAL) /* "string"_suffix - C++11 */ \ | |
142 | TK(WSTRING_USERDEF, LITERAL) /* L"string"_suffix - C++11 */ \ | |
143 | TK(STRING16_USERDEF, LITERAL) /* u"string"_suffix - C++11 */ \ | |
144 | TK(STRING32_USERDEF, LITERAL) /* U"string"_suffix - C++11 */ \ | |
145 | TK(UTF8STRING_USERDEF,LITERAL) /* u8"string"_suffix - C++11 */ \ | |
3ce4f9e4 | 146 | \ |
1844a4aa JJ |
147 | TK(EMBED, LITERAL) /* #embed - C23 */ \ |
148 | \ | |
21b11495 ZW |
149 | TK(COMMENT, LITERAL) /* Only if output comments. */ \ |
150 | /* SPELL_LITERAL happens to DTRT. */ \ | |
151 | TK(MACRO_ARG, NONE) /* Macro argument. */ \ | |
bc4071dd RH |
152 | TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \ |
153 | TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \ | |
21b11495 ZW |
154 | TK(PADDING, NONE) /* Whitespace for -E. */ |
155 | ||
156 | #define OP(e, s) CPP_ ## e, | |
157 | #define TK(e, s) CPP_ ## e, | |
3a2b2c7a | 158 | enum cpp_ttype |
c45da1ca | 159 | { |
1368ee70 | 160 | TTYPE_TABLE |
21b11495 ZW |
161 | N_TTYPES, |
162 | ||
083e891e MP |
163 | /* A token type for keywords, as opposed to ordinary identifiers. */ |
164 | CPP_KEYWORD, | |
165 | ||
21b11495 | 166 | /* Positions in the table. */ |
b52dbbf8 | 167 | CPP_LAST_EQ = CPP_LSHIFT, |
21b11495 | 168 | CPP_FIRST_DIGRAPH = CPP_HASH, |
b52dbbf8 | 169 | CPP_LAST_PUNCTUATOR= CPP_ATSIGN, |
21b11495 | 170 | CPP_LAST_CPP_OP = CPP_LESS_EQ |
1368ee70 | 171 | }; |
96be6998 ZW |
172 | #undef OP |
173 | #undef TK | |
1368ee70 | 174 | |
ecfd72e7 | 175 | /* C language kind, used when calling cpp_create_reader. */ |
094a609c | 176 | enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_GNUC11, CLK_GNUC17, CLK_GNUC23, |
0cf68222 | 177 | CLK_GNUC2Y, |
c76dc9c3 | 178 | CLK_STDC89, CLK_STDC94, CLK_STDC99, CLK_STDC11, CLK_STDC17, |
0cf68222 | 179 | CLK_STDC23, CLK_STDC2Y, |
61949153 | 180 | CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX11, CLK_CXX11, |
026a79f7 | 181 | CLK_GNUCXX14, CLK_CXX14, CLK_GNUCXX17, CLK_CXX17, |
78739c2d | 182 | CLK_GNUCXX20, CLK_CXX20, CLK_GNUCXX23, CLK_CXX23, |
5388a43f | 183 | CLK_GNUCXX26, CLK_CXX26, CLK_ASM}; |
dd07b884 | 184 | |
5d8ebbd8 | 185 | /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */ |
d1b38208 | 186 | struct GTY(()) cpp_string { |
1368ee70 | 187 | unsigned int len; |
f3b957ea LH |
188 | |
189 | /* TEXT is always null terminated (terminator not included in len); but this | |
190 | GTY markup arranges that PCH streaming works properly even if there is a | |
191 | null byte in the middle of the string. */ | |
192 | const unsigned char * GTY((string_length ("1 + %h.len"))) text; | |
1368ee70 ZW |
193 | }; |
194 | ||
c5a04734 | 195 | /* Flags for the cpp_token structure. */ |
041c3194 | 196 | #define PREV_WHITE (1 << 0) /* If whitespace before this token. */ |
93c80368 NB |
197 | #define DIGRAPH (1 << 1) /* If it was a digraph. */ |
198 | #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */ | |
199 | #define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */ | |
dd07b884 | 200 | #define NAMED_OP (1 << 4) /* C++ named operators. */ |
81fea426 MP |
201 | #define PREV_FALLTHROUGH (1 << 5) /* On a token preceeded by FALLTHROUGH |
202 | comment. */ | |
bedfca64 | 203 | #define DECIMAL_INT (1 << 6) /* Decimal integer, set in c-lex.cc. */ |
ab84748a | 204 | #define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend, |
e53b6e56 | 205 | set in c-lex.cc. */ |
37127ed9 | 206 | #define COLON_SCOPE PURE_ZERO /* Adjacent colons in C < 23. */ |
1ae24f7e JJ |
207 | #define NO_DOT_COLON PURE_ZERO /* Set on CPP_NAME tokens whose expansion |
208 | shouldn't start with CPP_DOT or CPP_COLON | |
209 | after optional CPP_PADDING. */ | |
aa508502 JM |
210 | #define SP_DIGRAPH (1 << 8) /* # or ## token was a digraph. */ |
211 | #define SP_PREV_WHITE (1 << 9) /* If whitespace before a ## | |
212 | operator, or before this token | |
213 | after a # operator. */ | |
81fea426 | 214 | #define NO_EXPAND (1 << 10) /* Do not macro-expand this token. */ |
0078a058 | 215 | #define PRAGMA_OP (1 << 11) /* _Pragma token. */ |
bedfca64 | 216 | #define BOL (1 << 12) /* Token at beginning of line. */ |
9e62c811 | 217 | |
d8044160 GK |
218 | /* Specify which field, if any, of the cpp_token union is used. */ |
219 | ||
220 | enum cpp_token_fld_kind { | |
221 | CPP_TOKEN_FLD_NODE, | |
222 | CPP_TOKEN_FLD_SOURCE, | |
223 | CPP_TOKEN_FLD_STR, | |
224 | CPP_TOKEN_FLD_ARG_NO, | |
9a0c6187 | 225 | CPP_TOKEN_FLD_TOKEN_NO, |
bc4071dd | 226 | CPP_TOKEN_FLD_PRAGMA, |
d8044160 GK |
227 | CPP_TOKEN_FLD_NONE |
228 | }; | |
229 | ||
9a0c6187 JM |
230 | /* A macro argument in the cpp_token union. */ |
231 | struct GTY(()) cpp_macro_arg { | |
232 | /* Argument number. */ | |
233 | unsigned int arg_no; | |
be5ffc59 JM |
234 | /* The original spelling of the macro argument token. */ |
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; | |
9a0c6187 JM |
240 | }; |
241 | ||
242 | /* An identifier in the cpp_token union. */ | |
243 | struct GTY(()) cpp_identifier { | |
244 | /* The canonical (UTF-8) spelling of the identifier. */ | |
245 | cpp_hashnode * | |
246 | GTY ((nested_ptr (union tree_node, | |
247 | "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL", | |
248 | "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"))) | |
249 | node; | |
be5ffc59 JM |
250 | /* The original spelling of the identifier. */ |
251 | cpp_hashnode * | |
252 | GTY ((nested_ptr (union tree_node, | |
253 | "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL", | |
254 | "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"))) | |
255 | spelling; | |
9a0c6187 JM |
256 | }; |
257 | ||
d9cdc500 LH |
258 | /* A preprocessing token. This occupies 32 bytes on a 64-bit host. On a |
259 | 32-bit host it occupies 20 or 24 bytes, depending whether a uint64_t | |
260 | requires 4- or 8-byte alignment. */ | |
261 | ||
d1b38208 | 262 | struct GTY(()) cpp_token { |
620e594b DM |
263 | |
264 | /* Location of first char of token, together with range of full token. */ | |
265 | location_t src_loc; | |
266 | ||
041c3194 | 267 | ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */ |
aa508502 | 268 | unsigned short flags; /* flags - see above */ |
041c3194 | 269 | |
d8044160 | 270 | union cpp_token_u |
1368ee70 | 271 | { |
d8044160 | 272 | /* An identifier. */ |
9a0c6187 | 273 | struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node; |
45ab93d9 | 274 | |
d8044160 GK |
275 | /* Inherit padding from this token. */ |
276 | cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source; | |
277 | ||
278 | /* A string, or number. */ | |
279 | struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str; | |
280 | ||
be5ffc59 | 281 | /* Argument no. (and original spelling) for a CPP_MACRO_ARG. */ |
9a0c6187 JM |
282 | struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg; |
283 | ||
284 | /* Original token no. for a CPP_PASTE (from a sequence of | |
285 | consecutive paste tokens in a macro expansion). */ | |
286 | unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no; | |
bc4071dd RH |
287 | |
288 | /* Caller-supplied identifier for a CPP_PRAGMA. */ | |
289 | unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma; | |
d8044160 | 290 | } GTY ((desc ("cpp_token_val_index (&%1)"))) val; |
7f2935c7 PB |
291 | }; |
292 | ||
d8044160 | 293 | /* Say which field is in use. */ |
c26302d5 | 294 | extern enum cpp_token_fld_kind cpp_token_val_index (const cpp_token *tok); |
d8044160 | 295 | |
4268e8bb | 296 | /* A type wide enough to hold any multibyte source character. |
625458d0 | 297 | cpplib's character constant interpreter requires an unsigned type. |
43839642 ZW |
298 | Also, a typedef for the signed equivalent. |
299 | The width of this type is capped at 32 bits; there do exist targets | |
300 | where wchar_t is 64 bits, but only in a non-default mode, and there | |
301 | would be no meaningful interpretation for a wchar_t value greater | |
302 | than 2^32 anyway -- the widest wide-character encoding around is | |
303 | ISO 10646, which stops at 2^31. */ | |
304 | #if CHAR_BIT * SIZEOF_INT >= 32 | |
625458d0 | 305 | # define CPPCHAR_SIGNED_T int |
43839642 ZW |
306 | #elif CHAR_BIT * SIZEOF_LONG >= 32 |
307 | # define CPPCHAR_SIGNED_T long | |
625458d0 | 308 | #else |
43839642 | 309 | # error "Cannot find a least-32-bit signed integer type" |
625458d0 NB |
310 | #endif |
311 | typedef unsigned CPPCHAR_SIGNED_T cppchar_t; | |
312 | typedef CPPCHAR_SIGNED_T cppchar_signed_t; | |
0d9f234d | 313 | |
72bb2c39 BI |
314 | /* Style of header dependencies to generate. */ |
315 | enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM }; | |
316 | ||
024f135a BB |
317 | /* Structured format of module dependencies to generate. */ |
318 | enum cpp_fdeps_format { FDEPS_FMT_NONE = 0, FDEPS_FMT_P1689R5 }; | |
319 | ||
50668cf6 GK |
320 | /* The possible normalization levels, from most restrictive to least. */ |
321 | enum cpp_normalize_level { | |
322 | /* In NFKC. */ | |
323 | normalized_KC = 0, | |
324 | /* In NFC. */ | |
325 | normalized_C, | |
326 | /* In NFC, except for subsequences where being in NFC would make | |
327 | the identifier invalid. */ | |
328 | normalized_identifier_C, | |
329 | /* Not normalized at all. */ | |
330 | normalized_none | |
331 | }; | |
332 | ||
45ab93d9 | 333 | enum cpp_main_search |
9844497a NS |
334 | { |
335 | CMS_none, /* A regular source file. */ | |
336 | CMS_header, /* Is a directly-specified header file (eg PCH or | |
337 | header-unit). */ | |
338 | CMS_user, /* Search the user INCLUDE path. */ | |
339 | CMS_system, /* Search the system INCLUDE path. */ | |
340 | }; | |
341 | ||
ae36f839 | 342 | /* The possible bidirectional control characters checking levels. */ |
51c50026 MP |
343 | enum cpp_bidirectional_level { |
344 | /* No checking. */ | |
ae36f839 | 345 | bidirectional_none = 0, |
51c50026 | 346 | /* Only detect unpaired uses of bidirectional control characters. */ |
ae36f839 | 347 | bidirectional_unpaired = 1, |
51c50026 | 348 | /* Detect any use of bidirectional control characters. */ |
ae36f839 MP |
349 | bidirectional_any = 2, |
350 | /* Also warn about UCNs. */ | |
351 | bidirectional_ucn = 4 | |
51c50026 MP |
352 | }; |
353 | ||
ae79697b ZW |
354 | /* This structure is nested inside struct cpp_reader, and |
355 | carries all the options visible to the command line. */ | |
356 | struct cpp_options | |
c50bca08 | 357 | { |
bdb05a7b NB |
358 | /* The language we're preprocessing. */ |
359 | enum c_lang lang; | |
360 | ||
7f2935c7 | 361 | /* Nonzero means use extra default include directories for C++. */ |
ae79697b | 362 | unsigned char cplusplus; |
7f2935c7 | 363 | |
6614fd40 | 364 | /* Nonzero means handle cplusplus style comments. */ |
ae79697b | 365 | unsigned char cplusplus_comments; |
7f2935c7 | 366 | |
899015a0 TT |
367 | /* Nonzero means define __OBJC__, treat @ as a special token, use |
368 | the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow | |
369 | "#import". */ | |
ae79697b | 370 | unsigned char objc; |
7f2935c7 | 371 | |
564ad5f4 | 372 | /* Nonzero means don't copy comments into the output file. */ |
ae79697b | 373 | unsigned char discard_comments; |
7f2935c7 | 374 | |
477cdac7 JT |
375 | /* Nonzero means don't copy comments into the output file during |
376 | macro expansion. */ | |
377 | unsigned char discard_comments_in_macro_exp; | |
378 | ||
041c3194 | 379 | /* Nonzero means process the ISO trigraph sequences. */ |
ae79697b | 380 | unsigned char trigraphs; |
7f2935c7 | 381 | |
9b55f29a NB |
382 | /* Nonzero means process the ISO digraph sequences. */ |
383 | unsigned char digraphs; | |
384 | ||
bdb05a7b NB |
385 | /* Nonzero means to allow hexadecimal floats and LL suffixes. */ |
386 | unsigned char extended_numbers; | |
387 | ||
b6baa67d KVH |
388 | /* Nonzero means process u/U prefix literals (UTF-16/32). */ |
389 | unsigned char uliterals; | |
390 | ||
fe95b036 ESR |
391 | /* Nonzero means process u8 prefixed character literals (UTF-8). */ |
392 | unsigned char utf8_char_literals; | |
393 | ||
7c1ffff9 | 394 | /* Nonzero means process r/R raw strings. If this is set, uliterals |
a48e3dd1 JM |
395 | must be set as well. */ |
396 | unsigned char rliterals; | |
397 | ||
7f2935c7 | 398 | /* Nonzero means print names of header files (-H). */ |
ae79697b | 399 | unsigned char print_include_names; |
7f2935c7 | 400 | |
9fbd3e41 | 401 | /* Nonzero means complain about deprecated features. */ |
e3339d0f | 402 | unsigned char cpp_warn_deprecated; |
9fbd3e41 | 403 | |
7f2935c7 | 404 | /* Nonzero means warn if slash-star appears in a comment. */ |
ae79697b | 405 | unsigned char warn_comments; |
7f2935c7 | 406 | |
e8ff5196 TB |
407 | /* Nonzero means to warn about __DATA__, __TIME__ and __TIMESTAMP__ usage. */ |
408 | unsigned char warn_date_time; | |
409 | ||
b02398bd BE |
410 | /* Nonzero means warn if a user-supplied include directory does not |
411 | exist. */ | |
412 | unsigned char warn_missing_include_dirs; | |
413 | ||
7f2935c7 | 414 | /* Nonzero means warn if there are any trigraphs. */ |
ae79697b | 415 | unsigned char warn_trigraphs; |
7f2935c7 | 416 | |
a5a49440 NB |
417 | /* Nonzero means warn about multicharacter charconsts. */ |
418 | unsigned char warn_multichar; | |
419 | ||
f9a0e96c ZW |
420 | /* Nonzero means warn about various incompatibilities with |
421 | traditional C. */ | |
e3339d0f | 422 | unsigned char cpp_warn_traditional; |
7f2935c7 | 423 | |
cd7ab83f | 424 | /* Nonzero means warn about long long numeric constants. */ |
e3339d0f | 425 | unsigned char cpp_warn_long_long; |
cd7ab83f | 426 | |
909de5da PE |
427 | /* Nonzero means warn about text after an #endif (or #else). */ |
428 | unsigned char warn_endif_labels; | |
429 | ||
68e65275 NB |
430 | /* Nonzero means warn about implicit sign changes owing to integer |
431 | promotions. */ | |
432 | unsigned char warn_num_sign_change; | |
433 | ||
e5b79219 RH |
434 | /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode. |
435 | Presumably the usage is protected by the appropriate #ifdef. */ | |
436 | unsigned char warn_variadic_macros; | |
437 | ||
c047ce93 SB |
438 | /* Nonzero means warn about builtin macros that are redefined or |
439 | explicitly undefined. */ | |
440 | unsigned char warn_builtin_macro_redefined; | |
441 | ||
70f6d5e1 JJ |
442 | /* Different -Wimplicit-fallthrough= levels. */ |
443 | unsigned char cpp_warn_implicit_fallthrough; | |
444 | ||
5943a2fa JJ |
445 | /* Nonzero means warn about a define of a different macro right after |
446 | #ifndef/#if !defined header guard directive. */ | |
447 | unsigned char warn_header_guard; | |
448 | ||
31031edd JL |
449 | /* Nonzero means we should look for header.gcc files that remap file |
450 | names. */ | |
ae79697b | 451 | unsigned char remap; |
31031edd | 452 | |
eebedaa5 | 453 | /* Zero means dollar signs are punctuation. */ |
ae79697b | 454 | unsigned char dollars_in_ident; |
7f2935c7 | 455 | |
af15a2fe JM |
456 | /* Nonzero means UCNs are accepted in identifiers. */ |
457 | unsigned char extended_identifiers; | |
458 | ||
78b8811a HPN |
459 | /* True if we should warn about dollars in identifiers or numbers |
460 | for this translation unit. */ | |
461 | unsigned char warn_dollars; | |
462 | ||
6ac34fdc | 463 | /* Nonzero means warn if undefined identifiers are evaluated in an #if. */ |
ae79697b | 464 | unsigned char warn_undef; |
6ac34fdc | 465 | |
fb2675cb PB |
466 | /* Nonzero means warn if "defined" is encountered in a place other than |
467 | an #if. */ | |
468 | unsigned char warn_expansion_to_defined; | |
469 | ||
a69cbaac NB |
470 | /* Nonzero means warn of unused macros from the main file. */ |
471 | unsigned char warn_unused_macros; | |
472 | ||
31948547 | 473 | /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */ |
ae79697b | 474 | unsigned char c99; |
31948547 | 475 | |
58551c23 NB |
476 | /* Nonzero if we are conforming to a specific C or C++ standard. */ |
477 | unsigned char std; | |
478 | ||
7f2935c7 | 479 | /* Nonzero means give all the error messages the ANSI standard requires. */ |
e3339d0f | 480 | unsigned char cpp_pedantic; |
7f2935c7 | 481 | |
3773a46b JM |
482 | /* Nonzero means we're looking at already preprocessed code, so don't |
483 | bother trying to do macro expansion and whatnot. */ | |
ae79697b | 484 | unsigned char preprocessed; |
45ab93d9 | 485 | |
847e697a TT |
486 | /* Nonzero means we are going to emit debugging logs during |
487 | preprocessing. */ | |
488 | unsigned char debug; | |
3773a46b | 489 | |
92582b75 TT |
490 | /* Nonzero means we are tracking locations of tokens involved in |
491 | macro expansion. 1 Means we track the location in degraded mode | |
492 | where we do not track locations of tokens resulting from the | |
493 | expansion of arguments of function-like macro. 2 Means we do | |
494 | track all macro expansions. This last option is the one that | |
495 | consumes the highest amount of memory. */ | |
496 | unsigned char track_macro_expansion; | |
497 | ||
644eddaa | 498 | /* Nonzero means handle C++ alternate operator names. */ |
be768055 | 499 | unsigned char operator_names; |
7e96d768 | 500 | |
3d8b2a98 ILT |
501 | /* Nonzero means warn about use of C++ alternate operator names. */ |
502 | unsigned char warn_cxx_operator_names; | |
503 | ||
004cb263 NB |
504 | /* True for traditional preprocessing. */ |
505 | unsigned char traditional; | |
506 | ||
01187df0 | 507 | /* Nonzero for C++ 2011 Standard user-defined literals. */ |
3ce4f9e4 ESR |
508 | unsigned char user_literals; |
509 | ||
7f5f5f98 OW |
510 | /* Nonzero means warn when a string or character literal is followed by a |
511 | ud-suffix which does not beging with an underscore. */ | |
512 | unsigned char warn_literal_suffix; | |
513 | ||
a4a0016d ESR |
514 | /* Nonzero means interpret imaginary, fixed-point, or other gnu extension |
515 | literal number suffixes as user-defined literal number suffixes. */ | |
516 | unsigned char ext_numeric_literals; | |
517 | ||
d3f4ff8b | 518 | /* Nonzero means extended identifiers allow the characters specified |
c264208e | 519 | in C11. */ |
d3f4ff8b JM |
520 | unsigned char c11_identifiers; |
521 | ||
36d20fa4 JM |
522 | /* Nonzero means extended identifiers allow the characters specified |
523 | by Unicode XID_Start and XID_Continue properties. */ | |
524 | unsigned char xid_identifiers; | |
525 | ||
01187df0 JJ |
526 | /* Nonzero for C++ 2014 Standard binary constants. */ |
527 | unsigned char binary_constants; | |
528 | ||
eb45d151 JJ |
529 | /* Nonzero for C2Y imaginary (floating) constants. */ |
530 | unsigned char imaginary_constants; | |
531 | ||
7057e645 ESR |
532 | /* Nonzero for C++ 2014 Standard digit separators. */ |
533 | unsigned char digit_separators; | |
534 | ||
094a609c | 535 | /* Nonzero for C23 decimal floating-point constants. */ |
175a85b2 JM |
536 | unsigned char dfp_constants; |
537 | ||
b04445d4 | 538 | /* Nonzero for C++20 __VA_OPT__ feature. */ |
fb771b9d TT |
539 | unsigned char va_opt; |
540 | ||
93313b94 JM |
541 | /* Nonzero for the '::' token. */ |
542 | unsigned char scope; | |
543 | ||
71d38ec8 JM |
544 | /* Nonzero for the '#elifdef' and '#elifndef' directives. */ |
545 | unsigned char elifdef; | |
546 | ||
d7c30001 JM |
547 | /* Nonzero for the '#warning' directive. */ |
548 | unsigned char warning_directive; | |
549 | ||
c9c3d5f2 NS |
550 | /* Nonzero means tokenize C++20 module directives. */ |
551 | unsigned char module_directives; | |
552 | ||
1f69e63c ESR |
553 | /* Nonzero for C++23 size_t literals. */ |
554 | unsigned char size_t_literals; | |
555 | ||
e9dd050e JJ |
556 | /* Nonzero for C++23 delimited escape sequences. */ |
557 | unsigned char delimited_escape_seqs; | |
558 | ||
e020116d JJ |
559 | /* Nonzero for C++23 named universal character escape sequences. */ |
560 | unsigned char named_uc_escape_seqs; | |
561 | ||
f3b5de94 JM |
562 | /* Nonzero for C++ and C23 UCNs for characters below 0xa0. */ |
563 | unsigned char low_ucns; | |
564 | ||
e020116d JJ |
565 | /* Nonzero for C2Y 0o prefixed octal integer constants. */ |
566 | unsigned char octal_constants; | |
567 | ||
0a91bdaf JM |
568 | /* Nonzero for 'true' and 'false' in #if expressions. */ |
569 | unsigned char true_false; | |
570 | ||
eba6d2aa JJ |
571 | /* Nonzero for the '#embed' directive. */ |
572 | unsigned char embed; | |
573 | ||
e6cc3a24 ZW |
574 | /* Holds the name of the target (execution) character set. */ |
575 | const char *narrow_charset; | |
576 | ||
577 | /* Holds the name of the target wide character set. */ | |
578 | const char *wide_charset; | |
579 | ||
cf551fba EC |
580 | /* Holds the name of the input character set. */ |
581 | const char *input_charset; | |
582 | ||
50668cf6 | 583 | /* The minimum permitted level of normalization before a warning |
1ef33fd4 MLI |
584 | is generated. See enum cpp_normalize_level. */ |
585 | int warn_normalize; | |
50668cf6 | 586 | |
783e2989 NB |
587 | /* True to warn about precompiled header files we couldn't use. */ |
588 | bool warn_invalid_pch; | |
589 | ||
590 | /* True if dependencies should be restored from a precompiled header. */ | |
591 | bool restore_pch_deps; | |
592 | ||
f3bede71 | 593 | /* True if warn about differences between C90 and C99. */ |
dd3ff077 | 594 | signed char cpp_warn_c90_c99_compat; |
f3bede71 | 595 | |
094a609c JM |
596 | /* True if warn about differences between C11 and C23. */ |
597 | signed char cpp_warn_c11_c23_compat; | |
175a85b2 | 598 | |
e020116d JJ |
599 | /* True if warn about differences between C23 and C2Y. */ |
600 | signed char cpp_warn_c23_c2y_compat; | |
601 | ||
fe191308 JM |
602 | /* True if warn about differences between C++98 and C++11. */ |
603 | bool cpp_warn_cxx11_compat; | |
604 | ||
60468d6c TH |
605 | /* True if warn about differences between C++17 and C++20. */ |
606 | bool cpp_warn_cxx20_compat; | |
607 | ||
51c50026 MP |
608 | /* Nonzero if bidirectional control characters checking is on. See enum |
609 | cpp_bidirectional_level. */ | |
610 | unsigned char cpp_warn_bidirectional; | |
611 | ||
0b8c57ed JJ |
612 | /* True if libcpp should warn about invalid UTF-8 characters in comments. |
613 | 2 if it should be a pedwarn. */ | |
614 | unsigned char cpp_warn_invalid_utf8; | |
615 | ||
572f5e1b JJ |
616 | /* True if libcpp should warn about invalid forms of delimited or named |
617 | escape sequences. */ | |
618 | bool cpp_warn_unicode; | |
619 | ||
0b8c57ed JJ |
620 | /* True if -finput-charset= option has been used explicitly. */ |
621 | bool cpp_input_charset_explicit; | |
622 | ||
d4499a23 JJ |
623 | /* -Wleading-whitespace= value. */ |
624 | unsigned char cpp_warn_leading_whitespace; | |
625 | ||
ac615e10 JJ |
626 | /* -Wtrailing-whitespace= value. */ |
627 | unsigned char cpp_warn_trailing_whitespace; | |
628 | ||
d4499a23 JJ |
629 | /* -ftabstop= value. */ |
630 | unsigned int cpp_tabstop; | |
631 | ||
f4ff5a69 NB |
632 | /* Dependency generation. */ |
633 | struct | |
634 | { | |
635 | /* Style of header dependencies to generate. */ | |
72bb2c39 | 636 | enum cpp_deps_style style; |
f4ff5a69 | 637 | |
024f135a BB |
638 | /* Structured format of module dependencies to generate. */ |
639 | enum cpp_fdeps_format fdeps_format; | |
640 | ||
f4ff5a69 NB |
641 | /* Assume missing files are generated files. */ |
642 | bool missing_files; | |
643 | ||
644 | /* Generate phony targets for each dependency apart from the first | |
645 | one. */ | |
646 | bool phony_targets; | |
182d89a3 | 647 | |
db87f19a NS |
648 | /* Generate dependency info for modules. */ |
649 | bool modules; | |
650 | ||
182d89a3 NB |
651 | /* If true, no dependency is generated on the main file. */ |
652 | bool ignore_main_file; | |
74dc6a11 CD |
653 | |
654 | /* If true, intend to use the preprocessor output (e.g., for compilation) | |
655 | in addition to the dependency info. */ | |
656 | bool need_preprocessor_output; | |
f4ff5a69 NB |
657 | } deps; |
658 | ||
44a147ad NB |
659 | /* Target-specific features set by the front end or client. */ |
660 | ||
661 | /* Precision for target CPP arithmetic, target characters, target | |
662 | ints and target wide characters, respectively. */ | |
663 | size_t precision, char_precision, int_precision, wchar_precision; | |
664 | ||
053876cd TH |
665 | /* True means chars (wide chars, UTF-8 chars) are unsigned. */ |
666 | bool unsigned_char, unsigned_wchar, unsigned_utf8char; | |
5279d739 | 667 | |
e6cc3a24 ZW |
668 | /* True if the most significant byte in a word has the lowest |
669 | address in memory. */ | |
670 | bool bytes_big_endian; | |
783e2989 | 671 | |
5279d739 ZW |
672 | /* Nonzero means __STDC__ should have the value 0 in system headers. */ |
673 | unsigned char stdc_0_in_system_headers; | |
21b11495 | 674 | |
ccfc4c91 OW |
675 | /* True disables tokenization outside of preprocessing directives. */ |
676 | bool directives_only; | |
5dc99c46 SB |
677 | |
678 | /* True enables canonicalization of system header file paths. */ | |
679 | bool canonical_system_headers; | |
1c6ffbab QZ |
680 | |
681 | /* The maximum depth of the nested #include. */ | |
682 | unsigned int max_include_depth; | |
9844497a NS |
683 | |
684 | cpp_main_search main_search : 8; | |
ae79697b | 685 | }; |
7f2935c7 | 686 | |
c397a8c1 JJ |
687 | #if GCC_VERSION >= 3005 |
688 | #define ATTRIBUTE_CPP_PPDIAG(m, n) \ | |
689 | __attribute__ ((__format__ (__gcc_diag__, m , n))) ATTRIBUTE_NONNULL(m) | |
690 | #else | |
691 | #define ATTRIBUTE_CPP_PPDIAG(m, n) ATTRIBUTE_NONNULL(m) | |
692 | #endif | |
693 | ||
c24300ba DM |
694 | /* Diagnostic levels. To get a diagnostic without associating a |
695 | position in the translation unit with it, use cpp_error_with_line | |
696 | with a line number of zero. */ | |
697 | ||
698 | enum cpp_diagnostic_level { | |
699 | /* Warning, an error with -Werror. */ | |
700 | CPP_DL_WARNING = 0, | |
701 | /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */ | |
702 | CPP_DL_WARNING_SYSHDR, | |
703 | /* Warning, an error with -pedantic-errors or -Werror. */ | |
704 | CPP_DL_PEDWARN, | |
705 | /* An error. */ | |
706 | CPP_DL_ERROR, | |
707 | /* An internal consistency check failed. Prints "internal error: ", | |
708 | otherwise the same as CPP_DL_ERROR. */ | |
709 | CPP_DL_ICE, | |
710 | /* An informative note following a warning. */ | |
711 | CPP_DL_NOTE, | |
712 | /* A fatal error. */ | |
713 | CPP_DL_FATAL | |
714 | }; | |
715 | ||
716 | /* Warning reason codes. Use a reason code of CPP_W_NONE for unclassified | |
717 | warnings and diagnostics that are not warnings. */ | |
718 | ||
719 | enum cpp_warning_reason { | |
720 | CPP_W_NONE = 0, | |
721 | CPP_W_DEPRECATED, | |
722 | CPP_W_COMMENTS, | |
723 | CPP_W_MISSING_INCLUDE_DIRS, | |
724 | CPP_W_TRIGRAPHS, | |
725 | CPP_W_MULTICHAR, | |
726 | CPP_W_TRADITIONAL, | |
727 | CPP_W_LONG_LONG, | |
728 | CPP_W_ENDIF_LABELS, | |
729 | CPP_W_NUM_SIGN_CHANGE, | |
730 | CPP_W_VARIADIC_MACROS, | |
731 | CPP_W_BUILTIN_MACRO_REDEFINED, | |
732 | CPP_W_DOLLARS, | |
733 | CPP_W_UNDEF, | |
734 | CPP_W_UNUSED_MACROS, | |
735 | CPP_W_CXX_OPERATOR_NAMES, | |
736 | CPP_W_NORMALIZE, | |
737 | CPP_W_INVALID_PCH, | |
738 | CPP_W_WARNING_DIRECTIVE, | |
739 | CPP_W_LITERAL_SUFFIX, | |
1f69e63c | 740 | CPP_W_SIZE_T_LITERALS, |
c24300ba DM |
741 | CPP_W_DATE_TIME, |
742 | CPP_W_PEDANTIC, | |
743 | CPP_W_C90_C99_COMPAT, | |
094a609c | 744 | CPP_W_C11_C23_COMPAT, |
e020116d | 745 | CPP_W_C23_C2Y_COMPAT, |
c24300ba | 746 | CPP_W_CXX11_COMPAT, |
60468d6c | 747 | CPP_W_CXX20_COMPAT, |
c5009eb8 JM |
748 | CPP_W_CXX14_EXTENSIONS, |
749 | CPP_W_CXX17_EXTENSIONS, | |
750 | CPP_W_CXX20_EXTENSIONS, | |
751 | CPP_W_CXX23_EXTENSIONS, | |
b510c53b | 752 | CPP_W_CXX26_EXTENSIONS, |
51c50026 | 753 | CPP_W_EXPANSION_TO_DEFINED, |
0b8c57ed | 754 | CPP_W_BIDIRECTIONAL, |
572f5e1b | 755 | CPP_W_INVALID_UTF8, |
5943a2fa | 756 | CPP_W_UNICODE, |
821d5610 | 757 | CPP_W_HEADER_GUARD, |
ac615e10 | 758 | CPP_W_PRAGMA_ONCE_OUTSIDE_HEADER, |
d4499a23 | 759 | CPP_W_LEADING_WHITESPACE, |
ac615e10 | 760 | CPP_W_TRAILING_WHITESPACE |
c24300ba DM |
761 | }; |
762 | ||
94d1613b MS |
763 | /* Callback for header lookup for HEADER, which is the name of a |
764 | source file. It is used as a method of last resort to find headers | |
765 | that are not otherwise found during the normal include processing. | |
766 | The return value is the malloced name of a header to try and open, | |
767 | if any, or NULL otherwise. This callback is called only if the | |
768 | header is otherwise unfound. */ | |
e3c287c9 | 769 | typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **); |
94d1613b | 770 | |
48c4721e | 771 | /* Call backs to cpplib client. */ |
7e96d768 NB |
772 | struct cpp_callbacks |
773 | { | |
97293897 | 774 | /* Called when a new line of preprocessed output is started. */ |
6cf87ca4 | 775 | void (*line_change) (cpp_reader *, const cpp_token *, int); |
4dc299fb PB |
776 | |
777 | /* Called when switching to/from a new file. | |
778 | The line_map is for the new file. It is NULL if there is no new file. | |
779 | (In C this happens when done with <built-in>+<command line> and also | |
780 | when done with a main file.) This can be used for resource cleanup. */ | |
0e50b624 | 781 | void (*file_change) (cpp_reader *, const line_map_ordinary *); |
4dc299fb | 782 | |
b20d9f0c | 783 | void (*dir_change) (cpp_reader *, const char *); |
620e594b | 784 | void (*include) (cpp_reader *, location_t, const unsigned char *, |
cbc43ae0 | 785 | const char *, int, const cpp_token **); |
620e594b DM |
786 | void (*define) (cpp_reader *, location_t, cpp_hashnode *); |
787 | void (*undef) (cpp_reader *, location_t, cpp_hashnode *); | |
788 | void (*ident) (cpp_reader *, location_t, const cpp_string *); | |
789 | void (*def_pragma) (cpp_reader *, location_t); | |
6cf87ca4 ZW |
790 | int (*valid_pch) (cpp_reader *, const char *, int); |
791 | void (*read_pch) (cpp_reader *, const char *, int, const char *); | |
94d1613b | 792 | missing_header_cb missing_header; |
178b58b5 | 793 | |
5950c3c9 BE |
794 | /* Context-sensitive macro support. Returns macro (if any) that should |
795 | be expanded. */ | |
796 | cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *); | |
797 | ||
148e4216 JM |
798 | /* Called to emit a diagnostic. This callback receives the |
799 | translated message. */ | |
c24300ba DM |
800 | bool (*diagnostic) (cpp_reader *, |
801 | enum cpp_diagnostic_level, | |
802 | enum cpp_warning_reason, | |
803 | rich_location *, | |
804 | const char *, va_list *) | |
c397a8c1 | 805 | ATTRIBUTE_CPP_PPDIAG (5,0); |
93d45d9e JM |
806 | |
807 | /* Callbacks for when a macro is expanded, or tested (whether | |
808 | defined or not at the time) in #ifdef, #ifndef or "defined". */ | |
620e594b DM |
809 | void (*used_define) (cpp_reader *, location_t, cpp_hashnode *); |
810 | void (*used_undef) (cpp_reader *, location_t, cpp_hashnode *); | |
93d45d9e JM |
811 | /* Called before #define and #undef or other macro definition |
812 | changes are processed. */ | |
813 | void (*before_define) (cpp_reader *); | |
3de8a540 AC |
814 | /* Called whenever a macro is expanded or tested. |
815 | Second argument is the location of the start of the current expansion. */ | |
620e594b | 816 | void (*used) (cpp_reader *, location_t, cpp_hashnode *); |
8e680db5 | 817 | |
42fd12b1 | 818 | /* Callback to identify whether an attribute exists. */ |
1d00f8c8 | 819 | int (*has_attribute) (cpp_reader *, bool); |
42fd12b1 | 820 | |
ad1539d5 MS |
821 | /* Callback to determine whether a built-in function is recognized. */ |
822 | int (*has_builtin) (cpp_reader *); | |
823 | ||
06280a90 AC |
824 | /* Callback to determine whether a feature is available. */ |
825 | int (*has_feature) (cpp_reader *, bool); | |
826 | ||
800c0e98 NS |
827 | /* Callback that can change a user lazy into normal macro. */ |
828 | void (*user_lazy_macro) (cpp_reader *, cpp_macro *, unsigned); | |
15c98b2e | 829 | |
b196e76a NS |
830 | /* Callback to handle deferred cpp_macros. */ |
831 | cpp_macro *(*user_deferred_macro) (cpp_reader *, location_t, cpp_hashnode *); | |
832 | ||
15c98b2e ES |
833 | /* Callback to parse SOURCE_DATE_EPOCH from environment. */ |
834 | time_t (*get_source_date_epoch) (cpp_reader *); | |
cb18fd07 DM |
835 | |
836 | /* Callback for providing suggestions for misspelled directives. */ | |
837 | const char *(*get_suggestion) (cpp_reader *, const char *, const char *const *); | |
05945a1b DM |
838 | |
839 | /* Callback for when a comment is encountered, giving the location | |
840 | of the opening slash, a pointer to the content (which is not | |
841 | necessarily 0-terminated), and the length of the content. | |
842 | The content contains the opening slash-star (or slash-slash), | |
843 | and for C-style comments contains the closing star-slash. For | |
844 | C++-style comments it does not include the terminating newline. */ | |
620e594b | 845 | void (*comment) (cpp_reader *, location_t, const unsigned char *, |
05945a1b | 846 | size_t); |
7365279f BK |
847 | |
848 | /* Callback for filename remapping in __FILE__ and __BASE_FILE__ macro | |
849 | expansions. */ | |
850 | const char *(*remap_filename) (const char*); | |
b196e76a NS |
851 | |
852 | /* Maybe translate a #include into something else. Return a | |
853 | cpp_buffer containing the translation if translating. */ | |
854 | char *(*translate_include) (cpp_reader *, line_maps *, location_t, | |
855 | const char *path); | |
7e96d768 NB |
856 | }; |
857 | ||
0c539b47 DR |
858 | #ifdef VMS |
859 | #define INO_T_CPP ino_t ino[3] | |
14e0d832 CC |
860 | #elif defined (_AIX) && SIZEOF_INO_T == 4 |
861 | #define INO_T_CPP ino64_t ino | |
0c539b47 DR |
862 | #else |
863 | #define INO_T_CPP ino_t ino | |
864 | #endif | |
865 | ||
14e0d832 CC |
866 | #if defined (_AIX) && SIZEOF_DEV_T == 4 |
867 | #define DEV_T_CPP dev64_t dev | |
868 | #else | |
869 | #define DEV_T_CPP dev_t dev | |
870 | #endif | |
871 | ||
5793b276 | 872 | /* Chain of directories to look for include files in. */ |
8f9b4009 | 873 | struct cpp_dir |
5793b276 NB |
874 | { |
875 | /* NULL-terminated singly-linked list. */ | |
8f9b4009 | 876 | struct cpp_dir *next; |
5793b276 | 877 | |
8f9b4009 | 878 | /* NAME of the directory, NUL-terminated. */ |
5793b276 NB |
879 | char *name; |
880 | unsigned int len; | |
881 | ||
882 | /* One if a system header, two if a system header that has extern | |
883 | "C" guards for C++. */ | |
884 | unsigned char sysp; | |
885 | ||
8f5929e1 JJ |
886 | /* Is this a user-supplied directory? */ |
887 | bool user_supplied_p; | |
888 | ||
45ab93d9 | 889 | /* The canonicalized NAME as determined by lrealpath. This field |
8f5929e1 JJ |
890 | is only used by hosts that lack reliable inode numbers. */ |
891 | char *canonical_name; | |
892 | ||
8f9b4009 NB |
893 | /* Mapping of file names for this directory for MS-DOS and related |
894 | platforms. A NULL-terminated array of (from, to) pairs. */ | |
895 | const char **name_map; | |
cf551fba | 896 | |
94d1613b MS |
897 | /* Routine to construct pathname, given the search path name and the |
898 | HEADER we are trying to find, return a constructed pathname to | |
899 | try and open. If this is NULL, the constructed pathname is as | |
900 | constructed by append_file_to_dir. */ | |
901 | char *(*construct) (const char *header, cpp_dir *dir); | |
902 | ||
5793b276 NB |
903 | /* The C front end uses these to recognize duplicated |
904 | directories in the search path. */ | |
0c539b47 | 905 | INO_T_CPP; |
14e0d832 | 906 | DEV_T_CPP; |
5793b276 NB |
907 | }; |
908 | ||
10f04917 NS |
909 | /* The kind of the cpp_macro. */ |
910 | enum cpp_macro_kind { | |
911 | cmk_macro, /* An ISO macro (token expansion). */ | |
3fb558b1 | 912 | cmk_assert, /* An assertion. */ |
7692e253 | 913 | cmk_traditional /* A traditional macro (text expansion). */ |
10f04917 NS |
914 | }; |
915 | ||
c5d725c0 NS |
916 | /* Each macro definition is recorded in a cpp_macro structure. |
917 | Variadic macros cannot occur with traditional cpp. */ | |
918 | struct GTY(()) cpp_macro { | |
45ab93d9 | 919 | union cpp_parm_u |
3fb558b1 NS |
920 | { |
921 | /* Parameters, if any. If parameter names use extended identifiers, | |
922 | the original spelling of those identifiers, not the canonical | |
923 | UTF-8 spelling, goes here. */ | |
924 | cpp_hashnode ** GTY ((tag ("false"), | |
925 | nested_ptr (union tree_node, | |
926 | "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL", | |
927 | "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"), | |
928 | length ("%1.paramc"))) params; | |
929 | ||
930 | /* If this is an assertion, the next one in the chain. */ | |
931 | cpp_macro *GTY ((tag ("true"))) next; | |
932 | } GTY ((desc ("%1.kind == cmk_assert"))) parm; | |
c5d725c0 | 933 | |
c5d725c0 | 934 | /* Definition line number. */ |
620e594b | 935 | location_t line; |
c5d725c0 | 936 | |
3fb558b1 NS |
937 | /* Number of tokens in body, or bytes for traditional macros. */ |
938 | /* Do we really need 2^32-1 range here? */ | |
c5d725c0 NS |
939 | unsigned int count; |
940 | ||
941 | /* Number of parameters. */ | |
942 | unsigned short paramc; | |
943 | ||
800c0e98 NS |
944 | /* Non-zero if this is a user-lazy macro, value provided by user. */ |
945 | unsigned char lazy; | |
946 | ||
10f04917 NS |
947 | /* The kind of this macro (ISO, trad or assert) */ |
948 | unsigned kind : 2; | |
949 | ||
c5d725c0 NS |
950 | /* If a function-like macro. */ |
951 | unsigned int fun_like : 1; | |
952 | ||
953 | /* If a variadic macro. */ | |
954 | unsigned int variadic : 1; | |
955 | ||
956 | /* If macro defined in system header. */ | |
957 | unsigned int syshdr : 1; | |
958 | ||
959 | /* Nonzero if it has been expanded or had its existence tested. */ | |
960 | unsigned int used : 1; | |
961 | ||
c5d725c0 NS |
962 | /* Indicate whether the tokens include extra CPP_PASTE tokens at the |
963 | end to track invalid redefinitions with consecutive CPP_PASTE | |
964 | tokens. */ | |
965 | unsigned int extra_tokens : 1; | |
10f04917 | 966 | |
62c5ea52 NS |
967 | /* Imported C++20 macro (from a header unit). */ |
968 | unsigned int imported_p : 1; | |
969 | ||
970 | /* 0 bits spare (32-bit). 32 on 64-bit target. */ | |
10f04917 NS |
971 | |
972 | union cpp_exp_u | |
973 | { | |
974 | /* Trailing array of replacement tokens (ISO), or assertion body value. */ | |
975 | cpp_token GTY ((tag ("false"), length ("%1.count"))) tokens[1]; | |
976 | ||
977 | /* Pointer to replacement text (traditional). See comment at top | |
978 | of cpptrad.c for how traditional function-like macros are | |
979 | encoded. */ | |
980 | const unsigned char *GTY ((tag ("true"))) text; | |
981 | } GTY ((desc ("%1.kind == cmk_traditional"))) exp; | |
c5d725c0 NS |
982 | }; |
983 | ||
a570d97f NS |
984 | /* Poisoned identifiers are flagged NODE_POISONED. NODE_OPERATOR (C++ |
985 | only) indicates an identifier that behaves like an operator such as | |
986 | "xor". NODE_DIAGNOSTIC is for speed in lex_token: it indicates a | |
93c80368 | 987 | diagnostic may be required for this node. Currently this only |
3d8b2a98 ILT |
988 | applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat |
989 | warnings about NODE_OPERATOR. */ | |
93c80368 NB |
990 | |
991 | /* Hash node flags. */ | |
992 | #define NODE_OPERATOR (1 << 0) /* C++ named operator. */ | |
993 | #define NODE_POISONED (1 << 1) /* Poisoned identifier. */ | |
a570d97f NS |
994 | #define NODE_DIAGNOSTIC (1 << 2) /* Possible diagnostic when lexed. */ |
995 | #define NODE_WARN (1 << 3) /* Warn if redefined or undefined. */ | |
996 | #define NODE_DISABLED (1 << 4) /* A disabled macro. */ | |
997 | #define NODE_USED (1 << 5) /* Dumped with -dU. */ | |
998 | #define NODE_CONDITIONAL (1 << 6) /* Conditional macro */ | |
999 | #define NODE_WARN_OPERATOR (1 << 7) /* Warn about C++ named operator. */ | |
c9c3d5f2 | 1000 | #define NODE_MODULE (1 << 8) /* C++-20 module-related name. */ |
93c80368 NB |
1001 | |
1002 | /* Different flavors of hash node. */ | |
f8f769ea ZW |
1003 | enum node_type |
1004 | { | |
a570d97f NS |
1005 | NT_VOID = 0, /* Maybe an assert? */ |
1006 | NT_MACRO_ARG, /* A macro arg. */ | |
1007 | NT_USER_MACRO, /* A user macro. */ | |
1008 | NT_BUILTIN_MACRO, /* A builtin macro. */ | |
1009 | NT_MACRO_MASK = NT_USER_MACRO /* Mask for either macro kind. */ | |
93c80368 NB |
1010 | }; |
1011 | ||
644eddaa NB |
1012 | /* Different flavors of builtin macro. _Pragma is an operator, but we |
1013 | handle it with the builtin code for efficiency reasons. */ | |
7e5487a2 | 1014 | enum cpp_builtin_type |
93c80368 NB |
1015 | { |
1016 | BT_SPECLINE = 0, /* `__LINE__' */ | |
1017 | BT_DATE, /* `__DATE__' */ | |
1018 | BT_FILE, /* `__FILE__' */ | |
1a9b3f04 | 1019 | BT_FILE_NAME, /* `__FILE_NAME__' */ |
93c80368 NB |
1020 | BT_BASE_FILE, /* `__BASE_FILE__' */ |
1021 | BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */ | |
1022 | BT_TIME, /* `__TIME__' */ | |
644eddaa | 1023 | BT_STDC, /* `__STDC__' */ |
be8ac3e2 | 1024 | BT_PRAGMA, /* `_Pragma' operator */ |
a702045a | 1025 | BT_TIMESTAMP, /* `__TIMESTAMP__' */ |
8e680db5 | 1026 | BT_COUNTER, /* `__COUNTER__' */ |
ad1a3914 | 1027 | BT_HAS_ATTRIBUTE, /* `__has_attribute(x)' */ |
1d00f8c8 | 1028 | BT_HAS_STD_ATTRIBUTE, /* `__has_c_attribute(x)' */ |
3d056cbf NS |
1029 | BT_HAS_BUILTIN, /* `__has_builtin(x)' */ |
1030 | BT_HAS_INCLUDE, /* `__has_include(x)' */ | |
06280a90 | 1031 | BT_HAS_INCLUDE_NEXT, /* `__has_include_next(x)' */ |
eba6d2aa | 1032 | BT_HAS_EMBED, /* `__has_embed(x)' */ |
06280a90 AC |
1033 | BT_HAS_FEATURE, /* `__has_feature(x)' */ |
1034 | BT_HAS_EXTENSION /* `__has_extension(x)' */ | |
f8f769ea ZW |
1035 | }; |
1036 | ||
2a967f3d | 1037 | #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE)) |
43af5ef1 NS |
1038 | #define HT_NODE(NODE) (&(NODE)->ident) |
1039 | #define NODE_LEN(NODE) HT_LEN (HT_NODE (NODE)) | |
1040 | #define NODE_NAME(NODE) HT_STR (HT_NODE (NODE)) | |
f8f769ea | 1041 | |
2a967f3d NB |
1042 | /* The common part of an identifier node shared amongst all 3 C front |
1043 | ends. Also used to store CPP identifiers, which are a superset of | |
1044 | identifiers in the grammatical sense. */ | |
c3f829c1 | 1045 | |
d1b38208 | 1046 | union GTY(()) _cpp_hashnode_value { |
a570d97f NS |
1047 | /* Assert (maybe NULL) */ |
1048 | cpp_macro * GTY((tag ("NT_VOID"))) answers; | |
13f93cf5 | 1049 | /* Macro (maybe NULL) */ |
a570d97f | 1050 | cpp_macro * GTY((tag ("NT_USER_MACRO"))) macro; |
c3f829c1 | 1051 | /* Code for a builtin macro. */ |
a570d97f | 1052 | enum cpp_builtin_type GTY ((tag ("NT_BUILTIN_MACRO"))) builtin; |
c3f829c1 | 1053 | /* Macro argument index. */ |
a570d97f | 1054 | unsigned short GTY ((tag ("NT_MACRO_ARG"))) arg_index; |
c3f829c1 GDR |
1055 | }; |
1056 | ||
d1b38208 | 1057 | struct GTY(()) cpp_hashnode { |
2a967f3d | 1058 | struct ht_identifier ident; |
4977bab6 | 1059 | unsigned int is_directive : 1; |
cf551fba | 1060 | unsigned int directive_index : 7; /* If is_directive, |
4977bab6 | 1061 | then index into directive table. |
71c0e7fc | 1062 | Otherwise, a NODE_OPERATOR. */ |
c9c3d5f2 NS |
1063 | unsigned int rid_code : 8; /* Rid code - for front ends. */ |
1064 | unsigned int flags : 9; /* CPP flags. */ | |
a5a35247 | 1065 | ENUM_BITFIELD(node_type) type : 2; /* CPP node type. */ |
a5a35247 | 1066 | |
13f93cf5 NS |
1067 | /* 5 bits spare. */ |
1068 | ||
62c5ea52 NS |
1069 | /* The deferred cookie is applicable to NT_USER_MACRO or NT_VOID. |
1070 | The latter for when a macro had a prevailing undef. | |
1071 | On a 64-bit system there would be 32-bits of padding to the value | |
13f93cf5 | 1072 | field. So placing the deferred index here is not costly. */ |
62c5ea52 | 1073 | unsigned deferred; /* Deferred cookie */ |
f8f769ea | 1074 | |
a570d97f | 1075 | union _cpp_hashnode_value GTY ((desc ("%1.type"))) value; |
f8f769ea ZW |
1076 | }; |
1077 | ||
cb05acdc LH |
1078 | /* Extra information we may need to store per identifier, which is needed rarely |
1079 | enough that it's not worth adding directly into the main identifier hash. */ | |
1080 | struct GTY(()) cpp_hashnode_extra | |
1081 | { | |
1082 | struct ht_identifier ident; | |
1083 | location_t poisoned_loc; | |
1084 | }; | |
1085 | ||
88fa5555 DM |
1086 | /* A class for iterating through the source locations within a |
1087 | string token (before escapes are interpreted, and before | |
1088 | concatenation). */ | |
1089 | ||
1090 | class cpp_string_location_reader { | |
1091 | public: | |
620e594b | 1092 | cpp_string_location_reader (location_t src_loc, |
88fa5555 DM |
1093 | line_maps *line_table); |
1094 | ||
1095 | source_range get_next (); | |
1096 | ||
1097 | private: | |
620e594b | 1098 | location_t m_loc; |
88fa5555 | 1099 | int m_offset_per_column; |
88fa5555 DM |
1100 | }; |
1101 | ||
1102 | /* A class for storing the source ranges of all of the characters within | |
1103 | a string literal, after escapes are interpreted, and after | |
1104 | concatenation. | |
1105 | ||
1106 | This is not GTY-marked, as instances are intended to be temporary. */ | |
1107 | ||
1108 | class cpp_substring_ranges | |
1109 | { | |
1110 | public: | |
1111 | cpp_substring_ranges (); | |
1112 | ~cpp_substring_ranges (); | |
1113 | ||
1114 | int get_num_ranges () const { return m_num_ranges; } | |
1115 | source_range get_range (int idx) const | |
1116 | { | |
1117 | linemap_assert (idx < m_num_ranges); | |
1118 | return m_ranges[idx]; | |
1119 | } | |
1120 | ||
1121 | void add_range (source_range range); | |
1122 | void add_n_ranges (int num, cpp_string_location_reader &loc_reader); | |
1123 | ||
1124 | private: | |
1125 | source_range *m_ranges; | |
1126 | int m_num_ranges; | |
1127 | int m_alloc_ranges; | |
1128 | }; | |
1129 | ||
b4e46cea PB |
1130 | /* Call this first to get a handle to pass to other functions. |
1131 | ||
cb05acdc LH |
1132 | The first hash table argument is for associating a struct cpp_hashnode |
1133 | with each identifier. The second hash table argument is for associating | |
1134 | a struct cpp_hashnode_extra with each identifier that needs one. For | |
1135 | either, pass in a NULL pointer if you want cpplib to create and manage | |
1136 | the hash table itself, or else pass a suitably initialized hash table to | |
1137 | be managed external to libcpp, as is done by the C-family frontends. */ | |
50f59cd7 | 1138 | extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *, |
cb05acdc LH |
1139 | class line_maps *, |
1140 | struct ht * = nullptr); | |
400023a3 | 1141 | |
5ffeb913 TT |
1142 | /* Reset the cpp_reader's line_map. This is only used after reading a |
1143 | PCH file. */ | |
99b1c316 | 1144 | extern void cpp_set_line_map (cpp_reader *, class line_maps *); |
5ffeb913 | 1145 | |
f749a36b NB |
1146 | /* Call this to change the selected language standard (e.g. because of |
1147 | command line options). */ | |
6cf87ca4 | 1148 | extern void cpp_set_lang (cpp_reader *, enum c_lang); |
f749a36b | 1149 | |
5793b276 | 1150 | /* Set the include paths. */ |
eba6d2aa JJ |
1151 | extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, |
1152 | cpp_dir *, int); | |
5793b276 | 1153 | |
c6e83800 ZW |
1154 | /* Call these to get pointers to the options, callback, and deps |
1155 | structures for a given reader. These pointers are good until you | |
1156 | call cpp_finish on that reader. You can either edit the callbacks | |
7e96d768 NB |
1157 | through the pointer returned from cpp_get_callbacks, or set them |
1158 | with cpp_set_callbacks. */ | |
7cf3f604 NS |
1159 | extern cpp_options *cpp_get_options (cpp_reader *) ATTRIBUTE_PURE; |
1160 | extern cpp_callbacks *cpp_get_callbacks (cpp_reader *) ATTRIBUTE_PURE; | |
6cf87ca4 | 1161 | extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *); |
7cf3f604 | 1162 | extern class mkdeps *cpp_get_deps (cpp_reader *) ATTRIBUTE_PURE; |
7e96d768 | 1163 | |
1f9db692 NS |
1164 | extern const char *cpp_probe_header_unit (cpp_reader *, const char *file, |
1165 | bool angle_p, location_t); | |
7ceb899e | 1166 | |
eccec868 JM |
1167 | /* Call these to get name data about the various compile-time |
1168 | charsets. */ | |
1169 | extern const char *cpp_get_narrow_charset_name (cpp_reader *) ATTRIBUTE_PURE; | |
1170 | extern const char *cpp_get_wide_charset_name (cpp_reader *) ATTRIBUTE_PURE; | |
1171 | ||
78673484 LH |
1172 | extern location_t cpp_get_diagnostic_override_loc (const cpp_reader *); |
1173 | ||
8e9ea4d7 PB |
1174 | /* This function reads the file, but does not start preprocessing. It |
1175 | returns the name of the original file; this is the same as the | |
1176 | input file, except for preprocessed input. This will generate at | |
1177 | least one file change callback, and possibly a line change callback | |
9ac97460 | 1178 | too. If there was an error opening the file, it returns NULL. */ |
6bf2ff0d NS |
1179 | extern const char *cpp_read_main_file (cpp_reader *, const char *, |
1180 | bool injecting = false); | |
9844497a NS |
1181 | extern location_t cpp_main_loc (const cpp_reader *); |
1182 | ||
1183 | /* Adjust for the main file to be an include. */ | |
1184 | extern void cpp_retrofit_as_include (cpp_reader *); | |
f5e99456 | 1185 | |
ccfc4c91 OW |
1186 | /* Set up built-ins with special behavior. Use cpp_init_builtins() |
1187 | instead unless your know what you are doing. */ | |
1188 | extern void cpp_init_special_builtins (cpp_reader *); | |
1189 | ||
c1bad961 | 1190 | /* Set up built-ins like __FILE__. */ |
6cf87ca4 | 1191 | extern void cpp_init_builtins (cpp_reader *, int); |
f5e99456 | 1192 | |
4169c321 | 1193 | /* This is called after options have been parsed, and partially |
59e4e217 | 1194 | processed. */ |
4169c321 PB |
1195 | extern void cpp_post_options (cpp_reader *); |
1196 | ||
e6cc3a24 ZW |
1197 | /* Set up translation to the target character set. */ |
1198 | extern void cpp_init_iconv (cpp_reader *); | |
1199 | ||
f4ff5a69 | 1200 | /* Call this to finish preprocessing. If you requested dependency |
024f135a BB |
1201 | generation, pass open stream(s) to write the information to, |
1202 | otherwise NULL. It is your responsibility to close the stream(s). */ | |
1203 | extern void cpp_finish (cpp_reader *, FILE *deps_stream, FILE *fdeps_stream = NULL); | |
f4ff5a69 | 1204 | |
f5e99456 | 1205 | /* Call this to release the handle at the end of preprocessing. Any |
148e4216 | 1206 | use of the handle after this function returns is invalid. */ |
6cf87ca4 | 1207 | extern void cpp_destroy (cpp_reader *); |
f5e99456 | 1208 | |
6cf87ca4 ZW |
1209 | extern unsigned int cpp_token_len (const cpp_token *); |
1210 | extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *); | |
1211 | extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *, | |
47e20491 | 1212 | unsigned char *, bool); |
6cf87ca4 | 1213 | extern void cpp_register_pragma (cpp_reader *, const char *, const char *, |
b5b3e36a | 1214 | void (*) (cpp_reader *), bool); |
bc4071dd RH |
1215 | extern void cpp_register_deferred_pragma (cpp_reader *, const char *, |
1216 | const char *, unsigned, bool, bool); | |
6cf87ca4 ZW |
1217 | extern int cpp_avoid_paste (cpp_reader *, const cpp_token *, |
1218 | const cpp_token *); | |
1219 | extern const cpp_token *cpp_get_token (cpp_reader *); | |
5ffeb913 | 1220 | extern const cpp_token *cpp_get_token_with_location (cpp_reader *, |
620e594b | 1221 | location_t *); |
3f6677f4 NS |
1222 | inline bool cpp_user_macro_p (const cpp_hashnode *node) |
1223 | { | |
a570d97f | 1224 | return node->type == NT_USER_MACRO; |
3f6677f4 NS |
1225 | } |
1226 | inline bool cpp_builtin_macro_p (const cpp_hashnode *node) | |
1227 | { | |
a570d97f | 1228 | return node->type == NT_BUILTIN_MACRO; |
3f6677f4 NS |
1229 | } |
1230 | inline bool cpp_macro_p (const cpp_hashnode *node) | |
1231 | { | |
a570d97f | 1232 | return node->type & NT_MACRO_MASK; |
3f6677f4 | 1233 | } |
13f93cf5 NS |
1234 | inline cpp_macro *cpp_set_deferred_macro (cpp_hashnode *node, |
1235 | cpp_macro *forced = NULL) | |
1236 | { | |
1237 | cpp_macro *old = node->value.macro; | |
1238 | ||
1239 | node->value.macro = forced; | |
1240 | node->type = NT_USER_MACRO; | |
1241 | node->flags &= ~NODE_USED; | |
1242 | ||
1243 | return old; | |
1244 | } | |
1245 | cpp_macro *cpp_get_deferred_macro (cpp_reader *, cpp_hashnode *, location_t); | |
a5a35247 | 1246 | |
3f6677f4 | 1247 | /* Returns true if NODE is a function-like user macro. */ |
7692e253 NS |
1248 | inline bool cpp_fun_like_macro_p (cpp_hashnode *node) |
1249 | { | |
1250 | return cpp_user_macro_p (node) && node->value.macro->fun_like; | |
1251 | } | |
3f6677f4 | 1252 | |
13f93cf5 NS |
1253 | extern const unsigned char *cpp_macro_definition (cpp_reader *, cpp_hashnode *); |
1254 | extern const unsigned char *cpp_macro_definition (cpp_reader *, cpp_hashnode *, | |
1255 | const cpp_macro *); | |
620e594b | 1256 | inline location_t cpp_macro_definition_location (cpp_hashnode *node) |
c9fb347e | 1257 | { |
13f93cf5 NS |
1258 | const cpp_macro *macro = node->value.macro; |
1259 | return macro ? macro->line : 0; | |
c9fb347e | 1260 | } |
4b5f564a | 1261 | /* Return an idempotent time stamp (possibly from SOURCE_DATE_EPOCH). */ |
45ab93d9 | 1262 | enum class CPP_time_kind |
4b5f564a NS |
1263 | { |
1264 | FIXED = -1, /* Fixed time via source epoch. */ | |
1265 | DYNAMIC = -2, /* Dynamic via time(2). */ | |
1266 | UNKNOWN = -3 /* Wibbly wobbly, timey wimey. */ | |
1267 | }; | |
1268 | extern CPP_time_kind cpp_get_date (cpp_reader *, time_t *); | |
1269 | ||
6cf87ca4 | 1270 | extern void _cpp_backup_tokens (cpp_reader *, unsigned int); |
5950c3c9 | 1271 | extern const cpp_token *cpp_peek_token (cpp_reader *, int); |
041c3194 | 1272 | |
2c6e3f55 | 1273 | /* Evaluate a CPP_*CHAR* token. */ |
6cf87ca4 ZW |
1274 | extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *, |
1275 | unsigned int *, int *); | |
2c6e3f55 | 1276 | /* Evaluate a vector of CPP_*STRING* tokens. */ |
e6cc3a24 ZW |
1277 | extern bool cpp_interpret_string (cpp_reader *, |
1278 | const cpp_string *, size_t, | |
b6baa67d | 1279 | cpp_string *, enum cpp_ttype); |
88fa5555 DM |
1280 | extern const char *cpp_interpret_string_ranges (cpp_reader *pfile, |
1281 | const cpp_string *from, | |
1282 | cpp_string_location_reader *, | |
1283 | size_t count, | |
1284 | cpp_substring_ranges *out, | |
1285 | enum cpp_ttype type); | |
423e95e2 EC |
1286 | extern bool cpp_interpret_string_notranslate (cpp_reader *, |
1287 | const cpp_string *, size_t, | |
b6baa67d | 1288 | cpp_string *, enum cpp_ttype); |
c8a96070 | 1289 | |
c5ff069d ZW |
1290 | /* Convert a host character constant to the execution character set. */ |
1291 | extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t); | |
1292 | ||
c1bad961 | 1293 | /* Used to register macros and assertions, perhaps from the command line. |
3d90d290 | 1294 | The text is the same as the command line argument. */ |
6cf87ca4 | 1295 | extern void cpp_define (cpp_reader *, const char *); |
6f1ae1ec | 1296 | extern void cpp_define_unused (cpp_reader *, const char *); |
45ab93d9 | 1297 | extern void cpp_define_formatted (cpp_reader *pfile, |
28f68625 | 1298 | const char *fmt, ...) ATTRIBUTE_PRINTF_2; |
6f1ae1ec PD |
1299 | extern void cpp_define_formatted_unused (cpp_reader *pfile, |
1300 | const char *fmt, | |
1301 | ...) ATTRIBUTE_PRINTF_2; | |
6cf87ca4 ZW |
1302 | extern void cpp_assert (cpp_reader *, const char *); |
1303 | extern void cpp_undef (cpp_reader *, const char *); | |
1304 | extern void cpp_unassert (cpp_reader *, const char *); | |
7f2935c7 | 1305 | |
800c0e98 NS |
1306 | /* Mark a node as a lazily defined macro. */ |
1307 | extern void cpp_define_lazily (cpp_reader *, cpp_hashnode *node, unsigned N); | |
1308 | ||
d1bd0ded GK |
1309 | /* Undefine all macros and assertions. */ |
1310 | extern void cpp_undef_all (cpp_reader *); | |
1311 | ||
6cf87ca4 | 1312 | extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *, |
4dc299fb | 1313 | size_t, int); |
6cf87ca4 | 1314 | extern int cpp_defined (cpp_reader *, const unsigned char *, int); |
c5a04734 | 1315 | |
cd7ab83f NB |
1316 | /* A preprocessing number. Code assumes that any unused high bits of |
1317 | the double integer are set to zero. */ | |
54da09ee | 1318 | |
edf6ddf6 | 1319 | /* This type has to be equal to unsigned HOST_WIDE_INT, see |
e53b6e56 | 1320 | gcc/c-family/c-lex.cc. */ |
edf6ddf6 | 1321 | typedef uint64_t cpp_num_part; |
cd7ab83f NB |
1322 | typedef struct cpp_num cpp_num; |
1323 | struct cpp_num | |
1324 | { | |
1325 | cpp_num_part high; | |
1326 | cpp_num_part low; | |
1327 | bool unsignedp; /* True if value should be treated as unsigned. */ | |
1328 | bool overflow; /* True if the most recent calculation overflowed. */ | |
1329 | }; | |
1330 | ||
1331 | /* cpplib provides two interfaces for interpretation of preprocessing | |
1332 | numbers. | |
1333 | ||
1334 | cpp_classify_number categorizes numeric constants according to | |
1335 | their field (integer, floating point, or invalid), radix (decimal, | |
1336 | octal, hexadecimal), and type suffixes. */ | |
1337 | ||
1338 | #define CPP_N_CATEGORY 0x000F | |
1339 | #define CPP_N_INVALID 0x0000 | |
1340 | #define CPP_N_INTEGER 0x0001 | |
1341 | #define CPP_N_FLOATING 0x0002 | |
1342 | ||
1343 | #define CPP_N_WIDTH 0x00F0 | |
8204be6c | 1344 | #define CPP_N_SMALL 0x0010 /* int, float, short _Fract/Accum */ |
ac6b1c67 CF |
1345 | #define CPP_N_MEDIUM 0x0020 /* long, double, long _Fract/_Accum. */ |
1346 | #define CPP_N_LARGE 0x0040 /* long long, long double, | |
1347 | long long _Fract/Accum. */ | |
cd7ab83f | 1348 | |
c77cd3d1 UB |
1349 | #define CPP_N_WIDTH_MD 0xF0000 /* machine defined. */ |
1350 | #define CPP_N_MD_W 0x10000 | |
1351 | #define CPP_N_MD_Q 0x20000 | |
1352 | ||
cd7ab83f NB |
1353 | #define CPP_N_RADIX 0x0F00 |
1354 | #define CPP_N_DECIMAL 0x0100 | |
1355 | #define CPP_N_HEX 0x0200 | |
1356 | #define CPP_N_OCTAL 0x0400 | |
f7fd775f | 1357 | #define CPP_N_BINARY 0x0800 |
cd7ab83f NB |
1358 | |
1359 | #define CPP_N_UNSIGNED 0x1000 /* Properties. */ | |
1360 | #define CPP_N_IMAGINARY 0x2000 | |
ad6ed77e | 1361 | #define CPP_N_DFLOAT 0x4000 |
839a3b8a | 1362 | #define CPP_N_DEFAULT 0x8000 |
cd7ab83f | 1363 | |
ac6b1c67 CF |
1364 | #define CPP_N_FRACT 0x100000 /* Fract types. */ |
1365 | #define CPP_N_ACCUM 0x200000 /* Accum types. */ | |
c65699ef JM |
1366 | #define CPP_N_FLOATN 0x400000 /* _FloatN types. */ |
1367 | #define CPP_N_FLOATNX 0x800000 /* _FloatNx types. */ | |
ac6b1c67 | 1368 | |
1f69e63c ESR |
1369 | #define CPP_N_USERDEF 0x1000000 /* C++11 user-defined literal. */ |
1370 | ||
1371 | #define CPP_N_SIZE_T 0x2000000 /* C++23 size_t literal. */ | |
c2565a31 | 1372 | #define CPP_N_BFLOAT16 0x4000000 /* std::bfloat16_t type. */ |
094a609c | 1373 | #define CPP_N_BITINT 0x8000000 /* C23 _BitInt literal. */ |
3ce4f9e4 | 1374 | |
c65699ef JM |
1375 | #define CPP_N_WIDTH_FLOATN_NX 0xF0000000 /* _FloatN / _FloatNx value |
1376 | of N, divided by 16. */ | |
1377 | #define CPP_FLOATN_SHIFT 24 | |
1378 | #define CPP_FLOATN_MAX 0xF0 | |
1379 | ||
cd7ab83f NB |
1380 | /* Classify a CPP_NUMBER token. The return value is a combination of |
1381 | the flags from the above sets. */ | |
3ce4f9e4 | 1382 | extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *, |
620e594b | 1383 | const char **, location_t); |
3ce4f9e4 ESR |
1384 | |
1385 | /* Return the classification flags for a float suffix. */ | |
a4a0016d ESR |
1386 | extern unsigned int cpp_interpret_float_suffix (cpp_reader *, const char *, |
1387 | size_t); | |
3ce4f9e4 ESR |
1388 | |
1389 | /* Return the classification flags for an int suffix. */ | |
a4a0016d ESR |
1390 | extern unsigned int cpp_interpret_int_suffix (cpp_reader *, const char *, |
1391 | size_t); | |
cd7ab83f NB |
1392 | |
1393 | /* Evaluate a token classified as category CPP_N_INTEGER. */ | |
6cf87ca4 | 1394 | extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *, |
3ce4f9e4 | 1395 | unsigned int); |
cd7ab83f | 1396 | |
ceeedfc1 NB |
1397 | /* Sign extend a number, with PRECISION significant bits and all |
1398 | others assumed clear, to fill out a cpp_num structure. */ | |
6cf87ca4 | 1399 | cpp_num cpp_num_sign_extend (cpp_num, size_t); |
ceeedfc1 | 1400 | |
ebef4e8c | 1401 | /* Output a diagnostic of some kind. */ |
c24300ba DM |
1402 | extern bool cpp_error (cpp_reader *, enum cpp_diagnostic_level, |
1403 | const char *msgid, ...) | |
c397a8c1 | 1404 | ATTRIBUTE_CPP_PPDIAG (3, 4); |
c24300ba DM |
1405 | extern bool cpp_warning (cpp_reader *, enum cpp_warning_reason, |
1406 | const char *msgid, ...) | |
c397a8c1 | 1407 | ATTRIBUTE_CPP_PPDIAG (3, 4); |
c24300ba DM |
1408 | extern bool cpp_pedwarning (cpp_reader *, enum cpp_warning_reason, |
1409 | const char *msgid, ...) | |
c397a8c1 | 1410 | ATTRIBUTE_CPP_PPDIAG (3, 4); |
c24300ba DM |
1411 | extern bool cpp_warning_syshdr (cpp_reader *, enum cpp_warning_reason reason, |
1412 | const char *msgid, ...) | |
c397a8c1 | 1413 | ATTRIBUTE_CPP_PPDIAG (3, 4); |
ebef4e8c | 1414 | |
bd5e882c DM |
1415 | /* As their counterparts above, but use RICHLOC. */ |
1416 | extern bool cpp_warning_at (cpp_reader *, enum cpp_warning_reason, | |
1417 | rich_location *richloc, const char *msgid, ...) | |
c397a8c1 | 1418 | ATTRIBUTE_CPP_PPDIAG (4, 5); |
bd5e882c DM |
1419 | extern bool cpp_pedwarning_at (cpp_reader *, enum cpp_warning_reason, |
1420 | rich_location *richloc, const char *msgid, ...) | |
c397a8c1 | 1421 | ATTRIBUTE_CPP_PPDIAG (4, 5); |
bd5e882c | 1422 | |
6cf87ca4 | 1423 | /* Output a diagnostic with "MSGID: " preceding the |
ebef4e8c | 1424 | error string of errno. No location is printed. */ |
c24300ba DM |
1425 | extern bool cpp_errno (cpp_reader *, enum cpp_diagnostic_level, |
1426 | const char *msgid); | |
46ce03de JJ |
1427 | /* Similarly, but with "FILENAME: " instead of "MSGID: ", where |
1428 | the filename is not localized. */ | |
c24300ba | 1429 | extern bool cpp_errno_filename (cpp_reader *, enum cpp_diagnostic_level, |
620e594b | 1430 | const char *filename, location_t loc); |
ebef4e8c NB |
1431 | |
1432 | /* Same as cpp_error, except additionally specifies a position as a | |
1433 | (translation unit) physical line and physical column. If the line is | |
1434 | zero, then no location is printed. */ | |
c24300ba | 1435 | extern bool cpp_error_with_line (cpp_reader *, enum cpp_diagnostic_level, |
620e594b | 1436 | location_t, unsigned, |
c24300ba | 1437 | const char *msgid, ...) |
c397a8c1 | 1438 | ATTRIBUTE_CPP_PPDIAG (5, 6); |
c24300ba | 1439 | extern bool cpp_warning_with_line (cpp_reader *, enum cpp_warning_reason, |
620e594b | 1440 | location_t, unsigned, |
c24300ba | 1441 | const char *msgid, ...) |
c397a8c1 | 1442 | ATTRIBUTE_CPP_PPDIAG (5, 6); |
c24300ba | 1443 | extern bool cpp_pedwarning_with_line (cpp_reader *, enum cpp_warning_reason, |
620e594b | 1444 | location_t, unsigned, |
c24300ba | 1445 | const char *msgid, ...) |
c397a8c1 | 1446 | ATTRIBUTE_CPP_PPDIAG (5, 6); |
c24300ba | 1447 | extern bool cpp_warning_with_line_syshdr (cpp_reader *, enum cpp_warning_reason, |
620e594b | 1448 | location_t, unsigned, |
c24300ba | 1449 | const char *msgid, ...) |
c397a8c1 | 1450 | ATTRIBUTE_CPP_PPDIAG (5, 6); |
f2d5f0cc | 1451 | |
c24300ba | 1452 | extern bool cpp_error_at (cpp_reader * pfile, enum cpp_diagnostic_level, |
620e594b | 1453 | location_t src_loc, const char *msgid, ...) |
c397a8c1 | 1454 | ATTRIBUTE_CPP_PPDIAG (4, 5); |
ac81cf0b | 1455 | |
c24300ba DM |
1456 | extern bool cpp_error_at (cpp_reader * pfile, enum cpp_diagnostic_level, |
1457 | rich_location *richloc, const char *msgid, ...) | |
c397a8c1 | 1458 | ATTRIBUTE_CPP_PPDIAG (4, 5); |
cb18fd07 | 1459 | |
e53b6e56 | 1460 | /* In lex.cc */ |
6cf87ca4 ZW |
1461 | extern int cpp_ideq (const cpp_token *, const char *); |
1462 | extern void cpp_output_line (cpp_reader *, FILE *); | |
5d6342eb TT |
1463 | extern unsigned char *cpp_output_line_to_string (cpp_reader *, |
1464 | const unsigned char *); | |
13f93cf5 NS |
1465 | extern const unsigned char *cpp_alloc_token_string |
1466 | (cpp_reader *, const unsigned char *, unsigned); | |
6cf87ca4 | 1467 | extern void cpp_output_token (const cpp_token *, FILE *); |
cfc93532 | 1468 | extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags); |
4268e8bb NB |
1469 | /* Returns the value of an escape sequence, truncated to the correct |
1470 | target precision. PSTR points to the input pointer, which is just | |
1471 | after the backslash. LIMIT is how much text we have. WIDE is true | |
1472 | if the escape sequence is part of a wide character constant or | |
1473 | string literal. Handles all relevant diagnostics. */ | |
6cf87ca4 ZW |
1474 | extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr, |
1475 | const unsigned char *limit, int wide); | |
1368ee70 | 1476 | |
631d0d36 MG |
1477 | /* Structure used to hold a comment block at a given location in the |
1478 | source code. */ | |
1479 | ||
1480 | typedef struct | |
1481 | { | |
1482 | /* Text of the comment including the terminators. */ | |
1483 | char *comment; | |
1484 | ||
1485 | /* source location for the given comment. */ | |
620e594b | 1486 | location_t sloc; |
631d0d36 MG |
1487 | } cpp_comment; |
1488 | ||
1489 | /* Structure holding all comments for a given cpp_reader. */ | |
1490 | ||
1491 | typedef struct | |
1492 | { | |
1493 | /* table of comment entries. */ | |
1494 | cpp_comment *entries; | |
1495 | ||
1496 | /* number of actual entries entered in the table. */ | |
1497 | int count; | |
1498 | ||
1499 | /* number of entries allocated currently. */ | |
1500 | int allocated; | |
1501 | } cpp_comment_table; | |
1502 | ||
1503 | /* Returns the table of comments encountered by the preprocessor. This | |
1504 | table is only populated when pfile->state.save_comments is true. */ | |
1505 | extern cpp_comment_table *cpp_get_comments (cpp_reader *); | |
1506 | ||
28f68625 | 1507 | /* In hash.c */ |
2a967f3d NB |
1508 | |
1509 | /* Lookup an identifier in the hashtable. Puts the identifier in the | |
1510 | table if it is not already there. */ | |
6cf87ca4 ZW |
1511 | extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *, |
1512 | unsigned int); | |
2a967f3d | 1513 | |
6cf87ca4 ZW |
1514 | typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *); |
1515 | extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *); | |
926c5678 | 1516 | |
e53b6e56 | 1517 | /* In macro.cc */ |
6cf87ca4 ZW |
1518 | extern void cpp_scan_nooutput (cpp_reader *); |
1519 | extern int cpp_sys_macro_p (cpp_reader *); | |
1520 | extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *, | |
1521 | unsigned int); | |
13f93cf5 NS |
1522 | extern bool cpp_compare_macros (const cpp_macro *macro1, |
1523 | const cpp_macro *macro2); | |
6de1e2a9 | 1524 | |
e53b6e56 | 1525 | /* In files.cc */ |
8f9b4009 | 1526 | extern bool cpp_included (cpp_reader *, const char *); |
620e594b | 1527 | extern bool cpp_included_before (cpp_reader *, const char *, location_t); |
6cf87ca4 | 1528 | extern void cpp_make_system_header (cpp_reader *, int, int); |
6cf87ca4 | 1529 | extern bool cpp_push_include (cpp_reader *, const char *); |
1efcb8c6 | 1530 | extern bool cpp_push_default_include (cpp_reader *, const char *); |
6cf87ca4 | 1531 | extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *); |
94d1613b | 1532 | extern const char *cpp_get_path (struct _cpp_file *); |
e3c287c9 | 1533 | extern cpp_dir *cpp_get_dir (struct _cpp_file *); |
94d1613b MS |
1534 | extern cpp_buffer *cpp_get_buffer (cpp_reader *); |
1535 | extern struct _cpp_file *cpp_get_file (cpp_buffer *); | |
1536 | extern cpp_buffer *cpp_get_prev (cpp_buffer *); | |
97f6bd40 | 1537 | extern void cpp_clear_file_cache (cpp_reader *); |
b0699dad | 1538 | |
3ac6b5cf LH |
1539 | /* cpp_get_converted_source returns the contents of the given file, as it exists |
1540 | after cpplib has read it and converted it from the input charset to the | |
1541 | source charset. Return struct will be zero-filled if the data could not be | |
1542 | read for any reason. The data starts at the DATA pointer, but the TO_FREE | |
1543 | pointer is what should be passed to free(), as there may be an offset. */ | |
1544 | struct cpp_converted_source | |
1545 | { | |
1546 | char *to_free; | |
1547 | char *data; | |
1548 | size_t len; | |
1549 | }; | |
1550 | cpp_converted_source cpp_get_converted_source (const char *fname, | |
1551 | const char *input_charset); | |
1552 | ||
e53b6e56 | 1553 | /* In pch.cc */ |
17211ab5 | 1554 | struct save_macro_data; |
6cf87ca4 ZW |
1555 | extern int cpp_save_state (cpp_reader *, FILE *); |
1556 | extern int cpp_write_pch_deps (cpp_reader *, FILE *); | |
1557 | extern int cpp_write_pch_state (cpp_reader *, FILE *); | |
1558 | extern int cpp_valid_state (cpp_reader *, const char *, int); | |
1559 | extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **); | |
1560 | extern int cpp_read_state (cpp_reader *, const char *, FILE *, | |
1561 | struct save_macro_data *); | |
17211ab5 | 1562 | |
e53b6e56 | 1563 | /* In lex.cc */ |
620e594b | 1564 | extern void cpp_force_token_locations (cpp_reader *, location_t); |
e3dfef44 | 1565 | extern void cpp_stop_forcing_token_locations (cpp_reader *); |
b224c376 NS |
1566 | enum CPP_DO_task |
1567 | { | |
1568 | CPP_DO_print, | |
1569 | CPP_DO_location, | |
1570 | CPP_DO_token | |
1571 | }; | |
1572 | ||
1573 | extern void cpp_directive_only_process (cpp_reader *pfile, | |
1574 | void *data, | |
1575 | void (*cb) (cpp_reader *, | |
1576 | CPP_DO_task, | |
1577 | void *data, ...)); | |
e3dfef44 | 1578 | |
e53b6e56 | 1579 | /* In expr.cc */ |
3ce4f9e4 ESR |
1580 | extern enum cpp_ttype cpp_userdef_string_remove_type |
1581 | (enum cpp_ttype type); | |
1582 | extern enum cpp_ttype cpp_userdef_string_add_type | |
1583 | (enum cpp_ttype type); | |
1584 | extern enum cpp_ttype cpp_userdef_char_remove_type | |
1585 | (enum cpp_ttype type); | |
1586 | extern enum cpp_ttype cpp_userdef_char_add_type | |
1587 | (enum cpp_ttype type); | |
1588 | extern bool cpp_userdef_string_p | |
1589 | (enum cpp_ttype type); | |
1590 | extern bool cpp_userdef_char_p | |
1591 | (enum cpp_ttype type); | |
1592 | extern const char * cpp_get_userdef_suffix | |
1593 | (const cpp_token *); | |
1594 | ||
e53b6e56 | 1595 | /* In charset.cc */ |
004bb936 | 1596 | |
bd5e882c DM |
1597 | /* The result of attempting to decode a run of UTF-8 bytes. */ |
1598 | ||
1599 | struct cpp_decoded_char | |
1600 | { | |
1601 | const char *m_start_byte; | |
1602 | const char *m_next_byte; | |
1603 | ||
1604 | bool m_valid_ch; | |
1605 | cppchar_t m_ch; | |
1606 | }; | |
1607 | ||
1608 | /* Information for mapping between code points and display columns. | |
1609 | ||
1610 | This is a tabstop value, along with a callback for getting the | |
1611 | widths of characters. Normally this callback is cpp_wcwidth, but we | |
1612 | support other schemes for escaping non-ASCII unicode as a series of | |
e53b6e56 | 1613 | ASCII chars when printing the user's source code in diagnostic-show-locus.cc |
bd5e882c DM |
1614 | |
1615 | For example, consider: | |
1616 | - the Unicode character U+03C0 "GREEK SMALL LETTER PI" (UTF-8: 0xCF 0x80) | |
1617 | - the Unicode character U+1F642 "SLIGHTLY SMILING FACE" | |
1618 | (UTF-8: 0xF0 0x9F 0x99 0x82) | |
1619 | - the byte 0xBF (a stray trailing byte of a UTF-8 character) | |
1620 | Normally U+03C0 would occupy one display column, U+1F642 | |
1621 | would occupy two display columns, and the stray byte would be | |
1622 | printed verbatim as one display column. | |
1623 | ||
1624 | However when escaping them as unicode code points as "<U+03C0>" | |
1625 | and "<U+1F642>" they occupy 8 and 9 display columns respectively, | |
1626 | and when escaping them as bytes as "<CF><80>" and "<F0><9F><99><82>" | |
1627 | they occupy 8 and 16 display columns respectively. In both cases | |
1628 | the stray byte is escaped to <BF> as 4 display columns. */ | |
1629 | ||
1630 | struct cpp_char_column_policy | |
1631 | { | |
1632 | cpp_char_column_policy (int tabstop, | |
1633 | int (*width_cb) (cppchar_t c)) | |
1634 | : m_tabstop (tabstop), | |
1635 | m_undecoded_byte_width (1), | |
1636 | m_width_cb (width_cb) | |
1637 | {} | |
1638 | ||
1639 | int m_tabstop; | |
1640 | /* Width in display columns of a stray byte that isn't decodable | |
1641 | as UTF-8. */ | |
1642 | int m_undecoded_byte_width; | |
1643 | int (*m_width_cb) (cppchar_t c); | |
1644 | }; | |
1645 | ||
004bb936 LH |
1646 | /* A class to manage the state while converting a UTF-8 sequence to cppchar_t |
1647 | and computing the display width one character at a time. */ | |
1648 | class cpp_display_width_computation { | |
1649 | public: | |
1650 | cpp_display_width_computation (const char *data, int data_length, | |
bd5e882c | 1651 | const cpp_char_column_policy &policy); |
004bb936 LH |
1652 | const char *next_byte () const { return m_next; } |
1653 | int bytes_processed () const { return m_next - m_begin; } | |
1654 | int bytes_left () const { return m_bytes_left; } | |
1655 | bool done () const { return !bytes_left (); } | |
1656 | int display_cols_processed () const { return m_display_cols; } | |
1657 | ||
bd5e882c | 1658 | int process_next_codepoint (cpp_decoded_char *out); |
004bb936 LH |
1659 | int advance_display_cols (int n); |
1660 | ||
1661 | private: | |
1662 | const char *const m_begin; | |
1663 | const char *m_next; | |
1664 | size_t m_bytes_left; | |
bd5e882c | 1665 | const cpp_char_column_policy &m_policy; |
004bb936 LH |
1666 | int m_display_cols; |
1667 | }; | |
1668 | ||
1669 | /* Convenience functions that are simple use cases for class | |
1670 | cpp_display_width_computation. Tab characters will be expanded to spaces | |
bd5e882c DM |
1671 | as determined by POLICY.m_tabstop, and non-printable-ASCII characters |
1672 | will be escaped as per POLICY. */ | |
3ac6b5cf | 1673 | |
ee925640 | 1674 | int cpp_byte_column_to_display_column (const char *data, int data_length, |
bd5e882c DM |
1675 | int column, |
1676 | const cpp_char_column_policy &policy); | |
004bb936 | 1677 | inline int cpp_display_width (const char *data, int data_length, |
bd5e882c | 1678 | const cpp_char_column_policy &policy) |
ee925640 | 1679 | { |
004bb936 | 1680 | return cpp_byte_column_to_display_column (data, data_length, data_length, |
bd5e882c | 1681 | policy); |
ee925640 LH |
1682 | } |
1683 | int cpp_display_column_to_byte_column (const char *data, int data_length, | |
bd5e882c DM |
1684 | int display_col, |
1685 | const cpp_char_column_policy &policy); | |
ee925640 LH |
1686 | int cpp_wcwidth (cppchar_t c); |
1687 | ||
3ac6b5cf LH |
1688 | bool cpp_input_conversion_is_trivial (const char *input_charset); |
1689 | int cpp_check_utf8_bom (const char *data, size_t data_length); | |
d495ea2b | 1690 | bool cpp_valid_utf8_p (const char *data, size_t num_bytes); |
3ac6b5cf | 1691 | |
4f01ae37 DM |
1692 | bool cpp_is_combining_char (cppchar_t c); |
1693 | bool cpp_is_printable_char (cppchar_t c); | |
1694 | ||
00dea7e8 RT |
1695 | enum cpp_xid_property { |
1696 | CPP_XID_START = 1, | |
1697 | CPP_XID_CONTINUE = 2 | |
1698 | }; | |
1699 | ||
1700 | unsigned int cpp_check_xid_property (cppchar_t c); | |
1701 | ||
998eb2a1 LH |
1702 | /* In errors.cc */ |
1703 | ||
1704 | /* RAII class to suppress CPP diagnostics in the current scope. */ | |
1705 | class cpp_auto_suppress_diagnostics | |
1706 | { | |
1707 | public: | |
1708 | explicit cpp_auto_suppress_diagnostics (cpp_reader *pfile); | |
1709 | ~cpp_auto_suppress_diagnostics (); | |
1710 | private: | |
1711 | cpp_reader *const m_pfile; | |
1712 | const decltype (cpp_callbacks::diagnostic) m_cb; | |
1713 | }; | |
1714 | ||
4f4e53dd | 1715 | #endif /* ! LIBCPP_CPPLIB_H */ |