1 /* Definitions for CPP library.
2 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 Free Software Foundation, Inc.
5 Written by Per Bothner, 1994-95.
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 2, or (at your option) any
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.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
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
27 #include <sys/types.h>
35 typedef struct cpp_reader cpp_reader;
36 typedef struct cpp_buffer cpp_buffer;
37 typedef struct cpp_options cpp_options;
38 typedef struct cpp_token cpp_token;
39 typedef struct cpp_string cpp_string;
40 typedef struct cpp_hashnode cpp_hashnode;
41 typedef struct cpp_macro cpp_macro;
42 typedef struct cpp_callbacks cpp_callbacks;
43 typedef struct cpp_dir cpp_dir;
48 /* The first three groups, apart from '=', can appear in preprocessor
49 expressions (+= and -= are used to indicate unary + and - resp.).
50 This allows a lookup table to be implemented in _cpp_parse_expr.
52 The first group, to CPP_LAST_EQ, can be immediately followed by an
53 '='. The lexer needs operators ending in '=', like ">>=", to be in
54 the same order as their counterparts without the '=', like ">>".
56 See the cpp_operator table optab in expr.c if you change the order or
57 add or remove anything in the first group. */
62 OP(GREATER, ">") /* compare */ \
64 OP(PLUS, "+") /* math */ \
69 OP(AND, "&") /* bit ops */ \
76 OP(AND_AND, "&&") /* logical */ \
80 OP(COMMA, ",") /* grouping */ \
82 OP(CLOSE_PAREN, ")") \
84 OP(EQ_EQ, "==") /* compare */ \
86 OP(GREATER_EQ, ">=") \
89 /* These two are unary + / - in preprocessor expressions. */ \
90 OP(PLUS_EQ, "+=") /* math */ \
96 OP(AND_EQ, "&=") /* bit ops */ \
99 OP(RSHIFT_EQ, ">>=") \
100 OP(LSHIFT_EQ, "<<=") \
101 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
102 OP(HASH, "#") /* digraphs */ \
104 OP(OPEN_SQUARE, "[") \
105 OP(CLOSE_SQUARE, "]") \
106 OP(OPEN_BRACE, "{") \
107 OP(CLOSE_BRACE, "}") \
108 /* The remainder of the punctuation. Order is not significant. */ \
109 OP(SEMICOLON, ";") /* structure */ \
110 OP(ELLIPSIS, "...") \
111 OP(PLUS_PLUS, "++") /* increment */ \
112 OP(MINUS_MINUS, "--") \
113 OP(DEREF, "->") /* accessors */ \
116 OP(DEREF_STAR, "->*") \
118 OP(ATSIGN, "@") /* used in Objective-C */ \
120 TK(NAME, IDENT) /* word */ \
121 TK(AT_NAME, IDENT) /* @word - Objective-C */ \
122 TK(NUMBER, LITERAL) /* 34_be+ta */ \
124 TK(CHAR, LITERAL) /* 'char' */ \
125 TK(WCHAR, LITERAL) /* L'char' */ \
126 TK(OTHER, LITERAL) /* stray punctuation */ \
128 TK(STRING, LITERAL) /* "string" */ \
129 TK(WSTRING, LITERAL) /* L"string" */ \
130 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \
131 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \
133 TK(COMMENT, LITERAL) /* Only if output comments. */ \
134 /* SPELL_LITERAL happens to DTRT. */ \
135 TK(MACRO_ARG, NONE) /* Macro argument. */ \
136 TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \
137 TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \
138 TK(PADDING, NONE) /* Whitespace for -E. */
140 #define OP(e, s) CPP_ ## e,
141 #define TK(e, s) CPP_ ## e,
147 /* Positions in the table. */
148 CPP_LAST_EQ = CPP_LSHIFT,
149 CPP_FIRST_DIGRAPH = CPP_HASH,
150 CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
151 CPP_LAST_CPP_OP = CPP_LESS_EQ
156 /* C language kind, used when calling cpp_create_reader. */
157 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
158 CLK_GNUCXX, CLK_CXX98, CLK_ASM};
160 /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
161 struct cpp_string GTY(())
164 const unsigned char *text;
167 /* Flags for the cpp_token structure. */
168 #define PREV_WHITE (1 << 0) /* If whitespace before this token. */
169 #define DIGRAPH (1 << 1) /* If it was a digraph. */
170 #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
171 #define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
172 #define NAMED_OP (1 << 4) /* C++ named operators. */
173 #define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
174 #define BOL (1 << 6) /* Token at beginning of line. */
175 #define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend,
178 /* Specify which field, if any, of the cpp_token union is used. */
180 enum cpp_token_fld_kind {
182 CPP_TOKEN_FLD_SOURCE,
184 CPP_TOKEN_FLD_ARG_NO,
185 CPP_TOKEN_FLD_PRAGMA,
189 /* A preprocessing token. This has been carefully packed and should
190 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
191 struct cpp_token GTY(())
193 source_location src_loc; /* Location of first char of token. */
194 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
195 unsigned char flags; /* flags - see above */
201 GTY ((nested_ptr (union tree_node,
202 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
203 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"),
204 tag ("CPP_TOKEN_FLD_NODE")))
207 /* Inherit padding from this token. */
208 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
210 /* A string, or number. */
211 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
213 /* Argument no. for a CPP_MACRO_ARG. */
214 unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no;
216 /* Caller-supplied identifier for a CPP_PRAGMA. */
217 unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
218 } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
221 /* Say which field is in use. */
222 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
224 /* A type wide enough to hold any multibyte source character.
225 cpplib's character constant interpreter requires an unsigned type.
226 Also, a typedef for the signed equivalent.
227 The width of this type is capped at 32 bits; there do exist targets
228 where wchar_t is 64 bits, but only in a non-default mode, and there
229 would be no meaningful interpretation for a wchar_t value greater
230 than 2^32 anyway -- the widest wide-character encoding around is
231 ISO 10646, which stops at 2^31. */
232 #if CHAR_BIT * SIZEOF_INT >= 32
233 # define CPPCHAR_SIGNED_T int
234 #elif CHAR_BIT * SIZEOF_LONG >= 32
235 # define CPPCHAR_SIGNED_T long
237 # error "Cannot find a least-32-bit signed integer type"
239 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
240 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
242 /* Style of header dependencies to generate. */
243 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
245 /* The possible normalization levels, from most restrictive to least. */
246 enum cpp_normalize_level {
251 /* In NFC, except for subsequences where being in NFC would make
252 the identifier invalid. */
253 normalized_identifier_C,
254 /* Not normalized at all. */
258 /* This structure is nested inside struct cpp_reader, and
259 carries all the options visible to the command line. */
262 /* Characters between tab stops. */
263 unsigned int tabstop;
265 /* The language we're preprocessing. */
268 /* Nonzero means use extra default include directories for C++. */
269 unsigned char cplusplus;
271 /* Nonzero means handle cplusplus style comments. */
272 unsigned char cplusplus_comments;
274 /* Nonzero means define __OBJC__, treat @ as a special token, and
275 use the OBJC[PLUS]_INCLUDE_PATH environment variable. */
278 /* Nonzero means don't copy comments into the output file. */
279 unsigned char discard_comments;
281 /* Nonzero means don't copy comments into the output file during
283 unsigned char discard_comments_in_macro_exp;
285 /* Nonzero means process the ISO trigraph sequences. */
286 unsigned char trigraphs;
288 /* Nonzero means process the ISO digraph sequences. */
289 unsigned char digraphs;
291 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
292 unsigned char extended_numbers;
294 /* Nonzero means print names of header files (-H). */
295 unsigned char print_include_names;
297 /* Nonzero means cpp_pedwarn causes a hard error. */
298 unsigned char pedantic_errors;
300 /* Nonzero means don't print warning messages. */
301 unsigned char inhibit_warnings;
303 /* Nonzero means complain about deprecated features. */
304 unsigned char warn_deprecated;
306 /* Nonzero means don't suppress warnings from system headers. */
307 unsigned char warn_system_headers;
309 /* Nonzero means don't print error messages. Has no option to
310 select it, but can be set by a user of cpplib (e.g. fix-header). */
311 unsigned char inhibit_errors;
313 /* Nonzero means warn if slash-star appears in a comment. */
314 unsigned char warn_comments;
316 /* Nonzero means warn if a user-supplied include directory does not
318 unsigned char warn_missing_include_dirs;
320 /* Nonzero means warn if there are any trigraphs. */
321 unsigned char warn_trigraphs;
323 /* Nonzero means warn about multicharacter charconsts. */
324 unsigned char warn_multichar;
326 /* Nonzero means warn about various incompatibilities with
328 unsigned char warn_traditional;
330 /* Nonzero means warn about long long numeric constants. */
331 unsigned char warn_long_long;
333 /* Nonzero means warn about text after an #endif (or #else). */
334 unsigned char warn_endif_labels;
336 /* Nonzero means warn about implicit sign changes owing to integer
338 unsigned char warn_num_sign_change;
340 /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
341 Presumably the usage is protected by the appropriate #ifdef. */
342 unsigned char warn_variadic_macros;
344 /* Nonzero means turn warnings into errors. */
345 unsigned char warnings_are_errors;
347 /* Nonzero means we should look for header.gcc files that remap file
351 /* Zero means dollar signs are punctuation. */
352 unsigned char dollars_in_ident;
354 /* Nonzero means UCNs are accepted in identifiers. */
355 unsigned char extended_identifiers;
357 /* True if we should warn about dollars in identifiers or numbers
358 for this translation unit. */
359 unsigned char warn_dollars;
361 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
362 unsigned char warn_undef;
364 /* Nonzero means warn of unused macros from the main file. */
365 unsigned char warn_unused_macros;
367 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
370 /* Nonzero if we are conforming to a specific C or C++ standard. */
373 /* Nonzero means give all the error messages the ANSI standard requires. */
374 unsigned char pedantic;
376 /* Nonzero means we're looking at already preprocessed code, so don't
377 bother trying to do macro expansion and whatnot. */
378 unsigned char preprocessed;
380 /* Print column number in error messages. */
381 unsigned char show_column;
383 /* Nonzero means handle C++ alternate operator names. */
384 unsigned char operator_names;
386 /* True for traditional preprocessing. */
387 unsigned char traditional;
389 /* Holds the name of the target (execution) character set. */
390 const char *narrow_charset;
392 /* Holds the name of the target wide character set. */
393 const char *wide_charset;
395 /* Holds the name of the input character set. */
396 const char *input_charset;
398 /* The minimum permitted level of normalization before a warning
400 enum cpp_normalize_level warn_normalize;
402 /* True to warn about precompiled header files we couldn't use. */
403 bool warn_invalid_pch;
405 /* True if dependencies should be restored from a precompiled header. */
406 bool restore_pch_deps;
408 /* Dependency generation. */
411 /* Style of header dependencies to generate. */
412 enum cpp_deps_style style;
414 /* Assume missing files are generated files. */
417 /* Generate phony targets for each dependency apart from the first
421 /* If true, no dependency is generated on the main file. */
422 bool ignore_main_file;
425 /* Target-specific features set by the front end or client. */
427 /* Precision for target CPP arithmetic, target characters, target
428 ints and target wide characters, respectively. */
429 size_t precision, char_precision, int_precision, wchar_precision;
431 /* True means chars (wide chars) are unsigned. */
432 bool unsigned_char, unsigned_wchar;
434 /* True if the most significant byte in a word has the lowest
435 address in memory. */
436 bool bytes_big_endian;
438 /* Nonzero means __STDC__ should have the value 0 in system headers. */
439 unsigned char stdc_0_in_system_headers;
441 /* True means error callback should be used for diagnostics. */
442 bool client_diagnostic;
445 /* Callback for header lookup for HEADER, which is the name of a
446 source file. It is used as a method of last resort to find headers
447 that are not otherwise found during the normal include processing.
448 The return value is the malloced name of a header to try and open,
449 if any, or NULL otherwise. This callback is called only if the
450 header is otherwise unfound. */
451 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
453 /* Call backs to cpplib client. */
456 /* Called when a new line of preprocessed output is started. */
457 void (*line_change) (cpp_reader *, const cpp_token *, int);
459 /* Called when switching to/from a new file.
460 The line_map is for the new file. It is NULL if there is no new file.
461 (In C this happens when done with <built-in>+<command line> and also
462 when done with a main file.) This can be used for resource cleanup. */
463 void (*file_change) (cpp_reader *, const struct line_map *);
465 void (*dir_change) (cpp_reader *, const char *);
466 void (*include) (cpp_reader *, unsigned int, const unsigned char *,
467 const char *, int, const cpp_token **);
468 void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
469 void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
470 void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
471 void (*def_pragma) (cpp_reader *, unsigned int);
472 int (*valid_pch) (cpp_reader *, const char *, int);
473 void (*read_pch) (cpp_reader *, const char *, int, const char *);
474 missing_header_cb missing_header;
476 /* Called to emit a diagnostic if client_diagnostic option is true.
477 This callback receives the translated message. */
478 void (*error) (cpp_reader *, int, const char *, va_list *)
479 ATTRIBUTE_FPTR_PRINTF(3,0);
482 /* Chain of directories to look for include files in. */
485 /* NULL-terminated singly-linked list. */
486 struct cpp_dir *next;
488 /* NAME of the directory, NUL-terminated. */
492 /* One if a system header, two if a system header that has extern
493 "C" guards for C++. */
496 /* Mapping of file names for this directory for MS-DOS and related
497 platforms. A NULL-terminated array of (from, to) pairs. */
498 const char **name_map;
500 /* Routine to construct pathname, given the search path name and the
501 HEADER we are trying to find, return a constructed pathname to
502 try and open. If this is NULL, the constructed pathname is as
503 constructed by append_file_to_dir. */
504 char *(*construct) (const char *header, cpp_dir *dir);
506 /* The C front end uses these to recognize duplicated
507 directories in the search path. */
511 /* Is this a user-supplied directory? */
512 bool user_supplied_p;
515 /* Name under which this program was invoked. */
516 extern const char *progname;
518 /* The structure of a node in the hash table. The hash table has
519 entries for all identifiers: either macros defined by #define
520 commands (type NT_MACRO), assertions created with #assert
521 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
522 like __LINE__ are flagged NODE_BUILTIN. Poisoned identifiers are
523 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
524 identifier that behaves like an operator such as "xor".
525 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
526 diagnostic may be required for this node. Currently this only
527 applies to __VA_ARGS__ and poisoned identifiers. */
529 /* Hash node flags. */
530 #define NODE_OPERATOR (1 << 0) /* C++ named operator. */
531 #define NODE_POISONED (1 << 1) /* Poisoned identifier. */
532 #define NODE_BUILTIN (1 << 2) /* Builtin macro. */
533 #define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
534 #define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
535 #define NODE_DISABLED (1 << 5) /* A disabled macro. */
536 #define NODE_MACRO_ARG (1 << 6) /* Used during #define processing. */
538 /* Different flavors of hash node. */
541 NT_VOID = 0, /* No definition yet. */
542 NT_MACRO, /* A macro of some form. */
543 NT_ASSERTION /* Predicate for #assert. */
546 /* Different flavors of builtin macro. _Pragma is an operator, but we
547 handle it with the builtin code for efficiency reasons. */
550 BT_SPECLINE = 0, /* `__LINE__' */
551 BT_DATE, /* `__DATE__' */
552 BT_FILE, /* `__FILE__' */
553 BT_BASE_FILE, /* `__BASE_FILE__' */
554 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
555 BT_TIME, /* `__TIME__' */
556 BT_STDC, /* `__STDC__' */
557 BT_PRAGMA, /* `_Pragma' operator */
558 BT_TIMESTAMP, /* `__TIMESTAMP__' */
559 BT_COUNTER /* `__COUNTER__' */
562 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
563 #define HT_NODE(NODE) ((ht_identifier *) (NODE))
564 #define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
565 #define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
567 /* Specify which field, if any, of the union is used. */
577 #define CPP_HASHNODE_VALUE_IDX(HNODE) \
578 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \
579 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \
580 ? NTV_BUILTIN : NTV_MACRO) \
581 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \
584 /* The common part of an identifier node shared amongst all 3 C front
585 ends. Also used to store CPP identifiers, which are a superset of
586 identifiers in the grammatical sense. */
588 union _cpp_hashnode_value GTY(())
591 cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
592 /* Answers to an assertion. */
593 struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
594 /* Code for a builtin macro. */
595 enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
596 /* Macro argument index. */
597 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
600 struct cpp_hashnode GTY(())
602 struct ht_identifier ident;
603 unsigned int is_directive : 1;
604 unsigned int directive_index : 7; /* If is_directive,
605 then index into directive table.
606 Otherwise, a NODE_OPERATOR. */
607 unsigned char rid_code; /* Rid code - for front ends. */
608 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */
609 unsigned char flags; /* CPP flags. */
611 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
614 /* Call this first to get a handle to pass to other functions.
616 If you want cpplib to manage its own hashtable, pass in a NULL
617 pointer. Otherwise you should pass in an initialized hash table
618 that cpplib will share; this technique is used by the C front
620 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
623 /* Call this to change the selected language standard (e.g. because of
624 command line options). */
625 extern void cpp_set_lang (cpp_reader *, enum c_lang);
627 /* Set the include paths. */
628 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
630 /* Call these to get pointers to the options, callback, and deps
631 structures for a given reader. These pointers are good until you
632 call cpp_finish on that reader. You can either edit the callbacks
633 through the pointer returned from cpp_get_callbacks, or set them
634 with cpp_set_callbacks. */
635 extern cpp_options *cpp_get_options (cpp_reader *);
636 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
637 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
638 extern struct deps *cpp_get_deps (cpp_reader *);
640 /* This function reads the file, but does not start preprocessing. It
641 returns the name of the original file; this is the same as the
642 input file, except for preprocessed input. This will generate at
643 least one file change callback, and possibly a line change callback
644 too. If there was an error opening the file, it returns NULL. */
645 extern const char *cpp_read_main_file (cpp_reader *, const char *);
647 /* Set up built-ins like __FILE__. */
648 extern void cpp_init_builtins (cpp_reader *, int);
650 /* This is called after options have been parsed, and partially
652 extern void cpp_post_options (cpp_reader *);
654 /* Set up translation to the target character set. */
655 extern void cpp_init_iconv (cpp_reader *);
657 /* Call this to finish preprocessing. If you requested dependency
658 generation, pass an open stream to write the information to,
659 otherwise NULL. It is your responsibility to close the stream.
661 Returns cpp_errors (pfile). */
662 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
664 /* Call this to release the handle at the end of preprocessing. Any
665 use of the handle after this function returns is invalid. Returns
666 cpp_errors (pfile). */
667 extern void cpp_destroy (cpp_reader *);
670 extern unsigned int cpp_errors (cpp_reader *);
672 extern unsigned int cpp_token_len (const cpp_token *);
673 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
674 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
675 unsigned char *, bool);
676 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
677 void (*) (cpp_reader *), bool);
678 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
679 const char *, unsigned, bool, bool);
680 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
682 extern const cpp_token *cpp_get_token (cpp_reader *);
683 extern const unsigned char *cpp_macro_definition (cpp_reader *,
684 const cpp_hashnode *);
685 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
687 /* Evaluate a CPP_CHAR or CPP_WCHAR token. */
688 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
689 unsigned int *, int *);
690 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens. */
691 extern bool cpp_interpret_string (cpp_reader *,
692 const cpp_string *, size_t,
694 extern bool cpp_interpret_string_notranslate (cpp_reader *,
695 const cpp_string *, size_t,
698 /* Convert a host character constant to the execution character set. */
699 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
701 /* Used to register macros and assertions, perhaps from the command line.
702 The text is the same as the command line argument. */
703 extern void cpp_define (cpp_reader *, const char *);
704 extern void cpp_assert (cpp_reader *, const char *);
705 extern void cpp_undef (cpp_reader *, const char *);
706 extern void cpp_unassert (cpp_reader *, const char *);
708 /* Undefine all macros and assertions. */
709 extern void cpp_undef_all (cpp_reader *);
711 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
713 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
715 /* A preprocessing number. Code assumes that any unused high bits of
716 the double integer are set to zero. */
717 typedef unsigned HOST_WIDE_INT cpp_num_part;
718 typedef struct cpp_num cpp_num;
723 bool unsignedp; /* True if value should be treated as unsigned. */
724 bool overflow; /* True if the most recent calculation overflowed. */
727 /* cpplib provides two interfaces for interpretation of preprocessing
730 cpp_classify_number categorizes numeric constants according to
731 their field (integer, floating point, or invalid), radix (decimal,
732 octal, hexadecimal), and type suffixes. */
734 #define CPP_N_CATEGORY 0x000F
735 #define CPP_N_INVALID 0x0000
736 #define CPP_N_INTEGER 0x0001
737 #define CPP_N_FLOATING 0x0002
739 #define CPP_N_WIDTH 0x00F0
740 #define CPP_N_SMALL 0x0010 /* int, float. */
741 #define CPP_N_MEDIUM 0x0020 /* long, double. */
742 #define CPP_N_LARGE 0x0040 /* long long, long double. */
744 #define CPP_N_RADIX 0x0F00
745 #define CPP_N_DECIMAL 0x0100
746 #define CPP_N_HEX 0x0200
747 #define CPP_N_OCTAL 0x0400
749 #define CPP_N_UNSIGNED 0x1000 /* Properties. */
750 #define CPP_N_IMAGINARY 0x2000
751 #define CPP_N_DFLOAT 0x4000
753 /* Classify a CPP_NUMBER token. The return value is a combination of
754 the flags from the above sets. */
755 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
757 /* Evaluate a token classified as category CPP_N_INTEGER. */
758 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
761 /* Sign extend a number, with PRECISION significant bits and all
762 others assumed clear, to fill out a cpp_num structure. */
763 cpp_num cpp_num_sign_extend (cpp_num, size_t);
765 /* Diagnostic levels. To get a diagnostic without associating a
766 position in the translation unit with it, use cpp_error_with_line
767 with a line number of zero. */
769 /* Warning, an error with -Werror. */
770 #define CPP_DL_WARNING 0x00
771 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */
772 #define CPP_DL_WARNING_SYSHDR 0x01
773 /* Warning, an error with -pedantic-errors or -Werror. */
774 #define CPP_DL_PEDWARN 0x02
776 #define CPP_DL_ERROR 0x03
777 /* An internal consistency check failed. Prints "internal error: ",
778 otherwise the same as CPP_DL_ERROR. */
779 #define CPP_DL_ICE 0x04
780 /* Extracts a diagnostic level from an int. */
781 #define CPP_DL_EXTRACT(l) (l & 0xf)
782 /* Nonzero if a diagnostic level is one of the warnings. */
783 #define CPP_DL_WARNING_P(l) (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
784 && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
786 /* Output a diagnostic of some kind. */
787 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
790 /* Output a diagnostic with "MSGID: " preceding the
791 error string of errno. No location is printed. */
792 extern void cpp_errno (cpp_reader *, int, const char *msgid);
794 /* Same as cpp_error, except additionally specifies a position as a
795 (translation unit) physical line and physical column. If the line is
796 zero, then no location is printed. */
797 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
798 const char *msgid, ...) ATTRIBUTE_PRINTF_5;
801 extern int cpp_ideq (const cpp_token *, const char *);
802 extern void cpp_output_line (cpp_reader *, FILE *);
803 extern void cpp_output_token (const cpp_token *, FILE *);
804 extern const char *cpp_type2name (enum cpp_ttype);
805 /* Returns the value of an escape sequence, truncated to the correct
806 target precision. PSTR points to the input pointer, which is just
807 after the backslash. LIMIT is how much text we have. WIDE is true
808 if the escape sequence is part of a wide character constant or
809 string literal. Handles all relevant diagnostics. */
810 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
811 const unsigned char *limit, int wide);
815 /* Lookup an identifier in the hashtable. Puts the identifier in the
816 table if it is not already there. */
817 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
820 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
821 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
824 extern void cpp_scan_nooutput (cpp_reader *);
825 extern int cpp_sys_macro_p (cpp_reader *);
826 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
830 extern bool cpp_included (cpp_reader *, const char *);
831 extern void cpp_make_system_header (cpp_reader *, int, int);
832 extern bool cpp_push_include (cpp_reader *, const char *);
833 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
834 extern const char *cpp_get_path (struct _cpp_file *);
835 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
836 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
837 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
838 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
841 struct save_macro_data;
842 extern int cpp_save_state (cpp_reader *, FILE *);
843 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
844 extern int cpp_write_pch_state (cpp_reader *, FILE *);
845 extern int cpp_valid_state (cpp_reader *, const char *, int);
846 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
847 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
848 struct save_macro_data *);
854 #endif /* ! LIBCPP_CPPLIB_H */