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