1 /* Definitions for CPP library. 2 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 3 2004, 2005 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 2, 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; if not, write to the Free Software 19 Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 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(OTHER, LITERAL) /* stray punctuation */ \ 127 \ 128 TK(STRING, LITERAL) /* "string" */ \ 129 TK(WSTRING, LITERAL) /* L"string" */ \ 130 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \ 131 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \ 132 \ 133 TK(COMMENT, LITERAL) /* Only if output comments. */ \ 134 /* SPELL_LITERAL happens to DTRT. */ \ 135 TK(MACRO_ARG, NONE) /* Macro argument. */ \ 136 TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \ 137 TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \ 138 TK(PADDING, NONE) /* Whitespace for -E. */ 139 140 #define OP(e, s) CPP_ ## e, 141 #define TK(e, s) CPP_ ## e, 142 enum cpp_ttype 143 { 144 TTYPE_TABLE 145 N_TTYPES, 146 147 /* Positions in the table. */ 148 CPP_LAST_EQ = CPP_LSHIFT, 149 CPP_FIRST_DIGRAPH = CPP_HASH, 150 CPP_LAST_PUNCTUATOR= CPP_ATSIGN, 151 CPP_LAST_CPP_OP = CPP_LESS_EQ 152 }; 153 #undef OP 154 #undef TK 155 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}; 159 160 /* Payload of a NUMBER, STRING, CHAR or COMMENT token. */ 161 struct cpp_string GTY(()) 162 { 163 unsigned int len; 164 const unsigned char *text; 165 }; 166 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, 176 set in c-lex.c. */ 177 178 /* Specify which field, if any, of the cpp_token union is used. */ 179 180 enum cpp_token_fld_kind { 181 CPP_TOKEN_FLD_NODE, 182 CPP_TOKEN_FLD_SOURCE, 183 CPP_TOKEN_FLD_STR, 184 CPP_TOKEN_FLD_ARG_NO, 185 CPP_TOKEN_FLD_PRAGMA, 186 CPP_TOKEN_FLD_NONE 187 }; 188 189 /* A preprocessing token. This has been carefully packed and should 190 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */ 191 struct cpp_token GTY(()) 192 { 193 source_location src_loc; /* Location of first char of token. */ 194 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */ 195 unsigned char flags; /* flags - see above */ 196 197 union cpp_token_u 198 { 199 /* An identifier. */ 200 cpp_hashnode * 201 GTY ((nested_ptr (union tree_node, 202 "%h ? CPP_HASHNODE (GCC_IDENT_TO_HT_IDENT (%h)) : NULL", 203 "%h ? HT_IDENT_TO_GCC_IDENT (HT_NODE (%h)) : NULL"), 204 tag ("CPP_TOKEN_FLD_NODE"))) 205 node; 206 207 /* Inherit padding from this token. */ 208 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source; 209 210 /* A string, or number. */ 211 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str; 212 213 /* Argument no. for a CPP_MACRO_ARG. */ 214 unsigned int GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) arg_no; 215 216 /* Caller-supplied identifier for a CPP_PRAGMA. */ 217 unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma; 218 } GTY ((desc ("cpp_token_val_index (&%1)"))) val; 219 }; 220 221 /* Say which field is in use. */ 222 extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok); 223 224 /* A type wide enough to hold any multibyte source character. 225 cpplib's character constant interpreter requires an unsigned type. 226 Also, a typedef for the signed equivalent. 227 The width of this type is capped at 32 bits; there do exist targets 228 where wchar_t is 64 bits, but only in a non-default mode, and there 229 would be no meaningful interpretation for a wchar_t value greater 230 than 2^32 anyway -- the widest wide-character encoding around is 231 ISO 10646, which stops at 2^31. */ 232 #if CHAR_BIT * SIZEOF_INT >= 32 233 # define CPPCHAR_SIGNED_T int 234 #elif CHAR_BIT * SIZEOF_LONG >= 32 235 # define CPPCHAR_SIGNED_T long 236 #else 237 # error "Cannot find a least-32-bit signed integer type" 238 #endif 239 typedef unsigned CPPCHAR_SIGNED_T cppchar_t; 240 typedef CPPCHAR_SIGNED_T cppchar_signed_t; 241 242 /* Style of header dependencies to generate. */ 243 enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM }; 244 245 /* The possible normalization levels, from most restrictive to least. */ 246 enum cpp_normalize_level { 247 /* In NFKC. */ 248 normalized_KC = 0, 249 /* In NFC. */ 250 normalized_C, 251 /* In NFC, except for subsequences where being in NFC would make 252 the identifier invalid. */ 253 normalized_identifier_C, 254 /* Not normalized at all. */ 255 normalized_none 256 }; 257 258 /* This structure is nested inside struct cpp_reader, and 259 carries all the options visible to the command line. */ 260 struct cpp_options 261 { 262 /* Characters between tab stops. */ 263 unsigned int tabstop; 264 265 /* The language we're preprocessing. */ 266 enum c_lang lang; 267 268 /* Nonzero means use extra default include directories for C++. */ 269 unsigned char cplusplus; 270 271 /* Nonzero means handle cplusplus style comments. */ 272 unsigned char cplusplus_comments; 273 274 /* Nonzero means define __OBJC__, treat @ as a special token, and 275 use the OBJC[PLUS]_INCLUDE_PATH environment variable. */ 276 unsigned char objc; 277 278 /* Nonzero means don't copy comments into the output file. */ 279 unsigned char discard_comments; 280 281 /* Nonzero means don't copy comments into the output file during 282 macro expansion. */ 283 unsigned char discard_comments_in_macro_exp; 284 285 /* Nonzero means process the ISO trigraph sequences. */ 286 unsigned char trigraphs; 287 288 /* Nonzero means process the ISO digraph sequences. */ 289 unsigned char digraphs; 290 291 /* Nonzero means to allow hexadecimal floats and LL suffixes. */ 292 unsigned char extended_numbers; 293 294 /* Nonzero means print names of header files (-H). */ 295 unsigned char print_include_names; 296 297 /* Nonzero means cpp_pedwarn causes a hard error. */ 298 unsigned char pedantic_errors; 299 300 /* Nonzero means don't print warning messages. */ 301 unsigned char inhibit_warnings; 302 303 /* Nonzero means complain about deprecated features. */ 304 unsigned char warn_deprecated; 305 306 /* Nonzero means don't suppress warnings from system headers. */ 307 unsigned char warn_system_headers; 308 309 /* Nonzero means don't print error messages. Has no option to 310 select it, but can be set by a user of cpplib (e.g. fix-header). */ 311 unsigned char inhibit_errors; 312 313 /* Nonzero means warn if slash-star appears in a comment. */ 314 unsigned char warn_comments; 315 316 /* Nonzero means warn if a user-supplied include directory does not 317 exist. */ 318 unsigned char warn_missing_include_dirs; 319 320 /* Nonzero means warn if there are any trigraphs. */ 321 unsigned char warn_trigraphs; 322 323 /* Nonzero means warn about multicharacter charconsts. */ 324 unsigned char warn_multichar; 325 326 /* Nonzero means warn about various incompatibilities with 327 traditional C. */ 328 unsigned char warn_traditional; 329 330 /* Nonzero means warn about long long numeric constants. */ 331 unsigned char warn_long_long; 332 333 /* Nonzero means warn about text after an #endif (or #else). */ 334 unsigned char warn_endif_labels; 335 336 /* Nonzero means warn about implicit sign changes owing to integer 337 promotions. */ 338 unsigned char warn_num_sign_change; 339 340 /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode. 341 Presumably the usage is protected by the appropriate #ifdef. */ 342 unsigned char warn_variadic_macros; 343 344 /* Nonzero means turn warnings into errors. */ 345 unsigned char warnings_are_errors; 346 347 /* Nonzero means we should look for header.gcc files that remap file 348 names. */ 349 unsigned char remap; 350 351 /* Zero means dollar signs are punctuation. */ 352 unsigned char dollars_in_ident; 353 354 /* Nonzero means UCNs are accepted in identifiers. */ 355 unsigned char extended_identifiers; 356 357 /* True if we should warn about dollars in identifiers or numbers 358 for this translation unit. */ 359 unsigned char warn_dollars; 360 361 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */ 362 unsigned char warn_undef; 363 364 /* Nonzero means warn of unused macros from the main file. */ 365 unsigned char warn_unused_macros; 366 367 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */ 368 unsigned char c99; 369 370 /* Nonzero if we are conforming to a specific C or C++ standard. */ 371 unsigned char std; 372 373 /* Nonzero means give all the error messages the ANSI standard requires. */ 374 unsigned char pedantic; 375 376 /* Nonzero means we're looking at already preprocessed code, so don't 377 bother trying to do macro expansion and whatnot. */ 378 unsigned char preprocessed; 379 380 /* Print column number in error messages. */ 381 unsigned char show_column; 382 383 /* Nonzero means handle C++ alternate operator names. */ 384 unsigned char operator_names; 385 386 /* True for traditional preprocessing. */ 387 unsigned char traditional; 388 389 /* Holds the name of the target (execution) character set. */ 390 const char *narrow_charset; 391 392 /* Holds the name of the target wide character set. */ 393 const char *wide_charset; 394 395 /* Holds the name of the input character set. */ 396 const char *input_charset; 397 398 /* The minimum permitted level of normalization before a warning 399 is generated. */ 400 enum cpp_normalize_level warn_normalize; 401 402 /* True to warn about precompiled header files we couldn't use. */ 403 bool warn_invalid_pch; 404 405 /* True if dependencies should be restored from a precompiled header. */ 406 bool restore_pch_deps; 407 408 /* Dependency generation. */ 409 struct 410 { 411 /* Style of header dependencies to generate. */ 412 enum cpp_deps_style style; 413 414 /* Assume missing files are generated files. */ 415 bool missing_files; 416 417 /* Generate phony targets for each dependency apart from the first 418 one. */ 419 bool phony_targets; 420 421 /* If true, no dependency is generated on the main file. */ 422 bool ignore_main_file; 423 } deps; 424 425 /* Target-specific features set by the front end or client. */ 426 427 /* Precision for target CPP arithmetic, target characters, target 428 ints and target wide characters, respectively. */ 429 size_t precision, char_precision, int_precision, wchar_precision; 430 431 /* True means chars (wide chars) are unsigned. */ 432 bool unsigned_char, unsigned_wchar; 433 434 /* True if the most significant byte in a word has the lowest 435 address in memory. */ 436 bool bytes_big_endian; 437 438 /* Nonzero means __STDC__ should have the value 0 in system headers. */ 439 unsigned char stdc_0_in_system_headers; 440 441 /* True means error callback should be used for diagnostics. */ 442 bool client_diagnostic; 443 }; 444 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 **); 452 453 /* Call backs to cpplib client. */ 454 struct cpp_callbacks 455 { 456 /* Called when a new line of preprocessed output is started. */ 457 void (*line_change) (cpp_reader *, const cpp_token *, int); 458 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 *); 464 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; 475 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); 480 }; 481 482 /* Chain of directories to look for include files in. */ 483 struct cpp_dir 484 { 485 /* NULL-terminated singly-linked list. */ 486 struct cpp_dir *next; 487 488 /* NAME of the directory, NUL-terminated. */ 489 char *name; 490 unsigned int len; 491 492 /* One if a system header, two if a system header that has extern 493 "C" guards for C++. */ 494 unsigned char sysp; 495 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; 499 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); 505 506 /* The C front end uses these to recognize duplicated 507 directories in the search path. */ 508 ino_t ino; 509 dev_t dev; 510 511 /* Is this a user-supplied directory? */ 512 bool user_supplied_p; 513 }; 514 515 /* Name under which this program was invoked. */ 516 extern const char *progname; 517 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. */ 528 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. */ 537 538 /* Different flavors of hash node. */ 539 enum node_type 540 { 541 NT_VOID = 0, /* No definition yet. */ 542 NT_MACRO, /* A macro of some form. */ 543 NT_ASSERTION /* Predicate for #assert. */ 544 }; 545 546 /* Different flavors of builtin macro. _Pragma is an operator, but we 547 handle it with the builtin code for efficiency reasons. */ 548 enum builtin_type 549 { 550 BT_SPECLINE = 0, /* `__LINE__' */ 551 BT_DATE, /* `__DATE__' */ 552 BT_FILE, /* `__FILE__' */ 553 BT_BASE_FILE, /* `__BASE_FILE__' */ 554 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */ 555 BT_TIME, /* `__TIME__' */ 556 BT_STDC, /* `__STDC__' */ 557 BT_PRAGMA, /* `_Pragma' operator */ 558 BT_TIMESTAMP /* `__TIMESTAMP__' */ 559 }; 560 561 #define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE)) 562 #define HT_NODE(NODE) ((ht_identifier *) (NODE)) 563 #define NODE_LEN(NODE) HT_LEN (&(NODE)->ident) 564 #define NODE_NAME(NODE) HT_STR (&(NODE)->ident) 565 566 /* Specify which field, if any, of the union is used. */ 567 568 enum { 569 NTV_MACRO, 570 NTV_ANSWER, 571 NTV_BUILTIN, 572 NTV_ARGUMENT, 573 NTV_NONE 574 }; 575 576 #define CPP_HASHNODE_VALUE_IDX(HNODE) \ 577 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \ 578 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \ 579 ? NTV_BUILTIN : NTV_MACRO) \ 580 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \ 581 : NTV_NONE) 582 583 /* The common part of an identifier node shared amongst all 3 C front 584 ends. Also used to store CPP identifiers, which are a superset of 585 identifiers in the grammatical sense. */ 586 587 union _cpp_hashnode_value GTY(()) 588 { 589 /* If a macro. */ 590 cpp_macro * GTY((tag ("NTV_MACRO"))) macro; 591 /* Answers to an assertion. */ 592 struct answer * GTY ((tag ("NTV_ANSWER"))) answers; 593 /* Code for a builtin macro. */ 594 enum builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin; 595 /* Macro argument index. */ 596 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index; 597 }; 598 599 struct cpp_hashnode GTY(()) 600 { 601 struct ht_identifier ident; 602 unsigned int is_directive : 1; 603 unsigned int directive_index : 7; /* If is_directive, 604 then index into directive table. 605 Otherwise, a NODE_OPERATOR. */ 606 unsigned char rid_code; /* Rid code - for front ends. */ 607 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */ 608 unsigned char flags; /* CPP flags. */ 609 610 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value; 611 }; 612 613 /* Call this first to get a handle to pass to other functions. 614 615 If you want cpplib to manage its own hashtable, pass in a NULL 616 pointer. Otherwise you should pass in an initialized hash table 617 that cpplib will share; this technique is used by the C front 618 ends. */ 619 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *, 620 struct line_maps *); 621 622 /* Call this to change the selected language standard (e.g. because of 623 command line options). */ 624 extern void cpp_set_lang (cpp_reader *, enum c_lang); 625 626 /* Set the include paths. */ 627 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int); 628 629 /* Call these to get pointers to the options, callback, and deps 630 structures for a given reader. These pointers are good until you 631 call cpp_finish on that reader. You can either edit the callbacks 632 through the pointer returned from cpp_get_callbacks, or set them 633 with cpp_set_callbacks. */ 634 extern cpp_options *cpp_get_options (cpp_reader *); 635 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *); 636 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *); 637 extern struct deps *cpp_get_deps (cpp_reader *); 638 639 /* This function reads the file, but does not start preprocessing. It 640 returns the name of the original file; this is the same as the 641 input file, except for preprocessed input. This will generate at 642 least one file change callback, and possibly a line change callback 643 too. If there was an error opening the file, it returns NULL. */ 644 extern const char *cpp_read_main_file (cpp_reader *, const char *); 645 646 /* Set up built-ins like __FILE__. */ 647 extern void cpp_init_builtins (cpp_reader *, int); 648 649 /* This is called after options have been parsed, and partially 650 processed. */ 651 extern void cpp_post_options (cpp_reader *); 652 653 /* Set up translation to the target character set. */ 654 extern void cpp_init_iconv (cpp_reader *); 655 656 /* Call this to finish preprocessing. If you requested dependency 657 generation, pass an open stream to write the information to, 658 otherwise NULL. It is your responsibility to close the stream. 659 660 Returns cpp_errors (pfile). */ 661 extern int cpp_finish (cpp_reader *, FILE *deps_stream); 662 663 /* Call this to release the handle at the end of preprocessing. Any 664 use of the handle after this function returns is invalid. Returns 665 cpp_errors (pfile). */ 666 extern void cpp_destroy (cpp_reader *); 667 668 /* Error count. */ 669 extern unsigned int cpp_errors (cpp_reader *); 670 671 extern unsigned int cpp_token_len (const cpp_token *); 672 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *); 673 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *, 674 unsigned char *, bool); 675 extern void cpp_register_pragma (cpp_reader *, const char *, const char *, 676 void (*) (cpp_reader *), bool); 677 extern void cpp_register_deferred_pragma (cpp_reader *, const char *, 678 const char *, unsigned, bool, bool); 679 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *, 680 const cpp_token *); 681 extern const cpp_token *cpp_get_token (cpp_reader *); 682 extern const unsigned char *cpp_macro_definition (cpp_reader *, 683 const cpp_hashnode *); 684 extern void _cpp_backup_tokens (cpp_reader *, unsigned int); 685 686 /* Evaluate a CPP_CHAR or CPP_WCHAR token. */ 687 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *, 688 unsigned int *, int *); 689 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens. */ 690 extern bool cpp_interpret_string (cpp_reader *, 691 const cpp_string *, size_t, 692 cpp_string *, bool); 693 extern bool cpp_interpret_string_notranslate (cpp_reader *, 694 const cpp_string *, size_t, 695 cpp_string *, bool); 696 697 /* Convert a host character constant to the execution character set. */ 698 extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t); 699 700 /* Used to register macros and assertions, perhaps from the command line. 701 The text is the same as the command line argument. */ 702 extern void cpp_define (cpp_reader *, const char *); 703 extern void cpp_assert (cpp_reader *, const char *); 704 extern void cpp_undef (cpp_reader *, const char *); 705 extern void cpp_unassert (cpp_reader *, const char *); 706 707 /* Undefine all macros and assertions. */ 708 extern void cpp_undef_all (cpp_reader *); 709 710 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *, 711 size_t, int); 712 extern int cpp_defined (cpp_reader *, const unsigned char *, int); 713 714 /* A preprocessing number. Code assumes that any unused high bits of 715 the double integer are set to zero. */ 716 typedef unsigned HOST_WIDE_INT cpp_num_part; 717 typedef struct cpp_num cpp_num; 718 struct cpp_num 719 { 720 cpp_num_part high; 721 cpp_num_part low; 722 bool unsignedp; /* True if value should be treated as unsigned. */ 723 bool overflow; /* True if the most recent calculation overflowed. */ 724 }; 725 726 /* cpplib provides two interfaces for interpretation of preprocessing 727 numbers. 728 729 cpp_classify_number categorizes numeric constants according to 730 their field (integer, floating point, or invalid), radix (decimal, 731 octal, hexadecimal), and type suffixes. */ 732 733 #define CPP_N_CATEGORY 0x000F 734 #define CPP_N_INVALID 0x0000 735 #define CPP_N_INTEGER 0x0001 736 #define CPP_N_FLOATING 0x0002 737 738 #define CPP_N_WIDTH 0x00F0 739 #define CPP_N_SMALL 0x0010 /* int, float. */ 740 #define CPP_N_MEDIUM 0x0020 /* long, double. */ 741 #define CPP_N_LARGE 0x0040 /* long long, long double. */ 742 743 #define CPP_N_RADIX 0x0F00 744 #define CPP_N_DECIMAL 0x0100 745 #define CPP_N_HEX 0x0200 746 #define CPP_N_OCTAL 0x0400 747 #define CPP_N_BINARY 0x0800 748 749 #define CPP_N_UNSIGNED 0x1000 /* Properties. */ 750 #define CPP_N_IMAGINARY 0x2000 751 #define CPP_N_DFLOAT 0x4000 752 #define CPP_N_DEFAULT 0x8000 753 754 /* Classify a CPP_NUMBER token. The return value is a combination of 755 the flags from the above sets. */ 756 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *); 757 758 /* Evaluate a token classified as category CPP_N_INTEGER. */ 759 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *, 760 unsigned int type); 761 762 /* Sign extend a number, with PRECISION significant bits and all 763 others assumed clear, to fill out a cpp_num structure. */ 764 cpp_num cpp_num_sign_extend (cpp_num, size_t); 765 766 /* Diagnostic levels. To get a diagnostic without associating a 767 position in the translation unit with it, use cpp_error_with_line 768 with a line number of zero. */ 769 770 /* Warning, an error with -Werror. */ 771 #define CPP_DL_WARNING 0x00 772 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */ 773 #define CPP_DL_WARNING_SYSHDR 0x01 774 /* Warning, an error with -pedantic-errors or -Werror. */ 775 #define CPP_DL_PEDWARN 0x02 776 /* An error. */ 777 #define CPP_DL_ERROR 0x03 778 /* An internal consistency check failed. Prints "internal error: ", 779 otherwise the same as CPP_DL_ERROR. */ 780 #define CPP_DL_ICE 0x04 781 /* Extracts a diagnostic level from an int. */ 782 #define CPP_DL_EXTRACT(l) (l & 0xf) 783 /* Nonzero if a diagnostic level is one of the warnings. */ 784 #define CPP_DL_WARNING_P(l) (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \ 785 && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN) 786 787 /* Output a diagnostic of some kind. */ 788 extern void cpp_error (cpp_reader *, int, const char *msgid, ...) 789 ATTRIBUTE_PRINTF_3; 790 791 /* Output a diagnostic with "MSGID: " preceding the 792 error string of errno. No location is printed. */ 793 extern void cpp_errno (cpp_reader *, int, const char *msgid); 794 795 /* Same as cpp_error, except additionally specifies a position as a 796 (translation unit) physical line and physical column. If the line is 797 zero, then no location is printed. */ 798 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned, 799 const char *msgid, ...) ATTRIBUTE_PRINTF_5; 800 801 /* In cpplex.c */ 802 extern int cpp_ideq (const cpp_token *, const char *); 803 extern void cpp_output_line (cpp_reader *, FILE *); 804 extern void cpp_output_token (const cpp_token *, FILE *); 805 extern const char *cpp_type2name (enum cpp_ttype); 806 /* Returns the value of an escape sequence, truncated to the correct 807 target precision. PSTR points to the input pointer, which is just 808 after the backslash. LIMIT is how much text we have. WIDE is true 809 if the escape sequence is part of a wide character constant or 810 string literal. Handles all relevant diagnostics. */ 811 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr, 812 const unsigned char *limit, int wide); 813 814 /* In cpphash.c */ 815 816 /* Lookup an identifier in the hashtable. Puts the identifier in the 817 table if it is not already there. */ 818 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *, 819 unsigned int); 820 821 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *); 822 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *); 823 824 /* In cppmacro.c */ 825 extern void cpp_scan_nooutput (cpp_reader *); 826 extern int cpp_sys_macro_p (cpp_reader *); 827 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *, 828 unsigned int); 829 830 /* In cppfiles.c */ 831 extern bool cpp_included (cpp_reader *, const char *); 832 extern void cpp_make_system_header (cpp_reader *, int, int); 833 extern bool cpp_push_include (cpp_reader *, const char *); 834 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *); 835 extern const char *cpp_get_path (struct _cpp_file *); 836 extern cpp_dir *cpp_get_dir (struct _cpp_file *); 837 extern cpp_buffer *cpp_get_buffer (cpp_reader *); 838 extern struct _cpp_file *cpp_get_file (cpp_buffer *); 839 extern cpp_buffer *cpp_get_prev (cpp_buffer *); 840 841 /* In cpppch.c */ 842 struct save_macro_data; 843 extern int cpp_save_state (cpp_reader *, FILE *); 844 extern int cpp_write_pch_deps (cpp_reader *, FILE *); 845 extern int cpp_write_pch_state (cpp_reader *, FILE *); 846 extern int cpp_valid_state (cpp_reader *, const char *, int); 847 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **); 848 extern int cpp_read_state (cpp_reader *, const char *, FILE *, 849 struct save_macro_data *); 850 851 #ifdef __cplusplus 852 } 853 #endif 854 855 #endif /* ! LIBCPP_CPPLIB_H */ 856