Reverting merge from trunk
[official-gcc.git] / libcpp / include / cpplib.h
blob7540e05383f35888b950df69b146d57fade4f11a
1 /* Definitions for CPP library.
2 Copyright (C) 1995-2013 Free Software Foundation, Inc.
3 Written by Per Bothner, 1994-95.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 3, or (at your option) any
8 later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; see the file COPYING3. If not see
17 <http://www.gnu.org/licenses/>.
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! */
22 #ifndef LIBCPP_CPPLIB_H
23 #define LIBCPP_CPPLIB_H
25 #include <sys/types.h>
26 #include "symtab.h"
27 #include "line-map.h"
29 typedef struct cpp_reader cpp_reader;
30 typedef struct cpp_buffer cpp_buffer;
31 typedef struct cpp_options cpp_options;
32 typedef struct cpp_token cpp_token;
33 typedef struct cpp_string cpp_string;
34 typedef struct cpp_hashnode cpp_hashnode;
35 typedef struct cpp_macro cpp_macro;
36 typedef struct cpp_callbacks cpp_callbacks;
37 typedef struct cpp_dir cpp_dir;
39 struct answer;
40 struct _cpp_file;
42 /* 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.
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
48 the same order as their counterparts without the '=', like ">>".
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. */
53 #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, "<<") \
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, "<=") \
83 /* These two are unary + / - in preprocessor expressions. */ \
84 OP(PLUS_EQ, "+=") /* math */ \
85 OP(MINUS_EQ, "-=") \
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, "<<=") \
95 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
96 OP(HASH, "#") /* digraphs */ \
97 OP(PASTE, "##") \
98 OP(OPEN_SQUARE, "[") \
99 OP(CLOSE_SQUARE, "]") \
100 OP(OPEN_BRACE, "{") \
101 OP(CLOSE_BRACE, "}") \
102 /* The remainder of the punctuation. Order is not significant. */ \
103 OP(SEMICOLON, ";") /* structure */ \
104 OP(ELLIPSIS, "...") \
105 OP(PLUS_PLUS, "++") /* increment */ \
106 OP(MINUS_MINUS, "--") \
107 OP(DEREF, "->") /* accessors */ \
108 OP(DOT, ".") \
109 OP(SCOPE, "::") \
110 OP(DEREF_STAR, "->*") \
111 OP(DOT_STAR, ".*") \
112 OP(ATSIGN, "@") /* used in Objective-C */ \
114 TK(NAME, IDENT) /* word */ \
115 TK(AT_NAME, IDENT) /* @word - Objective-C */ \
116 TK(NUMBER, LITERAL) /* 34_be+ta */ \
118 TK(CHAR, LITERAL) /* 'char' */ \
119 TK(WCHAR, LITERAL) /* L'char' */ \
120 TK(CHAR16, LITERAL) /* u'char' */ \
121 TK(CHAR32, LITERAL) /* U'char' */ \
122 TK(OTHER, LITERAL) /* stray punctuation */ \
124 TK(STRING, LITERAL) /* "string" */ \
125 TK(WSTRING, LITERAL) /* L"string" */ \
126 TK(STRING16, LITERAL) /* u"string" */ \
127 TK(STRING32, LITERAL) /* U"string" */ \
128 TK(UTF8STRING, LITERAL) /* u8"string" */ \
129 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \
130 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \
132 TK(CHAR_USERDEF, LITERAL) /* 'char'_suffix - C++-0x */ \
133 TK(WCHAR_USERDEF, LITERAL) /* L'char'_suffix - C++-0x */ \
134 TK(CHAR16_USERDEF, LITERAL) /* u'char'_suffix - C++-0x */ \
135 TK(CHAR32_USERDEF, LITERAL) /* U'char'_suffix - C++-0x */ \
136 TK(STRING_USERDEF, LITERAL) /* "string"_suffix - C++-0x */ \
137 TK(WSTRING_USERDEF, LITERAL) /* L"string"_suffix - C++-0x */ \
138 TK(STRING16_USERDEF, LITERAL) /* u"string"_suffix - C++-0x */ \
139 TK(STRING32_USERDEF, LITERAL) /* U"string"_suffix - C++-0x */ \
140 TK(UTF8STRING_USERDEF,LITERAL) /* u8"string"_suffix - C++-0x */ \
142 TK(COMMENT, LITERAL) /* Only if output comments. */ \
143 /* SPELL_LITERAL happens to DTRT. */ \
144 TK(MACRO_ARG, NONE) /* Macro argument. */ \
145 TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \
146 TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \
147 TK(PADDING, NONE) /* Whitespace for -E. */
149 #define OP(e, s) CPP_ ## e,
150 #define TK(e, s) CPP_ ## e,
151 enum cpp_ttype
153 TTYPE_TABLE
154 N_TTYPES,
156 /* Positions in the table. */
157 CPP_LAST_EQ = CPP_LSHIFT,
158 CPP_FIRST_DIGRAPH = CPP_HASH,
159 CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
160 CPP_LAST_CPP_OP = CPP_LESS_EQ
162 #undef OP
163 #undef TK
165 /* C language kind, used when calling cpp_create_reader. */
166 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_GNUC11,
167 CLK_STDC89, CLK_STDC94, CLK_STDC99, CLK_STDC11,
168 CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX11, CLK_CXX11,
169 CLK_GNUCXX1Y, CLK_CXX1Y, CLK_ASM};
171 /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
172 struct GTY(()) cpp_string {
173 unsigned int len;
174 const unsigned char *text;
177 /* Flags for the cpp_token structure. */
178 #define PREV_WHITE (1 << 0) /* If whitespace before this token. */
179 #define DIGRAPH (1 << 1) /* If it was a digraph. */
180 #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
181 #define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
182 #define NAMED_OP (1 << 4) /* C++ named operators. */
183 #define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
184 #define BOL (1 << 6) /* Token at beginning of line. */
185 #define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend,
186 set in c-lex.c. */
187 #define SP_DIGRAPH (1 << 8) /* # or ## token was a digraph. */
188 #define SP_PREV_WHITE (1 << 9) /* If whitespace before a ##
189 operator, or before this token
190 after a # operator. */
192 /* Specify which field, if any, of the cpp_token union is used. */
194 enum cpp_token_fld_kind {
195 CPP_TOKEN_FLD_NODE,
196 CPP_TOKEN_FLD_SOURCE,
197 CPP_TOKEN_FLD_STR,
198 CPP_TOKEN_FLD_ARG_NO,
199 CPP_TOKEN_FLD_TOKEN_NO,
200 CPP_TOKEN_FLD_PRAGMA,
201 CPP_TOKEN_FLD_NONE
204 /* A macro argument in the cpp_token union. */
205 struct GTY(()) cpp_macro_arg {
206 /* Argument number. */
207 unsigned int arg_no;
210 /* An identifier in the cpp_token union. */
211 struct GTY(()) cpp_identifier {
212 /* The canonical (UTF-8) spelling of the identifier. */
213 cpp_hashnode *
214 GTY ((nested_ptr (union tree_node,
215 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
216 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL")))
217 node;
220 /* A preprocessing token. This has been carefully packed and should
221 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
222 struct GTY(()) cpp_token {
223 source_location src_loc; /* Location of first char of token. */
224 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
225 unsigned short flags; /* flags - see above */
227 union cpp_token_u
229 /* An identifier. */
230 struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node;
232 /* Inherit padding from this token. */
233 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
235 /* A string, or number. */
236 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
238 /* Argument no. for a CPP_MACRO_ARG. */
239 struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg;
241 /* Original token no. for a CPP_PASTE (from a sequence of
242 consecutive paste tokens in a macro expansion). */
243 unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no;
245 /* Caller-supplied identifier for a CPP_PRAGMA. */
246 unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
247 } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
250 /* Say which field is in use. */
251 extern enum cpp_token_fld_kind cpp_token_val_index (const cpp_token *tok);
253 /* A type wide enough to hold any multibyte source character.
254 cpplib's character constant interpreter requires an unsigned type.
255 Also, a typedef for the signed equivalent.
256 The width of this type is capped at 32 bits; there do exist targets
257 where wchar_t is 64 bits, but only in a non-default mode, and there
258 would be no meaningful interpretation for a wchar_t value greater
259 than 2^32 anyway -- the widest wide-character encoding around is
260 ISO 10646, which stops at 2^31. */
261 #if CHAR_BIT * SIZEOF_INT >= 32
262 # define CPPCHAR_SIGNED_T int
263 #elif CHAR_BIT * SIZEOF_LONG >= 32
264 # define CPPCHAR_SIGNED_T long
265 #else
266 # error "Cannot find a least-32-bit signed integer type"
267 #endif
268 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
269 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
271 /* Style of header dependencies to generate. */
272 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
274 /* The possible normalization levels, from most restrictive to least. */
275 enum cpp_normalize_level {
276 /* In NFKC. */
277 normalized_KC = 0,
278 /* In NFC. */
279 normalized_C,
280 /* In NFC, except for subsequences where being in NFC would make
281 the identifier invalid. */
282 normalized_identifier_C,
283 /* Not normalized at all. */
284 normalized_none
287 /* This structure is nested inside struct cpp_reader, and
288 carries all the options visible to the command line. */
289 struct cpp_options
291 /* Characters between tab stops. */
292 unsigned int tabstop;
294 /* The language we're preprocessing. */
295 enum c_lang lang;
297 /* Nonzero means use extra default include directories for C++. */
298 unsigned char cplusplus;
300 /* Nonzero means handle cplusplus style comments. */
301 unsigned char cplusplus_comments;
303 /* Nonzero means define __OBJC__, treat @ as a special token, use
304 the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
305 "#import". */
306 unsigned char objc;
308 /* Nonzero means don't copy comments into the output file. */
309 unsigned char discard_comments;
311 /* Nonzero means don't copy comments into the output file during
312 macro expansion. */
313 unsigned char discard_comments_in_macro_exp;
315 /* Nonzero means process the ISO trigraph sequences. */
316 unsigned char trigraphs;
318 /* Nonzero means process the ISO digraph sequences. */
319 unsigned char digraphs;
321 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
322 unsigned char extended_numbers;
324 /* Nonzero means process u/U prefix literals (UTF-16/32). */
325 unsigned char uliterals;
327 /* Nonzero means process r/R raw strings. If this is set, uliterals
328 must be set as well. */
329 unsigned char rliterals;
331 /* Nonzero means print names of header files (-H). */
332 unsigned char print_include_names;
334 /* Nonzero means complain about deprecated features. */
335 unsigned char cpp_warn_deprecated;
337 /* Nonzero means warn if slash-star appears in a comment. */
338 unsigned char warn_comments;
340 /* Nonzero means to warn about __DATA__, __TIME__ and __TIMESTAMP__ usage. */
341 unsigned char warn_date_time;
343 /* Nonzero means warn if a user-supplied include directory does not
344 exist. */
345 unsigned char warn_missing_include_dirs;
347 /* Nonzero means warn if there are any trigraphs. */
348 unsigned char warn_trigraphs;
350 /* Nonzero means warn about multicharacter charconsts. */
351 unsigned char warn_multichar;
353 /* Nonzero means warn about various incompatibilities with
354 traditional C. */
355 unsigned char cpp_warn_traditional;
357 /* Nonzero means warn about long long numeric constants. */
358 unsigned char cpp_warn_long_long;
360 /* Nonzero means warn about text after an #endif (or #else). */
361 unsigned char warn_endif_labels;
363 /* Nonzero means warn about implicit sign changes owing to integer
364 promotions. */
365 unsigned char warn_num_sign_change;
367 /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
368 Presumably the usage is protected by the appropriate #ifdef. */
369 unsigned char warn_variadic_macros;
371 /* Nonzero means warn about builtin macros that are redefined or
372 explicitly undefined. */
373 unsigned char warn_builtin_macro_redefined;
375 /* Nonzero means we should look for header.gcc files that remap file
376 names. */
377 unsigned char remap;
379 /* Zero means dollar signs are punctuation. */
380 unsigned char dollars_in_ident;
382 /* Nonzero means UCNs are accepted in identifiers. */
383 unsigned char extended_identifiers;
385 /* True if we should warn about dollars in identifiers or numbers
386 for this translation unit. */
387 unsigned char warn_dollars;
389 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
390 unsigned char warn_undef;
392 /* Nonzero means warn of unused macros from the main file. */
393 unsigned char warn_unused_macros;
395 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
396 unsigned char c99;
398 /* Nonzero if we are conforming to a specific C or C++ standard. */
399 unsigned char std;
401 /* Nonzero means give all the error messages the ANSI standard requires. */
402 unsigned char cpp_pedantic;
404 /* Nonzero means we're looking at already preprocessed code, so don't
405 bother trying to do macro expansion and whatnot. */
406 unsigned char preprocessed;
408 /* Nonzero means we are going to emit debugging logs during
409 preprocessing. */
410 unsigned char debug;
412 /* Nonzero means we are tracking locations of tokens involved in
413 macro expansion. 1 Means we track the location in degraded mode
414 where we do not track locations of tokens resulting from the
415 expansion of arguments of function-like macro. 2 Means we do
416 track all macro expansions. This last option is the one that
417 consumes the highest amount of memory. */
418 unsigned char track_macro_expansion;
420 /* Nonzero means handle C++ alternate operator names. */
421 unsigned char operator_names;
423 /* Nonzero means warn about use of C++ alternate operator names. */
424 unsigned char warn_cxx_operator_names;
426 /* True for traditional preprocessing. */
427 unsigned char traditional;
429 /* Nonzero for C++ 2011 Standard user-defined literals. */
430 unsigned char user_literals;
432 /* Nonzero means warn when a string or character literal is followed by a
433 ud-suffix which does not beging with an underscore. */
434 unsigned char warn_literal_suffix;
436 /* Nonzero means interpret imaginary, fixed-point, or other gnu extension
437 literal number suffixes as user-defined literal number suffixes. */
438 unsigned char ext_numeric_literals;
440 /* Nonzero means extended identifiers allow the characters specified
441 in C11 and C++11. */
442 unsigned char c11_identifiers;
444 /* Nonzero for C++ 2014 Standard binary constants. */
445 unsigned char binary_constants;
447 /* Nonzero for C++ 2014 Standard digit separators. */
448 unsigned char digit_separators;
450 /* Holds the name of the target (execution) character set. */
451 const char *narrow_charset;
453 /* Holds the name of the target wide character set. */
454 const char *wide_charset;
456 /* Holds the name of the input character set. */
457 const char *input_charset;
459 /* The minimum permitted level of normalization before a warning
460 is generated. */
461 enum cpp_normalize_level warn_normalize;
463 /* True to warn about precompiled header files we couldn't use. */
464 bool warn_invalid_pch;
466 /* True if dependencies should be restored from a precompiled header. */
467 bool restore_pch_deps;
469 /* Dependency generation. */
470 struct
472 /* Style of header dependencies to generate. */
473 enum cpp_deps_style style;
475 /* Assume missing files are generated files. */
476 bool missing_files;
478 /* Generate phony targets for each dependency apart from the first
479 one. */
480 bool phony_targets;
482 /* If true, no dependency is generated on the main file. */
483 bool ignore_main_file;
485 /* If true, intend to use the preprocessor output (e.g., for compilation)
486 in addition to the dependency info. */
487 bool need_preprocessor_output;
488 } deps;
490 /* Target-specific features set by the front end or client. */
492 /* Precision for target CPP arithmetic, target characters, target
493 ints and target wide characters, respectively. */
494 size_t precision, char_precision, int_precision, wchar_precision;
496 /* True means chars (wide chars) are unsigned. */
497 bool unsigned_char, unsigned_wchar;
499 /* True if the most significant byte in a word has the lowest
500 address in memory. */
501 bool bytes_big_endian;
503 /* Nonzero means __STDC__ should have the value 0 in system headers. */
504 unsigned char stdc_0_in_system_headers;
506 /* True disables tokenization outside of preprocessing directives. */
507 bool directives_only;
509 /* True enables canonicalization of system header file paths. */
510 bool canonical_system_headers;
513 /* Callback for header lookup for HEADER, which is the name of a
514 source file. It is used as a method of last resort to find headers
515 that are not otherwise found during the normal include processing.
516 The return value is the malloced name of a header to try and open,
517 if any, or NULL otherwise. This callback is called only if the
518 header is otherwise unfound. */
519 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
521 /* Call backs to cpplib client. */
522 struct cpp_callbacks
524 /* Called when a new line of preprocessed output is started. */
525 void (*line_change) (cpp_reader *, const cpp_token *, int);
527 /* Called when switching to/from a new file.
528 The line_map is for the new file. It is NULL if there is no new file.
529 (In C this happens when done with <built-in>+<command line> and also
530 when done with a main file.) This can be used for resource cleanup. */
531 void (*file_change) (cpp_reader *, const struct line_map *);
533 void (*dir_change) (cpp_reader *, const char *);
534 void (*include) (cpp_reader *, source_location, const unsigned char *,
535 const char *, int, const cpp_token **);
536 void (*define) (cpp_reader *, source_location, cpp_hashnode *);
537 void (*undef) (cpp_reader *, source_location, cpp_hashnode *);
538 void (*ident) (cpp_reader *, source_location, const cpp_string *);
539 void (*def_pragma) (cpp_reader *, source_location);
540 int (*valid_pch) (cpp_reader *, const char *, int);
541 void (*read_pch) (cpp_reader *, const char *, int, const char *);
542 missing_header_cb missing_header;
544 /* Context-sensitive macro support. Returns macro (if any) that should
545 be expanded. */
546 cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
548 /* Called to emit a diagnostic. This callback receives the
549 translated message. */
550 bool (*error) (cpp_reader *, int, int, source_location, unsigned int,
551 const char *, va_list *)
552 ATTRIBUTE_FPTR_PRINTF(6,0);
554 /* Callbacks for when a macro is expanded, or tested (whether
555 defined or not at the time) in #ifdef, #ifndef or "defined". */
556 void (*used_define) (cpp_reader *, source_location, cpp_hashnode *);
557 void (*used_undef) (cpp_reader *, source_location, cpp_hashnode *);
558 /* Called before #define and #undef or other macro definition
559 changes are processed. */
560 void (*before_define) (cpp_reader *);
561 /* Called whenever a macro is expanded or tested.
562 Second argument is the location of the start of the current expansion. */
563 void (*used) (cpp_reader *, source_location, cpp_hashnode *);
565 /* Callback that can change a user builtin into normal macro. */
566 bool (*user_builtin_macro) (cpp_reader *, cpp_hashnode *);
569 #ifdef VMS
570 #define INO_T_CPP ino_t ino[3]
571 #else
572 #define INO_T_CPP ino_t ino
573 #endif
575 /* Chain of directories to look for include files in. */
576 struct cpp_dir
578 /* NULL-terminated singly-linked list. */
579 struct cpp_dir *next;
581 /* NAME of the directory, NUL-terminated. */
582 char *name;
583 unsigned int len;
585 /* One if a system header, two if a system header that has extern
586 "C" guards for C++. */
587 unsigned char sysp;
589 /* Is this a user-supplied directory? */
590 bool user_supplied_p;
592 /* The canonicalized NAME as determined by lrealpath. This field
593 is only used by hosts that lack reliable inode numbers. */
594 char *canonical_name;
596 /* Mapping of file names for this directory for MS-DOS and related
597 platforms. A NULL-terminated array of (from, to) pairs. */
598 const char **name_map;
600 /* Routine to construct pathname, given the search path name and the
601 HEADER we are trying to find, return a constructed pathname to
602 try and open. If this is NULL, the constructed pathname is as
603 constructed by append_file_to_dir. */
604 char *(*construct) (const char *header, cpp_dir *dir);
606 /* The C front end uses these to recognize duplicated
607 directories in the search path. */
608 INO_T_CPP;
609 dev_t dev;
612 /* The structure of a node in the hash table. The hash table has
613 entries for all identifiers: either macros defined by #define
614 commands (type NT_MACRO), assertions created with #assert
615 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
616 like __LINE__ are flagged NODE_BUILTIN. Poisoned identifiers are
617 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
618 identifier that behaves like an operator such as "xor".
619 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
620 diagnostic may be required for this node. Currently this only
621 applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat
622 warnings about NODE_OPERATOR. */
624 /* Hash node flags. */
625 #define NODE_OPERATOR (1 << 0) /* C++ named operator. */
626 #define NODE_POISONED (1 << 1) /* Poisoned identifier. */
627 #define NODE_BUILTIN (1 << 2) /* Builtin macro. */
628 #define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
629 #define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
630 #define NODE_DISABLED (1 << 5) /* A disabled macro. */
631 #define NODE_MACRO_ARG (1 << 6) /* Used during #define processing. */
632 #define NODE_USED (1 << 7) /* Dumped with -dU. */
633 #define NODE_CONDITIONAL (1 << 8) /* Conditional macro */
634 #define NODE_WARN_OPERATOR (1 << 9) /* Warn about C++ named operator. */
636 /* Different flavors of hash node. */
637 enum node_type
639 NT_VOID = 0, /* No definition yet. */
640 NT_MACRO, /* A macro of some form. */
641 NT_ASSERTION /* Predicate for #assert. */
644 /* Different flavors of builtin macro. _Pragma is an operator, but we
645 handle it with the builtin code for efficiency reasons. */
646 enum cpp_builtin_type
648 BT_SPECLINE = 0, /* `__LINE__' */
649 BT_DATE, /* `__DATE__' */
650 BT_FILE, /* `__FILE__' */
651 BT_BASE_FILE, /* `__BASE_FILE__' */
652 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
653 BT_TIME, /* `__TIME__' */
654 BT_STDC, /* `__STDC__' */
655 BT_PRAGMA, /* `_Pragma' operator */
656 BT_TIMESTAMP, /* `__TIMESTAMP__' */
657 BT_COUNTER, /* `__COUNTER__' */
658 BT_FIRST_USER, /* User defined builtin macros. */
659 BT_LAST_USER = BT_FIRST_USER + 31
662 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
663 #define HT_NODE(NODE) ((ht_identifier *) (NODE))
664 #define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
665 #define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
667 /* Specify which field, if any, of the union is used. */
669 enum {
670 NTV_MACRO,
671 NTV_ANSWER,
672 NTV_BUILTIN,
673 NTV_ARGUMENT,
674 NTV_NONE
677 #define CPP_HASHNODE_VALUE_IDX(HNODE) \
678 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \
679 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \
680 ? NTV_BUILTIN : NTV_MACRO) \
681 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \
682 : NTV_NONE)
684 /* The common part of an identifier node shared amongst all 3 C front
685 ends. Also used to store CPP identifiers, which are a superset of
686 identifiers in the grammatical sense. */
688 union GTY(()) _cpp_hashnode_value {
689 /* If a macro. */
690 cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
691 /* Answers to an assertion. */
692 struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
693 /* Code for a builtin macro. */
694 enum cpp_builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
695 /* Macro argument index. */
696 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
699 struct GTY(()) cpp_hashnode {
700 struct ht_identifier ident;
701 unsigned int is_directive : 1;
702 unsigned int directive_index : 7; /* If is_directive,
703 then index into directive table.
704 Otherwise, a NODE_OPERATOR. */
705 unsigned char rid_code; /* Rid code - for front ends. */
706 ENUM_BITFIELD(node_type) type : 6; /* CPP node type. */
707 unsigned int flags : 10; /* CPP flags. */
709 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
712 /* Call this first to get a handle to pass to other functions.
714 If you want cpplib to manage its own hashtable, pass in a NULL
715 pointer. Otherwise you should pass in an initialized hash table
716 that cpplib will share; this technique is used by the C front
717 ends. */
718 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
719 struct line_maps *);
721 /* Reset the cpp_reader's line_map. This is only used after reading a
722 PCH file. */
723 extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
725 /* Call this to change the selected language standard (e.g. because of
726 command line options). */
727 extern void cpp_set_lang (cpp_reader *, enum c_lang);
729 /* Set the include paths. */
730 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
732 /* Call these to get pointers to the options, callback, and deps
733 structures for a given reader. These pointers are good until you
734 call cpp_finish on that reader. You can either edit the callbacks
735 through the pointer returned from cpp_get_callbacks, or set them
736 with cpp_set_callbacks. */
737 extern cpp_options *cpp_get_options (cpp_reader *);
738 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
739 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
740 extern struct deps *cpp_get_deps (cpp_reader *);
742 /* This function reads the file, but does not start preprocessing. It
743 returns the name of the original file; this is the same as the
744 input file, except for preprocessed input. This will generate at
745 least one file change callback, and possibly a line change callback
746 too. If there was an error opening the file, it returns NULL. */
747 extern const char *cpp_read_main_file (cpp_reader *, const char *);
749 /* Set up built-ins with special behavior. Use cpp_init_builtins()
750 instead unless your know what you are doing. */
751 extern void cpp_init_special_builtins (cpp_reader *);
753 /* Set up built-ins like __FILE__. */
754 extern void cpp_init_builtins (cpp_reader *, int);
756 /* This is called after options have been parsed, and partially
757 processed. */
758 extern void cpp_post_options (cpp_reader *);
760 /* Set up translation to the target character set. */
761 extern void cpp_init_iconv (cpp_reader *);
763 /* Call this to finish preprocessing. If you requested dependency
764 generation, pass an open stream to write the information to,
765 otherwise NULL. It is your responsibility to close the stream. */
766 extern void cpp_finish (cpp_reader *, FILE *deps_stream);
768 /* Call this to release the handle at the end of preprocessing. Any
769 use of the handle after this function returns is invalid. */
770 extern void cpp_destroy (cpp_reader *);
772 extern unsigned int cpp_token_len (const cpp_token *);
773 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
774 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
775 unsigned char *, bool);
776 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
777 void (*) (cpp_reader *), bool);
778 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
779 const char *, unsigned, bool, bool);
780 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
781 const cpp_token *);
782 extern const cpp_token *cpp_get_token (cpp_reader *);
783 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
784 source_location *);
785 extern const unsigned char *cpp_macro_definition (cpp_reader *,
786 cpp_hashnode *);
787 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
788 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
790 /* Evaluate a CPP_*CHAR* token. */
791 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
792 unsigned int *, int *);
793 /* Evaluate a vector of CPP_*STRING* tokens. */
794 extern bool cpp_interpret_string (cpp_reader *,
795 const cpp_string *, size_t,
796 cpp_string *, enum cpp_ttype);
797 extern bool cpp_interpret_string_notranslate (cpp_reader *,
798 const cpp_string *, size_t,
799 cpp_string *, enum cpp_ttype);
801 /* Convert a host character constant to the execution character set. */
802 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
804 /* Used to register macros and assertions, perhaps from the command line.
805 The text is the same as the command line argument. */
806 extern void cpp_define (cpp_reader *, const char *);
807 extern void cpp_define_formatted (cpp_reader *pfile,
808 const char *fmt, ...) ATTRIBUTE_PRINTF_2;
809 extern void cpp_assert (cpp_reader *, const char *);
810 extern void cpp_undef (cpp_reader *, const char *);
811 extern void cpp_unassert (cpp_reader *, const char *);
813 /* Undefine all macros and assertions. */
814 extern void cpp_undef_all (cpp_reader *);
816 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
817 size_t, int);
818 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
820 /* A preprocessing number. Code assumes that any unused high bits of
821 the double integer are set to zero. */
822 typedef unsigned HOST_WIDE_INT cpp_num_part;
823 typedef struct cpp_num cpp_num;
824 struct cpp_num
826 cpp_num_part high;
827 cpp_num_part low;
828 bool unsignedp; /* True if value should be treated as unsigned. */
829 bool overflow; /* True if the most recent calculation overflowed. */
832 /* cpplib provides two interfaces for interpretation of preprocessing
833 numbers.
835 cpp_classify_number categorizes numeric constants according to
836 their field (integer, floating point, or invalid), radix (decimal,
837 octal, hexadecimal), and type suffixes. */
839 #define CPP_N_CATEGORY 0x000F
840 #define CPP_N_INVALID 0x0000
841 #define CPP_N_INTEGER 0x0001
842 #define CPP_N_FLOATING 0x0002
844 #define CPP_N_WIDTH 0x00F0
845 #define CPP_N_SMALL 0x0010 /* int, float, shrot _Fract/Accum */
846 #define CPP_N_MEDIUM 0x0020 /* long, double, long _Fract/_Accum. */
847 #define CPP_N_LARGE 0x0040 /* long long, long double,
848 long long _Fract/Accum. */
850 #define CPP_N_WIDTH_MD 0xF0000 /* machine defined. */
851 #define CPP_N_MD_W 0x10000
852 #define CPP_N_MD_Q 0x20000
854 #define CPP_N_RADIX 0x0F00
855 #define CPP_N_DECIMAL 0x0100
856 #define CPP_N_HEX 0x0200
857 #define CPP_N_OCTAL 0x0400
858 #define CPP_N_BINARY 0x0800
860 #define CPP_N_UNSIGNED 0x1000 /* Properties. */
861 #define CPP_N_IMAGINARY 0x2000
862 #define CPP_N_DFLOAT 0x4000
863 #define CPP_N_DEFAULT 0x8000
865 #define CPP_N_FRACT 0x100000 /* Fract types. */
866 #define CPP_N_ACCUM 0x200000 /* Accum types. */
868 #define CPP_N_USERDEF 0x1000000 /* C++0x user-defined literal. */
870 /* Classify a CPP_NUMBER token. The return value is a combination of
871 the flags from the above sets. */
872 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *,
873 const char **, source_location);
875 /* Return the classification flags for a float suffix. */
876 extern unsigned int cpp_interpret_float_suffix (cpp_reader *, const char *,
877 size_t);
879 /* Return the classification flags for an int suffix. */
880 extern unsigned int cpp_interpret_int_suffix (cpp_reader *, const char *,
881 size_t);
883 /* Evaluate a token classified as category CPP_N_INTEGER. */
884 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
885 unsigned int);
887 /* Sign extend a number, with PRECISION significant bits and all
888 others assumed clear, to fill out a cpp_num structure. */
889 cpp_num cpp_num_sign_extend (cpp_num, size_t);
891 /* Diagnostic levels. To get a diagnostic without associating a
892 position in the translation unit with it, use cpp_error_with_line
893 with a line number of zero. */
895 enum {
896 /* Warning, an error with -Werror. */
897 CPP_DL_WARNING = 0,
898 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */
899 CPP_DL_WARNING_SYSHDR,
900 /* Warning, an error with -pedantic-errors or -Werror. */
901 CPP_DL_PEDWARN,
902 /* An error. */
903 CPP_DL_ERROR,
904 /* An internal consistency check failed. Prints "internal error: ",
905 otherwise the same as CPP_DL_ERROR. */
906 CPP_DL_ICE,
907 /* An informative note following a warning. */
908 CPP_DL_NOTE,
909 /* A fatal error. */
910 CPP_DL_FATAL
913 /* Warning reason codes. Use a reason code of zero for unclassified warnings
914 and errors that are not warnings. */
915 enum {
916 CPP_W_NONE = 0,
917 CPP_W_DEPRECATED,
918 CPP_W_COMMENTS,
919 CPP_W_MISSING_INCLUDE_DIRS,
920 CPP_W_TRIGRAPHS,
921 CPP_W_MULTICHAR,
922 CPP_W_TRADITIONAL,
923 CPP_W_LONG_LONG,
924 CPP_W_ENDIF_LABELS,
925 CPP_W_NUM_SIGN_CHANGE,
926 CPP_W_VARIADIC_MACROS,
927 CPP_W_BUILTIN_MACRO_REDEFINED,
928 CPP_W_DOLLARS,
929 CPP_W_UNDEF,
930 CPP_W_UNUSED_MACROS,
931 CPP_W_CXX_OPERATOR_NAMES,
932 CPP_W_NORMALIZE,
933 CPP_W_INVALID_PCH,
934 CPP_W_WARNING_DIRECTIVE,
935 CPP_W_LITERAL_SUFFIX,
936 CPP_W_DATE_TIME
939 /* Output a diagnostic of some kind. */
940 extern bool cpp_error (cpp_reader *, int, const char *msgid, ...)
941 ATTRIBUTE_PRINTF_3;
942 extern bool cpp_warning (cpp_reader *, int, const char *msgid, ...)
943 ATTRIBUTE_PRINTF_3;
944 extern bool cpp_pedwarning (cpp_reader *, int, const char *msgid, ...)
945 ATTRIBUTE_PRINTF_3;
946 extern bool cpp_warning_syshdr (cpp_reader *, int, const char *msgid, ...)
947 ATTRIBUTE_PRINTF_3;
949 /* Output a diagnostic with "MSGID: " preceding the
950 error string of errno. No location is printed. */
951 extern bool cpp_errno (cpp_reader *, int, const char *msgid);
953 /* Same as cpp_error, except additionally specifies a position as a
954 (translation unit) physical line and physical column. If the line is
955 zero, then no location is printed. */
956 extern bool cpp_error_with_line (cpp_reader *, int, source_location,
957 unsigned, const char *msgid, ...)
958 ATTRIBUTE_PRINTF_5;
959 extern bool cpp_warning_with_line (cpp_reader *, int, source_location,
960 unsigned, const char *msgid, ...)
961 ATTRIBUTE_PRINTF_5;
962 extern bool cpp_pedwarning_with_line (cpp_reader *, int, source_location,
963 unsigned, const char *msgid, ...)
964 ATTRIBUTE_PRINTF_5;
965 extern bool cpp_warning_with_line_syshdr (cpp_reader *, int, source_location,
966 unsigned, const char *msgid, ...)
967 ATTRIBUTE_PRINTF_5;
969 /* In lex.c */
970 extern int cpp_ideq (const cpp_token *, const char *);
971 extern void cpp_output_line (cpp_reader *, FILE *);
972 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
973 const unsigned char *);
974 extern void cpp_output_token (const cpp_token *, FILE *);
975 extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags);
976 /* Returns the value of an escape sequence, truncated to the correct
977 target precision. PSTR points to the input pointer, which is just
978 after the backslash. LIMIT is how much text we have. WIDE is true
979 if the escape sequence is part of a wide character constant or
980 string literal. Handles all relevant diagnostics. */
981 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
982 const unsigned char *limit, int wide);
984 /* Structure used to hold a comment block at a given location in the
985 source code. */
987 typedef struct
989 /* Text of the comment including the terminators. */
990 char *comment;
992 /* source location for the given comment. */
993 source_location sloc;
994 } cpp_comment;
996 /* Structure holding all comments for a given cpp_reader. */
998 typedef struct
1000 /* table of comment entries. */
1001 cpp_comment *entries;
1003 /* number of actual entries entered in the table. */
1004 int count;
1006 /* number of entries allocated currently. */
1007 int allocated;
1008 } cpp_comment_table;
1010 /* Returns the table of comments encountered by the preprocessor. This
1011 table is only populated when pfile->state.save_comments is true. */
1012 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
1014 /* In hash.c */
1016 /* Lookup an identifier in the hashtable. Puts the identifier in the
1017 table if it is not already there. */
1018 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
1019 unsigned int);
1021 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
1022 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
1024 /* In macro.c */
1025 extern void cpp_scan_nooutput (cpp_reader *);
1026 extern int cpp_sys_macro_p (cpp_reader *);
1027 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
1028 unsigned int);
1030 /* In files.c */
1031 extern bool cpp_included (cpp_reader *, const char *);
1032 extern bool cpp_included_before (cpp_reader *, const char *, source_location);
1033 extern void cpp_make_system_header (cpp_reader *, int, int);
1034 extern bool cpp_push_include (cpp_reader *, const char *);
1035 extern bool cpp_push_default_include (cpp_reader *, const char *);
1036 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
1037 extern const char *cpp_get_path (struct _cpp_file *);
1038 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
1039 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
1040 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
1041 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
1042 extern void cpp_clear_file_cache (cpp_reader *);
1044 /* In pch.c */
1045 struct save_macro_data;
1046 extern int cpp_save_state (cpp_reader *, FILE *);
1047 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
1048 extern int cpp_write_pch_state (cpp_reader *, FILE *);
1049 extern int cpp_valid_state (cpp_reader *, const char *, int);
1050 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
1051 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
1052 struct save_macro_data *);
1054 /* In lex.c */
1055 extern void cpp_force_token_locations (cpp_reader *, source_location *);
1056 extern void cpp_stop_forcing_token_locations (cpp_reader *);
1058 /* In expr.c */
1059 extern enum cpp_ttype cpp_userdef_string_remove_type
1060 (enum cpp_ttype type);
1061 extern enum cpp_ttype cpp_userdef_string_add_type
1062 (enum cpp_ttype type);
1063 extern enum cpp_ttype cpp_userdef_char_remove_type
1064 (enum cpp_ttype type);
1065 extern enum cpp_ttype cpp_userdef_char_add_type
1066 (enum cpp_ttype type);
1067 extern bool cpp_userdef_string_p
1068 (enum cpp_ttype type);
1069 extern bool cpp_userdef_char_p
1070 (enum cpp_ttype type);
1071 extern const char * cpp_get_userdef_suffix
1072 (const cpp_token *);
1074 #endif /* ! LIBCPP_CPPLIB_H */