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