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 ">>". */
59 OP(GREATER, ">") /* compare */ \
61 OP(PLUS, "+") /* math */ \
66 OP(AND, "&") /* bit ops */ \
71 OP(MIN, "<?") /* extension */ \
75 OP(AND_AND, "&&") /* logical */ \
79 OP(COMMA, ",") /* grouping */ \
81 OP(CLOSE_PAREN, ")") \
83 OP(EQ_EQ, "==") /* compare */ \
85 OP(GREATER_EQ, ">=") \
88 /* These two are unary + / - in preprocessor expressions. */ \
89 OP(PLUS_EQ, "+=") /* math */ \
95 OP(AND_EQ, "&=") /* bit ops */ \
98 OP(RSHIFT_EQ, ">>=") \
99 OP(LSHIFT_EQ, "<<=") \
100 OP(MIN_EQ, "<?=") /* extension */ \
102 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
103 OP(HASH, "#") /* digraphs */ \
105 OP(OPEN_SQUARE, "[") \
106 OP(CLOSE_SQUARE, "]") \
107 OP(OPEN_BRACE, "{") \
108 OP(CLOSE_BRACE, "}") \
109 /* The remainder of the punctuation. Order is not significant. */ \
110 OP(SEMICOLON, ";") /* structure */ \
111 OP(ELLIPSIS, "...") \
112 OP(PLUS_PLUS, "++") /* increment */ \
113 OP(MINUS_MINUS, "--") \
114 OP(DEREF, "->") /* accessors */ \
117 OP(DEREF_STAR, "->*") \
119 OP(ATSIGN, "@") /* used in Objective-C */ \
121 TK(NAME, IDENT) /* word */ \
122 TK(AT_NAME, IDENT) /* @word - Objective-C */ \
123 TK(NUMBER, LITERAL) /* 34_be+ta */ \
125 TK(CHAR, LITERAL) /* 'char' */ \
126 TK(WCHAR, LITERAL) /* L'char' */ \
127 TK(OTHER, LITERAL) /* stray punctuation */ \
129 TK(STRING, LITERAL) /* "string" */ \
130 TK(WSTRING, LITERAL) /* L"string" */ \
131 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \
132 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \
134 TK(COMMENT, LITERAL) /* Only if output comments. */ \
135 /* SPELL_LITERAL happens to DTRT. */ \
136 TK(MACRO_ARG, NONE) /* Macro argument. */ \
137 TK(PRAGMA, NONE) /* Only if deferring 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_MAX,
149 CPP_FIRST_DIGRAPH = CPP_HASH,
150 CPP_LAST_PUNCTUATOR= CPP_DOT_STAR,
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,
188 /* A preprocessing token. This has been carefully packed and should
189 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
190 struct cpp_token GTY(())
192 source_location src_loc; /* Location of first char of token. */
193 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
194 unsigned char flags; /* flags - see above */
200 GTY ((nested_ptr (union tree_node,
201 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
202 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"),
203 tag ("CPP_TOKEN_FLD_NODE")))
206 /* Inherit padding from this token. */
207 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
209 /* A string, or number. */
210 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
212 /* Argument no. for a CPP_MACRO_ARG. */
213 unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no;
214 } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
217 /* Say which field is in use. */
218 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
220 /* A type wide enough to hold any multibyte source character.
221 cpplib's character constant interpreter requires an unsigned type.
222 Also, a typedef for the signed equivalent.
223 The width of this type is capped at 32 bits; there do exist targets
224 where wchar_t is 64 bits, but only in a non-default mode, and there
225 would be no meaningful interpretation for a wchar_t value greater
226 than 2^32 anyway -- the widest wide-character encoding around is
227 ISO 10646, which stops at 2^31. */
228 #if CHAR_BIT * SIZEOF_INT >= 32
229 # define CPPCHAR_SIGNED_T int
230 #elif CHAR_BIT * SIZEOF_LONG >= 32
231 # define CPPCHAR_SIGNED_T long
233 # error "Cannot find a least-32-bit signed integer type"
235 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
236 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
238 /* Style of header dependencies to generate. */
239 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
241 /* The possible normalization levels, from most restrictive to least. */
242 enum cpp_normalize_level {
247 /* In NFC, except for subsequences where being in NFC would make
248 the identifier invalid. */
249 normalized_identifier_C,
250 /* Not normalized at all. */
254 /* This structure is nested inside struct cpp_reader, and
255 carries all the options visible to the command line. */
258 /* Characters between tab stops. */
259 unsigned int tabstop;
261 /* The language we're preprocessing. */
264 /* Nonzero means use extra default include directories for C++. */
265 unsigned char cplusplus;
267 /* Nonzero means handle cplusplus style comments. */
268 unsigned char cplusplus_comments;
270 /* Nonzero means define __OBJC__, treat @ as a special token, and
271 use the OBJC[PLUS]_INCLUDE_PATH environment variable. */
274 /* Nonzero means don't copy comments into the output file. */
275 unsigned char discard_comments;
277 /* Nonzero means don't copy comments into the output file during
279 unsigned char discard_comments_in_macro_exp;
281 /* Nonzero means process the ISO trigraph sequences. */
282 unsigned char trigraphs;
284 /* Nonzero means process the ISO digraph sequences. */
285 unsigned char digraphs;
287 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
288 unsigned char extended_numbers;
290 /* Nonzero means print names of header files (-H). */
291 unsigned char print_include_names;
293 /* Nonzero means cpp_pedwarn causes a hard error. */
294 unsigned char pedantic_errors;
296 /* Nonzero means don't print warning messages. */
297 unsigned char inhibit_warnings;
299 /* Nonzero means complain about deprecated features. */
300 unsigned char warn_deprecated;
302 /* Nonzero means don't suppress warnings from system headers. */
303 unsigned char warn_system_headers;
305 /* Nonzero means don't print error messages. Has no option to
306 select it, but can be set by a user of cpplib (e.g. fix-header). */
307 unsigned char inhibit_errors;
309 /* Nonzero means warn if slash-star appears in a comment. */
310 unsigned char warn_comments;
312 /* Nonzero means warn if a user-supplied include directory does not
314 unsigned char warn_missing_include_dirs;
316 /* Nonzero means warn if there are any trigraphs. */
317 unsigned char warn_trigraphs;
319 /* Nonzero means warn about multicharacter charconsts. */
320 unsigned char warn_multichar;
322 /* Nonzero means warn about various incompatibilities with
324 unsigned char warn_traditional;
326 /* Nonzero means warn about long long numeric constants. */
327 unsigned char warn_long_long;
329 /* Nonzero means warn about text after an #endif (or #else). */
330 unsigned char warn_endif_labels;
332 /* Nonzero means warn about implicit sign changes owing to integer
334 unsigned char warn_num_sign_change;
336 /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
337 Presumably the usage is protected by the appropriate #ifdef. */
338 unsigned char warn_variadic_macros;
340 /* Nonzero means turn warnings into errors. */
341 unsigned char warnings_are_errors;
343 /* Nonzero means we should look for header.gcc files that remap file
347 /* Zero means dollar signs are punctuation. */
348 unsigned char dollars_in_ident;
350 /* Nonzero means UCNs are accepted in identifiers. */
351 unsigned char extended_identifiers;
353 /* True if we should warn about dollars in identifiers or numbers
354 for this translation unit. */
355 unsigned char warn_dollars;
357 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
358 unsigned char warn_undef;
360 /* Nonzero means warn of unused macros from the main file. */
361 unsigned char warn_unused_macros;
363 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
366 /* Nonzero if we are conforming to a specific C or C++ standard. */
369 /* Nonzero means give all the error messages the ANSI standard requires. */
370 unsigned char pedantic;
372 /* Nonzero means we're looking at already preprocessed code, so don't
373 bother trying to do macro expansion and whatnot. */
374 unsigned char preprocessed;
376 /* Print column number in error messages. */
377 unsigned char show_column;
379 /* Nonzero means handle C++ alternate operator names. */
380 unsigned char operator_names;
382 /* True for traditional preprocessing. */
383 unsigned char traditional;
385 /* Holds the name of the target (execution) character set. */
386 const char *narrow_charset;
388 /* Holds the name of the target wide character set. */
389 const char *wide_charset;
391 /* Holds the name of the input character set. */
392 const char *input_charset;
394 /* The minimum permitted level of normalization before a warning
396 enum cpp_normalize_level warn_normalize;
398 /* True to warn about precompiled header files we couldn't use. */
399 bool warn_invalid_pch;
401 /* True if dependencies should be restored from a precompiled header. */
402 bool restore_pch_deps;
404 /* Dependency generation. */
407 /* Style of header dependencies to generate. */
408 enum cpp_deps_style style;
410 /* Assume missing files are generated files. */
413 /* Generate phony targets for each dependency apart from the first
417 /* If true, no dependency is generated on the main file. */
418 bool ignore_main_file;
421 /* Target-specific features set by the front end or client. */
423 /* Precision for target CPP arithmetic, target characters, target
424 ints and target wide characters, respectively. */
425 size_t precision, char_precision, int_precision, wchar_precision;
427 /* True means chars (wide chars) are unsigned. */
428 bool unsigned_char, unsigned_wchar;
430 /* True if the most significant byte in a word has the lowest
431 address in memory. */
432 bool bytes_big_endian;
434 /* Nonzero means __STDC__ should have the value 0 in system headers. */
435 unsigned char stdc_0_in_system_headers;
437 /* True means return pragmas as tokens rather than processing
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 */
560 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
561 #define HT_NODE(NODE) ((ht_identifier *) (NODE))
562 #define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
563 #define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
565 /* Specify which field, if any, of the union is used. */
575 #define CPP_HASHNODE_VALUE_IDX(HNODE) \
576 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \
577 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \
578 ? NTV_BUILTIN : NTV_MACRO) \
579 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \
582 /* The common part of an identifier node shared amongst all 3 C front
583 ends. Also used to store CPP identifiers, which are a superset of
584 identifiers in the grammatical sense. */
586 union _cpp_hashnode_value GTY(())
589 cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
590 /* Answers to an assertion. */
591 struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
592 /* Code for a builtin macro. */
593 enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
594 /* Macro argument index. */
595 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
598 struct cpp_hashnode GTY(())
600 struct ht_identifier ident;
601 unsigned int is_directive : 1;
602 unsigned int directive_index : 7; /* If is_directive,
603 then index into directive table.
604 Otherwise, a NODE_OPERATOR. */
605 unsigned char rid_code; /* Rid code - for front ends. */
606 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */
607 unsigned char flags; /* CPP flags. */
609 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
612 /* Call this first to get a handle to pass to other functions.
614 If you want cpplib to manage its own hashtable, pass in a NULL
615 pointer. Otherwise you should pass in an initialized hash table
616 that cpplib will share; this technique is used by the C front
618 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
621 /* Call this to change the selected language standard (e.g. because of
622 command line options). */
623 extern void cpp_set_lang (cpp_reader *, enum c_lang);
625 /* Set the include paths. */
626 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
628 /* Call these to get pointers to the options, callback, and deps
629 structures for a given reader. These pointers are good until you
630 call cpp_finish on that reader. You can either edit the callbacks
631 through the pointer returned from cpp_get_callbacks, or set them
632 with cpp_set_callbacks. */
633 extern cpp_options *cpp_get_options (cpp_reader *);
634 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
635 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
636 extern struct deps *cpp_get_deps (cpp_reader *);
638 /* This function reads the file, but does not start preprocessing. It
639 returns the name of the original file; this is the same as the
640 input file, except for preprocessed input. This will generate at
641 least one file change callback, and possibly a line change callback
642 too. If there was an error opening the file, it returns NULL. */
643 extern const char *cpp_read_main_file (cpp_reader *, const char *);
645 /* Set up built-ins like __FILE__. */
646 extern void cpp_init_builtins (cpp_reader *, int);
648 /* This is called after options have been parsed, and partially
650 extern void cpp_post_options (cpp_reader *);
652 /* Set up translation to the target character set. */
653 extern void cpp_init_iconv (cpp_reader *);
655 /* Call this to finish preprocessing. If you requested dependency
656 generation, pass an open stream to write the information to,
657 otherwise NULL. It is your responsibility to close the stream.
659 Returns cpp_errors (pfile). */
660 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
662 /* Call this to release the handle at the end of preprocessing. Any
663 use of the handle after this function returns is invalid. Returns
664 cpp_errors (pfile). */
665 extern void cpp_destroy (cpp_reader *);
668 extern unsigned int cpp_errors (cpp_reader *);
670 extern unsigned int cpp_token_len (const cpp_token *);
671 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
672 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
673 unsigned char *, bool);
674 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
675 void (*) (cpp_reader *), bool);
676 extern void cpp_handle_deferred_pragma (cpp_reader *, const cpp_string *);
677 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
679 extern const cpp_token *cpp_get_token (cpp_reader *);
680 extern const unsigned char *cpp_macro_definition (cpp_reader *,
681 const cpp_hashnode *);
682 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
684 /* Evaluate a CPP_CHAR or CPP_WCHAR token. */
685 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
686 unsigned int *, int *);
687 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens. */
688 extern bool cpp_interpret_string (cpp_reader *,
689 const cpp_string *, size_t,
691 extern bool cpp_interpret_string_notranslate (cpp_reader *,
692 const cpp_string *, size_t,
695 /* Convert a host character constant to the execution character set. */
696 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
698 /* Used to register macros and assertions, perhaps from the command line.
699 The text is the same as the command line argument. */
700 extern void cpp_define (cpp_reader *, const char *);
701 extern void cpp_assert (cpp_reader *, const char *);
702 extern void cpp_undef (cpp_reader *, const char *);
703 extern void cpp_unassert (cpp_reader *, const char *);
705 /* Undefine all macros and assertions. */
706 extern void cpp_undef_all (cpp_reader *);
708 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
710 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
712 /* A preprocessing number. Code assumes that any unused high bits of
713 the double integer are set to zero. */
714 typedef unsigned HOST_WIDE_INT cpp_num_part;
715 typedef struct cpp_num cpp_num;
720 bool unsignedp; /* True if value should be treated as unsigned. */
721 bool overflow; /* True if the most recent calculation overflowed. */
724 /* cpplib provides two interfaces for interpretation of preprocessing
727 cpp_classify_number categorizes numeric constants according to
728 their field (integer, floating point, or invalid), radix (decimal,
729 octal, hexadecimal), and type suffixes. */
731 #define CPP_N_CATEGORY 0x000F
732 #define CPP_N_INVALID 0x0000
733 #define CPP_N_INTEGER 0x0001
734 #define CPP_N_FLOATING 0x0002
736 #define CPP_N_WIDTH 0x00F0
737 #define CPP_N_SMALL 0x0010 /* int, float. */
738 #define CPP_N_MEDIUM 0x0020 /* long, double. */
739 #define CPP_N_LARGE 0x0040 /* long long, long double. */
741 #define CPP_N_RADIX 0x0F00
742 #define CPP_N_DECIMAL 0x0100
743 #define CPP_N_HEX 0x0200
744 #define CPP_N_OCTAL 0x0400
746 #define CPP_N_UNSIGNED 0x1000 /* Properties. */
747 #define CPP_N_IMAGINARY 0x2000
748 #define CPP_N_DFLOAT 0x4000
750 /* Classify a CPP_NUMBER token. The return value is a combination of
751 the flags from the above sets. */
752 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
754 /* Evaluate a token classified as category CPP_N_INTEGER. */
755 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
758 /* Sign extend a number, with PRECISION significant bits and all
759 others assumed clear, to fill out a cpp_num structure. */
760 cpp_num cpp_num_sign_extend (cpp_num, size_t);
762 /* Diagnostic levels. To get a diagnostic without associating a
763 position in the translation unit with it, use cpp_error_with_line
764 with a line number of zero. */
766 /* Warning, an error with -Werror. */
767 #define CPP_DL_WARNING 0x00
768 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */
769 #define CPP_DL_WARNING_SYSHDR 0x01
770 /* Warning, an error with -pedantic-errors or -Werror. */
771 #define CPP_DL_PEDWARN 0x02
773 #define CPP_DL_ERROR 0x03
774 /* An internal consistency check failed. Prints "internal error: ",
775 otherwise the same as CPP_DL_ERROR. */
776 #define CPP_DL_ICE 0x04
777 /* Extracts a diagnostic level from an int. */
778 #define CPP_DL_EXTRACT(l) (l & 0xf)
779 /* Nonzero if a diagnostic level is one of the warnings. */
780 #define CPP_DL_WARNING_P(l) (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
781 && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
783 /* Output a diagnostic of some kind. */
784 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
787 /* Output a diagnostic with "MSGID: " preceding the
788 error string of errno. No location is printed. */
789 extern void cpp_errno (cpp_reader *, int, const char *msgid);
791 /* Same as cpp_error, except additionally specifies a position as a
792 (translation unit) physical line and physical column. If the line is
793 zero, then no location is printed. */
794 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
795 const char *msgid, ...) ATTRIBUTE_PRINTF_5;
798 extern int cpp_ideq (const cpp_token *, const char *);
799 extern void cpp_output_line (cpp_reader *, FILE *);
800 extern void cpp_output_token (const cpp_token *, FILE *);
801 extern const char *cpp_type2name (enum cpp_ttype);
802 /* Returns the value of an escape sequence, truncated to the correct
803 target precision. PSTR points to the input pointer, which is just
804 after the backslash. LIMIT is how much text we have. WIDE is true
805 if the escape sequence is part of a wide character constant or
806 string literal. Handles all relevant diagnostics. */
807 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
808 const unsigned char *limit, int wide);
812 /* Lookup an identifier in the hashtable. Puts the identifier in the
813 table if it is not already there. */
814 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
817 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
818 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
821 extern void cpp_scan_nooutput (cpp_reader *);
822 extern int cpp_sys_macro_p (cpp_reader *);
823 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
827 extern bool cpp_included (cpp_reader *, const char *);
828 extern void cpp_make_system_header (cpp_reader *, int, int);
829 extern bool cpp_push_include (cpp_reader *, const char *);
830 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
831 extern const char *cpp_get_path (struct _cpp_file *);
832 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
833 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
834 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
835 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
838 struct save_macro_data;
839 extern int cpp_save_state (cpp_reader *, FILE *);
840 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
841 extern int cpp_write_pch_state (cpp_reader *, FILE *);
842 extern int cpp_valid_state (cpp_reader *, const char *, int);
843 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
844 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
845 struct save_macro_data *);
851 #endif /* ! LIBCPP_CPPLIB_H */