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