git.gag.com Git - fw/sdcc/blob - support/cpp2/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
   3    Free Software Foundation, Inc.
   4    Written by Per Bothner, 1994-95.
   5
   6 This program is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20  In other words, you are welcome to use, share and improve this program.
  21  You are forbidden to forbid anyone else to use, share and improve
  22  what you give them.   Help stamp out software-hoarding!  */
  23 #ifndef GCC_CPPLIB_H
  24 #define GCC_CPPLIB_H
  25
  26 #include <sys/types.h>
  27 #include "hashtable.h"
  28 #include "line-map.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 typedef struct cpp_reader cpp_reader;
  35 typedef struct cpp_buffer cpp_buffer;
  36 typedef struct cpp_options cpp_options;
  37 typedef struct cpp_token cpp_token;
  38 typedef struct cpp_string cpp_string;
  39 typedef struct cpp_hashnode cpp_hashnode;
  40 typedef struct cpp_macro cpp_macro;
  41 typedef struct cpp_callbacks cpp_callbacks;
  42 typedef struct cpp_dir cpp_dir;
  43
  44 struct answer;
  45
  46 /* The first three groups, apart from '=', can appear in preprocessor
  47    expressions (+= and -= are used to indicate unary + and - resp.).
  48    This allows a lookup table to be implemented in _cpp_parse_expr.
  49
  50    The first group, to CPP_LAST_EQ, can be immediately followed by an
  51    '='.  The lexer needs operators ending in '=', like ">>=", to be in
  52    the same order as their counterparts without the '=', like ">>".  */
  53
  54 /* Positions in the table.  */
  55 #define CPP_LAST_EQ CPP_MAX
  56 #define CPP_FIRST_DIGRAPH CPP_HASH
  57 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
  58 #define CPP_LAST_CPP_OP CPP_LESS_EQ
  59
  60 #define TTYPE_TABLE                             \
  61   OP(CPP_EQ = 0,        "=")                    \
  62   OP(CPP_NOT,           "!")                    \
  63   OP(CPP_GREATER,       ">")    /* compare */   \
  64   OP(CPP_LESS,          "<")                    \
  65   OP(CPP_PLUS,          "+")    /* math */      \
  66   OP(CPP_MINUS,         "-")                    \
  67   OP(CPP_MULT,          "*")                    \
  68   OP(CPP_DIV,           "/")                    \
  69   OP(CPP_MOD,           "%")                    \
  70   OP(CPP_AND,           "&")    /* bit ops */   \
  71   OP(CPP_OR,            "|")                    \
  72   OP(CPP_XOR,           "^")                    \
  73   OP(CPP_RSHIFT,        ">>")                   \
  74   OP(CPP_LSHIFT,        "<<")                   \
  75   OP(CPP_MIN,           "<?")   /* extension */ \
  76   OP(CPP_MAX,           ">?")                   \
  77 \
  78   OP(CPP_COMPL,         "~")                    \
  79   OP(CPP_AND_AND,       "&&")   /* logical */   \
  80   OP(CPP_OR_OR,         "||")                   \
  81   OP(CPP_QUERY,         "?")                    \
  82   OP(CPP_COLON,         ":")                    \
  83   OP(CPP_COMMA,         ",")    /* grouping */  \
  84   OP(CPP_OPEN_PAREN,    "(")                    \
  85   OP(CPP_CLOSE_PAREN,   ")")                    \
  86   TK(CPP_EOF,           SPELL_NONE)             \
  87   OP(CPP_EQ_EQ,         "==")   /* compare */   \
  88   OP(CPP_NOT_EQ,        "!=")                   \
  89   OP(CPP_GREATER_EQ,    ">=")                   \
  90   OP(CPP_LESS_EQ,       "<=")                   \
  91 \
  92   /* These two are unary + / - in preprocessor expressions.  */ \
  93   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
  94   OP(CPP_MINUS_EQ,      "-=")                   \
  95 \
  96   OP(CPP_MULT_EQ,       "*=")                   \
  97   OP(CPP_DIV_EQ,        "/=")                   \
  98   OP(CPP_MOD_EQ,        "%=")                   \
  99   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
 100   OP(CPP_OR_EQ,         "|=")                   \
 101   OP(CPP_XOR_EQ,        "^=")                   \
 102   OP(CPP_RSHIFT_EQ,     ">>=")                  \
 103   OP(CPP_LSHIFT_EQ,     "<<=")                  \
 104   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
 105   OP(CPP_MAX_EQ,        ">?=")                  \
 106   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
 107   OP(CPP_HASH,          "#")    /* digraphs */  \
 108   OP(CPP_PASTE,         "##")                   \
 109   OP(CPP_OPEN_SQUARE,   "[")                    \
 110   OP(CPP_CLOSE_SQUARE,  "]")                    \
 111   OP(CPP_OPEN_BRACE,    "{")                    \
 112   OP(CPP_CLOSE_BRACE,   "}")                    \
 113   /* The remainder of the punctuation.  Order is not significant.  */   \
 114   OP(CPP_SEMICOLON,     ";")    /* structure */ \
 115   OP(CPP_ELLIPSIS,      "...")                  \
 116   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
 117   OP(CPP_MINUS_MINUS,   "--")                   \
 118   OP(CPP_DEREF,         "->")   /* accessors */ \
 119   OP(CPP_DOT,           ".")                    \
 120   OP(CPP_SCOPE,         "::")                   \
 121   OP(CPP_DEREF_STAR,    "->*")                  \
 122   OP(CPP_DOT_STAR,      ".*")                   \
 123   OP(CPP_ATSIGN,        "@")  /* used in Objective-C */ \
 124 \
 125   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
 126   TK(CPP_AT_NAME,       SPELL_IDENT)    /* @word - Objective-C */       \
 127   TK(CPP_NUMBER,        SPELL_LITERAL)  /* 34_be+ta  */                 \
 128 \
 129   TK(CPP_CHAR,          SPELL_LITERAL)  /* 'char' */                    \
 130   TK(CPP_WCHAR,         SPELL_LITERAL)  /* L'char' */                   \
 131   TK(CPP_OTHER,         SPELL_LITERAL)  /* stray punctuation */         \
 132 \
 133   TK(CPP_STRING,        SPELL_LITERAL)  /* "string" */                  \
 134   TK(CPP_WSTRING,       SPELL_LITERAL)  /* L"string" */                 \
 135   TK(CPP_OBJC_STRING,   SPELL_LITERAL)  /* @"string" - Objective-C */   \
 136   TK(CPP_HEADER_NAME,   SPELL_LITERAL)  /* <stdio.h> in #include */     \
 137 \
 138   TK(CPP_COMMENT,       SPELL_LITERAL)  /* Only if output comments.  */ \
 139                                         /* SPELL_LITERAL happens to DTRT.  */ \
 140   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
 141   TK(CPP_PADDING,       SPELL_NONE)     /* Whitespace for cpp0.  */     \
 142 \
 143   /* SDCC _asm specific */                                              \
 144   TK(CPP_ASM,           SPELL_LITERAL)   /* _asm ... _endasm ; */
 145 #define OP(e, s) e,
 146 #define TK(e, s) e,
 147 enum cpp_ttype
 148 {
 149   TTYPE_TABLE
 150   N_TTYPES
 151 };
 152 #undef OP
 153 #undef TK
 154
 155 /* C language kind, used when calling cpp_reader_init.  */
 156 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
 157              CLK_GNUCXX, CLK_CXX98, CLK_ASM};
 158
 159 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
 160 struct cpp_string
 161 {
 162   unsigned int len;
 163   const unsigned char *text;
 164 };
 165
 166 /* Flags for the cpp_token structure.  */
 167 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
 168 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
 169 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
 170 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
 171 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
 172 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
 173 #define BOL             (1 << 6) /* Token at beginning of line.  */
 174
 175 /* A preprocessing token.  This has been carefully packed and should
 176    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
 177 struct cpp_token
 178 {
 179   fileline line;                /* Logical line of first char of token.  */
 180   unsigned short col;           /* Column of first char of token.  */
 181   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
 182   unsigned char flags;          /* flags - see above */
 183
 184   union
 185   {
 186     cpp_hashnode *node;         /* An identifier.  */
 187     const cpp_token *source;    /* Inherit padding from this token.  */
 188     struct cpp_string str;      /* A string, or number.  */
 189     unsigned int arg_no;        /* Argument no. for a CPP_MACRO_ARG.  */
 190   } val;
 191 };
 192
 193 /* A type wide enough to hold any multibyte source character.
 194    cpplib's character constant interpreter requires an unsigned type.
 195    Also, a typedef for the signed equivalent.
 196    The width of this type is capped at 32 bits; there do exist targets
 197    where wchar_t is 64 bits, but only in a non-default mode, and there
 198    would be no meaningful interpretation for a wchar_t value greater
 199    than 2^32 anyway -- the widest wide-character encoding around is
 200    ISO 10646, which stops at 2^31.  */
 201 #if CHAR_BIT * SIZEOF_INT >= 32
 202 # define CPPCHAR_SIGNED_T int
 203 #elif CHAR_BIT * SIZEOF_LONG >= 32
 204 # define CPPCHAR_SIGNED_T long
 205 #else
 206 # error "Cannot find a least-32-bit signed integer type"
 207 #endif
 208 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
 209 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
 210
 211 /* This structure is nested inside struct cpp_reader, and
 212    carries all the options visible to the command line.  */
 213 struct cpp_options
 214 {
 215   /* Characters between tab stops.  */
 216   unsigned int tabstop;
 217
 218   /* The language we're preprocessing.  */
 219   enum c_lang lang;
 220
 221   /* Nonzero means use extra default include directories for C++.  */
 222   unsigned char cplusplus;
 223
 224   /* Nonzero means handle cplusplus style comments.  */
 225   unsigned char cplusplus_comments;
 226
 227   /* Nonzero means define __OBJC__, treat @ as a special token, and
 228      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
 229   unsigned char objc;
 230
 231   /* Nonzero means don't copy comments into the output file.  */
 232   unsigned char discard_comments;
 233
 234   /* Nonzero means don't copy comments into the output file during
 235      macro expansion.  */
 236   unsigned char discard_comments_in_macro_exp;
 237
 238   /* Nonzero means process the ISO trigraph sequences.  */
 239   unsigned char trigraphs;
 240
 241   /* Nonzero means process the ISO digraph sequences.  */
 242   unsigned char digraphs;
 243
 244   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
 245   unsigned char extended_numbers;
 246
 247   /* Nonzero means print names of header files (-H).  */
 248   unsigned char print_include_names;
 249
 250   /* Nonzero means cpp_pedwarn causes a hard error.  */
 251   unsigned char pedantic_errors;
 252
 253   /* Nonzero means don't print warning messages.  */
 254   unsigned char inhibit_warnings;
 255
 256   /* Nonzero means complain about deprecated features.  */
 257   unsigned char warn_deprecated;
 258
 259   /* Nonzero means don't suppress warnings from system headers.  */
 260   unsigned char warn_system_headers;
 261
 262   /* Nonzero means don't print error messages.  Has no option to
 263      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 264   unsigned char inhibit_errors;
 265
 266   /* Nonzero means warn if slash-star appears in a comment.  */
 267   unsigned char warn_comments;
 268
 269   /* Nonzero means warn if there are any trigraphs.  */
 270   unsigned char warn_trigraphs;
 271
 272   /* Nonzero means warn about multicharacter charconsts.  */
 273   unsigned char warn_multichar;
 274
 275   /* Nonzero means warn about various incompatibilities with
 276      traditional C.  */
 277   unsigned char warn_traditional;
 278
 279   /* Nonzero means warn about long long numeric constants.  */
 280   unsigned char warn_long_long;
 281
 282   /* Nonzero means warn about text after an #endif (or #else).  */
 283   unsigned char warn_endif_labels;
 284
 285   /* Nonzero means warn about implicit sign changes owing to integer
 286      promotions.  */
 287   unsigned char warn_num_sign_change;
 288
 289   /* Nonzero means turn warnings into errors.  */
 290   unsigned char warnings_are_errors;
 291
 292   /* Nonzero means we should look for header.gcc files that remap file
 293      names.  */
 294   unsigned char remap;
 295
 296   /* Zero means dollar signs are punctuation.  */
 297   unsigned char dollars_in_ident;
 298
 299   /* True if we should warn about dollars in identifiers or numbers
 300      for this translation unit.  */
 301   unsigned char warn_dollars;
 302
 303   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 304   unsigned char warn_undef;
 305
 306   /* Nonzero means warn of unused macros from the main file.  */
 307   unsigned char warn_unused_macros;
 308
 309   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 310   unsigned char c99;
 311
 312   /* Nonzero if we are conforming to a specific C or C++ standard.  */
 313   unsigned char std;
 314
 315   /* Nonzero means give all the error messages the ANSI standard requires.  */
 316   unsigned char pedantic;
 317
 318   /* Nonzero means we're looking at already preprocessed code, so don't
 319      bother trying to do macro expansion and whatnot.  */
 320   unsigned char preprocessed;
 321
 322   /* Print column number in error messages.  */
 323   unsigned char show_column;
 324
 325   /* Nonzero means handle C++ alternate operator names.  */
 326   unsigned char operator_names;
 327
 328   /* True for traditional preprocessing.  */
 329   unsigned char traditional;
 330
 331   /* Holds the name of the target (execution) character set.  */
 332   const char *narrow_charset;
 333
 334   /* Holds the name of the target wide character set.  */
 335   const char *wide_charset;
 336
 337   /* Holds the name of the input character set.  */
 338   const char *input_charset;
 339
 340   /* True to warn about precompiled header files we couldn't use.  */
 341   bool warn_invalid_pch;
 342
 343   /* True if dependencies should be restored from a precompiled header.  */
 344   bool restore_pch_deps;
 345
 346   /* SDCC abuse by Kevin: allow naked '#' characters in expanded macros
 347    * (see _cpp_create_definition in cppmacro.c)
 348    */
 349   unsigned char allow_naked_hash;
 350
 351   /* SDCC _asm specific
 352      switch _asm block preprocessing on / off */
 353   unsigned char preproc_asm;
 354
 355   /* SDCC specific
 356      object file exetnsion */
 357   const char *obj_ext;
 358
 359   /* SDCC specific
 360      pedantic_parse_number */
 361   unsigned char pedantic_parse_number;
 362
 363   /* Dependency generation.  */
 364   struct
 365   {
 366     /* Style of header dependencies to generate.  */
 367     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
 368
 369     /* Assume missing files are generated files.  */
 370     bool missing_files;
 371
 372     /* Generate phony targets for each dependency apart from the first
 373        one.  */
 374     bool phony_targets;
 375
 376     /* If true, no dependency is generated on the main file.  */
 377     bool ignore_main_file;
 378   } deps;
 379
 380   /* Target-specific features set by the front end or client.  */
 381
 382   /* Precision for target CPP arithmetic, target characters, target
 383      ints and target wide characters, respectively.  */
 384   size_t precision, char_precision, int_precision, wchar_precision;
 385
 386   /* True means chars (wide chars) are unsigned.  */
 387   bool unsigned_char, unsigned_wchar;
 388
 389   /* True if the most significant byte in a word has the lowest
 390      address in memory.  */
 391   bool bytes_big_endian;
 392
 393   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
 394   unsigned char stdc_0_in_system_headers;
 395 };
 396
 397 /* Call backs to cpplib client.  */
 398 struct cpp_callbacks
 399 {
 400   /* Called when a new line of preprocessed output is started.  */
 401   void (*line_change) (cpp_reader *, const cpp_token *, int);
 402
 403   /* Called when switching to/from a new file.
 404      The line_map is for the new file.  It is NULL if there is no new file.
 405      (In C this happens when done with <built-in>+<command line> and also
 406      when done with a main file.)  This can be used for resource cleanup.  */
 407   void (*file_change) (cpp_reader *, const struct line_map *);
 408
 409   void (*dir_change) (cpp_reader *, const char *);
 410   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
 411                    const char *, int);
 412   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
 413   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
 414   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
 415   void (*def_pragma) (cpp_reader *, unsigned int);
 416   int (*valid_pch) (cpp_reader *, const char *, int);
 417   void (*read_pch) (cpp_reader *, const char *, int, const char *);
 418 };
 419
 420 /* Chain of directories to look for include files in.  */
 421 struct cpp_dir
 422 {
 423   /* NULL-terminated singly-linked list.  */
 424   struct cpp_dir *next;
 425
 426   /* NAME of the directory, NUL-terminated.  */
 427   char *name;
 428   unsigned int len;
 429
 430   /* One if a system header, two if a system header that has extern
 431      "C" guards for C++.  */
 432   unsigned char sysp;
 433
 434   /* Mapping of file names for this directory for MS-DOS and related
 435      platforms.  A NULL-terminated array of (from, to) pairs.  */
 436   const char **name_map;
 437
 438   /* The C front end uses these to recognize duplicated
 439      directories in the search path.  */
 440   ino_t ino;
 441   dev_t dev;
 442 };
 443
 444 /* Name under which this program was invoked.  */
 445 extern const char *progname;
 446
 447 /* The structure of a node in the hash table.  The hash table has
 448    entries for all identifiers: either macros defined by #define
 449    commands (type NT_MACRO), assertions created with #assert
 450    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
 451    like __LINE__ are flagged NODE_BUILTIN.  Poisoned identifiers are
 452    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
 453    identifier that behaves like an operator such as "xor".
 454    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
 455    diagnostic may be required for this node.  Currently this only
 456    applies to __VA_ARGS__ and poisoned identifiers.  */
 457
 458 /* Hash node flags.  */
 459 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
 460 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
 461 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
 462 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
 463 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
 464 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
 465 #define NODE_MACRO_ARG  (1 << 6)        /* Used during #define processing.  */
 466
 467 /* Different flavors of hash node.  */
 468 enum node_type
 469 {
 470   NT_VOID = 0,     /* No definition yet.  */
 471   NT_MACRO,        /* A macro of some form.  */
 472   NT_ASSERTION     /* Predicate for #assert.  */
 473 };
 474
 475 /* Different flavors of builtin macro.  _Pragma is an operator, but we
 476    handle it with the builtin code for efficiency reasons.  */
 477 enum builtin_type
 478 {
 479   BT_SPECLINE = 0,              /* `__LINE__' */
 480   BT_DATE,                      /* `__DATE__' */
 481   BT_FILE,                      /* `__FILE__' */
 482   BT_BASE_FILE,                 /* `__BASE_FILE__' */
 483   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
 484   BT_TIME,                      /* `__TIME__' */
 485   BT_STDC,                      /* `__STDC__' */
 486   BT_PRAGMA                     /* `_Pragma' operator */
 487 };
 488
 489 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
 490 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
 491 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
 492 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
 493
 494 /* The common part of an identifier node shared amongst all 3 C front
 495    ends.  Also used to store CPP identifiers, which are a superset of
 496    identifiers in the grammatical sense.  */
 497 struct cpp_hashnode GTY(())
 498 {
 499   struct ht_identifier ident;
 500   unsigned int is_directive : 1;
 501   unsigned int directive_index : 7;     /* If is_directive,
 502                                            then index into directive table.
 503                                            Otherwise, a NODE_OPERATOR.  */
 504   unsigned char rid_code;               /* Rid code - for front ends.  */
 505   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
 506   unsigned char flags;                  /* CPP flags.  */
 507
 508   union _cpp_hashnode_value
 509   {
 510     /* If a macro.  */
 511     cpp_macro * GTY((skip (""))) macro;
 512     /* Answers to an assertion.  */
 513     struct answer * GTY ((skip (""))) answers;
 514     /* Code for a builtin macro.  */
 515     enum builtin_type GTY ((tag ("1"))) builtin;
 516     /* Macro argument index.  */
 517     unsigned short GTY ((tag ("0"))) arg_index;
 518   } GTY ((desc ("0"))) value;
 519 };
 520
 521 /* Call this first to get a handle to pass to other functions.
 522
 523    If you want cpplib to manage its own hashtable, pass in a NULL
 524    pointer.  Otherwise you should pass in an initialized hash table
 525    that cpplib will share; this technique is used by the C front
 526    ends.  */
 527 extern cpp_reader *cpp_create_reader (enum c_lang, struct ht *);
 528
 529 /* Call this to change the selected language standard (e.g. because of
 530    command line options).  */
 531 extern void cpp_set_lang (cpp_reader *, enum c_lang);
 532
 533 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
 534    called any number of times before cpp_read_main_file().  If no
 535    targets have been added before cpp_read_main_file(), then the
 536    default target is used.  */
 537 extern void cpp_add_dependency_target (cpp_reader *, const char *, int);
 538
 539 /* Set the include paths.  */
 540 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
 541
 542 /* Call these to get pointers to the options and callback structures
 543    for a given reader.  These pointers are good until you call
 544    cpp_finish on that reader.  You can either edit the callbacks
 545    through the pointer returned from cpp_get_callbacks, or set them
 546    with cpp_set_callbacks.  */
 547 extern cpp_options *cpp_get_options (cpp_reader *);
 548 extern struct line_maps *cpp_get_line_maps (cpp_reader *);
 549 extern cpp_callbacks *cpp_get_callbacks (cpp_reader *);
 550 extern void cpp_set_callbacks (cpp_reader *, cpp_callbacks *);
 551
 552 /* This function reads the file, but does not start preprocessing.  It
 553    returns the name of the original file; this is the same as the
 554    input file, except for preprocessed input.  This will generate at
 555    least one file change callback, and possibly a line change callback
 556    too.  If there was an error opening the file, it returns NULL. */
 557 extern const char *cpp_read_main_file (cpp_reader *, const char *);
 558
 559 /* Set up built-ins like __FILE__.  */
 560 extern void cpp_init_builtins (cpp_reader *, int);
 561
 562 /* This is called after options have been parsed, and partially
 563    processed.  */
 564 extern void cpp_post_options (cpp_reader *);
 565
 566 /* Set up translation to the target character set.  */
 567 extern void cpp_init_iconv (cpp_reader *);
 568
 569 /* Call this to finish preprocessing.  If you requested dependency
 570    generation, pass an open stream to write the information to,
 571    otherwise NULL.  It is your responsibility to close the stream.
 572
 573    Returns cpp_errors (pfile).  */
 574 extern int cpp_finish (cpp_reader *, FILE *deps_stream);
 575
 576 /* Call this to release the handle at the end of preprocessing.  Any
 577    use of the handle after this function returns is invalid.  Returns
 578    cpp_errors (pfile).  */
 579 extern void cpp_destroy (cpp_reader *);
 580
 581 /* Error count.  */
 582 extern unsigned int cpp_errors (cpp_reader *);
 583
 584 extern unsigned int cpp_token_len (const cpp_token *);
 585 extern unsigned char *cpp_token_as_text (cpp_reader *, const cpp_token *);
 586 extern unsigned char *cpp_spell_token (cpp_reader *, const cpp_token *,
 587                                        unsigned char *);
 588 extern void cpp_register_pragma (cpp_reader *, const char *, const char *,
 589                                  void (*) (cpp_reader *));
 590 extern int cpp_avoid_paste (cpp_reader *, const cpp_token *,
 591                             const cpp_token *);
 592 extern const cpp_token *cpp_get_token (cpp_reader *);
 593 extern const unsigned char *cpp_macro_definition (cpp_reader *,
 594                                                   const cpp_hashnode *);
 595 extern void _cpp_backup_tokens (cpp_reader *, unsigned int);
 596
 597 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
 598 extern cppchar_t cpp_interpret_charconst (cpp_reader *, const cpp_token *,
 599                                           unsigned int *, int *);
 600 /* Evaluate a vector of CPP_STRING or CPP_WSTRING tokens.  */
 601 extern bool cpp_interpret_string (cpp_reader *,
 602                                   const cpp_string *, size_t,
 603                                   cpp_string *, bool);
 604
 605 /* Used to register macros and assertions, perhaps from the command line.
 606    The text is the same as the command line argument.  */
 607 extern void cpp_define (cpp_reader *, const char *);
 608 extern void cpp_assert (cpp_reader *, const char *);
 609 extern void cpp_undef (cpp_reader *, const char *);
 610 extern void cpp_unassert (cpp_reader *, const char *);
 611
 612 /* Undefine all macros and assertions.  */
 613 extern void cpp_undef_all (cpp_reader *);
 614
 615 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
 616                                     size_t, int);
 617 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
 618
 619 /* A preprocessing number.  Code assumes that any unused high bits of
 620    the double integer are set to zero.  */
 621 typedef unsigned HOST_WIDE_INT cpp_num_part;
 622 typedef struct cpp_num cpp_num;
 623 struct cpp_num
 624 {
 625   cpp_num_part high;
 626   cpp_num_part low;
 627   bool unsignedp;  /* True if value should be treated as unsigned.  */
 628   bool overflow;   /* True if the most recent calculation overflowed.  */
 629 };
 630
 631 /* cpplib provides two interfaces for interpretation of preprocessing
 632    numbers.
 633
 634    cpp_classify_number categorizes numeric constants according to
 635    their field (integer, floating point, or invalid), radix (decimal,
 636    octal, hexadecimal), and type suffixes.  */
 637
 638 #define CPP_N_CATEGORY  0x000F
 639 #define CPP_N_INVALID   0x0000
 640 #define CPP_N_INTEGER   0x0001
 641 #define CPP_N_FLOATING  0x0002
 642
 643 #define CPP_N_WIDTH     0x00F0
 644 #define CPP_N_SMALL     0x0010  /* int, float.  */
 645 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
 646 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
 647
 648 #define CPP_N_RADIX     0x0F00
 649 #define CPP_N_DECIMAL   0x0100
 650 #define CPP_N_HEX       0x0200
 651 #define CPP_N_OCTAL     0x0400
 652
 653 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
 654 #define CPP_N_IMAGINARY 0x2000
 655
 656 /* Classify a CPP_NUMBER token.  The return value is a combination of
 657    the flags from the above sets.  */
 658 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
 659
 660 /* Evaluate a token classified as category CPP_N_INTEGER.  */
 661 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
 662                                       unsigned int type);
 663
 664 /* Sign extend a number, with PRECISION significant bits and all
 665    others assumed clear, to fill out a cpp_num structure.  */
 666 cpp_num cpp_num_sign_extend (cpp_num, size_t);
 667
 668 /* Diagnostic levels.  To get a diagnostic without associating a
 669    position in the translation unit with it, use cpp_error_with_line
 670    with a line number of zero.  */
 671
 672 /* Warning, an error with -Werror.  */
 673 #define CPP_DL_WARNING          0x00
 674 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
 675 #define CPP_DL_WARNING_SYSHDR   0x01
 676 /* Warning, an error with -pedantic-errors or -Werror.  */
 677 #define CPP_DL_PEDWARN          0x02
 678 /* An error.  */
 679 #define CPP_DL_ERROR            0x03
 680 /* An internal consistency check failed.  Prints "internal error: ",
 681    otherwise the same as CPP_DL_ERROR.  */
 682 #define CPP_DL_ICE              0x04
 683 /* Extracts a diagnostic level from an int.  */
 684 #define CPP_DL_EXTRACT(l)       (l & 0xf)
 685 /* Nonzero if a diagnostic level is one of the warnings.  */
 686 #define CPP_DL_WARNING_P(l)     (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
 687                                  && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
 688
 689 /* N.B. The error-message-printer prototypes have not been nicely
 690    formatted because exgettext needs to see 'msgid' on the same line
 691    as the name of the function in order to work properly.  Only the
 692    string argument gets a name in an effort to keep the lines from
 693    getting ridiculously oversized.  */
 694
 695 /* Output a diagnostic of some kind.  */
 696 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
 697   ATTRIBUTE_PRINTF_3;
 698
 699 /* Output a diagnostic with "MSGID: " preceding the
 700    error string of errno.  No location is printed.  */
 701 extern void cpp_errno (cpp_reader *, int, const char *msgid);
 702
 703 /* Same as cpp_error, except additionally specifies a position as a
 704    (translation unit) physical line and physical column.  If the line is
 705    zero, then no location is printed.  */
 706 extern void cpp_error_with_line (cpp_reader *, int, fileline, unsigned,
 707                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
 708
 709 /* In cpplex.c */
 710 extern int cpp_ideq (const cpp_token *, const char *);
 711 extern void cpp_output_line (cpp_reader *, FILE *);
 712 extern void cpp_output_token (const cpp_token *, FILE *);
 713 extern const char *cpp_type2name (enum cpp_ttype);
 714 /* Returns the value of an escape sequence, truncated to the correct
 715    target precision.  PSTR points to the input pointer, which is just
 716    after the backslash.  LIMIT is how much text we have.  WIDE is true
 717    if the escape sequence is part of a wide character constant or
 718    string literal.  Handles all relevant diagnostics.  */
 719 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
 720                                    const unsigned char *limit, int wide);
 721
 722 /* In cpphash.c */
 723
 724 /* Lookup an identifier in the hashtable.  Puts the identifier in the
 725    table if it is not already there.  */
 726 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
 727                                  unsigned int);
 728
 729 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
 730 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
 731
 732 /* In cppmacro.c */
 733 extern void cpp_scan_nooutput (cpp_reader *);
 734 extern int  cpp_sys_macro_p (cpp_reader *);
 735 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
 736                                         unsigned int);
 737
 738 /* In cppfiles.c */
 739 extern bool cpp_included (cpp_reader *, const char *);
 740 extern void cpp_make_system_header (cpp_reader *, int, int);
 741 extern bool cpp_push_include (cpp_reader *, const char *);
 742 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
 743
 744 /* In cpppch.c */
 745 struct save_macro_data;
 746 extern int cpp_save_state (cpp_reader *, FILE *);
 747 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
 748 extern int cpp_write_pch_state (cpp_reader *, FILE *);
 749 extern int cpp_valid_state (cpp_reader *, const char *, int);
 750 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
 751 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
 752                            struct save_macro_data *);
 753
 754 #ifdef __cplusplus
 755 }
 756 #endif
 757
 758 #endif /* ! GCC_CPPLIB_H */