1 /* Definitions for CPP library.
2 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
3 2004, 2005, 2007, 2008, 2009
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 3, 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; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>.
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(CHAR16, LITERAL) /* u'char' */ \
127 TK(CHAR32, LITERAL) /* U'char' */ \
128 TK(OTHER, LITERAL) /* stray punctuation */ \
130 TK(STRING, LITERAL) /* "string" */ \
131 TK(WSTRING, LITERAL) /* L"string" */ \
132 TK(STRING16, LITERAL) /* u"string" */ \
133 TK(STRING32, LITERAL) /* U"string" */ \
134 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \
135 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \
137 TK(COMMENT, LITERAL) /* Only if output comments. */ \
138 /* SPELL_LITERAL happens to DTRT. */ \
139 TK(MACRO_ARG, NONE) /* Macro argument. */ \
140 TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \
141 TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \
142 TK(PADDING, NONE) /* Whitespace for -E. */ \
144 /* SDCC _asm specific */ \
145 TK(ASM, LITERAL) /* _asm ... _endasm ; */
147 #define OP(e, s) CPP_ ## e,
148 #define TK(e, s) CPP_ ## e,
154 /* Positions in the table. */
155 CPP_LAST_EQ = CPP_LSHIFT,
156 CPP_FIRST_DIGRAPH = CPP_HASH,
157 CPP_LAST_PUNCTUATOR= CPP_ATSIGN,
158 CPP_LAST_CPP_OP = CPP_LESS_EQ
163 /* C language kind, used when calling cpp_create_reader. */
164 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
165 CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX0X, CLK_CXX0X, CLK_ASM};
167 /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
168 struct cpp_string GTY(())
171 const unsigned char *text;
174 /* Flags for the cpp_token structure. */
175 #define PREV_WHITE (1 << 0) /* If whitespace before this token. */
176 #define DIGRAPH (1 << 1) /* If it was a digraph. */
177 #define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
178 #define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
179 #define NAMED_OP (1 << 4) /* C++ named operators. */
180 #define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
181 #define BOL (1 << 6) /* Token at beginning of line. */
182 #define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend,
185 /* Specify which field, if any, of the cpp_token union is used. */
187 enum cpp_token_fld_kind {
189 CPP_TOKEN_FLD_SOURCE,
191 CPP_TOKEN_FLD_ARG_NO,
192 CPP_TOKEN_FLD_PRAGMA,
196 /* A preprocessing token. This has been carefully packed and should
197 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
198 struct cpp_token GTY(())
200 source_location src_loc; /* Location of first char of token. */
201 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
202 unsigned char flags; /* flags - see above */
208 GTY ((nested_ptr (union tree_node,
209 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL",
210 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"),
211 tag ("CPP_TOKEN_FLD_NODE")))
214 /* Inherit padding from this token. */
215 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source;
217 /* A string, or number. */
218 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str;
220 /* Argument no. for a CPP_MACRO_ARG. */
221 unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no;
223 /* Caller-supplied identifier for a CPP_PRAGMA. */
224 unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma;
225 } GTY ((desc ("cpp_token_val_index (&%1)"))) val;
228 /* Say which field is in use. */
229 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok);
231 /* A type wide enough to hold any multibyte source character.
232 cpplib's character constant interpreter requires an unsigned type.
233 Also, a typedef for the signed equivalent.
234 The width of this type is capped at 32 bits; there do exist targets
235 where wchar_t is 64 bits, but only in a non-default mode, and there
236 would be no meaningful interpretation for a wchar_t value greater
237 than 2^32 anyway -- the widest wide-character encoding around is
238 ISO 10646, which stops at 2^31. */
239 #if CHAR_BIT * SIZEOF_INT >= 32
240 # define CPPCHAR_SIGNED_T int
241 #elif CHAR_BIT * SIZEOF_LONG >= 32
242 # define CPPCHAR_SIGNED_T long
244 # error "Cannot find a least-32-bit signed integer type"
246 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
247 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
249 /* Style of header dependencies to generate. */
250 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM };
252 /* The possible normalization levels, from most restrictive to least. */
253 enum cpp_normalize_level {
258 /* In NFC, except for subsequences where being in NFC would make
259 the identifier invalid. */
260 normalized_identifier_C,
261 /* Not normalized at all. */
265 /* This structure is nested inside struct cpp_reader, and
266 carries all the options visible to the command line. */
269 /* Characters between tab stops. */
270 unsigned int tabstop;
272 /* The language we're preprocessing. */
275 /* Nonzero means use extra default include directories for C++. */
276 unsigned char cplusplus;
278 /* Nonzero means handle cplusplus style comments. */
279 unsigned char cplusplus_comments;
281 /* Nonzero means define __OBJC__, treat @ as a special token, use
282 the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow
286 /* Nonzero means don't copy comments into the output file. */
287 unsigned char discard_comments;
289 /* Nonzero means don't copy comments into the output file during
291 unsigned char discard_comments_in_macro_exp;
293 /* Nonzero means process the ISO trigraph sequences. */
294 unsigned char trigraphs;
296 /* Nonzero means process the ISO digraph sequences. */
297 unsigned char digraphs;
299 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
300 unsigned char extended_numbers;
302 /* Nonzero means process u/U prefix literals (UTF-16/32). */
303 unsigned char uliterals;
305 /* Nonzero means print names of header files (-H). */
306 unsigned char print_include_names;
308 /* Nonzero means cpp_pedwarn causes a hard error. */
309 unsigned char pedantic_errors;
311 /* Nonzero means don't print warning messages. */
312 unsigned char inhibit_warnings;
314 /* Nonzero means complain about deprecated features. */
315 unsigned char warn_deprecated;
317 /* Nonzero means don't suppress warnings from system headers. */
318 unsigned char warn_system_headers;
320 /* Nonzero means don't print error messages. Has no option to
321 select it, but can be set by a user of cpplib (e.g. fix-header). */
322 unsigned char inhibit_errors;
324 /* Nonzero means warn if slash-star appears in a comment. */
325 unsigned char warn_comments;
327 /* Nonzero means warn if a user-supplied include directory does not
329 unsigned char warn_missing_include_dirs;
331 /* Nonzero means warn if there are any trigraphs. */
332 unsigned char warn_trigraphs;
334 /* Nonzero means warn about multicharacter charconsts. */
335 unsigned char warn_multichar;
337 /* Nonzero means warn about various incompatibilities with
339 unsigned char warn_traditional;
341 /* Nonzero means warn about long long numeric constants. */
342 unsigned char warn_long_long;
344 /* Nonzero means warn about text after an #endif (or #else). */
345 unsigned char warn_endif_labels;
347 /* Nonzero means warn about implicit sign changes owing to integer
349 unsigned char warn_num_sign_change;
351 /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
352 Presumably the usage is protected by the appropriate #ifdef. */
353 unsigned char warn_variadic_macros;
355 /* Nonzero means warn about builtin macros that are redefined or
356 explicitly undefined. */
357 unsigned char warn_builtin_macro_redefined;
359 /* Nonzero means turn warnings into errors. */
360 unsigned char warnings_are_errors;
362 /* Nonzero means we should look for header.gcc files that remap file
366 /* Zero means dollar signs are punctuation. */
367 unsigned char dollars_in_ident;
369 /* Nonzero means UCNs are accepted in identifiers. */
370 unsigned char extended_identifiers;
372 /* True if we should warn about dollars in identifiers or numbers
373 for this translation unit. */
374 unsigned char warn_dollars;
376 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
377 unsigned char warn_undef;
379 /* Nonzero means warn of unused macros from the main file. */
380 unsigned char warn_unused_macros;
382 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
385 /* Nonzero if we are conforming to a specific C or C++ standard. */
388 /* Nonzero means give all the error messages the ANSI standard requires. */
389 unsigned char pedantic;
391 /* Nonzero means we're looking at already preprocessed code, so don't
392 bother trying to do macro expansion and whatnot. */
393 unsigned char preprocessed;
395 /* Print column number in error messages. */
396 unsigned char show_column;
398 /* Nonzero means handle C++ alternate operator names. */
399 unsigned char operator_names;
401 /* True for traditional preprocessing. */
402 unsigned char traditional;
404 /* Holds the name of the target (execution) character set. */
405 const char *narrow_charset;
407 /* Holds the name of the target wide character set. */
408 const char *wide_charset;
410 /* Holds the name of the input character set. */
411 const char *input_charset;
413 /* The minimum permitted level of normalization before a warning
415 enum cpp_normalize_level warn_normalize;
417 /* True to warn about precompiled header files we couldn't use. */
418 bool warn_invalid_pch;
420 /* True if dependencies should be restored from a precompiled header. */
421 bool restore_pch_deps;
423 /* SDCC abuse by Kevin: allow naked '#' characters in expanded macros
424 * (see _cpp_create_definition in cppmacro.c)
426 unsigned char allow_naked_hash;
428 /* SDCC _asm specific
429 switch _asm block preprocessing on / off */
430 unsigned char preproc_asm;
433 object file exetnsion */
437 pedantic_parse_number */
438 unsigned char pedantic_parse_number;
440 /* Dependency generation. */
443 /* Style of header dependencies to generate. */
444 enum cpp_deps_style style;
446 /* Assume missing files are generated files. */
449 /* Generate phony targets for each dependency apart from the first
453 /* If true, no dependency is generated on the main file. */
454 bool ignore_main_file;
457 /* Target-specific features set by the front end or client. */
459 /* Precision for target CPP arithmetic, target characters, target
460 ints and target wide characters, respectively. */
461 size_t precision, char_precision, int_precision, wchar_precision;
463 /* True means chars (wide chars) are unsigned. */
464 bool unsigned_char, unsigned_wchar;
466 /* True if the most significant byte in a word has the lowest
467 address in memory. */
468 bool bytes_big_endian;
470 /* Nonzero means __STDC__ should have the value 0 in system headers. */
471 unsigned char stdc_0_in_system_headers;
473 /* True means error callback should be used for diagnostics. */
474 bool client_diagnostic;
476 /* True disables tokenization outside of preprocessing directives. */
477 bool directives_only;
480 /* Callback for header lookup for HEADER, which is the name of a
481 source file. It is used as a method of last resort to find headers
482 that are not otherwise found during the normal include processing.
483 The return value is the malloced name of a header to try and open,
484 if any, or NULL otherwise. This callback is called only if the
485 header is otherwise unfound. */
486 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **);
488 /* Call backs to cpplib client. */
491 /* Called when a new line of preprocessed output is started. */
492 void (*line_change) (cpp_reader *, const cpp_token *, int);
494 /* Called when switching to/from a new file.
495 The line_map is for the new file. It is NULL if there is no new file.
496 (In C this happens when done with <built-in>+<command line> and also
497 when done with a main file.) This can be used for resource cleanup. */
498 void (*file_change) (cpp_reader *, const struct line_map *);
500 void (*dir_change) (cpp_reader *, const char *);
501 void (*include) (cpp_reader *, unsigned int, const unsigned char *,
502 const char *, int, const cpp_token **);
503 void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
504 void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
505 void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
506 void (*def_pragma) (cpp_reader *, unsigned int);
507 int (*valid_pch) (cpp_reader *, const char *, int);
508 void (*read_pch) (cpp_reader *, const char *, int, const char *);
509 missing_header_cb missing_header;
511 /* Context-sensitive macro support. Returns macro (if any) that should
513 cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *);
515 /* Called to emit a diagnostic if client_diagnostic option is true.
516 This callback receives the translated message. */
517 void (*error) (cpp_reader *, int, const char *, va_list *)
518 ATTRIBUTE_FPTR_PRINTF(3,0);
520 /* Callbacks for when a macro is expanded, or tested (whether
521 defined or not at the time) in #ifdef, #ifndef or "defined". */
522 void (*used_define) (cpp_reader *, unsigned int, cpp_hashnode *);
523 void (*used_undef) (cpp_reader *, unsigned int, cpp_hashnode *);
524 /* Called before #define and #undef or other macro definition
525 changes are processed. */
526 void (*before_define) (cpp_reader *);
529 /* Chain of directories to look for include files in. */
532 /* NULL-terminated singly-linked list. */
533 struct cpp_dir *next;
535 /* NAME of the directory, NUL-terminated. */
539 /* One if a system header, two if a system header that has extern
540 "C" guards for C++. */
543 /* Is this a user-supplied directory? */
544 bool user_supplied_p;
546 /* The canonicalized NAME as determined by lrealpath. This field
547 is only used by hosts that lack reliable inode numbers. */
548 char *canonical_name;
550 /* Mapping of file names for this directory for MS-DOS and related
551 platforms. A NULL-terminated array of (from, to) pairs. */
552 const char **name_map;
554 /* Routine to construct pathname, given the search path name and the
555 HEADER we are trying to find, return a constructed pathname to
556 try and open. If this is NULL, the constructed pathname is as
557 constructed by append_file_to_dir. */
558 char *(*construct) (const char *header, cpp_dir *dir);
560 /* The C front end uses these to recognize duplicated
561 directories in the search path. */
566 /* Name under which this program was invoked. */
567 extern const char *progname;
569 /* The structure of a node in the hash table. The hash table has
570 entries for all identifiers: either macros defined by #define
571 commands (type NT_MACRO), assertions created with #assert
572 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
573 like __LINE__ are flagged NODE_BUILTIN. Poisoned identifiers are
574 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
575 identifier that behaves like an operator such as "xor".
576 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
577 diagnostic may be required for this node. Currently this only
578 applies to __VA_ARGS__ and poisoned identifiers. */
580 /* Hash node flags. */
581 #define NODE_OPERATOR (1 << 0) /* C++ named operator. */
582 #define NODE_POISONED (1 << 1) /* Poisoned identifier. */
583 #define NODE_BUILTIN (1 << 2) /* Builtin macro. */
584 #define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
585 #define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
586 #define NODE_DISABLED (1 << 5) /* A disabled macro. */
587 #define NODE_MACRO_ARG (1 << 6) /* Used during #define processing. */
588 #define NODE_USED (1 << 7) /* Dumped with -dU. */
589 #define NODE_CONDITIONAL (1 << 8) /* Conditional macro */
591 /* Different flavors of hash node. */
594 NT_VOID = 0, /* No definition yet. */
595 NT_MACRO, /* A macro of some form. */
596 NT_ASSERTION /* Predicate for #assert. */
599 /* Different flavors of builtin macro. _Pragma is an operator, but we
600 handle it with the builtin code for efficiency reasons. */
603 BT_SPECLINE = 0, /* `__LINE__' */
604 BT_DATE, /* `__DATE__' */
605 BT_FILE, /* `__FILE__' */
606 BT_BASE_FILE, /* `__BASE_FILE__' */
607 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
608 BT_TIME, /* `__TIME__' */
609 BT_STDC, /* `__STDC__' */
610 BT_PRAGMA, /* `_Pragma' operator */
611 BT_TIMESTAMP, /* `__TIMESTAMP__' */
612 BT_COUNTER /* `__COUNTER__' */
615 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
616 #define HT_NODE(NODE) ((ht_identifier *) (NODE))
617 #define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
618 #define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
620 /* Specify which field, if any, of the union is used. */
630 #define CPP_HASHNODE_VALUE_IDX(HNODE) \
631 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \
632 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \
633 ? NTV_BUILTIN : NTV_MACRO) \
634 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \
637 /* The common part of an identifier node shared amongst all 3 C front
638 ends. Also used to store CPP identifiers, which are a superset of
639 identifiers in the grammatical sense. */
641 union _cpp_hashnode_value GTY(())
644 cpp_macro * GTY((tag ("NTV_MACRO"))) macro;
645 /* Answers to an assertion. */
646 struct answer * GTY ((tag ("NTV_ANSWER"))) answers;
647 /* Code for a builtin macro. */
648 enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin;
649 /* Macro argument index. */
650 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index;
653 struct cpp_hashnode GTY(())
655 struct ht_identifier ident;
656 unsigned int is_directive : 1;
657 unsigned int directive_index : 7; /* If is_directive,
658 then index into directive table.
659 Otherwise, a NODE_OPERATOR. */
660 unsigned char rid_code; /* Rid code - for front ends. */
661 ENUM_BITFIELD(node_type) type : 7; /* CPP node type. */
662 unsigned int flags : 9; /* CPP flags. */
664 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value;
667 /* Call this first to get a handle to pass to other functions.
669 If you want cpplib to manage its own hashtable, pass in a NULL
670 pointer. Otherwise you should pass in an initialized hash table
671 that cpplib will share; this technique is used by the C front
673 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *,
676 /* Reset the cpp_reader's line_map. This is only used after reading a
678 extern void cpp_set_line_map (cpp_reader *, struct line_maps *);
680 /* Call this to change the selected language standard (e.g. because of
681 command line options). */
682 extern void cpp_set_lang (cpp_reader *, enum c_lang);
684 /* Set the include paths. */
685 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
687 /* Call these to get pointers to the options, callback, and deps
688 structures for a given reader. These pointers are good until you
689 call cpp_finish on that reader. You can either edit the callbacks
690 through the pointer returned from cpp_get_callbacks, or set them
691 with cpp_set_callbacks. */
692 extern cpp_options *cpp_get_options (cpp_reader *);
693 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
694 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
695 extern struct deps *cpp_get_deps (cpp_reader *);
697 /* This function reads the file, but does not start preprocessing. It
698 returns the name of the original file; this is the same as the
699 input file, except for preprocessed input. This will generate at
700 least one file change callback, and possibly a line change callback
701 too. If there was an error opening the file, it returns NULL. */
702 extern const char *cpp_read_main_file (cpp_reader *, const char *);
704 /* Set up built-ins with special behavior. Use cpp_init_builtins()
705 instead unless your know what you are doing. */
706 extern void cpp_init_special_builtins (cpp_reader *);
708 /* Set up built-ins like __FILE__. */
709 extern void cpp_init_builtins (cpp_reader *, int);
711 /* This is called after options have been parsed, and partially
713 extern void cpp_post_options (cpp_reader *);
715 /* Set up translation to the target character set. */
716 extern void cpp_init_iconv (cpp_reader *);
718 /* Call this to finish preprocessing. If you requested dependency
719 generation, pass an open stream to write the information to,
720 otherwise NULL. It is your responsibility to close the stream.
722 Returns cpp_errors (pfile). */
723 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
725 /* Call this to release the handle at the end of preprocessing. Any
726 use of the handle after this function returns is invalid. Returns
727 cpp_errors (pfile). */
728 extern void cpp_destroy (cpp_reader *);
731 extern unsigned int cpp_errors (cpp_reader *);
733 extern unsigned int cpp_token_len (const cpp_token *);
734 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
735 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
736 unsigned char *, bool);
737 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
738 void (*) (cpp_reader *), bool);
739 extern void cpp_register_deferred_pragma (cpp_reader *, const char *,
740 const char *, unsigned, bool, bool);
741 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
743 extern const cpp_token *cpp_get_token (cpp_reader *);
744 extern const cpp_token *cpp_get_token_with_location (cpp_reader *,
746 extern const unsigned char *cpp_macro_definition (cpp_reader *,
747 const cpp_hashnode *);
748 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
749 extern const cpp_token *cpp_peek_token (cpp_reader *, int);
751 /* Evaluate a CPP_CHAR or CPP_WCHAR token. */
752 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
753 unsigned int *, int *);
754 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens. */
755 extern bool cpp_interpret_string (cpp_reader *,
756 const cpp_string *, size_t,
757 cpp_string *, enum cpp_ttype);
758 extern bool cpp_interpret_string_notranslate (cpp_reader *,
759 const cpp_string *, size_t,
760 cpp_string *, enum cpp_ttype);
762 /* Convert a host character constant to the execution character set. */
763 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t);
765 /* Used to register macros and assertions, perhaps from the command line.
766 The text is the same as the command line argument. */
767 extern void cpp_define (cpp_reader *, const char *);
768 extern void cpp_define_formatted (cpp_reader *pfile,
769 const char *fmt, ...) ATTRIBUTE_PRINTF_2;
770 extern void cpp_assert (cpp_reader *, const char *);
771 extern void cpp_undef (cpp_reader *, const char *);
772 extern void cpp_unassert (cpp_reader *, const char *);
774 extern cpp_macro *cpp_push_definition (cpp_reader *, const char *);
775 extern void cpp_pop_definition (cpp_reader *, const char *, cpp_macro *);
777 /* Undefine all macros and assertions. */
778 extern void cpp_undef_all (cpp_reader *);
780 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
782 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
784 /* A preprocessing number. Code assumes that any unused high bits of
785 the double integer are set to zero. */
786 typedef unsigned HOST_WIDE_INT cpp_num_part;
787 typedef struct cpp_num cpp_num;
792 bool unsignedp; /* True if value should be treated as unsigned. */
793 bool overflow; /* True if the most recent calculation overflowed. */
796 /* cpplib provides two interfaces for interpretation of preprocessing
799 cpp_classify_number categorizes numeric constants according to
800 their field (integer, floating point, or invalid), radix (decimal,
801 octal, hexadecimal), and type suffixes. */
803 #define CPP_N_CATEGORY 0x000F
804 #define CPP_N_INVALID 0x0000
805 #define CPP_N_INTEGER 0x0001
806 #define CPP_N_FLOATING 0x0002
808 #define CPP_N_WIDTH 0x00F0
809 #define CPP_N_SMALL 0x0010 /* int, float, shrot _Fract/Accum */
810 #define CPP_N_MEDIUM 0x0020 /* long, double, long _Fract/_Accum. */
811 #define CPP_N_LARGE 0x0040 /* long long, long double,
812 long long _Fract/Accum. */
814 #define CPP_N_WIDTH_MD 0xF0000 /* machine defined. */
815 #define CPP_N_MD_W 0x10000
816 #define CPP_N_MD_Q 0x20000
818 #define CPP_N_RADIX 0x0F00
819 #define CPP_N_DECIMAL 0x0100
820 #define CPP_N_HEX 0x0200
821 #define CPP_N_OCTAL 0x0400
822 #define CPP_N_BINARY 0x0800
824 #define CPP_N_UNSIGNED 0x1000 /* Properties. */
825 #define CPP_N_IMAGINARY 0x2000
826 #define CPP_N_DFLOAT 0x4000
828 #define CPP_N_FRACT 0x100000 /* Fract types. */
829 #define CPP_N_ACCUM 0x200000 /* Accum types. */
831 /* Classify a CPP_NUMBER token. The return value is a combination of
832 the flags from the above sets. */
833 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
835 /* Evaluate a token classified as category CPP_N_INTEGER. */
836 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
839 /* Sign extend a number, with PRECISION significant bits and all
840 others assumed clear, to fill out a cpp_num structure. */
841 cpp_num cpp_num_sign_extend (cpp_num, size_t);
843 /* Diagnostic levels. To get a diagnostic without associating a
844 position in the translation unit with it, use cpp_error_with_line
845 with a line number of zero. */
847 /* Warning, an error with -Werror. */
848 #define CPP_DL_WARNING 0x00
849 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */
850 #define CPP_DL_WARNING_SYSHDR 0x01
851 /* Warning, an error with -pedantic-errors or -Werror. */
852 #define CPP_DL_PEDWARN 0x02
854 #define CPP_DL_ERROR 0x03
855 /* An internal consistency check failed. Prints "internal error: ",
856 otherwise the same as CPP_DL_ERROR. */
857 #define CPP_DL_ICE 0x04
858 /* Extracts a diagnostic level from an int. */
859 #define CPP_DL_EXTRACT(l) (l & 0xf)
860 /* Nonzero if a diagnostic level is one of the warnings. */
861 #define CPP_DL_WARNING_P(l) (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
862 && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
864 /* Output a diagnostic of some kind. */
865 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
868 /* Output a diagnostic with "MSGID: " preceding the
869 error string of errno. No location is printed. */
870 extern void cpp_errno (cpp_reader *, int, const char *msgid);
872 /* Same as cpp_error, except additionally specifies a position as a
873 (translation unit) physical line and physical column. If the line is
874 zero, then no location is printed. */
875 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
876 const char *msgid, ...) ATTRIBUTE_PRINTF_5;
879 extern int cpp_ideq (const cpp_token *, const char *);
880 extern void cpp_output_line (cpp_reader *, FILE *);
881 extern unsigned char *cpp_output_line_to_string (cpp_reader *,
882 const unsigned char *);
883 extern void cpp_output_token (const cpp_token *, FILE *);
884 extern const char *cpp_type2name (enum cpp_ttype);
885 /* Returns the value of an escape sequence, truncated to the correct
886 target precision. PSTR points to the input pointer, which is just
887 after the backslash. LIMIT is how much text we have. WIDE is true
888 if the escape sequence is part of a wide character constant or
889 string literal. Handles all relevant diagnostics. */
890 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
891 const unsigned char *limit, int wide);
893 /* Structure used to hold a comment block at a given location in the
898 /* Text of the comment including the terminators. */
901 /* source location for the given comment. */
902 source_location sloc;
905 /* Structure holding all comments for a given cpp_reader. */
909 /* table of comment entries. */
910 cpp_comment *entries;
912 /* number of actual entries entered in the table. */
915 /* number of entries allocated currently. */
919 /* Returns the table of comments encountered by the preprocessor. This
920 table is only populated when pfile->state.save_comments is true. */
921 extern cpp_comment_table *cpp_get_comments (cpp_reader *);
925 /* Lookup an identifier in the hashtable. Puts the identifier in the
926 table if it is not already there. */
927 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
930 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
931 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
934 extern void cpp_scan_nooutput (cpp_reader *);
935 extern int cpp_sys_macro_p (cpp_reader *);
936 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
940 extern bool cpp_included (cpp_reader *, const char *);
941 extern bool cpp_included_before (cpp_reader *, const char *, source_location);
942 extern void cpp_make_system_header (cpp_reader *, int, int);
943 extern bool cpp_push_include (cpp_reader *, const char *);
944 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
945 extern const char *cpp_get_path (struct _cpp_file *);
946 extern cpp_dir *cpp_get_dir (struct _cpp_file *);
947 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
948 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
949 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
950 extern void cpp_clear_file_cache (cpp_reader *);
953 struct save_macro_data;
954 extern int cpp_save_state (cpp_reader *, FILE *);
955 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
956 extern int cpp_write_pch_state (cpp_reader *, FILE *);
957 extern int cpp_valid_state (cpp_reader *, const char *, int);
958 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
959 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
960 struct save_macro_data *);
966 #endif /* ! LIBCPP_CPPLIB_H */