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