1/* Definitions for CPP library. 2 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 3 2004, 2005, 2007, 2008, 2009, 2010 4 Free Software Foundation, Inc. 5 Written by Per Bothner, 1994-95. 6 7This program is free software; you can redistribute it and/or modify it 8under the terms of the GNU General Public License as published by the 9Free Software Foundation; either version 3, or (at your option) any 10later version. 11 12This program is distributed in the hope that it will be useful, 13but WITHOUT ANY WARRANTY; without even the implied warranty of 14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15GNU General Public License for more details. 16 17You should have received a copy of the GNU General Public License 18along 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 31typedef struct cpp_reader cpp_reader; 32typedef struct cpp_buffer cpp_buffer; 33typedef struct cpp_options cpp_options; 34typedef struct cpp_token cpp_token; 35typedef struct cpp_string cpp_string; 36typedef struct cpp_hashnode cpp_hashnode; 37typedef struct cpp_macro cpp_macro; 38typedef struct cpp_callbacks cpp_callbacks; 39typedef struct cpp_dir cpp_dir; 40 41struct answer; 42struct _cpp_file; 43 44/* The first three groups, apart from '=', can appear in preprocessor 45 expressions (+= and -= are used to indicate unary + and - resp.). 46 This allows a lookup table to be implemented in _cpp_parse_expr. 47 48 The first group, to CPP_LAST_EQ, can be immediately followed by an 49 '='. The lexer needs operators ending in '=', like ">>=", to be in 50 the same order as their counterparts without the '=', like ">>". 51 52 See the cpp_operator table optab in expr.c if you change the order or 53 add or remove anything in the first group. */ 54 55#define TTYPE_TABLE \ 56 OP(EQ, "=") \ 57 OP(NOT, "!") \ 58 OP(GREATER, ">") /* compare */ \ 59 OP(LESS, "<") \ 60 OP(PLUS, "+") /* math */ \ 61 OP(MINUS, "-") \ 62 OP(MULT, "*") \ 63 OP(DIV, "/") \ 64 OP(MOD, "%") \ 65 OP(AND, "&") /* bit ops */ \ 66 OP(OR, "|") \ 67 OP(XOR, "^") \ 68 OP(RSHIFT, ">>") \ 69 OP(LSHIFT, "<<") \ 70 \ 71 OP(COMPL, "~") \ 72 OP(AND_AND, "&&") /* logical */ \ 73 OP(OR_OR, "||") \ 74 OP(QUERY, "?") \ 75 OP(COLON, ":") \ 76 OP(COMMA, ",") /* grouping */ \ 77 OP(OPEN_PAREN, "(") \ 78 OP(CLOSE_PAREN, ")") \ 79 TK(EOF, NONE) \ 80 OP(EQ_EQ, "==") /* compare */ \ 81 OP(NOT_EQ, "!=") \ 82 OP(GREATER_EQ, ">=") \ 83 OP(LESS_EQ, "<=") \ 84 \ 85 /* These two are unary + / - in preprocessor expressions. */ \ 86 OP(PLUS_EQ, "+=") /* math */ \ 87 OP(MINUS_EQ, "-=") \ 88 \ 89 OP(MULT_EQ, "*=") \ 90 OP(DIV_EQ, "/=") \ 91 OP(MOD_EQ, "%=") \ 92 OP(AND_EQ, "&=") /* bit ops */ \ 93 OP(OR_EQ, "|=") \ 94 OP(XOR_EQ, "^=") \ 95 OP(RSHIFT_EQ, ">>=") \ 96 OP(LSHIFT_EQ, "<<=") \ 97 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \ 98 OP(HASH, "#") /* digraphs */ \ 99 OP(PASTE, "##") \ 100 OP(OPEN_SQUARE, "[") \ 101 OP(CLOSE_SQUARE, "]") \ 102 OP(OPEN_BRACE, "{") \ 103 OP(CLOSE_BRACE, "}") \ 104 /* The remainder of the punctuation. Order is not significant. */ \ 105 OP(SEMICOLON, ";") /* structure */ \ 106 OP(ELLIPSIS, "...") \ 107 OP(PLUS_PLUS, "++") /* increment */ \ 108 OP(MINUS_MINUS, "--") \ 109 OP(DEREF, "->") /* accessors */ \ 110 OP(DOT, ".") \ 111 OP(SCOPE, "::") \ 112 OP(DEREF_STAR, "->*") \ 113 OP(DOT_STAR, ".*") \ 114 OP(ATSIGN, "@") /* used in Objective-C */ \ 115 \ 116 TK(NAME, IDENT) /* word */ \ 117 TK(AT_NAME, IDENT) /* @word - Objective-C */ \ 118 TK(NUMBER, LITERAL) /* 34_be+ta */ \ 119 \ 120 TK(CHAR, LITERAL) /* 'char' */ \ 121 TK(WCHAR, LITERAL) /* L'char' */ \ 122 TK(CHAR16, LITERAL) /* u'char' */ \ 123 TK(CHAR32, LITERAL) /* U'char' */ \ 124 TK(OTHER, LITERAL) /* stray punctuation */ \ 125 \ 126 TK(STRING, LITERAL) /* "string" */ \ 127 TK(WSTRING, LITERAL) /* L"string" */ \ 128 TK(STRING16, LITERAL) /* u"string" */ \ 129 TK(STRING32, LITERAL) /* U"string" */ \ 130 TK(UTF8STRING, LITERAL) /* u8"string" */ \ 131 TK(OBJC_STRING, LITERAL) /* @"string" - Objective-C */ \ 132 TK(HEADER_NAME, LITERAL) /* <stdio.h> in #include */ \ 133 \ 134 TK(COMMENT, LITERAL) /* Only if output comments. */ \ 135 /* SPELL_LITERAL happens to DTRT. */ \ 136 TK(MACRO_ARG, NONE) /* Macro argument. */ \ 137 TK(PRAGMA, NONE) /* Only for deferred pragmas. */ \ 138 TK(PRAGMA_EOL, NONE) /* End-of-line for deferred pragmas. */ \ 139 TK(PADDING, NONE) /* Whitespace for -E. */ 140 141#define OP(e, s) CPP_ ## e, 142#define TK(e, s) CPP_ ## e, 143enum cpp_ttype 144{ 145 TTYPE_TABLE 146 N_TTYPES, 147 148 /* Positions in the table. */ 149 CPP_LAST_EQ = CPP_LSHIFT, 150 CPP_FIRST_DIGRAPH = CPP_HASH, 151 CPP_LAST_PUNCTUATOR= CPP_ATSIGN, 152 CPP_LAST_CPP_OP = CPP_LESS_EQ 153}; 154#undef OP 155#undef TK 156 157/* C language kind, used when calling cpp_create_reader. */ 158enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_GNUC1X, 159 CLK_STDC89, CLK_STDC94, CLK_STDC99, CLK_STDC1X, 160 CLK_GNUCXX, CLK_CXX98, CLK_GNUCXX0X, CLK_CXX0X, CLK_ASM}; 161 162/* Payload of a NUMBER, STRING, CHAR or COMMENT token. */ 163struct GTY(()) cpp_string { 164 unsigned int len; 165 const unsigned char *text; 166}; 167 168/* Flags for the cpp_token structure. */ 169#define PREV_WHITE (1 << 0) /* If whitespace before this token. */ 170#define DIGRAPH (1 << 1) /* If it was a digraph. */ 171#define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */ 172#define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */ 173#define NAMED_OP (1 << 4) /* C++ named operators. */ 174#define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */ 175#define BOL (1 << 6) /* Token at beginning of line. */ 176#define PURE_ZERO (1 << 7) /* Single 0 digit, used by the C++ frontend, 177 set in c-lex.c. */ 178#define SP_DIGRAPH (1 << 8) /* # or ## token was a digraph. */ 179#define SP_PREV_WHITE (1 << 9) /* If whitespace before a ## 180 operator, or before this token 181 after a # operator. */ 182 183/* Specify which field, if any, of the cpp_token union is used. */ 184 185enum cpp_token_fld_kind { 186 CPP_TOKEN_FLD_NODE, 187 CPP_TOKEN_FLD_SOURCE, 188 CPP_TOKEN_FLD_STR, 189 CPP_TOKEN_FLD_ARG_NO, 190 CPP_TOKEN_FLD_TOKEN_NO, 191 CPP_TOKEN_FLD_PRAGMA, 192 CPP_TOKEN_FLD_NONE 193}; 194 195/* A macro argument in the cpp_token union. */ 196struct GTY(()) cpp_macro_arg { 197 /* Argument number. */ 198 unsigned int arg_no; 199}; 200 201/* An identifier in the cpp_token union. */ 202struct GTY(()) cpp_identifier { 203 /* The canonical (UTF-8) spelling of the 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 node; 209}; 210 211/* A preprocessing token. This has been carefully packed and should 212 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */ 213struct GTY(()) cpp_token { 214 source_location src_loc; /* Location of first char of token. */ 215 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */ 216 unsigned short flags; /* flags - see above */ 217 218 union cpp_token_u 219 { 220 /* An identifier. */ 221 struct cpp_identifier GTY ((tag ("CPP_TOKEN_FLD_NODE"))) node; 222 223 /* Inherit padding from this token. */ 224 cpp_token * GTY ((tag ("CPP_TOKEN_FLD_SOURCE"))) source; 225 226 /* A string, or number. */ 227 struct cpp_string GTY ((tag ("CPP_TOKEN_FLD_STR"))) str; 228 229 /* Argument no. for a CPP_MACRO_ARG. */ 230 struct cpp_macro_arg GTY ((tag ("CPP_TOKEN_FLD_ARG_NO"))) macro_arg; 231 232 /* Original token no. for a CPP_PASTE (from a sequence of 233 consecutive paste tokens in a macro expansion). */ 234 unsigned int GTY ((tag ("CPP_TOKEN_FLD_TOKEN_NO"))) token_no; 235 236 /* Caller-supplied identifier for a CPP_PRAGMA. */ 237 unsigned int GTY ((tag ("CPP_TOKEN_FLD_PRAGMA"))) pragma; 238 } GTY ((desc ("cpp_token_val_index (&%1)"))) val; 239}; 240 241/* Say which field is in use. */ 242extern enum cpp_token_fld_kind cpp_token_val_index (cpp_token *tok); 243 244/* A type wide enough to hold any multibyte source character. 245 cpplib's character constant interpreter requires an unsigned type. 246 Also, a typedef for the signed equivalent. 247 The width of this type is capped at 32 bits; there do exist targets 248 where wchar_t is 64 bits, but only in a non-default mode, and there 249 would be no meaningful interpretation for a wchar_t value greater 250 than 2^32 anyway -- the widest wide-character encoding around is 251 ISO 10646, which stops at 2^31. */ 252#if CHAR_BIT * SIZEOF_INT >= 32 253# define CPPCHAR_SIGNED_T int 254#elif CHAR_BIT * SIZEOF_LONG >= 32 255# define CPPCHAR_SIGNED_T long 256#else 257# error "Cannot find a least-32-bit signed integer type" 258#endif 259typedef unsigned CPPCHAR_SIGNED_T cppchar_t; 260typedef CPPCHAR_SIGNED_T cppchar_signed_t; 261 262/* Style of header dependencies to generate. */ 263enum cpp_deps_style { DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM }; 264 265/* The possible normalization levels, from most restrictive to least. */ 266enum cpp_normalize_level { 267 /* In NFKC. */ 268 normalized_KC = 0, 269 /* In NFC. */ 270 normalized_C, 271 /* In NFC, except for subsequences where being in NFC would make 272 the identifier invalid. */ 273 normalized_identifier_C, 274 /* Not normalized at all. */ 275 normalized_none 276}; 277 278/* This structure is nested inside struct cpp_reader, and 279 carries all the options visible to the command line. */ 280struct cpp_options 281{ 282 /* Characters between tab stops. */ 283 unsigned int tabstop; 284 285 /* The language we're preprocessing. */ 286 enum c_lang lang; 287 288 /* Nonzero means use extra default include directories for C++. */ 289 unsigned char cplusplus; 290 291 /* Nonzero means handle cplusplus style comments. */ 292 unsigned char cplusplus_comments; 293 294 /* Nonzero means define __OBJC__, treat @ as a special token, use 295 the OBJC[PLUS]_INCLUDE_PATH environment variable, and allow 296 "#import". */ 297 unsigned char objc; 298 299 /* Nonzero means don't copy comments into the output file. */ 300 unsigned char discard_comments; 301 302 /* Nonzero means don't copy comments into the output file during 303 macro expansion. */ 304 unsigned char discard_comments_in_macro_exp; 305 306 /* Nonzero means process the ISO trigraph sequences. */ 307 unsigned char trigraphs; 308 309 /* Nonzero means process the ISO digraph sequences. */ 310 unsigned char digraphs; 311 312 /* Nonzero means to allow hexadecimal floats and LL suffixes. */ 313 unsigned char extended_numbers; 314 315 /* Nonzero means process u/U prefix literals (UTF-16/32). */ 316 unsigned char uliterals; 317 318 /* Nonzero means print names of header files (-H). */ 319 unsigned char print_include_names; 320 321 /* Nonzero means complain about deprecated features. */ 322 unsigned char cpp_warn_deprecated; 323 324 /* Nonzero means warn if slash-star appears in a comment. */ 325 unsigned char warn_comments; 326 327 /* Nonzero means warn if a user-supplied include directory does not 328 exist. */ 329 unsigned char warn_missing_include_dirs; 330 331 /* Nonzero means warn if there are any trigraphs. */ 332 unsigned char warn_trigraphs; 333 334 /* Nonzero means warn about multicharacter charconsts. */ 335 unsigned char warn_multichar; 336 337 /* Nonzero means warn about various incompatibilities with 338 traditional C. */ 339 unsigned char cpp_warn_traditional; 340 341 /* Nonzero means warn about long long numeric constants. */ 342 unsigned char cpp_warn_long_long; 343 344 /* Nonzero means warn about text after an #endif (or #else). */ 345 unsigned char warn_endif_labels; 346 347 /* Nonzero means warn about implicit sign changes owing to integer 348 promotions. */ 349 unsigned char warn_num_sign_change; 350 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; 354 355 /* Nonzero means warn about builtin macros that are redefined or 356 explicitly undefined. */ 357 unsigned char warn_builtin_macro_redefined; 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 cpp_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 /* Nonzero means handle C++ alternate operator names. */ 393 unsigned char operator_names; 394 395 /* Nonzero means warn about use of C++ alternate operator names. */ 396 unsigned char warn_cxx_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 disables tokenization outside of preprocessing directives. */ 458 bool directives_only; 459}; 460 461/* Callback for header lookup for HEADER, which is the name of a 462 source file. It is used as a method of last resort to find headers 463 that are not otherwise found during the normal include processing. 464 The return value is the malloced name of a header to try and open, 465 if any, or NULL otherwise. This callback is called only if the 466 header is otherwise unfound. */ 467typedef const char *(*missing_header_cb)(cpp_reader *, const char *header, cpp_dir **); 468 469/* Call backs to cpplib client. */ 470struct cpp_callbacks 471{ 472 /* Called when a new line of preprocessed output is started. */ 473 void (*line_change) (cpp_reader *, const cpp_token *, int); 474 475 /* Called when switching to/from a new file. 476 The line_map is for the new file. It is NULL if there is no new file. 477 (In C this happens when done with <built-in>+<command line> and also 478 when done with a main file.) This can be used for resource cleanup. */ 479 void (*file_change) (cpp_reader *, const struct line_map *); 480 481 void (*dir_change) (cpp_reader *, const char *); 482 void (*include) (cpp_reader *, unsigned int, const unsigned char *, 483 const char *, int, const cpp_token **); 484 void (*define) (cpp_reader *, unsigned int, cpp_hashnode *); 485 void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *); 486 void (*ident) (cpp_reader *, unsigned int, const cpp_string *); 487 void (*def_pragma) (cpp_reader *, unsigned int); 488 int (*valid_pch) (cpp_reader *, const char *, int); 489 void (*read_pch) (cpp_reader *, const char *, int, const char *); 490 missing_header_cb missing_header; 491 492 /* Context-sensitive macro support. Returns macro (if any) that should 493 be expanded. */ 494 cpp_hashnode * (*macro_to_expand) (cpp_reader *, const cpp_token *); 495 496 /* Called to emit a diagnostic. This callback receives the 497 translated message. */ 498 bool (*error) (cpp_reader *, int, int, source_location, unsigned int, 499 const char *, va_list *) 500 ATTRIBUTE_FPTR_PRINTF(6,0); 501 502 /* Callbacks for when a macro is expanded, or tested (whether 503 defined or not at the time) in #ifdef, #ifndef or "defined". */ 504 void (*used_define) (cpp_reader *, unsigned int, cpp_hashnode *); 505 void (*used_undef) (cpp_reader *, unsigned int, cpp_hashnode *); 506 /* Called before #define and #undef or other macro definition 507 changes are processed. */ 508 void (*before_define) (cpp_reader *); 509 /* Called whenever a macro is expanded or tested. 510 Second argument is the location of the start of the current expansion. */ 511 void (*used) (cpp_reader *, source_location, cpp_hashnode *); 512 513 /* Callback that can change a user builtin into normal macro. */ 514 bool (*user_builtin_macro) (cpp_reader *, cpp_hashnode *); 515}; 516 517#ifdef VMS 518#define INO_T_CPP ino_t ino[3] 519#else 520#define INO_T_CPP ino_t ino 521#endif 522 523/* Chain of directories to look for include files in. */ 524struct cpp_dir 525{ 526 /* NULL-terminated singly-linked list. */ 527 struct cpp_dir *next; 528 529 /* NAME of the directory, NUL-terminated. */ 530 char *name; 531 unsigned int len; 532 533 /* One if a system header, two if a system header that has extern 534 "C" guards for C++. */ 535 unsigned char sysp; 536 537 /* Is this a user-supplied directory? */ 538 bool user_supplied_p; 539 540 /* The canonicalized NAME as determined by lrealpath. This field 541 is only used by hosts that lack reliable inode numbers. */ 542 char *canonical_name; 543 544 /* Mapping of file names for this directory for MS-DOS and related 545 platforms. A NULL-terminated array of (from, to) pairs. */ 546 const char **name_map; 547 548 /* Routine to construct pathname, given the search path name and the 549 HEADER we are trying to find, return a constructed pathname to 550 try and open. If this is NULL, the constructed pathname is as 551 constructed by append_file_to_dir. */ 552 char *(*construct) (const char *header, cpp_dir *dir); 553 554 /* The C front end uses these to recognize duplicated 555 directories in the search path. */ 556 INO_T_CPP; 557 dev_t dev; 558}; 559 560/* The structure of a node in the hash table. The hash table has 561 entries for all identifiers: either macros defined by #define 562 commands (type NT_MACRO), assertions created with #assert 563 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros 564 like __LINE__ are flagged NODE_BUILTIN. Poisoned identifiers are 565 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an 566 identifier that behaves like an operator such as "xor". 567 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a 568 diagnostic may be required for this node. Currently this only 569 applies to __VA_ARGS__, poisoned identifiers, and -Wc++-compat 570 warnings about NODE_OPERATOR. */ 571 572/* Hash node flags. */ 573#define NODE_OPERATOR (1 << 0) /* C++ named operator. */ 574#define NODE_POISONED (1 << 1) /* Poisoned identifier. */ 575#define NODE_BUILTIN (1 << 2) /* Builtin macro. */ 576#define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */ 577#define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */ 578#define NODE_DISABLED (1 << 5) /* A disabled macro. */ 579#define NODE_MACRO_ARG (1 << 6) /* Used during #define processing. */ 580#define NODE_USED (1 << 7) /* Dumped with -dU. */ 581#define NODE_CONDITIONAL (1 << 8) /* Conditional macro */ 582#define NODE_WARN_OPERATOR (1 << 9) /* Warn about C++ named operator. */ 583 584/* Different flavors of hash node. */ 585enum node_type 586{ 587 NT_VOID = 0, /* No definition yet. */ 588 NT_MACRO, /* A macro of some form. */ 589 NT_ASSERTION /* Predicate for #assert. */ 590}; 591 592/* Different flavors of builtin macro. _Pragma is an operator, but we 593 handle it with the builtin code for efficiency reasons. */ 594enum cpp_builtin_type 595{ 596 BT_SPECLINE = 0, /* `__LINE__' */ 597 BT_DATE, /* `__DATE__' */ 598 BT_FILE, /* `__FILE__' */ 599 BT_BASE_FILE, /* `__BASE_FILE__' */ 600 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */ 601 BT_TIME, /* `__TIME__' */ 602 BT_STDC, /* `__STDC__' */ 603 BT_PRAGMA, /* `_Pragma' operator */ 604 BT_TIMESTAMP, /* `__TIMESTAMP__' */ 605 BT_COUNTER, /* `__COUNTER__' */ 606 BT_FIRST_USER, /* User defined builtin macros. */ 607 BT_LAST_USER = BT_FIRST_USER + 31 608}; 609 610#define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE)) 611#define HT_NODE(NODE) ((ht_identifier *) (NODE)) 612#define NODE_LEN(NODE) HT_LEN (&(NODE)->ident) 613#define NODE_NAME(NODE) HT_STR (&(NODE)->ident) 614 615/* Specify which field, if any, of the union is used. */ 616 617enum { 618 NTV_MACRO, 619 NTV_ANSWER, 620 NTV_BUILTIN, 621 NTV_ARGUMENT, 622 NTV_NONE 623}; 624 625#define CPP_HASHNODE_VALUE_IDX(HNODE) \ 626 ((HNODE.flags & NODE_MACRO_ARG) ? NTV_ARGUMENT \ 627 : HNODE.type == NT_MACRO ? ((HNODE.flags & NODE_BUILTIN) \ 628 ? NTV_BUILTIN : NTV_MACRO) \ 629 : HNODE.type == NT_ASSERTION ? NTV_ANSWER \ 630 : NTV_NONE) 631 632/* The common part of an identifier node shared amongst all 3 C front 633 ends. Also used to store CPP identifiers, which are a superset of 634 identifiers in the grammatical sense. */ 635 636union GTY(()) _cpp_hashnode_value { 637 /* If a macro. */ 638 cpp_macro * GTY((tag ("NTV_MACRO"))) macro; 639 /* Answers to an assertion. */ 640 struct answer * GTY ((tag ("NTV_ANSWER"))) answers; 641 /* Code for a builtin macro. */ 642 enum cpp_builtin_type GTY ((tag ("NTV_BUILTIN"))) builtin; 643 /* Macro argument index. */ 644 unsigned short GTY ((tag ("NTV_ARGUMENT"))) arg_index; 645}; 646 647struct GTY(()) cpp_hashnode { 648 struct ht_identifier ident; 649 unsigned int is_directive : 1; 650 unsigned int directive_index : 7; /* If is_directive, 651 then index into directive table. 652 Otherwise, a NODE_OPERATOR. */ 653 unsigned char rid_code; /* Rid code - for front ends. */ 654 ENUM_BITFIELD(node_type) type : 6; /* CPP node type. */ 655 unsigned int flags : 10; /* CPP flags. */ 656 657 union _cpp_hashnode_value GTY ((desc ("CPP_HASHNODE_VALUE_IDX (%1)"))) value; 658}; 659 660/* Call this first to get a handle to pass to other functions. 661 662 If you want cpplib to manage its own hashtable, pass in a NULL 663 pointer. Otherwise you should pass in an initialized hash table 664 that cpplib will share; this technique is used by the C front 665 ends. */ 666extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *, 667 struct line_maps *); 668 669/* Reset the cpp_reader's line_map. This is only used after reading a 670 PCH file. */ 671extern void cpp_set_line_map (cpp_reader *, struct line_maps *); 672 673/* Call this to change the selected language standard (e.g. because of 674 command line options). */ 675extern void cpp_set_lang (cpp_reader *, enum c_lang); 676 677/* Set the include paths. */ 678extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int); 679 680/* Call these to get pointers to the options, callback, and deps 681 structures for a given reader. These pointers are good until you 682 call cpp_finish on that reader. You can either edit the callbacks 683 through the pointer returned from cpp_get_callbacks, or set them 684 with cpp_set_callbacks. */ 685extern cpp_options *cpp_get_options (cpp_reader *); 686extern cpp_callbacks *cpp_get_callbacks (cpp_reader *); 687extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *); 688extern struct deps *cpp_get_deps (cpp_reader *); 689 690/* This function reads the file, but does not start preprocessing. It 691 returns the name of the original file; this is the same as the 692 input file, except for preprocessed input. This will generate at 693 least one file change callback, and possibly a line change callback 694 too. If there was an error opening the file, it returns NULL. */ 695extern const char *cpp_read_main_file (cpp_reader *, const char *); 696 697/* Set up built-ins with special behavior. Use cpp_init_builtins() 698 instead unless your know what you are doing. */ 699extern void cpp_init_special_builtins (cpp_reader *); 700 701/* Set up built-ins like __FILE__. */ 702extern void cpp_init_builtins (cpp_reader *, int); 703 704/* This is called after options have been parsed, and partially 705 processed. */ 706extern void cpp_post_options (cpp_reader *); 707 708/* Set up translation to the target character set. */ 709extern void cpp_init_iconv (cpp_reader *); 710 711/* Call this to finish preprocessing. If you requested dependency 712 generation, pass an open stream to write the information to, 713 otherwise NULL. It is your responsibility to close the stream. */ 714extern void cpp_finish (cpp_reader *, FILE *deps_stream); 715 716/* Call this to release the handle at the end of preprocessing. Any 717 use of the handle after this function returns is invalid. */ 718extern void cpp_destroy (cpp_reader *); 719 720extern unsigned int cpp_token_len (const cpp_token *); 721extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *); 722extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *, 723 unsigned char *, bool); 724extern void cpp_register_pragma (cpp_reader *, const char *, const char *, 725 void (*) (cpp_reader *), bool); 726extern void cpp_register_deferred_pragma (cpp_reader *, const char *, 727 const char *, unsigned, bool, bool); 728extern int cpp_avoid_paste (cpp_reader *, const cpp_token *, 729 const cpp_token *); 730extern const cpp_token *cpp_get_token (cpp_reader *); 731extern const cpp_token *cpp_get_token_with_location (cpp_reader *, 732 source_location *); 733extern const unsigned char *cpp_macro_definition (cpp_reader *, 734 cpp_hashnode *); 735extern void _cpp_backup_tokens (cpp_reader *, unsigned int); 736extern const cpp_token *cpp_peek_token (cpp_reader *, int); 737 738/* Evaluate a CPP_*CHAR* token. */ 739extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *, 740 unsigned int *, int *); 741/* Evaluate a vector of CPP_*STRING* tokens. */ 742extern bool cpp_interpret_string (cpp_reader *, 743 const cpp_string *, size_t, 744 cpp_string *, enum cpp_ttype); 745extern bool cpp_interpret_string_notranslate (cpp_reader *, 746 const cpp_string *, size_t, 747 cpp_string *, enum cpp_ttype); 748 749/* Convert a host character constant to the execution character set. */ 750extern cppchar_t cpp_host_to_exec_charset (cpp_reader *, cppchar_t); 751 752/* Used to register macros and assertions, perhaps from the command line. 753 The text is the same as the command line argument. */ 754extern void cpp_define (cpp_reader *, const char *); 755extern void cpp_define_formatted (cpp_reader *pfile, 756 const char *fmt, ...) ATTRIBUTE_PRINTF_2; 757extern void cpp_assert (cpp_reader *, const char *); 758extern void cpp_undef (cpp_reader *, const char *); 759extern void cpp_unassert (cpp_reader *, const char *); 760 761/* Undefine all macros and assertions. */ 762extern void cpp_undef_all (cpp_reader *); 763 764extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *, 765 size_t, int); 766extern 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. */ 770typedef unsigned HOST_WIDE_INT cpp_num_part; 771typedef struct cpp_num cpp_num; 772struct 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#define CPP_N_DEFAULT 0x8000 812 813#define CPP_N_FRACT 0x100000 /* Fract types. */ 814#define CPP_N_ACCUM 0x200000 /* Accum types. */ 815 816/* Classify a CPP_NUMBER token. The return value is a combination of 817 the flags from the above sets. */ 818extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *); 819 820/* Evaluate a token classified as category CPP_N_INTEGER. */ 821extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *, 822 unsigned int type); 823 824/* Sign extend a number, with PRECISION significant bits and all 825 others assumed clear, to fill out a cpp_num structure. */ 826cpp_num cpp_num_sign_extend (cpp_num, size_t); 827 828/* Diagnostic levels. To get a diagnostic without associating a 829 position in the translation unit with it, use cpp_error_with_line 830 with a line number of zero. */ 831 832enum { 833 /* Warning, an error with -Werror. */ 834 CPP_DL_WARNING = 0, 835 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers. */ 836 CPP_DL_WARNING_SYSHDR, 837 /* Warning, an error with -pedantic-errors or -Werror. */ 838 CPP_DL_PEDWARN, 839 /* An error. */ 840 CPP_DL_ERROR, 841 /* An internal consistency check failed. Prints "internal error: ", 842 otherwise the same as CPP_DL_ERROR. */ 843 CPP_DL_ICE, 844 /* An informative note following a warning. */ 845 CPP_DL_NOTE, 846 /* A fatal error. */ 847 CPP_DL_FATAL 848}; 849 850/* Warning reason codes. Use a reason code of zero for unclassified warnings 851 and errors that are not warnings. */ 852enum { 853 CPP_W_NONE = 0, 854 CPP_W_DEPRECATED, 855 CPP_W_COMMENTS, 856 CPP_W_MISSING_INCLUDE_DIRS, 857 CPP_W_TRIGRAPHS, 858 CPP_W_MULTICHAR, 859 CPP_W_TRADITIONAL, 860 CPP_W_LONG_LONG, 861 CPP_W_ENDIF_LABELS, 862 CPP_W_NUM_SIGN_CHANGE, 863 CPP_W_VARIADIC_MACROS, 864 CPP_W_BUILTIN_MACRO_REDEFINED, 865 CPP_W_DOLLARS, 866 CPP_W_UNDEF, 867 CPP_W_UNUSED_MACROS, 868 CPP_W_CXX_OPERATOR_NAMES, 869 CPP_W_NORMALIZE, 870 CPP_W_INVALID_PCH, 871 CPP_W_WARNING_DIRECTIVE 872}; 873 874/* Output a diagnostic of some kind. */ 875extern bool cpp_error (cpp_reader *, int, const char *msgid, ...) 876 ATTRIBUTE_PRINTF_3; 877extern bool cpp_warning (cpp_reader *, int, const char *msgid, ...) 878 ATTRIBUTE_PRINTF_3; 879extern bool cpp_pedwarning (cpp_reader *, int, const char *msgid, ...) 880 ATTRIBUTE_PRINTF_3; 881extern bool cpp_warning_syshdr (cpp_reader *, int, const char *msgid, ...) 882 ATTRIBUTE_PRINTF_3; 883 884/* Output a diagnostic with "MSGID: " preceding the 885 error string of errno. No location is printed. */ 886extern bool cpp_errno (cpp_reader *, int, const char *msgid); 887 888/* Same as cpp_error, except additionally specifies a position as a 889 (translation unit) physical line and physical column. If the line is 890 zero, then no location is printed. */ 891extern bool cpp_error_with_line (cpp_reader *, int, source_location, 892 unsigned, const char *msgid, ...) 893 ATTRIBUTE_PRINTF_5; 894extern bool cpp_warning_with_line (cpp_reader *, int, source_location, 895 unsigned, const char *msgid, ...) 896 ATTRIBUTE_PRINTF_5; 897extern bool cpp_pedwarning_with_line (cpp_reader *, int, source_location, 898 unsigned, const char *msgid, ...) 899 ATTRIBUTE_PRINTF_5; 900extern bool cpp_warning_with_line_syshdr (cpp_reader *, int, source_location, 901 unsigned, const char *msgid, ...) 902 ATTRIBUTE_PRINTF_5; 903 904/* In lex.c */ 905extern int cpp_ideq (const cpp_token *, const char *); 906extern void cpp_output_line (cpp_reader *, FILE *); 907extern unsigned char *cpp_output_line_to_string (cpp_reader *, 908 const unsigned char *); 909extern void cpp_output_token (const cpp_token *, FILE *); 910extern const char *cpp_type2name (enum cpp_ttype, unsigned char flags); 911/* Returns the value of an escape sequence, truncated to the correct 912 target precision. PSTR points to the input pointer, which is just 913 after the backslash. LIMIT is how much text we have. WIDE is true 914 if the escape sequence is part of a wide character constant or 915 string literal. Handles all relevant diagnostics. */ 916extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr, 917 const unsigned char *limit, int wide); 918 919/* Structure used to hold a comment block at a given location in the 920 source code. */ 921 922typedef struct 923{ 924 /* Text of the comment including the terminators. */ 925 char *comment; 926 927 /* source location for the given comment. */ 928 source_location sloc; 929} cpp_comment; 930 931/* Structure holding all comments for a given cpp_reader. */ 932 933typedef struct 934{ 935 /* table of comment entries. */ 936 cpp_comment *entries; 937 938 /* number of actual entries entered in the table. */ 939 int count; 940 941 /* number of entries allocated currently. */ 942 int allocated; 943} cpp_comment_table; 944 945/* Returns the table of comments encountered by the preprocessor. This 946 table is only populated when pfile->state.save_comments is true. */ 947extern cpp_comment_table *cpp_get_comments (cpp_reader *); 948 949/* In hash.c */ 950 951/* Lookup an identifier in the hashtable. Puts the identifier in the 952 table if it is not already there. */ 953extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *, 954 unsigned int); 955 956typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *); 957extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *); 958 959/* In macro.c */ 960extern void cpp_scan_nooutput (cpp_reader *); 961extern int cpp_sys_macro_p (cpp_reader *); 962extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *, 963 unsigned int); 964 965/* In files.c */ 966extern bool cpp_included (cpp_reader *, const char *); 967extern bool cpp_included_before (cpp_reader *, const char *, source_location); 968extern void cpp_make_system_header (cpp_reader *, int, int); 969extern bool cpp_push_include (cpp_reader *, const char *); 970extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *); 971extern const char *cpp_get_path (struct _cpp_file *); 972extern cpp_dir *cpp_get_dir (struct _cpp_file *); 973extern cpp_buffer *cpp_get_buffer (cpp_reader *); 974extern struct _cpp_file *cpp_get_file (cpp_buffer *); 975extern cpp_buffer *cpp_get_prev (cpp_buffer *); 976extern void cpp_clear_file_cache (cpp_reader *); 977 978/* In pch.c */ 979struct save_macro_data; 980extern int cpp_save_state (cpp_reader *, FILE *); 981extern int cpp_write_pch_deps (cpp_reader *, FILE *); 982extern int cpp_write_pch_state (cpp_reader *, FILE *); 983extern int cpp_valid_state (cpp_reader *, const char *, int); 984extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **); 985extern int cpp_read_state (cpp_reader *, const char *, FILE *, 986 struct save_macro_data *); 987 988#endif /* ! LIBCPP_CPPLIB_H */ 989