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