]>
Commit | Line | Data |
---|---|---|
7f2935c7 | 1 | /* Definitions for CPP library. |
c58b209a | 2 | Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 |
2398fb2a | 3 | Free Software Foundation, Inc. |
7f2935c7 PB |
4 | Written by Per Bothner, 1994-95. |
5 | ||
6 | This program is free software; you can redistribute it and/or modify it | |
7 | under the terms of the GNU General Public License as published by the | |
8 | Free Software Foundation; either version 2, or (at your option) any | |
9 | later version. | |
10 | ||
11 | This program is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
17 | along with this program; if not, write to the Free Software | |
940d9d63 | 18 | Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
7f2935c7 PB |
19 | |
20 | In other words, you are welcome to use, share and improve this program. | |
21 | You are forbidden to forbid anyone else to use, share and improve | |
22 | what you give them. Help stamp out software-hoarding! */ | |
2a967f3d NB |
23 | #ifndef GCC_CPPLIB_H |
24 | #define GCC_CPPLIB_H | |
7f2935c7 PB |
25 | |
26 | #include <sys/types.h> | |
2a967f3d | 27 | #include "hashtable.h" |
d82fc108 | 28 | #include "line-map.h" |
7f2935c7 PB |
29 | |
30 | #ifdef __cplusplus | |
31 | extern "C" { | |
32 | #endif | |
33 | ||
7f2935c7 PB |
34 | typedef struct cpp_reader cpp_reader; |
35 | typedef struct cpp_buffer cpp_buffer; | |
36 | typedef struct cpp_options cpp_options; | |
1368ee70 | 37 | typedef struct cpp_token cpp_token; |
bfb9dc7f | 38 | typedef struct cpp_string cpp_string; |
a50882dc | 39 | typedef struct cpp_hashnode cpp_hashnode; |
93c80368 | 40 | typedef struct cpp_macro cpp_macro; |
7e96d768 | 41 | typedef struct cpp_callbacks cpp_callbacks; |
93c80368 | 42 | |
93c80368 | 43 | struct answer; |
93c80368 | 44 | struct file_name_map_list; |
c5a04734 | 45 | |
f8b954fc NB |
46 | /* The first three groups, apart from '=', can appear in preprocessor |
47 | expressions (+= and -= are used to indicate unary + and - resp.). | |
48 | This allows a lookup table to be implemented in _cpp_parse_expr. | |
c5a04734 ZW |
49 | |
50 | The first group, to CPP_LAST_EQ, can be immediately followed by an | |
51 | '='. The lexer needs operators ending in '=', like ">>=", to be in | |
52 | the same order as their counterparts without the '=', like ">>". */ | |
53 | ||
54 | /* Positions in the table. */ | |
6fee6033 | 55 | #define CPP_LAST_EQ CPP_MAX |
c5a04734 | 56 | #define CPP_FIRST_DIGRAPH CPP_HASH |
9ec7291f | 57 | #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR |
87ed109f | 58 | #define CPP_LAST_CPP_OP CPP_LESS_EQ |
1368ee70 | 59 | |
1368ee70 | 60 | #define TTYPE_TABLE \ |
96be6998 ZW |
61 | OP(CPP_EQ = 0, "=") \ |
62 | OP(CPP_NOT, "!") \ | |
63 | OP(CPP_GREATER, ">") /* compare */ \ | |
64 | OP(CPP_LESS, "<") \ | |
65 | OP(CPP_PLUS, "+") /* math */ \ | |
66 | OP(CPP_MINUS, "-") \ | |
67 | OP(CPP_MULT, "*") \ | |
68 | OP(CPP_DIV, "/") \ | |
69 | OP(CPP_MOD, "%") \ | |
70 | OP(CPP_AND, "&") /* bit ops */ \ | |
71 | OP(CPP_OR, "|") \ | |
72 | OP(CPP_XOR, "^") \ | |
73 | OP(CPP_RSHIFT, ">>") \ | |
74 | OP(CPP_LSHIFT, "<<") \ | |
92936ecf ZW |
75 | OP(CPP_MIN, "<?") /* extension */ \ |
76 | OP(CPP_MAX, ">?") \ | |
c5a04734 | 77 | \ |
96be6998 ZW |
78 | OP(CPP_COMPL, "~") \ |
79 | OP(CPP_AND_AND, "&&") /* logical */ \ | |
80 | OP(CPP_OR_OR, "||") \ | |
81 | OP(CPP_QUERY, "?") \ | |
82 | OP(CPP_COLON, ":") \ | |
83 | OP(CPP_COMMA, ",") /* grouping */ \ | |
84 | OP(CPP_OPEN_PAREN, "(") \ | |
85 | OP(CPP_CLOSE_PAREN, ")") \ | |
87ed109f | 86 | TK(CPP_EOF, SPELL_NONE) \ |
96be6998 ZW |
87 | OP(CPP_EQ_EQ, "==") /* compare */ \ |
88 | OP(CPP_NOT_EQ, "!=") \ | |
89 | OP(CPP_GREATER_EQ, ">=") \ | |
90 | OP(CPP_LESS_EQ, "<=") \ | |
1368ee70 | 91 | \ |
87ed109f | 92 | /* These two are unary + / - in preprocessor expressions. */ \ |
96be6998 ZW |
93 | OP(CPP_PLUS_EQ, "+=") /* math */ \ |
94 | OP(CPP_MINUS_EQ, "-=") \ | |
f8b954fc | 95 | \ |
96be6998 ZW |
96 | OP(CPP_MULT_EQ, "*=") \ |
97 | OP(CPP_DIV_EQ, "/=") \ | |
98 | OP(CPP_MOD_EQ, "%=") \ | |
99 | OP(CPP_AND_EQ, "&=") /* bit ops */ \ | |
100 | OP(CPP_OR_EQ, "|=") \ | |
101 | OP(CPP_XOR_EQ, "^=") \ | |
102 | OP(CPP_RSHIFT_EQ, ">>=") \ | |
103 | OP(CPP_LSHIFT_EQ, "<<=") \ | |
92936ecf ZW |
104 | OP(CPP_MIN_EQ, "<?=") /* extension */ \ |
105 | OP(CPP_MAX_EQ, ">?=") \ | |
c5a04734 | 106 | /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \ |
96be6998 ZW |
107 | OP(CPP_HASH, "#") /* digraphs */ \ |
108 | OP(CPP_PASTE, "##") \ | |
109 | OP(CPP_OPEN_SQUARE, "[") \ | |
110 | OP(CPP_CLOSE_SQUARE, "]") \ | |
111 | OP(CPP_OPEN_BRACE, "{") \ | |
112 | OP(CPP_CLOSE_BRACE, "}") \ | |
113 | /* The remainder of the punctuation. Order is not significant. */ \ | |
114 | OP(CPP_SEMICOLON, ";") /* structure */ \ | |
115 | OP(CPP_ELLIPSIS, "...") \ | |
96be6998 ZW |
116 | OP(CPP_PLUS_PLUS, "++") /* increment */ \ |
117 | OP(CPP_MINUS_MINUS, "--") \ | |
118 | OP(CPP_DEREF, "->") /* accessors */ \ | |
119 | OP(CPP_DOT, ".") \ | |
120 | OP(CPP_SCOPE, "::") \ | |
121 | OP(CPP_DEREF_STAR, "->*") \ | |
122 | OP(CPP_DOT_STAR, ".*") \ | |
40f03658 | 123 | OP(CPP_ATSIGN, "@") /* used in Objective-C */ \ |
1368ee70 | 124 | \ |
96be6998 | 125 | TK(CPP_NAME, SPELL_IDENT) /* word */ \ |
47ad4138 | 126 | TK(CPP_NUMBER, SPELL_NUMBER) /* 34_be+ta */ \ |
1368ee70 | 127 | \ |
96be6998 ZW |
128 | TK(CPP_CHAR, SPELL_STRING) /* 'char' */ \ |
129 | TK(CPP_WCHAR, SPELL_STRING) /* L'char' */ \ | |
130 | TK(CPP_OTHER, SPELL_CHAR) /* stray punctuation */ \ | |
131 | \ | |
132 | TK(CPP_STRING, SPELL_STRING) /* "string" */ \ | |
133 | TK(CPP_WSTRING, SPELL_STRING) /* L"string" */ \ | |
134 | TK(CPP_HEADER_NAME, SPELL_STRING) /* <stdio.h> in #include */ \ | |
135 | \ | |
47ad4138 ZW |
136 | TK(CPP_COMMENT, SPELL_NUMBER) /* Only if output comments. */ \ |
137 | /* SPELL_NUMBER happens to DTRT. */ \ | |
96be6998 | 138 | TK(CPP_MACRO_ARG, SPELL_NONE) /* Macro argument. */ \ |
f8b954fc | 139 | TK(CPP_PADDING, SPELL_NONE) /* Whitespace for cpp0. */ |
1368ee70 | 140 | |
96be6998 ZW |
141 | #define OP(e, s) e, |
142 | #define TK(e, s) e, | |
3a2b2c7a | 143 | enum cpp_ttype |
c45da1ca | 144 | { |
1368ee70 ZW |
145 | TTYPE_TABLE |
146 | N_TTYPES | |
147 | }; | |
96be6998 ZW |
148 | #undef OP |
149 | #undef TK | |
1368ee70 | 150 | |
dd07b884 NB |
151 | /* C language kind, used when calling cpp_reader_init. */ |
152 | enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99, | |
bdcae02b | 153 | CLK_GNUCXX, CLK_CXX98, CLK_ASM}; |
dd07b884 | 154 | |
5d8ebbd8 | 155 | /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */ |
bfb9dc7f | 156 | struct cpp_string |
1368ee70 ZW |
157 | { |
158 | unsigned int len; | |
f617b8e2 | 159 | const unsigned char *text; |
1368ee70 ZW |
160 | }; |
161 | ||
c5a04734 | 162 | /* Flags for the cpp_token structure. */ |
041c3194 | 163 | #define PREV_WHITE (1 << 0) /* If whitespace before this token. */ |
93c80368 NB |
164 | #define DIGRAPH (1 << 1) /* If it was a digraph. */ |
165 | #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */ | |
166 | #define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */ | |
dd07b884 | 167 | #define NAMED_OP (1 << 4) /* C++ named operators. */ |
93c80368 | 168 | #define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */ |
4ed5bcfb | 169 | #define BOL (1 << 6) /* Token at beginning of line. */ |
9e62c811 | 170 | |
1920de47 | 171 | /* A preprocessing token. This has been carefully packed and should |
644eddaa | 172 | occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */ |
1368ee70 ZW |
173 | struct cpp_token |
174 | { | |
1444f2ed NB |
175 | unsigned int line; /* Logical line of first char of token. */ |
176 | unsigned short col; /* Column of first char of token. */ | |
041c3194 ZW |
177 | ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */ |
178 | unsigned char flags; /* flags - see above */ | |
179 | ||
1368ee70 ZW |
180 | union |
181 | { | |
2a967f3d | 182 | cpp_hashnode *node; /* An identifier. */ |
4ed5bcfb | 183 | const cpp_token *source; /* Inherit padding from this token. */ |
6c53ebff NB |
184 | struct cpp_string str; /* A string, or number. */ |
185 | unsigned int arg_no; /* Argument no. for a CPP_MACRO_ARG. */ | |
186 | unsigned char c; /* Character represented by CPP_OTHER. */ | |
1368ee70 | 187 | } val; |
7f2935c7 PB |
188 | }; |
189 | ||
4268e8bb | 190 | /* A type wide enough to hold any multibyte source character. |
625458d0 NB |
191 | cpplib's character constant interpreter requires an unsigned type. |
192 | Also, a typedef for the signed equivalent. */ | |
193 | #ifndef MAX_WCHAR_TYPE_SIZE | |
194 | # define MAX_WCHAR_TYPE_SIZE WCHAR_TYPE_SIZE | |
195 | #endif | |
a5a49440 | 196 | #if CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE |
625458d0 NB |
197 | # define CPPCHAR_SIGNED_T int |
198 | #else | |
a5a49440 | 199 | # if CHAR_BIT * SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG |
625458d0 NB |
200 | # define CPPCHAR_SIGNED_T long |
201 | # else | |
202 | # define CPPCHAR_SIGNED_T long long | |
203 | # endif | |
204 | #endif | |
205 | typedef unsigned CPPCHAR_SIGNED_T cppchar_t; | |
206 | typedef CPPCHAR_SIGNED_T cppchar_signed_t; | |
0d9f234d | 207 | |
ae79697b ZW |
208 | /* Values for opts.dump_macros. |
209 | dump_only means inhibit output of the preprocessed text | |
210 | and instead output the definitions of all user-defined | |
86702e31 | 211 | macros in a form suitable for use as input to cpp. |
ae79697b ZW |
212 | dump_names means pass #define and the macro name through to output. |
213 | dump_definitions means pass the whole definition (plus #define) through | |
214 | */ | |
215 | enum { dump_none = 0, dump_only, dump_names, dump_definitions }; | |
7f2935c7 | 216 | |
ae79697b ZW |
217 | /* This structure is nested inside struct cpp_reader, and |
218 | carries all the options visible to the command line. */ | |
219 | struct cpp_options | |
c50bca08 | 220 | { |
6ab3e7dd NB |
221 | /* Characters between tab stops. */ |
222 | unsigned int tabstop; | |
223 | ||
eebedaa5 | 224 | /* Pending options - -D, -U, -A, -I, -ixxx. */ |
ae79697b | 225 | struct cpp_pending *pending; |
7f2935c7 | 226 | |
ae79697b | 227 | /* Search paths for include files. */ |
591e15a1 NB |
228 | struct search_path *quote_include; /* "" */ |
229 | struct search_path *bracket_include; /* <> */ | |
7f2935c7 | 230 | |
ae79697b ZW |
231 | /* Map between header names and file names, used only on DOS where |
232 | file names are limited in length. */ | |
7e2eb697 PB |
233 | struct file_name_map_list *map_list; |
234 | ||
ae79697b ZW |
235 | /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION' |
236 | in the standard include file directories. */ | |
237 | const char *include_prefix; | |
238 | unsigned int include_prefix_len; | |
239 | ||
bdb05a7b NB |
240 | /* The language we're preprocessing. */ |
241 | enum c_lang lang; | |
242 | ||
7f2935c7 | 243 | /* Non-0 means -v, so print the full set of include dirs. */ |
ae79697b | 244 | unsigned char verbose; |
7f2935c7 PB |
245 | |
246 | /* Nonzero means use extra default include directories for C++. */ | |
ae79697b | 247 | unsigned char cplusplus; |
7f2935c7 PB |
248 | |
249 | /* Nonzero means handle cplusplus style comments */ | |
ae79697b | 250 | unsigned char cplusplus_comments; |
7f2935c7 | 251 | |
bdcae02b NB |
252 | /* Nonzero means define __OBJC__, treat @ as a special token, and |
253 | use the OBJC[PLUS]_INCLUDE_PATH environment variable. */ | |
ae79697b | 254 | unsigned char objc; |
7f2935c7 | 255 | |
564ad5f4 | 256 | /* Nonzero means don't copy comments into the output file. */ |
ae79697b | 257 | unsigned char discard_comments; |
7f2935c7 | 258 | |
477cdac7 JT |
259 | /* Nonzero means don't copy comments into the output file during |
260 | macro expansion. */ | |
261 | unsigned char discard_comments_in_macro_exp; | |
262 | ||
041c3194 | 263 | /* Nonzero means process the ISO trigraph sequences. */ |
ae79697b | 264 | unsigned char trigraphs; |
7f2935c7 | 265 | |
9b55f29a NB |
266 | /* Nonzero means process the ISO digraph sequences. */ |
267 | unsigned char digraphs; | |
268 | ||
bdb05a7b NB |
269 | /* Nonzero means to allow hexadecimal floats and LL suffixes. */ |
270 | unsigned char extended_numbers; | |
271 | ||
7f2935c7 | 272 | /* Nonzero means print names of header files (-H). */ |
ae79697b | 273 | unsigned char print_include_names; |
7f2935c7 | 274 | |
ae79697b ZW |
275 | /* Nonzero means cpp_pedwarn causes a hard error. */ |
276 | unsigned char pedantic_errors; | |
7f2935c7 | 277 | |
c1212d2f | 278 | /* Nonzero means don't print warning messages. */ |
ae79697b | 279 | unsigned char inhibit_warnings; |
7f2935c7 | 280 | |
317639a8 BC |
281 | /* Nonzero means don't suppress warnings from system headers. */ |
282 | unsigned char warn_system_headers; | |
283 | ||
ae79697b ZW |
284 | /* Nonzero means don't print error messages. Has no option to |
285 | select it, but can be set by a user of cpplib (e.g. fix-header). */ | |
286 | unsigned char inhibit_errors; | |
c1212d2f | 287 | |
7f2935c7 | 288 | /* Nonzero means warn if slash-star appears in a comment. */ |
ae79697b | 289 | unsigned char warn_comments; |
7f2935c7 PB |
290 | |
291 | /* Nonzero means warn if there are any trigraphs. */ | |
ae79697b | 292 | unsigned char warn_trigraphs; |
7f2935c7 PB |
293 | |
294 | /* Nonzero means warn if #import is used. */ | |
ae79697b | 295 | unsigned char warn_import; |
7f2935c7 | 296 | |
a5a49440 NB |
297 | /* Nonzero means warn about multicharacter charconsts. */ |
298 | unsigned char warn_multichar; | |
299 | ||
f9a0e96c ZW |
300 | /* Nonzero means warn about various incompatibilities with |
301 | traditional C. */ | |
07aa0b04 | 302 | unsigned char warn_traditional; |
7f2935c7 | 303 | |
cd7ab83f NB |
304 | /* Nonzero means warn about long long numeric constants. */ |
305 | unsigned char warn_long_long; | |
306 | ||
909de5da PE |
307 | /* Nonzero means warn about text after an #endif (or #else). */ |
308 | unsigned char warn_endif_labels; | |
309 | ||
68e65275 NB |
310 | /* Nonzero means warn about implicit sign changes owing to integer |
311 | promotions. */ | |
312 | unsigned char warn_num_sign_change; | |
313 | ||
7f2935c7 | 314 | /* Nonzero means turn warnings into errors. */ |
ae79697b | 315 | unsigned char warnings_are_errors; |
7f2935c7 | 316 | |
ae79697b ZW |
317 | /* Nonzero causes output not to be done, but directives such as |
318 | #define that have side effects are still obeyed. */ | |
319 | unsigned char no_output; | |
7f2935c7 | 320 | |
31031edd JL |
321 | /* Nonzero means we should look for header.gcc files that remap file |
322 | names. */ | |
ae79697b | 323 | unsigned char remap; |
31031edd | 324 | |
7f2935c7 | 325 | /* Nonzero means don't output line number information. */ |
ae79697b | 326 | unsigned char no_line_commands; |
7f2935c7 | 327 | |
ae79697b ZW |
328 | /* Nonzero means -I- has been seen, so don't look for #include "foo" |
329 | the source-file directory. */ | |
330 | unsigned char ignore_srcdir; | |
7f2935c7 | 331 | |
eebedaa5 | 332 | /* Zero means dollar signs are punctuation. */ |
ae79697b | 333 | unsigned char dollars_in_ident; |
7f2935c7 | 334 | |
6ac34fdc | 335 | /* Nonzero means warn if undefined identifiers are evaluated in an #if. */ |
ae79697b | 336 | unsigned char warn_undef; |
6ac34fdc | 337 | |
a69cbaac NB |
338 | /* Nonzero means warn of unused macros from the main file. */ |
339 | unsigned char warn_unused_macros; | |
340 | ||
31948547 | 341 | /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */ |
ae79697b | 342 | unsigned char c99; |
31948547 | 343 | |
58551c23 NB |
344 | /* Nonzero if we are conforming to a specific C or C++ standard. */ |
345 | unsigned char std; | |
346 | ||
7f2935c7 | 347 | /* Nonzero means give all the error messages the ANSI standard requires. */ |
ae79697b | 348 | unsigned char pedantic; |
7f2935c7 | 349 | |
3773a46b JM |
350 | /* Nonzero means we're looking at already preprocessed code, so don't |
351 | bother trying to do macro expansion and whatnot. */ | |
ae79697b | 352 | unsigned char preprocessed; |
3773a46b | 353 | |
ae79697b ZW |
354 | /* Nonzero disables all the standard directories for headers. */ |
355 | unsigned char no_standard_includes; | |
7f2935c7 | 356 | |
ae79697b ZW |
357 | /* Nonzero disables the C++-specific standard directories for headers. */ |
358 | unsigned char no_standard_cplusplus_includes; | |
7f2935c7 | 359 | |
ae79697b ZW |
360 | /* Nonzero means dump macros in some fashion - see above. */ |
361 | unsigned char dump_macros; | |
7f2935c7 | 362 | |
ae79697b ZW |
363 | /* Nonzero means pass #include lines through to the output. */ |
364 | unsigned char dump_includes; | |
7f2935c7 | 365 | |
ae79697b ZW |
366 | /* Print column number in error messages. */ |
367 | unsigned char show_column; | |
be768055 | 368 | |
644eddaa | 369 | /* Nonzero means handle C++ alternate operator names. */ |
be768055 | 370 | unsigned char operator_names; |
7e96d768 | 371 | |
004cb263 NB |
372 | /* True for traditional preprocessing. */ |
373 | unsigned char traditional; | |
374 | ||
f4ff5a69 NB |
375 | /* Dependency generation. */ |
376 | struct | |
377 | { | |
378 | /* Style of header dependencies to generate. */ | |
379 | enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style; | |
380 | ||
381 | /* Assume missing files are generated files. */ | |
382 | bool missing_files; | |
383 | ||
384 | /* Generate phony targets for each dependency apart from the first | |
385 | one. */ | |
386 | bool phony_targets; | |
182d89a3 NB |
387 | |
388 | /* If true, no dependency is generated on the main file. */ | |
389 | bool ignore_main_file; | |
f4ff5a69 NB |
390 | } deps; |
391 | ||
44a147ad NB |
392 | /* Target-specific features set by the front end or client. */ |
393 | ||
394 | /* Precision for target CPP arithmetic, target characters, target | |
395 | ints and target wide characters, respectively. */ | |
396 | size_t precision, char_precision, int_precision, wchar_precision; | |
397 | ||
23ff0223 NB |
398 | /* True means chars (wide chars) are unsigned. */ |
399 | bool unsigned_char, unsigned_wchar; | |
5279d739 ZW |
400 | |
401 | /* Nonzero means __STDC__ should have the value 0 in system headers. */ | |
402 | unsigned char stdc_0_in_system_headers; | |
17211ab5 GK |
403 | |
404 | /* True to warn about precompiled header files we couldn't use. */ | |
405 | bool warn_invalid_pch; | |
406 | ||
407 | /* True if dependencies should be restored from a precompiled header. */ | |
408 | bool restore_pch_deps; | |
ae79697b | 409 | }; |
7f2935c7 | 410 | |
7e96d768 NB |
411 | /* Call backs. */ |
412 | struct cpp_callbacks | |
413 | { | |
97293897 NB |
414 | /* Called when a new line of preprocessed output is started. */ |
415 | void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int)); | |
416 | void (*file_change) PARAMS ((cpp_reader *, const struct line_map *)); | |
417 | void (*include) PARAMS ((cpp_reader *, unsigned int, | |
418 | const unsigned char *, const cpp_token *)); | |
419 | void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *)); | |
420 | void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *)); | |
421 | void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *)); | |
422 | void (*def_pragma) PARAMS ((cpp_reader *, unsigned int)); | |
3d90d290 NB |
423 | /* Called when the client has a chance to properly register |
424 | built-ins with cpp_define() and cpp_assert(). */ | |
425 | void (*register_builtins) PARAMS ((cpp_reader *)); | |
17211ab5 GK |
426 | int (*valid_pch) PARAMS ((cpp_reader *, const char *, int)); |
427 | void (*read_pch) PARAMS ((cpp_reader *, const char *, int, const char *)); | |
7e96d768 NB |
428 | }; |
429 | ||
7f2935c7 | 430 | /* Name under which this program was invoked. */ |
bcc5cac9 | 431 | extern const char *progname; |
7f2935c7 | 432 | |
93c80368 NB |
433 | /* The structure of a node in the hash table. The hash table has |
434 | entries for all identifiers: either macros defined by #define | |
435 | commands (type NT_MACRO), assertions created with #assert | |
436 | (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros | |
95bd1dd7 | 437 | like __LINE__ are flagged NODE_BUILTIN. Poisoned identifiers are |
93c80368 NB |
438 | flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an |
439 | identifier that behaves like an operator such as "xor". | |
440 | NODE_DIAGNOSTIC is for speed in lex_token: it indicates a | |
441 | diagnostic may be required for this node. Currently this only | |
442 | applies to __VA_ARGS__ and poisoned identifiers. */ | |
443 | ||
444 | /* Hash node flags. */ | |
445 | #define NODE_OPERATOR (1 << 0) /* C++ named operator. */ | |
446 | #define NODE_POISONED (1 << 1) /* Poisoned identifier. */ | |
447 | #define NODE_BUILTIN (1 << 2) /* Builtin macro. */ | |
448 | #define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */ | |
618cdda7 | 449 | #define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */ |
644eddaa | 450 | #define NODE_DISABLED (1 << 5) /* A disabled macro. */ |
4977bab6 | 451 | #define NODE_MACRO_ARG (1 << 6) /* Used during #define processing. */ |
93c80368 NB |
452 | |
453 | /* Different flavors of hash node. */ | |
f8f769ea ZW |
454 | enum node_type |
455 | { | |
93c80368 NB |
456 | NT_VOID = 0, /* No definition yet. */ |
457 | NT_MACRO, /* A macro of some form. */ | |
458 | NT_ASSERTION /* Predicate for #assert. */ | |
459 | }; | |
460 | ||
644eddaa NB |
461 | /* Different flavors of builtin macro. _Pragma is an operator, but we |
462 | handle it with the builtin code for efficiency reasons. */ | |
93c80368 NB |
463 | enum builtin_type |
464 | { | |
465 | BT_SPECLINE = 0, /* `__LINE__' */ | |
466 | BT_DATE, /* `__DATE__' */ | |
467 | BT_FILE, /* `__FILE__' */ | |
468 | BT_BASE_FILE, /* `__BASE_FILE__' */ | |
469 | BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */ | |
470 | BT_TIME, /* `__TIME__' */ | |
644eddaa NB |
471 | BT_STDC, /* `__STDC__' */ |
472 | BT_PRAGMA /* `_Pragma' operator */ | |
f8f769ea ZW |
473 | }; |
474 | ||
2a967f3d NB |
475 | #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE)) |
476 | #define HT_NODE(NODE) ((ht_identifier *) (NODE)) | |
477 | #define NODE_LEN(NODE) HT_LEN (&(NODE)->ident) | |
478 | #define NODE_NAME(NODE) HT_STR (&(NODE)->ident) | |
f8f769ea | 479 | |
2a967f3d NB |
480 | /* The common part of an identifier node shared amongst all 3 C front |
481 | ends. Also used to store CPP identifiers, which are a superset of | |
482 | identifiers in the grammatical sense. */ | |
17211ab5 | 483 | struct cpp_hashnode GTY(()) |
f8f769ea | 484 | { |
2a967f3d | 485 | struct ht_identifier ident; |
4977bab6 ZW |
486 | unsigned int is_directive : 1; |
487 | unsigned int directive_index : 7; /* If is_directive, | |
488 | then index into directive table. | |
489 | Otherwise, a NODE_OPERATOR. */ | |
2a967f3d NB |
490 | unsigned char rid_code; /* Rid code - for front ends. */ |
491 | ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */ | |
492 | unsigned char flags; /* CPP flags. */ | |
f8f769ea | 493 | |
4977bab6 | 494 | union _cpp_hashnode_value |
041c3194 | 495 | { |
17211ab5 GK |
496 | /* If a macro. */ |
497 | cpp_macro * GTY((skip (""))) macro; | |
498 | /* Answers to an assertion. */ | |
499 | struct answer * GTY ((skip (""))) answers; | |
500 | /* Code for a builtin macro. */ | |
501 | enum builtin_type GTY ((tag ("1"))) builtin; | |
502 | /* Macro argument index. */ | |
503 | unsigned short GTY ((tag ("0"))) arg_index; | |
504 | } GTY ((desc ("0"))) value; | |
f8f769ea ZW |
505 | }; |
506 | ||
f5e99456 NB |
507 | /* Call this first to get a handle to pass to other functions. */ |
508 | extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang)); | |
400023a3 | 509 | |
f749a36b NB |
510 | /* Call this to change the selected language standard (e.g. because of |
511 | command line options). */ | |
512 | extern void cpp_set_lang PARAMS ((cpp_reader *, enum c_lang)); | |
513 | ||
76c3e73e NB |
514 | /* Add a dependency TARGET. Quote it for "make" if QUOTE. Can be |
515 | called any number of times before cpp_read_main_file(). If no | |
516 | targets have been added before cpp_read_main_file(), then the | |
517 | default target is used. */ | |
518 | extern void cpp_add_dependency_target PARAMS ((cpp_reader *, | |
519 | const char * target, | |
520 | int quote)); | |
521 | ||
7e96d768 NB |
522 | /* Call these to get pointers to the options and callback structures |
523 | for a given reader. These pointers are good until you call | |
524 | cpp_finish on that reader. You can either edit the callbacks | |
525 | through the pointer returned from cpp_get_callbacks, or set them | |
526 | with cpp_set_callbacks. */ | |
527 | extern cpp_options *cpp_get_options PARAMS ((cpp_reader *)); | |
47d89cf3 | 528 | extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *)); |
7e96d768 NB |
529 | extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *)); |
530 | extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *)); | |
531 | ||
96302433 NB |
532 | /* Now call cpp_handle_option[s] to handle 1[or more] switches. The |
533 | return value is the number of arguments used. If | |
534 | cpp_handle_options returns without using all arguments, it couldn't | |
f4ff5a69 NB |
535 | understand the next switch. Options processing is not completed |
536 | until you call cpp_finish_options. */ | |
96302433 | 537 | extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **)); |
09e77dee | 538 | extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **)); |
96302433 | 539 | |
f5e99456 NB |
540 | /* This function reads the file, but does not start preprocessing. It |
541 | returns the name of the original file; this is the same as the | |
542 | input file, except for preprocessed input. This will generate at | |
543 | least one file change callback, and possibly a line change callback | |
544 | too. If there was an error opening the file, it returns NULL. | |
545 | ||
546 | If you want cpplib to manage its own hashtable, pass in a NULL | |
95bd1dd7 | 547 | pointer. Otherwise you should pass in an initialized hash table |
f5e99456 NB |
548 | that cpplib will share; this technique is used by the C front |
549 | ends. */ | |
550 | extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *, | |
551 | struct ht *)); | |
552 | ||
553 | /* Deferred handling of command line options that can generate debug | |
554 | callbacks, such as -D and -imacros. Call this after | |
555 | cpp_read_main_file. The front ends need this separation so they | |
556 | can initialize debug output with the original file name, returned | |
557 | from cpp_read_main_file, before they get debug callbacks. */ | |
558 | extern void cpp_finish_options PARAMS ((cpp_reader *)); | |
559 | ||
f4ff5a69 NB |
560 | /* Call this to finish preprocessing. If you requested dependency |
561 | generation, pass an open stream to write the information to, | |
562 | otherwise NULL. It is your responsibility to close the stream. | |
563 | ||
564 | Returns cpp_errors (pfile). */ | |
565 | extern int cpp_finish PARAMS ((cpp_reader *, FILE *deps_stream)); | |
566 | ||
f5e99456 NB |
567 | /* Call this to release the handle at the end of preprocessing. Any |
568 | use of the handle after this function returns is invalid. Returns | |
569 | cpp_errors (pfile). */ | |
76c3e73e | 570 | extern void cpp_destroy PARAMS ((cpp_reader *)); |
f5e99456 | 571 | |
7e96d768 NB |
572 | /* Error count. */ |
573 | extern unsigned int cpp_errors PARAMS ((cpp_reader *)); | |
574 | ||
93c80368 | 575 | extern unsigned int cpp_token_len PARAMS ((const cpp_token *)); |
dd07b884 NB |
576 | extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *, |
577 | const cpp_token *)); | |
93c80368 NB |
578 | extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *, |
579 | unsigned char *)); | |
58fea6af ZW |
580 | extern void cpp_register_pragma PARAMS ((cpp_reader *, |
581 | const char *, const char *, | |
582 | void (*) PARAMS ((cpp_reader *)))); | |
58fea6af | 583 | |
93c80368 NB |
584 | extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *, |
585 | const cpp_token *)); | |
4ed5bcfb | 586 | extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *)); |
93c80368 NB |
587 | extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *, |
588 | const cpp_hashnode *)); | |
bdcbe496 | 589 | extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int)); |
041c3194 | 590 | |
c8a96070 | 591 | /* Evaluate a CPP_CHAR or CPP_WCHAR token. */ |
4268e8bb | 592 | extern cppchar_t |
c8a96070 | 593 | cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *, |
a5a49440 | 594 | unsigned int *, int *)); |
c8a96070 | 595 | |
3d90d290 NB |
596 | /* Used to register builtins during the register_builtins callback. |
597 | The text is the same as the command line argument. */ | |
7ceb3598 NB |
598 | extern void cpp_define PARAMS ((cpp_reader *, const char *)); |
599 | extern void cpp_assert PARAMS ((cpp_reader *, const char *)); | |
600 | extern void cpp_undef PARAMS ((cpp_reader *, const char *)); | |
601 | extern void cpp_unassert PARAMS ((cpp_reader *, const char *)); | |
7f2935c7 | 602 | |
711b8824 | 603 | extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *, |
0bda4760 | 604 | const unsigned char *, size_t, |
29401c30 | 605 | int, int)); |
711b8824 | 606 | extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int)); |
c5a04734 | 607 | |
cd7ab83f NB |
608 | /* A preprocessing number. Code assumes that any unused high bits of |
609 | the double integer are set to zero. */ | |
610 | typedef unsigned HOST_WIDE_INT cpp_num_part; | |
611 | typedef struct cpp_num cpp_num; | |
612 | struct cpp_num | |
613 | { | |
614 | cpp_num_part high; | |
615 | cpp_num_part low; | |
616 | bool unsignedp; /* True if value should be treated as unsigned. */ | |
617 | bool overflow; /* True if the most recent calculation overflowed. */ | |
618 | }; | |
619 | ||
620 | /* cpplib provides two interfaces for interpretation of preprocessing | |
621 | numbers. | |
622 | ||
623 | cpp_classify_number categorizes numeric constants according to | |
624 | their field (integer, floating point, or invalid), radix (decimal, | |
625 | octal, hexadecimal), and type suffixes. */ | |
626 | ||
627 | #define CPP_N_CATEGORY 0x000F | |
628 | #define CPP_N_INVALID 0x0000 | |
629 | #define CPP_N_INTEGER 0x0001 | |
630 | #define CPP_N_FLOATING 0x0002 | |
631 | ||
632 | #define CPP_N_WIDTH 0x00F0 | |
633 | #define CPP_N_SMALL 0x0010 /* int, float. */ | |
634 | #define CPP_N_MEDIUM 0x0020 /* long, double. */ | |
635 | #define CPP_N_LARGE 0x0040 /* long long, long double. */ | |
636 | ||
637 | #define CPP_N_RADIX 0x0F00 | |
638 | #define CPP_N_DECIMAL 0x0100 | |
639 | #define CPP_N_HEX 0x0200 | |
640 | #define CPP_N_OCTAL 0x0400 | |
641 | ||
642 | #define CPP_N_UNSIGNED 0x1000 /* Properties. */ | |
643 | #define CPP_N_IMAGINARY 0x2000 | |
644 | ||
645 | /* Classify a CPP_NUMBER token. The return value is a combination of | |
646 | the flags from the above sets. */ | |
647 | extern unsigned cpp_classify_number PARAMS ((cpp_reader *, const cpp_token *)); | |
648 | ||
649 | /* Evaluate a token classified as category CPP_N_INTEGER. */ | |
650 | extern cpp_num cpp_interpret_integer PARAMS ((cpp_reader *, const cpp_token *, | |
651 | unsigned int type)); | |
652 | ||
ceeedfc1 NB |
653 | /* Sign extend a number, with PRECISION significant bits and all |
654 | others assumed clear, to fill out a cpp_num structure. */ | |
655 | cpp_num cpp_num_sign_extend PARAMS ((cpp_num, size_t)); | |
656 | ||
95bd1dd7 | 657 | /* Diagnostic levels. To get a diagnostic without associating a |
ebef4e8c NB |
658 | position in the translation unit with it, use cpp_error_with_line |
659 | with a line number of zero. */ | |
660 | ||
661 | /* Warning, an error with -Werror. */ | |
662 | #define DL_WARNING 0x00 | |
663 | /* Same as DL_WARNING, except it is not suppressed in system headers. */ | |
664 | #define DL_WARNING_SYSHDR 0x01 | |
665 | /* Warning, an error with -pedantic-errors or -Werror. */ | |
666 | #define DL_PEDWARN 0x02 | |
667 | /* An error. */ | |
668 | #define DL_ERROR 0x03 | |
ebef4e8c | 669 | /* An internal consistency check failed. Prints "internal error: ", |
bdee42b1 NB |
670 | otherwise the same as DL_ERROR. */ |
671 | #define DL_ICE 0x04 | |
ebef4e8c NB |
672 | /* Extracts a diagnostic level from an int. */ |
673 | #define DL_EXTRACT(l) (l & 0xf) | |
da7d8304 | 674 | /* Nonzero if a diagnostic level is one of the warnings. */ |
ebef4e8c NB |
675 | #define DL_WARNING_P(l) (DL_EXTRACT (l) >= DL_WARNING \ |
676 | && DL_EXTRACT (l) <= DL_PEDWARN) | |
677 | ||
c1212d2f ZW |
678 | /* N.B. The error-message-printer prototypes have not been nicely |
679 | formatted because exgettext needs to see 'msgid' on the same line | |
680 | as the name of the function in order to work properly. Only the | |
681 | string argument gets a name in an effort to keep the lines from | |
682 | getting ridiculously oversized. */ | |
683 | ||
ebef4e8c NB |
684 | /* Output a diagnostic of some kind. */ |
685 | extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...)) | |
686 | ATTRIBUTE_PRINTF_3; | |
687 | ||
688 | /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the | |
689 | error string of errno. No location is printed. */ | |
690 | extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg)); | |
691 | ||
692 | /* Same as cpp_error, except additionally specifies a position as a | |
693 | (translation unit) physical line and physical column. If the line is | |
694 | zero, then no location is printed. */ | |
695 | extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...)) | |
696 | ATTRIBUTE_PRINTF_5; | |
f2d5f0cc ZW |
697 | |
698 | /* In cpplex.c */ | |
bfb9dc7f ZW |
699 | extern int cpp_ideq PARAMS ((const cpp_token *, |
700 | const char *)); | |
93c80368 NB |
701 | extern void cpp_output_line PARAMS ((cpp_reader *, FILE *)); |
702 | extern void cpp_output_token PARAMS ((const cpp_token *, FILE *)); | |
703 | extern const char *cpp_type2name PARAMS ((enum cpp_ttype)); | |
4268e8bb NB |
704 | /* Returns the value of an escape sequence, truncated to the correct |
705 | target precision. PSTR points to the input pointer, which is just | |
706 | after the backslash. LIMIT is how much text we have. WIDE is true | |
707 | if the escape sequence is part of a wide character constant or | |
708 | string literal. Handles all relevant diagnostics. */ | |
709 | extern cppchar_t cpp_parse_escape PARAMS ((cpp_reader *, | |
710 | const unsigned char ** pstr, | |
711 | const unsigned char *limit, | |
712 | int wide)); | |
1368ee70 | 713 | |
f2d5f0cc | 714 | /* In cpphash.c */ |
2a967f3d NB |
715 | |
716 | /* Lookup an identifier in the hashtable. Puts the identifier in the | |
717 | table if it is not already there. */ | |
93c80368 | 718 | extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *, |
2a967f3d NB |
719 | const unsigned char *, |
720 | unsigned int)); | |
721 | ||
722 | typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *)); | |
93c80368 | 723 | extern void cpp_forall_identifiers PARAMS ((cpp_reader *, |
2a967f3d | 724 | cpp_cb, void *)); |
926c5678 | 725 | |
58fea6af | 726 | /* In cppmacro.c */ |
ef6e958a | 727 | extern void cpp_scan_nooutput PARAMS ((cpp_reader *)); |
c691145a | 728 | extern int cpp_sys_macro_p PARAMS ((cpp_reader *)); |
dcc229e5 ZW |
729 | extern unsigned char *cpp_quote_string PARAMS ((unsigned char *, |
730 | const unsigned char *, | |
731 | unsigned int)); | |
6de1e2a9 | 732 | |
add7091b | 733 | /* In cppfiles.c */ |
711b8824 | 734 | extern int cpp_included PARAMS ((cpp_reader *, const char *)); |
614c7d37 | 735 | extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int)); |
b0699dad | 736 | |
17211ab5 GK |
737 | /* In cpppch.c */ |
738 | struct save_macro_data; | |
739 | extern int cpp_save_state PARAMS ((cpp_reader *, FILE *)); | |
740 | extern int cpp_write_pch_deps PARAMS ((cpp_reader *, FILE *)); | |
741 | extern int cpp_write_pch_state PARAMS ((cpp_reader *, FILE *)); | |
742 | extern int cpp_valid_state PARAMS ((cpp_reader *, const char *, int)); | |
743 | extern void cpp_prepare_state PARAMS ((cpp_reader *, | |
744 | struct save_macro_data **)); | |
745 | extern int cpp_read_state PARAMS ((cpp_reader *, const char *, FILE *, | |
746 | struct save_macro_data *)); | |
747 | ||
aaf93206 | 748 | /* In cppmain.c */ |
460bd0e3 | 749 | extern void cpp_preprocess_file PARAMS ((cpp_reader *, const char *, FILE *)); |
aaf93206 | 750 | |
7f2935c7 PB |
751 | #ifdef __cplusplus |
752 | } | |
753 | #endif | |
88657302 RH |
754 | |
755 | #endif /* ! GCC_CPPLIB_H */ |