blob: 99992a280ba64ee28cb919175eafaa2a9967207a [file] [log] [blame]
Per Bothner7f2935c1995-03-16 13:59:07 -08001/* Definitions for CPP library.
Jakub Jelinek85ec4fe2018-01-03 11:03:58 +01002 Copyright (C) 1995-2018 Free Software Foundation, Inc.
Per Bothner7f2935c1995-03-16 13:59:07 -08003 Written by Per Bothner, 1994-95.
4
5This program is free software; you can redistribute it and/or modify it
6under the terms of the GNU General Public License as published by the
Jakub Jelinek748086b2009-04-09 17:00:19 +02007Free Software Foundation; either version 3, or (at your option) any
Per Bothner7f2935c1995-03-16 13:59:07 -08008later version.
9
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
Jakub Jelinek748086b2009-04-09 17:00:19 +020016along with this program; see the file COPYING3. If not see
17<http://www.gnu.org/licenses/>.
Per Bothner7f2935c1995-03-16 13:59:07 -080018
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! */
Paolo Bonzini4f4e53dd2004-05-24 10:50:45 +000022#ifndef LIBCPP_CPPLIB_H
23#define LIBCPP_CPPLIB_H
Per Bothner7f2935c1995-03-16 13:59:07 -080024
25#include <sys/types.h>
Paolo Bonzini4f4e53dd2004-05-24 10:50:45 +000026#include "symtab.h"
Neil Boothd82fc102001-08-02 23:03:31 +000027#include "line-map.h"
Per Bothner7f2935c1995-03-16 13:59:07 -080028
Per Bothner7f2935c1995-03-16 13:59:07 -080029typedef struct cpp_reader cpp_reader;
30typedef struct cpp_buffer cpp_buffer;
31typedef struct cpp_options cpp_options;
Zack Weinberg1368ee72000-04-20 19:33:11 +000032typedef struct cpp_token cpp_token;
Zack Weinbergbfb9dc72000-07-08 19:00:39 +000033typedef struct cpp_string cpp_string;
Neil Bootha50882d2001-05-16 21:55:14 +000034typedef struct cpp_hashnode cpp_hashnode;
Neil Booth93c803682000-10-28 17:59:06 +000035typedef struct cpp_macro cpp_macro;
Neil Booth7e96d762001-01-13 01:00:01 +000036typedef struct cpp_callbacks cpp_callbacks;
Neil Booth8f9b4002003-07-29 22:26:13 +000037typedef struct cpp_dir cpp_dir;
Neil Booth93c803682000-10-28 17:59:06 +000038
Neil Booth93c803682000-10-28 17:59:06 +000039struct answer;
Mike Stump94d16132004-03-04 00:18:54 +000040struct _cpp_file;
Per Bothner7f2935c1995-03-16 13:59:07 -080041
Neil Boothf8b954f2002-04-26 06:32:50 +000042/* The first three groups, apart from '=', can appear in preprocessor
43 expressions (+= and -= are used to indicate unary + and - resp.).
44 This allows a lookup table to be implemented in _cpp_parse_expr.
Zack Weinbergc5a04732000-04-25 19:32:36 +000045
46 The first group, to CPP_LAST_EQ, can be immediately followed by an
47 '='. The lexer needs operators ending in '=', like ">>=", to be in
Steve Ellceyb52dbbf2006-08-14 23:13:54 +000048 the same order as their counterparts without the '=', like ">>".
49
50 See the cpp_operator table optab in expr.c if you change the order or
51 add or remove anything in the first group. */
Zack Weinbergc5a04732000-04-25 19:32:36 +000052
Zack Weinberg21b11492004-09-09 19:16:56 +000053#define TTYPE_TABLE \
54 OP(EQ, "=") \
55 OP(NOT, "!") \
56 OP(GREATER, ">") /* compare */ \
57 OP(LESS, "<") \
58 OP(PLUS, "+") /* math */ \
59 OP(MINUS, "-") \
60 OP(MULT, "*") \
61 OP(DIV, "/") \
62 OP(MOD, "%") \
63 OP(AND, "&") /* bit ops */ \
64 OP(OR, "|") \
65 OP(XOR, "^") \
66 OP(RSHIFT, ">>") \
67 OP(LSHIFT, "<<") \
Zack Weinberg21b11492004-09-09 19:16:56 +000068 \
69 OP(COMPL, "~") \
70 OP(AND_AND, "&&") /* logical */ \
71 OP(OR_OR, "||") \
72 OP(QUERY, "?") \
73 OP(COLON, ":") \
74 OP(COMMA, ",") /* grouping */ \
75 OP(OPEN_PAREN, "(") \
76 OP(CLOSE_PAREN, ")") \
77 TK(EOF, NONE) \
78 OP(EQ_EQ, "==") /* compare */ \
79 OP(NOT_EQ, "!=") \
80 OP(GREATER_EQ, ">=") \
81 OP(LESS_EQ, "<=") \
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, "<<=") \
Zack Weinberg21b11492004-09-09 19:16:56 +000095 /* 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' */ \
Kris Van Heesb6baa672008-04-18 13:58:08 +0000120 TK(CHAR16, LITERAL) /* u'char' */ \
121 TK(CHAR32, LITERAL) /* U'char' */ \
Edward Smith-Rowlandfe95b032015-06-30 12:58:48 +0000122 TK(UTF8CHAR, LITERAL) /* u8'char' */ \
Zack Weinberg21b11492004-09-09 19:16:56 +0000123 TK(OTHER, LITERAL) /* stray punctuation */ \
124 \
125 TK(STRING, LITERAL) /* "string" */ \
126 TK(WSTRING, LITERAL) /* L"string" */ \
Kris Van Heesb6baa672008-04-18 13:58:08 +0000127 TK(STRING16, LITERAL) /* u"string" */ \
128 TK(STRING32, LITERAL) /* U"string" */ \
Jakub Jelinek2c6e3f52009-10-19 23:41:15 +0200129 TK(UTF8STRING, LITERAL) /* u8"string" */ \
Zack Weinberg21b11492004-09-09 19:16:56 +0000130 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \
131 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \
132 \
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +0000133 TK(CHAR_USERDEF, LITERAL) /* 'char'_suffix - C++-0x */ \
134 TK(WCHAR_USERDEF, LITERAL) /* L'char'_suffix - C++-0x */ \
135 TK(CHAR16_USERDEF, LITERAL) /* u'char'_suffix - C++-0x */ \
136 TK(CHAR32_USERDEF, LITERAL) /* U'char'_suffix - C++-0x */ \
Edward Smith-Rowlandfe95b032015-06-30 12:58:48 +0000137 TK(UTF8CHAR_USERDEF, LITERAL) /* u8'char'_suffix - C++-0x */ \
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +0000138 TK(STRING_USERDEF, LITERAL) /* "string"_suffix - C++-0x */ \
139 TK(WSTRING_USERDEF, LITERAL) /* L"string"_suffix - C++-0x */ \
140 TK(STRING16_USERDEF, LITERAL) /* u"string"_suffix - C++-0x */ \
141 TK(STRING32_USERDEF, LITERAL) /* U"string"_suffix - C++-0x */ \
142 TK(UTF8STRING_USERDEF,LITERAL) /* u8"string"_suffix - C++-0x */ \
143 \
Zack Weinberg21b11492004-09-09 19:16:56 +0000144 TK(COMMENT, LITERAL) /* Only if output comments. */ \
145 /* SPELL_LITERAL happens to DTRT. */ \
146 TK(MACRO_ARG, NONE) /* Macro argument. */ \
Richard Hendersonbc4071d2006-01-04 08:33:38 -0800147 TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \
148 TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \
Zack Weinberg21b11492004-09-09 19:16:56 +0000149 TK(PADDING, NONE) /* Whitespace for -E. */
Zack Weinbergc5a04732000-04-25 19:32:36 +0000150
Zack Weinberg21b11492004-09-09 19:16:56 +0000151#define OP(e, s) CPP_ ## e,
152#define TK(e, s) CPP_ ## e,
Zack Weinberg3a2b2c72000-04-11 08:29:34 +0000153enum cpp_ttype
Zack Weinbergc45da1c2000-03-02 20:14:32 +0000154{
Zack Weinberg1368ee72000-04-20 19:33:11 +0000155 TTYPE_TABLE
Zack Weinberg21b11492004-09-09 19:16:56 +0000156 N_TTYPES,
157
Marek Polacek083e8912014-09-24 17:23:56 +0000158 /* A token type for keywords, as opposed to ordinary identifiers. */
159 CPP_KEYWORD,
160
Zack Weinberg21b11492004-09-09 19:16:56 +0000161 /* Positions in the table. */
Steve Ellceyb52dbbf2006-08-14 23:13:54 +0000162 CPP_LAST_EQ = CPP_LSHIFT,
Zack Weinberg21b11492004-09-09 19:16:56 +0000163 CPP_FIRST_DIGRAPH = CPP_HASH,
Steve Ellceyb52dbbf2006-08-14 23:13:54 +0000164 CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
Zack Weinberg21b11492004-09-09 19:16:56 +0000165 CPP_LAST_CPP_OP = CPP_LESS_EQ
Zack Weinberg1368ee72000-04-20 19:33:11 +0000166};
Zack Weinberg96be6992000-07-18 23:25:06 +0000167#undef OP
168#undef TK
Zack Weinberg1368ee72000-04-20 19:33:11 +0000169
Tobias Schlüterecfd72e2005-01-11 19:19:56 +0100170/* C language kind, used when calling cpp_create_reader. */
Joseph Myersc76dc9c2017-10-30 12:17:40 +0000171enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_GNUC11, CLK_GNUC17,
172 CLK_STDC89, CLK_STDC94, CLK_STDC99, CLK_STDC11, CLK_STDC17,
Paolo Carlini61949152013-04-24 19:33:54 +0000173 CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX11, CLK_CXX11,
Andrew Sutton026a79f2017-09-15 21:16:37 +0000174 CLK_GNUCXX14, CLK_CXX14, CLK_GNUCXX17, CLK_CXX17,
175 CLK_GNUCXX2A, CLK_CXX2A, CLK_ASM};
Neil Boothdd07b882000-11-20 18:27:32 +0000176
Neil Booth5d8ebbd2002-01-03 21:43:09 +0000177/* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
Taras Glekd1b38202009-04-22 18:29:36 +0000178struct GTY(()) cpp_string {
Zack Weinberg1368ee72000-04-20 19:33:11 +0000179 unsigned int len;
Neil Boothf617b8e2000-05-14 22:42:58 +0000180 const unsigned char *text;
Per Bothner7f2935c1995-03-16 13:59:07 -0800181};
182
Zack Weinbergc5a04732000-04-25 19:32:36 +0000183/* Flags for the cpp_token structure. */
Zack Weinberg041c3192000-07-04 01:58:21 +0000184#define PREV_WHITE (1 << 0) /* If whitespace before this token. */
Neil Booth93c803682000-10-28 17:59:06 +0000185#define DIGRAPH (1 << 1) /* If it was a digraph. */
186#define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
187#define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
Neil Boothdd07b882000-11-20 18:27:32 +0000188#define NAMED_OP (1 << 4) /* C++ named operators. */
Marek Polacek81fea422016-09-26 09:42:50 +0000189#define PREV_FALLTHROUGH (1 << 5) /* On a token preceeded by FALLTHROUGH
190 comment. */
Neil Booth4ed5bcf2001-09-24 22:53:12 +0000191#define BOL (1 << 6) /* Token at beginning of line. */
Volker Reicheltab847482005-12-22 12:01:44 +0000192#define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend,
193 set in c-lex.c. */
Joseph Myersaa508502009-04-19 18:10:56 +0100194#define SP_DIGRAPH (1 << 8) /* # or ## token was a digraph. */
195#define SP_PREV_WHITE (1 << 9) /* If whitespace before a ##
196 operator, or before this token
197 after a # operator. */
Marek Polacek81fea422016-09-26 09:42:50 +0000198#define NO_EXPAND (1 << 10) /* Do not macro-expand this token. */
Zack Weinberg9e62c812000-04-21 17:18:50 +0000199
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000200/* Specify which field, if any, of the cpp_token union is used. */
201
202enum cpp_token_fld_kind {
203 CPP_TOKEN_FLD_NODE,
204 CPP_TOKEN_FLD_SOURCE,
205 CPP_TOKEN_FLD_STR,
206 CPP_TOKEN_FLD_ARG_NO,
Joseph Myers9a0c6182009-05-10 15:27:32 +0100207 CPP_TOKEN_FLD_TOKEN_NO,
Richard Hendersonbc4071d2006-01-04 08:33:38 -0800208 CPP_TOKEN_FLD_PRAGMA,
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000209 CPP_TOKEN_FLD_NONE
210};
211
Joseph Myers9a0c6182009-05-10 15:27:32 +0100212/* A macro argument in the cpp_token union. */
213struct GTY(()) cpp_macro_arg {
214 /* Argument number. */
215 unsigned int arg_no;
Joseph Myersbe5ffc52014-11-06 21:08:52 +0000216 /* The original spelling of the macro argument token. */
217 cpp_hashnode *
218 GTY ((nested_ptr (union tree_node,
219 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
220 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
221 spelling;
Joseph Myers9a0c6182009-05-10 15:27:32 +0100222};
223
224/* An identifier in the cpp_token union. */
225struct GTY(()) cpp_identifier {
226 /* The canonical (UTF-8) spelling of the identifier. */
227 cpp_hashnode *
228 GTY ((nested_ptr (union tree_node,
229 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
230 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
231 node;
Joseph Myersbe5ffc52014-11-06 21:08:52 +0000232 /* The original spelling of the identifier. */
233 cpp_hashnode *
234 GTY ((nested_ptr (union tree_node,
235 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
236 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
237 spelling;
Joseph Myers9a0c6182009-05-10 15:27:32 +0100238};
239
Zack Weinberg1920de42000-05-03 15:35:47 +0000240/* A preprocessing token. This has been carefully packed and should
Neil Booth644edda2001-10-02 12:57:24 +0000241 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
Taras Glekd1b38202009-04-22 18:29:36 +0000242struct GTY(()) cpp_token {
David Malcolmebedc9a2015-11-13 16:29:59 +0000243 source_location src_loc; /* Location of first char of token,
244 together with range of full token. */
Zack Weinberg041c3192000-07-04 01:58:21 +0000245 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
Joseph Myersaa508502009-04-19 18:10:56 +0100246 unsigned short flags; /* flags - see above */
Zack Weinberg041c3192000-07-04 01:58:21 +0000247
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000248 union cpp_token_u
Zack Weinberg1368ee72000-04-20 19:33:11 +0000249 {
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000250 /* An identifier. */
Joseph Myers9a0c6182009-05-10 15:27:32 +0100251 struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node;
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000252
253 /* Inherit padding from this token. */
254 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
255
256 /* A string, or number. */
257 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
258
Joseph Myersbe5ffc52014-11-06 21:08:52 +0000259 /* Argument no. (and original spelling) for a CPP_MACRO_ARG. */
Joseph Myers9a0c6182009-05-10 15:27:32 +0100260 struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg;
261
262 /* Original token no. for a CPP_PASTE (from a sequence of
263 consecutive paste tokens in a macro expansion). */
264 unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no;
Richard Hendersonbc4071d2006-01-04 08:33:38 -0800265
266 /* Caller-supplied identifier for a CPP_PRAGMA. */
267 unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000268 } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
Zack Weinberg1368ee72000-04-20 19:33:11 +0000269};
270
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000271/* Say which field is in use. */
Jakub Jelinekc26302d2013-07-10 18:49:24 +0200272extern enum cpp_token_fld_kind cpp_token_val_index (const cpp_token *tok);
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000273
Neil Booth4268e8b2002-05-04 07:30:32 +0000274/* A type wide enough to hold any multibyte source character.
Neil Booth625458d2002-05-04 19:42:01 +0000275 cpplib's character constant interpreter requires an unsigned type.
Zack Weinberg43839642003-07-13 17:34:18 +0000276 Also, a typedef for the signed equivalent.
277 The width of this type is capped at 32 bits; there do exist targets
278 where wchar_t is 64 bits, but only in a non-default mode, and there
279 would be no meaningful interpretation for a wchar_t value greater
280 than 2^32 anyway -- the widest wide-character encoding around is
281 ISO 10646, which stops at 2^31. */
282#if CHAR_BIT * SIZEOF_INT >= 32
Neil Booth625458d2002-05-04 19:42:01 +0000283# define CPPCHAR_SIGNED_T int
Zack Weinberg43839642003-07-13 17:34:18 +0000284#elif CHAR_BIT * SIZEOF_LONG >= 32
285# define CPPCHAR_SIGNED_T long
Neil Booth625458d2002-05-04 19:42:01 +0000286#else
Zack Weinberg43839642003-07-13 17:34:18 +0000287# error "Cannot find a least-32-bit signed integer type"
Neil Booth625458d2002-05-04 19:42:01 +0000288#endif
289typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
290typedef CPPCHAR_SIGNED_T cppchar_signed_t;
Neil Booth0d9f2342000-09-18 18:43:05 +0000291
Bernardo Innocenti72bb2c32004-07-24 20:04:42 +0200292/* Style of header dependencies to generate. */
293enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
294
Geoffrey Keating50668cf2005-03-15 00:36:33 +0000295/* The possible normalization levels, from most restrictive to least. */
296enum cpp_normalize_level {
297 /* In NFKC. */
298 normalized_KC = 0,
299 /* In NFC. */
300 normalized_C,
301 /* In NFC, except for subsequences where being in NFC would make
302 the identifier invalid. */
303 normalized_identifier_C,
304 /* Not normalized at all. */
305 normalized_none
306};
307
Zack Weinbergae796972000-03-31 23:16:11 +0000308/* This structure is nested inside struct cpp_reader, and
309 carries all the options visible to the command line. */
310struct cpp_options
311{
Neil Booth6ab3e7d2000-05-18 11:09:27 +0000312 /* Characters between tab stops. */
313 unsigned int tabstop;
314
Neil Boothbdb05a72000-11-26 17:31:13 +0000315 /* The language we're preprocessing. */
316 enum c_lang lang;
317
Zack Weinbergae796972000-03-31 23:16:11 +0000318 /* Nonzero means use extra default include directories for C++. */
319 unsigned char cplusplus;
320
Kazu Hirata6614fd42003-12-21 14:08:35 +0000321 /* Nonzero means handle cplusplus style comments. */
Zack Weinbergae796972000-03-31 23:16:11 +0000322 unsigned char cplusplus_comments;
323
Tom Tromey899015a2008-05-13 14:50:27 +0000324 /* Nonzero means define __OBJC__, treat @ as a special token, use
325 the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
326 "#import". */
Zack Weinbergae796972000-03-31 23:16:11 +0000327 unsigned char objc;
328
Zack Weinbergae796972000-03-31 23:16:11 +0000329 /* Nonzero means don't copy comments into the output file. */
330 unsigned char discard_comments;
331
Jason Thorpe477cdac2002-04-07 03:12:23 +0000332 /* Nonzero means don't copy comments into the output file during
333 macro expansion. */
334 unsigned char discard_comments_in_macro_exp;
335
Zack Weinberg041c3192000-07-04 01:58:21 +0000336 /* Nonzero means process the ISO trigraph sequences. */
Zack Weinbergae796972000-03-31 23:16:11 +0000337 unsigned char trigraphs;
338
Neil Booth9b55f292000-07-11 08:58:28 +0000339 /* Nonzero means process the ISO digraph sequences. */
340 unsigned char digraphs;
341
Neil Boothbdb05a72000-11-26 17:31:13 +0000342 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
343 unsigned char extended_numbers;
344
Kris Van Heesb6baa672008-04-18 13:58:08 +0000345 /* Nonzero means process u/U prefix literals (UTF-16/32). */
346 unsigned char uliterals;
347
Edward Smith-Rowlandfe95b032015-06-30 12:58:48 +0000348 /* Nonzero means process u8 prefixed character literals (UTF-8). */
349 unsigned char utf8_char_literals;
350
Joseph Myers7c1ffff2011-08-18 16:24:45 +0100351 /* Nonzero means process r/R raw strings. If this is set, uliterals
Joseph Myersa48e3dd2011-08-18 16:13:49 +0100352 must be set as well. */
353 unsigned char rliterals;
354
Zack Weinbergae796972000-03-31 23:16:11 +0000355 /* Nonzero means print names of header files (-H). */
356 unsigned char print_include_names;
357
Jason Merrill9fbd3e42003-01-28 14:30:00 -0500358 /* Nonzero means complain about deprecated features. */
Joseph Myerse3339d02010-09-29 15:49:14 +0100359 unsigned char cpp_warn_deprecated;
Jason Merrill9fbd3e42003-01-28 14:30:00 -0500360
Zack Weinbergae796972000-03-31 23:16:11 +0000361 /* Nonzero means warn if slash-star appears in a comment. */
362 unsigned char warn_comments;
363
Tobias Burnuse8ff5192013-11-05 21:27:22 +0100364 /* Nonzero means to warn about __DATA__, __TIME__ and __TIMESTAMP__ usage. */
365 unsigned char warn_date_time;
366
Ben Ellistonb02398b2004-05-22 02:39:35 +0000367 /* Nonzero means warn if a user-supplied include directory does not
368 exist. */
369 unsigned char warn_missing_include_dirs;
370
Zack Weinbergae796972000-03-31 23:16:11 +0000371 /* Nonzero means warn if there are any trigraphs. */
372 unsigned char warn_trigraphs;
373
Neil Bootha5a49442002-05-06 22:53:10 +0000374 /* Nonzero means warn about multicharacter charconsts. */
375 unsigned char warn_multichar;
376
Zack Weinbergf9a0e962000-07-13 02:32:41 +0000377 /* Nonzero means warn about various incompatibilities with
378 traditional C. */
Joseph Myerse3339d02010-09-29 15:49:14 +0100379 unsigned char cpp_warn_traditional;
Zack Weinbergae796972000-03-31 23:16:11 +0000380
Neil Boothcd7ab832002-05-29 17:15:42 +0000381 /* Nonzero means warn about long long numeric constants. */
Joseph Myerse3339d02010-09-29 15:49:14 +0100382 unsigned char cpp_warn_long_long;
Neil Boothcd7ab832002-05-29 17:15:42 +0000383
Phil Edwards909de5d2002-03-22 21:59:04 +0000384 /* Nonzero means warn about text after an #endif (or #else). */
385 unsigned char warn_endif_labels;
386
Neil Booth68e652752002-07-20 13:31:56 +0000387 /* Nonzero means warn about implicit sign changes owing to integer
388 promotions. */
389 unsigned char warn_num_sign_change;
390
Richard Hendersone5b79212004-02-19 14:18:50 -0800391 /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
392 Presumably the usage is protected by the appropriate #ifdef. */
393 unsigned char warn_variadic_macros;
394
Simon Baldwinc047ce92008-09-18 15:39:08 +0000395 /* Nonzero means warn about builtin macros that are redefined or
396 explicitly undefined. */
397 unsigned char warn_builtin_macro_redefined;
398
Jakub Jelinek70f6d5e2016-10-12 01:19:06 +0200399 /* Different -Wimplicit-fallthrough= levels. */
400 unsigned char cpp_warn_implicit_fallthrough;
401
Zack Weinbergae796972000-03-31 23:16:11 +0000402 /* Nonzero means we should look for header.gcc files that remap file
403 names. */
404 unsigned char remap;
405
Kazu Hirataeebedaa2001-10-11 12:43:43 +0000406 /* Zero means dollar signs are punctuation. */
Zack Weinbergae796972000-03-31 23:16:11 +0000407 unsigned char dollars_in_ident;
408
Joseph Myersaf15a2f2005-09-20 21:31:37 +0100409 /* Nonzero means UCNs are accepted in identifiers. */
410 unsigned char extended_identifiers;
411
Hans-Peter Nilsson78b88112003-06-12 06:09:15 +0000412 /* True if we should warn about dollars in identifiers or numbers
413 for this translation unit. */
414 unsigned char warn_dollars;
415
Zack Weinbergae796972000-03-31 23:16:11 +0000416 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
417 unsigned char warn_undef;
418
Paolo Bonzinifb2675c2016-11-23 10:06:07 +0000419 /* Nonzero means warn if "defined" is encountered in a place other than
420 an #if. */
421 unsigned char warn_expansion_to_defined;
422
Neil Bootha69cbaa2002-07-23 22:57:49 +0000423 /* Nonzero means warn of unused macros from the main file. */
424 unsigned char warn_unused_macros;
425
Zack Weinbergae796972000-03-31 23:16:11 +0000426 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
427 unsigned char c99;
428
Neil Booth58551c22002-08-06 20:35:46 +0000429 /* Nonzero if we are conforming to a specific C or C++ standard. */
430 unsigned char std;
431
Zack Weinbergae796972000-03-31 23:16:11 +0000432 /* Nonzero means give all the error messages the ANSI standard requires. */
Joseph Myerse3339d02010-09-29 15:49:14 +0100433 unsigned char cpp_pedantic;
Zack Weinbergae796972000-03-31 23:16:11 +0000434
435 /* Nonzero means we're looking at already preprocessed code, so don't
436 bother trying to do macro expansion and whatnot. */
437 unsigned char preprocessed;
Tom Tromey847e6972011-10-17 09:59:40 +0000438
439 /* Nonzero means we are going to emit debugging logs during
440 preprocessing. */
441 unsigned char debug;
Zack Weinbergae796972000-03-31 23:16:11 +0000442
Tom Tromey92582b72011-10-17 09:59:12 +0000443 /* Nonzero means we are tracking locations of tokens involved in
444 macro expansion. 1 Means we track the location in degraded mode
445 where we do not track locations of tokens resulting from the
446 expansion of arguments of function-like macro. 2 Means we do
447 track all macro expansions. This last option is the one that
448 consumes the highest amount of memory. */
449 unsigned char track_macro_expansion;
450
Neil Booth644edda2001-10-02 12:57:24 +0000451 /* Nonzero means handle C++ alternate operator names. */
Jakub Jelinekbe768052000-12-15 16:49:28 +0100452 unsigned char operator_names;
Neil Booth7e96d762001-01-13 01:00:01 +0000453
Ian Lance Taylor3d8b2a92009-06-12 19:43:25 +0000454 /* Nonzero means warn about use of C++ alternate operator names. */
455 unsigned char warn_cxx_operator_names;
456
Neil Booth004cb262002-05-17 20:16:48 +0000457 /* True for traditional preprocessing. */
458 unsigned char traditional;
459
Jakub Jelinek01187df2013-04-28 23:36:57 +0200460 /* Nonzero for C++ 2011 Standard user-defined literals. */
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +0000461 unsigned char user_literals;
462
Ollie Wild7f5f5f92012-04-27 14:29:32 +0000463 /* Nonzero means warn when a string or character literal is followed by a
464 ud-suffix which does not beging with an underscore. */
465 unsigned char warn_literal_suffix;
466
Ed Smith-Rowlanda4a00162012-11-10 00:08:49 +0000467 /* Nonzero means interpret imaginary, fixed-point, or other gnu extension
468 literal number suffixes as user-defined literal number suffixes. */
469 unsigned char ext_numeric_literals;
470
Joseph Myersd3f4ff82013-11-16 00:05:08 +0000471 /* Nonzero means extended identifiers allow the characters specified
472 in C11 and C++11. */
473 unsigned char c11_identifiers;
474
Jakub Jelinek01187df2013-04-28 23:36:57 +0200475 /* Nonzero for C++ 2014 Standard binary constants. */
476 unsigned char binary_constants;
477
Edward Smith-Rowland7057e642013-10-31 14:01:23 +0000478 /* Nonzero for C++ 2014 Standard digit separators. */
479 unsigned char digit_separators;
480
Tom Tromeyfb771b92017-11-13 20:17:42 +0000481 /* Nonzero for C++2a __VA_OPT__ feature. */
482 unsigned char va_opt;
483
Zack Weinberge6cc3a22003-07-05 00:24:00 +0000484 /* Holds the name of the target (execution) character set. */
485 const char *narrow_charset;
486
487 /* Holds the name of the target wide character set. */
488 const char *wide_charset;
489
Eric Christophercf551fb2004-01-16 22:37:49 +0000490 /* Holds the name of the input character set. */
491 const char *input_charset;
492
Geoffrey Keating50668cf2005-03-15 00:36:33 +0000493 /* The minimum permitted level of normalization before a warning
Manuel López-Ibáñez1ef33fd2014-09-09 21:41:43 +0000494 is generated. See enum cpp_normalize_level. */
495 int warn_normalize;
Geoffrey Keating50668cf2005-03-15 00:36:33 +0000496
Neil Booth783e2982003-03-17 06:41:06 +0000497 /* True to warn about precompiled header files we couldn't use. */
498 bool warn_invalid_pch;
499
500 /* True if dependencies should be restored from a precompiled header. */
501 bool restore_pch_deps;
502
Marek Polacekf3bede72014-08-10 06:10:49 +0000503 /* True if warn about differences between C90 and C99. */
Marek Polacekdd3ff072014-08-20 04:12:58 +0000504 signed char cpp_warn_c90_c99_compat;
Marek Polacekf3bede72014-08-10 06:10:49 +0000505
Jason Merrillfe191302015-05-09 00:50:10 -0400506 /* True if warn about differences between C++98 and C++11. */
507 bool cpp_warn_cxx11_compat;
508
Neil Boothf4ff5a62002-08-12 22:44:30 +0000509 /* Dependency generation. */
510 struct
511 {
512 /* Style of header dependencies to generate. */
Bernardo Innocenti72bb2c32004-07-24 20:04:42 +0200513 enum cpp_deps_style style;
Neil Boothf4ff5a62002-08-12 22:44:30 +0000514
515 /* Assume missing files are generated files. */
516 bool missing_files;
517
518 /* Generate phony targets for each dependency apart from the first
519 one. */
520 bool phony_targets;
Neil Booth182d89a2002-08-14 22:34:50 +0000521
522 /* If true, no dependency is generated on the main file. */
523 bool ignore_main_file;
Chris Demetriou74dc6a12009-09-18 23:15:21 -0700524
525 /* If true, intend to use the preprocessor output (e.g., for compilation)
526 in addition to the dependency info. */
527 bool need_preprocessor_output;
Neil Boothf4ff5a62002-08-12 22:44:30 +0000528 } deps;
529
Neil Booth44a147a2002-05-07 21:07:24 +0000530 /* Target-specific features set by the front end or client. */
531
532 /* Precision for target CPP arithmetic, target characters, target
533 ints and target wide characters, respectively. */
534 size_t precision, char_precision, int_precision, wchar_precision;
535
Neil Booth23ff0222002-07-17 17:27:14 +0000536 /* True means chars (wide chars) are unsigned. */
537 bool unsigned_char, unsigned_wchar;
Zack Weinberg5279d732002-05-16 19:03:02 +0000538
Zack Weinberge6cc3a22003-07-05 00:24:00 +0000539 /* True if the most significant byte in a word has the lowest
540 address in memory. */
541 bool bytes_big_endian;
Neil Booth783e2982003-03-17 06:41:06 +0000542
Zack Weinberg5279d732002-05-16 19:03:02 +0000543 /* Nonzero means __STDC__ should have the value 0 in system headers. */
544 unsigned char stdc_0_in_system_headers;
Zack Weinberg21b11492004-09-09 19:16:56 +0000545
Ollie Wildccfc4c92007-07-30 18:29:20 +0000546 /* True disables tokenization outside of preprocessing directives. */
547 bool directives_only;
Simon Baldwin5dc99c42012-11-16 17:14:05 +0000548
549 /* True enables canonicalization of system header file paths. */
550 bool canonical_system_headers;
Zack Weinbergae796972000-03-31 23:16:11 +0000551};
552
Mike Stump94d16132004-03-04 00:18:54 +0000553/* Callback for header lookup for HEADER, which is the name of a
554 source file. It is used as a method of last resort to find headers
555 that are not otherwise found during the normal include processing.
556 The return value is the malloced name of a header to try and open,
557 if any, or NULL otherwise. This callback is called only if the
558 header is otherwise unfound. */
Mike Stumpe3c287c2004-05-05 18:25:52 +0000559typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
Mike Stump94d16132004-03-04 00:18:54 +0000560
Martin Schaffner48c47212003-06-25 23:01:10 +0200561/* Call backs to cpplib client. */
Neil Booth7e96d762001-01-13 01:00:01 +0000562struct cpp_callbacks
563{
Neil Booth97293892001-09-14 22:04:46 +0000564 /* Called when a new line of preprocessed output is started. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000565 void (*line_change) (cpp_reader *, const cpp_token *, int);
Per Bothner4dc299f2003-10-02 07:23:27 +0000566
567 /* Called when switching to/from a new file.
568 The line_map is for the new file. It is NULL if there is no new file.
569 (In C this happens when done with <built-in>+<command line> and also
570 when done with a main file.) This can be used for resource cleanup. */
David Malcolm0e50b622015-05-19 13:18:01 +0000571 void (*file_change) (cpp_reader *, const line_map_ordinary *);
Per Bothner4dc299f2003-10-02 07:23:27 +0000572
Alexandre Olivab20d9f02003-08-05 21:15:57 +0000573 void (*dir_change) (cpp_reader *, const char *);
Dodji Seketelid0a9fbe2011-07-15 21:34:02 +0000574 void (*include) (cpp_reader *, source_location, const unsigned char *,
Ian Lance Taylorcbc43ae2005-10-04 18:06:19 +0000575 const char *, int, const cpp_token **);
Dodji Seketelid0a9fbe2011-07-15 21:34:02 +0000576 void (*define) (cpp_reader *, source_location, cpp_hashnode *);
577 void (*undef) (cpp_reader *, source_location, cpp_hashnode *);
578 void (*ident) (cpp_reader *, source_location, const cpp_string *);
579 void (*def_pragma) (cpp_reader *, source_location);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000580 int (*valid_pch) (cpp_reader *, const char *, int);
581 void (*read_pch) (cpp_reader *, const char *, int, const char *);
Mike Stump94d16132004-03-04 00:18:54 +0000582 missing_header_cb missing_header;
Joseph Myers178b58b2005-11-03 23:08:18 +0000583
Ben Elliston5950c3c2008-07-14 05:09:48 +0000584 /* Context-sensitive macro support. Returns macro (if any) that should
585 be expanded. */
586 cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
587
Joseph Myers148e4212009-03-29 23:56:07 +0100588 /* Called to emit a diagnostic. This callback receives the
589 translated message. */
David Malcolm8a645152015-11-06 19:50:50 +0000590 bool (*error) (cpp_reader *, int, int, rich_location *,
Joseph Myers148e4212009-03-29 23:56:07 +0100591 const char *, va_list *)
David Malcolm8a645152015-11-06 19:50:50 +0000592 ATTRIBUTE_FPTR_PRINTF(5,0);
Joseph Myers93d45d92008-04-02 20:42:53 +0100593
594 /* Callbacks for when a macro is expanded, or tested (whether
595 defined or not at the time) in #ifdef, #ifndef or "defined". */
Dodji Seketelid0a9fbe2011-07-15 21:34:02 +0000596 void (*used_define) (cpp_reader *, source_location, cpp_hashnode *);
597 void (*used_undef) (cpp_reader *, source_location, cpp_hashnode *);
Joseph Myers93d45d92008-04-02 20:42:53 +0100598 /* Called before #define and #undef or other macro definition
599 changes are processed. */
600 void (*before_define) (cpp_reader *);
Arnaud Charlet3de8a542009-11-20 08:18:16 +0000601 /* Called whenever a macro is expanded or tested.
602 Second argument is the location of the start of the current expansion. */
603 void (*used) (cpp_reader *, source_location, cpp_hashnode *);
Jakub Jelinek8e680db2010-06-11 20:37:34 +0200604
Edward Smith-Rowland42fd12b2014-11-10 15:53:12 +0000605 /* Callback to identify whether an attribute exists. */
606 int (*has_attribute) (cpp_reader *);
607
Jakub Jelinek8e680db2010-06-11 20:37:34 +0200608 /* Callback that can change a user builtin into normal macro. */
609 bool (*user_builtin_macro) (cpp_reader *, cpp_hashnode *);
Eduard Sanou15c98b22016-06-01 16:42:41 +0000610
611 /* Callback to parse SOURCE_DATE_EPOCH from environment. */
612 time_t (*get_source_date_epoch) (cpp_reader *);
David Malcolmcb18fd02016-08-18 18:52:43 +0000613
614 /* Callback for providing suggestions for misspelled directives. */
615 const char *(*get_suggestion) (cpp_reader *, const char *, const char *const *);
David Malcolm05945a12017-06-05 20:53:06 +0000616
617 /* Callback for when a comment is encountered, giving the location
618 of the opening slash, a pointer to the content (which is not
619 necessarily 0-terminated), and the length of the content.
620 The content contains the opening slash-star (or slash-slash),
621 and for C-style comments contains the closing star-slash. For
622 C++-style comments it does not include the terminating newline. */
623 void (*comment) (cpp_reader *, source_location, const unsigned char *,
624 size_t);
Boris Kolpackov7365279f2018-01-18 13:17:37 +0000625
626 /* Callback for filename remapping in __FILE__ and __BASE_FILE__ macro
627 expansions. */
628 const char *(*remap_filename) (const char*);
Neil Booth7e96d762001-01-13 01:00:01 +0000629};
630
Douglas B Rupp0c539b42009-07-27 17:27:10 +0000631#ifdef VMS
632#define INO_T_CPP ino_t ino[3]
633#else
634#define INO_T_CPP ino_t ino
635#endif
636
Neil Booth5793b272003-03-01 14:31:21 +0000637/* Chain of directories to look for include files in. */
Neil Booth8f9b4002003-07-29 22:26:13 +0000638struct cpp_dir
Neil Booth5793b272003-03-01 14:31:21 +0000639{
640 /* NULL-terminated singly-linked list. */
Neil Booth8f9b4002003-07-29 22:26:13 +0000641 struct cpp_dir *next;
Neil Booth5793b272003-03-01 14:31:21 +0000642
Neil Booth8f9b4002003-07-29 22:26:13 +0000643 /* NAME of the directory, NUL-terminated. */
Neil Booth5793b272003-03-01 14:31:21 +0000644 char *name;
645 unsigned int len;
646
647 /* One if a system header, two if a system header that has extern
648 "C" guards for C++. */
649 unsigned char sysp;
650
Jakub Jelinek8f5929e2009-03-18 18:04:26 +0100651 /* Is this a user-supplied directory? */
652 bool user_supplied_p;
653
654 /* The canonicalized NAME as determined by lrealpath. This field
655 is only used by hosts that lack reliable inode numbers. */
656 char *canonical_name;
657
Neil Booth8f9b4002003-07-29 22:26:13 +0000658 /* Mapping of file names for this directory for MS-DOS and related
659 platforms. A NULL-terminated array of (from, to) pairs. */
660 const char **name_map;
Eric Christophercf551fb2004-01-16 22:37:49 +0000661
Mike Stump94d16132004-03-04 00:18:54 +0000662 /* Routine to construct pathname, given the search path name and the
663 HEADER we are trying to find, return a constructed pathname to
664 try and open. If this is NULL, the constructed pathname is as
665 constructed by append_file_to_dir. */
666 char *(*construct) (const char *header, cpp_dir *dir);
667
Neil Booth5793b272003-03-01 14:31:21 +0000668 /* The C front end uses these to recognize duplicated
669 directories in the search path. */
Douglas B Rupp0c539b42009-07-27 17:27:10 +0000670 INO_T_CPP;
Neil Booth5793b272003-03-01 14:31:21 +0000671 dev_t dev;
672};
673
Neil Booth93c803682000-10-28 17:59:06 +0000674/* The structure of a node in the hash table. The hash table has
675 entries for all identifiers: either macros defined by #define
676 commands (type NT_MACRO), assertions created with #assert
677 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
Kazu Hirata95bd1dd2003-01-18 02:26:43 +0000678 like __LINE__ are flagged NODE_BUILTIN. Poisoned identifiers are
Neil Booth93c803682000-10-28 17:59:06 +0000679 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
680 identifier that behaves like an operator such as "xor".
681 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
682 diagnostic may be required for this node. Currently this only
Ian Lance Taylor3d8b2a92009-06-12 19:43:25 +0000683 applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat
684 warnings about NODE_OPERATOR. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000685
Neil Booth93c803682000-10-28 17:59:06 +0000686/* Hash node flags. */
687#define NODE_OPERATOR (1 << 0) /* C++ named operator. */
688#define NODE_POISONED (1 << 1) /* Poisoned identifier. */
689#define NODE_BUILTIN (1 << 2) /* Builtin macro. */
690#define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
Neil Booth618cdda2001-02-25 09:43:03 +0000691#define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
Neil Booth644edda2001-10-02 12:57:24 +0000692#define NODE_DISABLED (1 << 5) /* A disabled macro. */
Kazu Hirata71c0e7f2003-06-23 15:27:37 +0000693#define NODE_MACRO_ARG (1 << 6) /* Used during #define processing. */
Joseph Myers93d45d92008-04-02 20:42:53 +0100694#define NODE_USED (1 << 7) /* Dumped with -dU. */
Ben Elliston5950c3c2008-07-14 05:09:48 +0000695#define NODE_CONDITIONAL (1 << 8) /* Conditional macro */
Ian Lance Taylor3d8b2a92009-06-12 19:43:25 +0000696#define NODE_WARN_OPERATOR (1 << 9) /* Warn about C++ named operator. */
Neil Booth93c803682000-10-28 17:59:06 +0000697
698/* Different flavors of hash node. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000699enum node_type
700{
Neil Booth93c803682000-10-28 17:59:06 +0000701 NT_VOID = 0, /* No definition yet. */
702 NT_MACRO, /* A macro of some form. */
703 NT_ASSERTION /* Predicate for #assert. */
704};
705
Neil Booth644edda2001-10-02 12:57:24 +0000706/* Different flavors of builtin macro. _Pragma is an operator, but we
707 handle it with the builtin code for efficiency reasons. */
Ian Lance Taylor7e5487a2009-05-16 06:54:11 +0000708enum cpp_builtin_type
Neil Booth93c803682000-10-28 17:59:06 +0000709{
710 BT_SPECLINE = 0, /* `__LINE__' */
711 BT_DATE, /* `__DATE__' */
712 BT_FILE, /* `__FILE__' */
713 BT_BASE_FILE, /* `__BASE_FILE__' */
714 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
715 BT_TIME, /* `__TIME__' */
Neil Booth644edda2001-10-02 12:57:24 +0000716 BT_STDC, /* `__STDC__' */
Grigory Zagorodnevbe8ac3e2006-02-18 09:25:31 +0000717 BT_PRAGMA, /* `_Pragma' operator */
Ollie Wilda7020452007-05-24 20:55:36 +0000718 BT_TIMESTAMP, /* `__TIMESTAMP__' */
Jakub Jelinek8e680db2010-06-11 20:37:34 +0200719 BT_COUNTER, /* `__COUNTER__' */
Jakub Jelinek1f8d3e82014-12-19 13:20:58 +0100720 BT_HAS_ATTRIBUTE, /* `__has_attribute__(x)' */
Jakub Jelinek8e680db2010-06-11 20:37:34 +0200721 BT_FIRST_USER, /* User defined builtin macros. */
Jakub Jelinek53723262018-01-27 07:27:47 +0100722 BT_LAST_USER = BT_FIRST_USER + 63
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000723};
724
Neil Booth2a967f32001-05-20 06:26:45 +0000725#define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
726#define HT_NODE(NODE) ((ht_identifier *) (NODE))
727#define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
728#define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000729
Geoffrey Keatingd8044162004-06-09 20:10:13 +0000730/* Specify which field, if any, of the union is used. */
731
732enum {
733 NTV_MACRO,
734 NTV_ANSWER,
735 NTV_BUILTIN,
736 NTV_ARGUMENT,
737 NTV_NONE
738};
739
740#define CPP_HASHNODE_VALUE_IDX(HNODE) \
741 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \
742 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \
743 ? NTV_BUILTIN : NTV_MACRO) \
744 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \
745 : NTV_NONE)
746
Neil Booth2a967f32001-05-20 06:26:45 +0000747/* The common part of an identifier node shared amongst all 3 C front
748 ends. Also used to store CPP identifiers, which are a superset of
749 identifiers in the grammatical sense. */
Gabriel Dos Reisc3f829c2005-05-28 15:52:48 +0000750
Taras Glekd1b38202009-04-22 18:29:36 +0000751union GTY(()) _cpp_hashnode_value {
Gabriel Dos Reisc3f829c2005-05-28 15:52:48 +0000752 /* If a macro. */
753 cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
754 /* Answers to an assertion. */
755 struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
756 /* Code for a builtin macro. */
Ian Lance Taylor7e5487a2009-05-16 06:54:11 +0000757 enum cpp_builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
Gabriel Dos Reisc3f829c2005-05-28 15:52:48 +0000758 /* Macro argument index. */
759 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
760};
761
Taras Glekd1b38202009-04-22 18:29:36 +0000762struct GTY(()) cpp_hashnode {
Neil Booth2a967f32001-05-20 06:26:45 +0000763 struct ht_identifier ident;
Zack Weinberg4977bab2002-12-16 18:23:00 +0000764 unsigned int is_directive : 1;
Eric Christophercf551fb2004-01-16 22:37:49 +0000765 unsigned int directive_index : 7; /* If is_directive,
Zack Weinberg4977bab2002-12-16 18:23:00 +0000766 then index into directive table.
Kazu Hirata71c0e7f2003-06-23 15:27:37 +0000767 Otherwise, a NODE_OPERATOR. */
Neil Booth2a967f32001-05-20 06:26:45 +0000768 unsigned char rid_code; /* Rid code - for front ends. */
Ian Lance Taylor3d8b2a92009-06-12 19:43:25 +0000769 ENUM_BITFIELD(node_type) type : 6; /* CPP node type. */
770 unsigned int flags : 10; /* CPP flags. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000771
Gabriel Dos Reisc3f829c2005-05-28 15:52:48 +0000772 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000773};
774
David Malcolm88fa5552016-08-05 18:08:33 +0000775/* A class for iterating through the source locations within a
776 string token (before escapes are interpreted, and before
777 concatenation). */
778
779class cpp_string_location_reader {
780 public:
781 cpp_string_location_reader (source_location src_loc,
782 line_maps *line_table);
783
784 source_range get_next ();
785
786 private:
787 source_location m_loc;
788 int m_offset_per_column;
789 line_maps *m_line_table;
790};
791
792/* A class for storing the source ranges of all of the characters within
793 a string literal, after escapes are interpreted, and after
794 concatenation.
795
796 This is not GTY-marked, as instances are intended to be temporary. */
797
798class cpp_substring_ranges
799{
800 public:
801 cpp_substring_ranges ();
802 ~cpp_substring_ranges ();
803
804 int get_num_ranges () const { return m_num_ranges; }
805 source_range get_range (int idx) const
806 {
807 linemap_assert (idx < m_num_ranges);
808 return m_ranges[idx];
809 }
810
811 void add_range (source_range range);
812 void add_n_ranges (int num, cpp_string_location_reader &loc_reader);
813
814 private:
815 source_range *m_ranges;
816 int m_num_ranges;
817 int m_alloc_ranges;
818};
819
Per Bothnerb4e46ce2003-03-20 16:46:18 +0000820/* Call this first to get a handle to pass to other functions.
821
822 If you want cpplib to manage its own hashtable, pass in a NULL
823 pointer. Otherwise you should pass in an initialized hash table
824 that cpplib will share; this technique is used by the C front
825 ends. */
Per Bothner50f59cd2004-01-19 21:30:18 -0800826extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
827 struct line_maps *);
Neil Booth400023a2001-01-14 22:00:20 +0000828
Tom Tromey5ffeb9132007-09-06 16:24:05 +0000829/* Reset the cpp_reader's line_map. This is only used after reading a
830 PCH file. */
831extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
832
Neil Boothf749a362002-08-10 20:58:45 +0000833/* Call this to change the selected language standard (e.g. because of
834 command line options). */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000835extern void cpp_set_lang (cpp_reader *, enum c_lang);
Neil Boothf749a362002-08-10 20:58:45 +0000836
Neil Booth5793b272003-03-01 14:31:21 +0000837/* Set the include paths. */
Neil Booth8f9b4002003-07-29 22:26:13 +0000838extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
Neil Booth5793b272003-03-01 14:31:21 +0000839
Zack Weinbergc6e83802004-06-05 20:58:06 +0000840/* Call these to get pointers to the options, callback, and deps
841 structures for a given reader. These pointers are good until you
842 call cpp_finish on that reader. You can either edit the callbacks
Neil Booth7e96d762001-01-13 01:00:01 +0000843 through the pointer returned from cpp_get_callbacks, or set them
844 with cpp_set_callbacks. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000845extern cpp_options *cpp_get_options (cpp_reader *);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000846extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
847extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
Zack Weinbergc6e83802004-06-05 20:58:06 +0000848extern struct deps *cpp_get_deps (cpp_reader *);
Neil Booth7e96d762001-01-13 01:00:01 +0000849
Per Bothner8e9ea4d2004-02-04 22:52:26 -0800850/* This function reads the file, but does not start preprocessing. It
851 returns the name of the original file; this is the same as the
852 input file, except for preprocessed input. This will generate at
853 least one file change callback, and possibly a line change callback
Kazu Hirata9ac97462004-02-16 14:20:10 +0000854 too. If there was an error opening the file, it returns NULL. */
Per Bothner8e9ea4d2004-02-04 22:52:26 -0800855extern const char *cpp_read_main_file (cpp_reader *, const char *);
Neil Boothf5e99452001-11-15 10:01:10 +0000856
Ollie Wildccfc4c92007-07-30 18:29:20 +0000857/* Set up built-ins with special behavior. Use cpp_init_builtins()
858 instead unless your know what you are doing. */
859extern void cpp_init_special_builtins (cpp_reader *);
860
Neil Boothc1bad962003-03-15 12:18:47 +0000861/* Set up built-ins like __FILE__. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000862extern void cpp_init_builtins (cpp_reader *, int);
Neil Boothf5e99452001-11-15 10:01:10 +0000863
Per Bothner4169c322003-08-09 22:14:07 +0000864/* This is called after options have been parsed, and partially
Kazu Hirata59e4e212003-08-19 21:04:38 +0000865 processed. */
Per Bothner4169c322003-08-09 22:14:07 +0000866extern void cpp_post_options (cpp_reader *);
867
Zack Weinberge6cc3a22003-07-05 00:24:00 +0000868/* Set up translation to the target character set. */
869extern void cpp_init_iconv (cpp_reader *);
870
Neil Boothf4ff5a62002-08-12 22:44:30 +0000871/* Call this to finish preprocessing. If you requested dependency
872 generation, pass an open stream to write the information to,
Joseph Myers148e4212009-03-29 23:56:07 +0100873 otherwise NULL. It is your responsibility to close the stream. */
874extern void cpp_finish (cpp_reader *, FILE *deps_stream);
Neil Boothf4ff5a62002-08-12 22:44:30 +0000875
Neil Boothf5e99452001-11-15 10:01:10 +0000876/* Call this to release the handle at the end of preprocessing. Any
Joseph Myers148e4212009-03-29 23:56:07 +0100877 use of the handle after this function returns is invalid. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000878extern void cpp_destroy (cpp_reader *);
Neil Boothf5e99452001-11-15 10:01:10 +0000879
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000880extern unsigned int cpp_token_len (const cpp_token *);
881extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
882extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
Geoffrey Keating47e20492005-03-12 10:44:06 +0000883 unsigned char *, bool);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000884extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
Daniel Jacobowitzb5b3e362004-11-23 23:25:40 +0000885 void (*) (cpp_reader *), bool);
Richard Hendersonbc4071d2006-01-04 08:33:38 -0800886extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
887 const char *, unsigned, bool, bool);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000888extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
889 const cpp_token *);
890extern const cpp_token *cpp_get_token (cpp_reader *);
Tom Tromey5ffeb9132007-09-06 16:24:05 +0000891extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
892 source_location *);
Nathan Sidwell3f6677f2018-08-16 13:51:38 +0000893inline bool cpp_user_macro_p (const cpp_hashnode *node)
894{
895 return node->type == NT_MACRO && !(node->flags & NODE_BUILTIN);
896}
897inline bool cpp_builtin_macro_p (const cpp_hashnode *node)
898{
899 return node->flags & NODE_BUILTIN;
900}
901inline bool cpp_macro_p (const cpp_hashnode *node)
902{
903 return node->type == NT_MACRO;
904}
905/* Returns true if NODE is a function-like user macro. */
906extern bool cpp_fun_like_macro_p (cpp_hashnode *node);
907
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000908extern const unsigned char *cpp_macro_definition (cpp_reader *,
Jakub Jelinek8e680db2010-06-11 20:37:34 +0200909 cpp_hashnode *);
David Malcolm01ada122017-11-21 00:40:53 +0000910extern source_location cpp_macro_definition_location (cpp_hashnode *);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000911extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
Ben Elliston5950c3c2008-07-14 05:09:48 +0000912extern const cpp_token *cpp_peek_token (cpp_reader *, int);
Zack Weinberg041c3192000-07-04 01:58:21 +0000913
Jakub Jelinek2c6e3f52009-10-19 23:41:15 +0200914/* Evaluate a CPP_*CHAR* token. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000915extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
916 unsigned int *, int *);
Jakub Jelinek2c6e3f52009-10-19 23:41:15 +0200917/* Evaluate a vector of CPP_*STRING* tokens. */
Zack Weinberge6cc3a22003-07-05 00:24:00 +0000918extern bool cpp_interpret_string (cpp_reader *,
919 const cpp_string *, size_t,
Kris Van Heesb6baa672008-04-18 13:58:08 +0000920 cpp_string *, enum cpp_ttype);
David Malcolm88fa5552016-08-05 18:08:33 +0000921extern const char *cpp_interpret_string_ranges (cpp_reader *pfile,
922 const cpp_string *from,
923 cpp_string_location_reader *,
924 size_t count,
925 cpp_substring_ranges *out,
926 enum cpp_ttype type);
Eric Christopher423e95e2004-02-12 02:25:03 +0000927extern bool cpp_interpret_string_notranslate (cpp_reader *,
928 const cpp_string *, size_t,
Kris Van Heesb6baa672008-04-18 13:58:08 +0000929 cpp_string *, enum cpp_ttype);
Neil Boothc8a96072001-05-11 23:48:21 +0000930
Zack Weinbergc5ff0692005-02-20 17:01:32 +0000931/* Convert a host character constant to the execution character set. */
932extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
933
Neil Boothc1bad962003-03-15 12:18:47 +0000934/* Used to register macros and assertions, perhaps from the command line.
Neil Booth3d90d292002-05-04 20:15:00 +0000935 The text is the same as the command line argument. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000936extern void cpp_define (cpp_reader *, const char *);
Daniel Franke28f68622008-04-22 14:04:32 -0400937extern void cpp_define_formatted (cpp_reader *pfile,
938 const char *fmt, ...) ATTRIBUTE_PRINTF_2;
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000939extern void cpp_assert (cpp_reader *, const char *);
940extern void cpp_undef (cpp_reader *, const char *);
941extern void cpp_unassert (cpp_reader *, const char *);
Per Bothner7f2935c1995-03-16 13:59:07 -0800942
Geoffrey Keatingd1bd0de2003-07-11 08:33:21 +0000943/* Undefine all macros and assertions. */
944extern void cpp_undef_all (cpp_reader *);
945
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000946extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
Per Bothner4dc299f2003-10-02 07:23:27 +0000947 size_t, int);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +0000948extern int cpp_defined (cpp_reader *, const unsigned char *, int);
Zack Weinbergc5a04732000-04-25 19:32:36 +0000949
Neil Boothcd7ab832002-05-29 17:15:42 +0000950/* A preprocessing number. Code assumes that any unused high bits of
951 the double integer are set to zero. */
Richard Biener54da09e2014-05-20 08:01:32 +0000952
Richard Bieneredf6ddf2014-05-26 08:19:02 +0000953/* This type has to be equal to unsigned HOST_WIDE_INT, see
Richard Biener54da09e2014-05-20 08:01:32 +0000954 gcc/c-family/c-lex.c. */
Richard Bieneredf6ddf2014-05-26 08:19:02 +0000955typedef uint64_t cpp_num_part;
Neil Boothcd7ab832002-05-29 17:15:42 +0000956typedef struct cpp_num cpp_num;
957struct cpp_num
958{
959 cpp_num_part high;
960 cpp_num_part low;
961 bool unsignedp; /* True if value should be treated as unsigned. */
962 bool overflow; /* True if the most recent calculation overflowed. */
963};
964
965/* cpplib provides two interfaces for interpretation of preprocessing
966 numbers.
967
968 cpp_classify_number categorizes numeric constants according to
969 their field (integer, floating point, or invalid), radix (decimal,
970 octal, hexadecimal), and type suffixes. */
971
972#define CPP_N_CATEGORY 0x000F
973#define CPP_N_INVALID 0x0000
974#define CPP_N_INTEGER 0x0001
975#define CPP_N_FLOATING 0x0002
976
977#define CPP_N_WIDTH 0x00F0
Andreas Schwab8204be62016-08-01 12:45:32 +0000978#define CPP_N_SMALL 0x0010 /* int, float, short _Fract/Accum */
Chao-ying Fuac6b1c62007-08-30 23:05:17 +0000979#define CPP_N_MEDIUM 0x0020 /* long, double, long _Fract/_Accum. */
980#define CPP_N_LARGE 0x0040 /* long long, long double,
981 long long _Fract/Accum. */
Neil Boothcd7ab832002-05-29 17:15:42 +0000982
Uros Bizjakc77cd3d2007-07-03 07:53:58 +0200983#define CPP_N_WIDTH_MD 0xF0000 /* machine defined. */
984#define CPP_N_MD_W 0x10000
985#define CPP_N_MD_Q 0x20000
986
Neil Boothcd7ab832002-05-29 17:15:42 +0000987#define CPP_N_RADIX 0x0F00
988#define CPP_N_DECIMAL 0x0100
989#define CPP_N_HEX 0x0200
990#define CPP_N_OCTAL 0x0400
Joerg Wunschf7fd7752007-06-05 22:25:27 +0000991#define CPP_N_BINARY 0x0800
Neil Boothcd7ab832002-05-29 17:15:42 +0000992
993#define CPP_N_UNSIGNED 0x1000 /* Properties. */
994#define CPP_N_IMAGINARY 0x2000
Jon Grimmad6ed772005-12-06 23:13:15 +0000995#define CPP_N_DFLOAT 0x4000
Janis Johnson839a3b82009-04-01 17:31:26 +0000996#define CPP_N_DEFAULT 0x8000
Neil Boothcd7ab832002-05-29 17:15:42 +0000997
Chao-ying Fuac6b1c62007-08-30 23:05:17 +0000998#define CPP_N_FRACT 0x100000 /* Fract types. */
999#define CPP_N_ACCUM 0x200000 /* Accum types. */
Joseph Myersc65699e2016-08-19 18:43:26 +01001000#define CPP_N_FLOATN 0x400000 /* _FloatN types. */
1001#define CPP_N_FLOATNX 0x800000 /* _FloatNx types. */
Chao-ying Fuac6b1c62007-08-30 23:05:17 +00001002
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +00001003#define CPP_N_USERDEF 0x1000000 /* C++0x user-defined literal. */
1004
Joseph Myersc65699e2016-08-19 18:43:26 +01001005#define CPP_N_WIDTH_FLOATN_NX 0xF0000000 /* _FloatN / _FloatNx value
1006 of N, divided by 16. */
1007#define CPP_FLOATN_SHIFT 24
1008#define CPP_FLOATN_MAX 0xF0
1009
Neil Boothcd7ab832002-05-29 17:15:42 +00001010/* Classify a CPP_NUMBER token. The return value is a combination of
1011 the flags from the above sets. */
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +00001012extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *,
Dodji Seketeli0b2c4be2012-05-16 10:51:15 +00001013 const char **, source_location);
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +00001014
1015/* Return the classification flags for a float suffix. */
Ed Smith-Rowlanda4a00162012-11-10 00:08:49 +00001016extern unsigned int cpp_interpret_float_suffix (cpp_reader *, const char *,
1017 size_t);
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +00001018
1019/* Return the classification flags for an int suffix. */
Ed Smith-Rowlanda4a00162012-11-10 00:08:49 +00001020extern unsigned int cpp_interpret_int_suffix (cpp_reader *, const char *,
1021 size_t);
Neil Boothcd7ab832002-05-29 17:15:42 +00001022
1023/* Evaluate a token classified as category CPP_N_INTEGER. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001024extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +00001025 unsigned int);
Neil Boothcd7ab832002-05-29 17:15:42 +00001026
Neil Boothceeedfc2002-06-02 19:37:34 +00001027/* Sign extend a number, with PRECISION significant bits and all
1028 others assumed clear, to fill out a cpp_num structure. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001029cpp_num cpp_num_sign_extend (cpp_num, size_t);
Neil Boothceeedfc2002-06-02 19:37:34 +00001030
Kazu Hirata95bd1dd2003-01-18 02:26:43 +00001031/* Diagnostic levels. To get a diagnostic without associating a
Neil Boothebef4e82002-04-14 18:42:47 +00001032 position in the translation unit with it, use cpp_error_with_line
1033 with a line number of zero. */
1034
Simon Baldwin87cf0652010-04-07 17:18:10 +00001035enum {
1036 /* Warning, an error with -Werror. */
1037 CPP_DL_WARNING = 0,
1038 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */
1039 CPP_DL_WARNING_SYSHDR,
1040 /* Warning, an error with -pedantic-errors or -Werror. */
1041 CPP_DL_PEDWARN,
1042 /* An error. */
1043 CPP_DL_ERROR,
1044 /* An internal consistency check failed. Prints "internal error: ",
1045 otherwise the same as CPP_DL_ERROR. */
1046 CPP_DL_ICE,
1047 /* An informative note following a warning. */
1048 CPP_DL_NOTE,
1049 /* A fatal error. */
1050 CPP_DL_FATAL
1051};
1052
1053/* Warning reason codes. Use a reason code of zero for unclassified warnings
1054 and errors that are not warnings. */
1055enum {
1056 CPP_W_NONE = 0,
1057 CPP_W_DEPRECATED,
1058 CPP_W_COMMENTS,
1059 CPP_W_MISSING_INCLUDE_DIRS,
1060 CPP_W_TRIGRAPHS,
1061 CPP_W_MULTICHAR,
1062 CPP_W_TRADITIONAL,
1063 CPP_W_LONG_LONG,
1064 CPP_W_ENDIF_LABELS,
1065 CPP_W_NUM_SIGN_CHANGE,
1066 CPP_W_VARIADIC_MACROS,
1067 CPP_W_BUILTIN_MACRO_REDEFINED,
1068 CPP_W_DOLLARS,
1069 CPP_W_UNDEF,
1070 CPP_W_UNUSED_MACROS,
1071 CPP_W_CXX_OPERATOR_NAMES,
1072 CPP_W_NORMALIZE,
1073 CPP_W_INVALID_PCH,
Ollie Wild7f5f5f92012-04-27 14:29:32 +00001074 CPP_W_WARNING_DIRECTIVE,
Tobias Burnuse8ff5192013-11-05 21:27:22 +01001075 CPP_W_LITERAL_SUFFIX,
Manuel López-Ibáñez2b71f4a2014-09-04 15:13:40 +00001076 CPP_W_DATE_TIME,
1077 CPP_W_PEDANTIC,
Jason Merrillfe191302015-05-09 00:50:10 -04001078 CPP_W_C90_C99_COMPAT,
Paolo Bonzinifb2675c2016-11-23 10:06:07 +00001079 CPP_W_CXX11_COMPAT,
1080 CPP_W_EXPANSION_TO_DEFINED
Simon Baldwin87cf0652010-04-07 17:18:10 +00001081};
Neil Boothebef4e82002-04-14 18:42:47 +00001082
Neil Boothebef4e82002-04-14 18:42:47 +00001083/* Output a diagnostic of some kind. */
Joseph Myers148e4212009-03-29 23:56:07 +01001084extern bool cpp_error (cpp_reader *, int, const char *msgid, ...)
Neil Boothebef4e82002-04-14 18:42:47 +00001085 ATTRIBUTE_PRINTF_3;
Simon Baldwin87cf0652010-04-07 17:18:10 +00001086extern bool cpp_warning (cpp_reader *, int, const char *msgid, ...)
1087 ATTRIBUTE_PRINTF_3;
1088extern bool cpp_pedwarning (cpp_reader *, int, const char *msgid, ...)
1089 ATTRIBUTE_PRINTF_3;
1090extern bool cpp_warning_syshdr (cpp_reader *, int, const char *msgid, ...)
1091 ATTRIBUTE_PRINTF_3;
Neil Boothebef4e82002-04-14 18:42:47 +00001092
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001093/* Output a diagnostic with "MSGID: " preceding the
Neil Boothebef4e82002-04-14 18:42:47 +00001094 error string of errno. No location is printed. */
Joseph Myers148e4212009-03-29 23:56:07 +01001095extern bool cpp_errno (cpp_reader *, int, const char *msgid);
Jakub Jelinek46ce03d2015-11-19 09:27:12 +01001096/* Similarly, but with "FILENAME: " instead of "MSGID: ", where
1097 the filename is not localized. */
David Malcolmac81cf02016-06-22 15:29:21 +00001098extern bool cpp_errno_filename (cpp_reader *, int, const char *filename,
1099 source_location loc);
Neil Boothebef4e82002-04-14 18:42:47 +00001100
1101/* Same as cpp_error, except additionally specifies a position as a
1102 (translation unit) physical line and physical column. If the line is
1103 zero, then no location is printed. */
Simon Baldwin87cf0652010-04-07 17:18:10 +00001104extern bool cpp_error_with_line (cpp_reader *, int, source_location,
1105 unsigned, const char *msgid, ...)
1106 ATTRIBUTE_PRINTF_5;
1107extern bool cpp_warning_with_line (cpp_reader *, int, source_location,
1108 unsigned, const char *msgid, ...)
1109 ATTRIBUTE_PRINTF_5;
1110extern bool cpp_pedwarning_with_line (cpp_reader *, int, source_location,
1111 unsigned, const char *msgid, ...)
1112 ATTRIBUTE_PRINTF_5;
1113extern bool cpp_warning_with_line_syshdr (cpp_reader *, int, source_location,
1114 unsigned, const char *msgid, ...)
1115 ATTRIBUTE_PRINTF_5;
Per Bothner7f2935c1995-03-16 13:59:07 -08001116
David Malcolmac81cf02016-06-22 15:29:21 +00001117extern bool cpp_error_at (cpp_reader * pfile, int level,
1118 source_location src_loc, const char *msgid, ...)
1119 ATTRIBUTE_PRINTF_4;
1120
David Malcolm64a59122017-10-31 20:21:58 +00001121extern bool cpp_error_at (cpp_reader * pfile, int level,
1122 rich_location *richloc, const char *msgid,
1123 ...)
David Malcolmcb18fd02016-08-18 18:52:43 +00001124 ATTRIBUTE_PRINTF_4;
1125
Daniel Franke28f68622008-04-22 14:04:32 -04001126/* In lex.c */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001127extern int cpp_ideq (const cpp_token *, const char *);
1128extern void cpp_output_line (cpp_reader *, FILE *);
Tom Tromey5d6342e2008-05-21 21:52:57 +00001129extern unsigned char *cpp_output_line_to_string (cpp_reader *,
1130 const unsigned char *);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001131extern void cpp_output_token (const cpp_token *, FILE *);
Manuel López-Ibáñezcfc93532009-04-22 15:32:18 +00001132extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
Neil Booth4268e8b2002-05-04 07:30:32 +00001133/* Returns the value of an escape sequence, truncated to the correct
1134 target precision. PSTR points to the input pointer, which is just
1135 after the backslash. LIMIT is how much text we have. WIDE is true
1136 if the escape sequence is part of a wide character constant or
1137 string literal. Handles all relevant diagnostics. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001138extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
1139 const unsigned char *limit, int wide);
Zack Weinberg1368ee72000-04-20 19:33:11 +00001140
Matthew Gingell631d0d32008-10-05 12:35:36 +00001141/* Structure used to hold a comment block at a given location in the
1142 source code. */
1143
1144typedef struct
1145{
1146 /* Text of the comment including the terminators. */
1147 char *comment;
1148
1149 /* source location for the given comment. */
1150 source_location sloc;
1151} cpp_comment;
1152
1153/* Structure holding all comments for a given cpp_reader. */
1154
1155typedef struct
1156{
1157 /* table of comment entries. */
1158 cpp_comment *entries;
1159
1160 /* number of actual entries entered in the table. */
1161 int count;
1162
1163 /* number of entries allocated currently. */
1164 int allocated;
1165} cpp_comment_table;
1166
1167/* Returns the table of comments encountered by the preprocessor. This
1168 table is only populated when pfile->state.save_comments is true. */
1169extern cpp_comment_table *cpp_get_comments (cpp_reader *);
1170
Daniel Franke28f68622008-04-22 14:04:32 -04001171/* In hash.c */
Neil Booth2a967f32001-05-20 06:26:45 +00001172
1173/* Lookup an identifier in the hashtable. Puts the identifier in the
1174 table if it is not already there. */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001175extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
1176 unsigned int);
Neil Booth2a967f32001-05-20 06:26:45 +00001177
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001178typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
1179extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
Geoff Keating926c5672000-10-29 07:07:20 +00001180
Daniel Franke28f68622008-04-22 14:04:32 -04001181/* In macro.c */
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001182extern void cpp_scan_nooutput (cpp_reader *);
1183extern int cpp_sys_macro_p (cpp_reader *);
1184extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
1185 unsigned int);
Zack Weinberg6de1e2a1999-02-18 15:35:49 +00001186
Daniel Franke28f68622008-04-22 14:04:32 -04001187/* In files.c */
Neil Booth8f9b4002003-07-29 22:26:13 +00001188extern bool cpp_included (cpp_reader *, const char *);
Tom Tromeyf1e20712007-11-12 00:38:48 +00001189extern bool cpp_included_before (cpp_reader *, const char *, source_location);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001190extern void cpp_make_system_header (cpp_reader *, int, int);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001191extern bool cpp_push_include (cpp_reader *, const char *);
Joseph Myers1efcb8c2012-10-23 15:55:55 +01001192extern bool cpp_push_default_include (cpp_reader *, const char *);
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001193extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
Mike Stump94d16132004-03-04 00:18:54 +00001194extern const char *cpp_get_path (struct _cpp_file *);
Mike Stumpe3c287c2004-05-05 18:25:52 +00001195extern cpp_dir *cpp_get_dir (struct _cpp_file *);
Mike Stump94d16132004-03-04 00:18:54 +00001196extern cpp_buffer *cpp_get_buffer (cpp_reader *);
1197extern struct _cpp_file *cpp_get_file (cpp_buffer *);
1198extern cpp_buffer *cpp_get_prev (cpp_buffer *);
Tom Tromey97f6bd42007-12-06 18:56:26 +00001199extern void cpp_clear_file_cache (cpp_reader *);
Zack Weinbergb0699da2000-03-07 20:58:47 +00001200
Daniel Franke28f68622008-04-22 14:04:32 -04001201/* In pch.c */
Geoffrey Keating17211ab2003-01-10 02:22:34 +00001202struct save_macro_data;
Zack Weinberg6cf87ca2003-06-17 06:17:44 +00001203extern int cpp_save_state (cpp_reader *, FILE *);
1204extern int cpp_write_pch_deps (cpp_reader *, FILE *);
1205extern int cpp_write_pch_state (cpp_reader *, FILE *);
1206extern int cpp_valid_state (cpp_reader *, const char *, int);
1207extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
1208extern int cpp_read_state (cpp_reader *, const char *, FILE *,
1209 struct save_macro_data *);
Geoffrey Keating17211ab2003-01-10 02:22:34 +00001210
Gabriel Charettee3dfef42011-08-22 20:41:07 +00001211/* In lex.c */
1212extern void cpp_force_token_locations (cpp_reader *, source_location *);
1213extern void cpp_stop_forcing_token_locations (cpp_reader *);
1214
Ed Smith-Rowland3ce4f9e2011-10-26 19:30:59 +00001215/* In expr.c */
1216extern enum cpp_ttype cpp_userdef_string_remove_type
1217 (enum cpp_ttype type);
1218extern enum cpp_ttype cpp_userdef_string_add_type
1219 (enum cpp_ttype type);
1220extern enum cpp_ttype cpp_userdef_char_remove_type
1221 (enum cpp_ttype type);
1222extern enum cpp_ttype cpp_userdef_char_add_type
1223 (enum cpp_ttype type);
1224extern bool cpp_userdef_string_p
1225 (enum cpp_ttype type);
1226extern bool cpp_userdef_char_p
1227 (enum cpp_ttype type);
1228extern const char * cpp_get_userdef_suffix
1229 (const cpp_token *);
1230
Paolo Bonzini4f4e53dd2004-05-24 10:50:45 +00001231#endif /* ! LIBCPP_CPPLIB_H */