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