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