OSDN Git Service

905ca5d5e0e55c2ad40eaa006a1439a342a42ec3
[pf3gnuchains/gcc-fork.git] / gcc / 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 struct _cpp_file;
46
47 /* The first three groups, apart from '=', can appear in preprocessor
48    expressions (+= and -= are used to indicate unary + and - resp.).
49    This allows a lookup table to be implemented in _cpp_parse_expr.
50
51    The first group, to CPP_LAST_EQ, can be immediately followed by an
52    '='.  The lexer needs operators ending in '=', like ">>=", to be in
53    the same order as their counterparts without the '=', like ">>".  */
54
55 /* Positions in the table.  */
56 #define CPP_LAST_EQ CPP_MAX
57 #define CPP_FIRST_DIGRAPH CPP_HASH
58 #define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
59 #define CPP_LAST_CPP_OP CPP_LESS_EQ
60
61 #define TTYPE_TABLE                             \
62   OP(CPP_EQ = 0,        "=")                    \
63   OP(CPP_NOT,           "!")                    \
64   OP(CPP_GREATER,       ">")    /* compare */   \
65   OP(CPP_LESS,          "<")                    \
66   OP(CPP_PLUS,          "+")    /* math */      \
67   OP(CPP_MINUS,         "-")                    \
68   OP(CPP_MULT,          "*")                    \
69   OP(CPP_DIV,           "/")                    \
70   OP(CPP_MOD,           "%")                    \
71   OP(CPP_AND,           "&")    /* bit ops */   \
72   OP(CPP_OR,            "|")                    \
73   OP(CPP_XOR,           "^")                    \
74   OP(CPP_RSHIFT,        ">>")                   \
75   OP(CPP_LSHIFT,        "<<")                   \
76   OP(CPP_MIN,           "<?")   /* extension */ \
77   OP(CPP_MAX,           ">?")                   \
78 \
79   OP(CPP_COMPL,         "~")                    \
80   OP(CPP_AND_AND,       "&&")   /* logical */   \
81   OP(CPP_OR_OR,         "||")                   \
82   OP(CPP_QUERY,         "?")                    \
83   OP(CPP_COLON,         ":")                    \
84   OP(CPP_COMMA,         ",")    /* grouping */  \
85   OP(CPP_OPEN_PAREN,    "(")                    \
86   OP(CPP_CLOSE_PAREN,   ")")                    \
87   TK(CPP_EOF,           SPELL_NONE)             \
88   OP(CPP_EQ_EQ,         "==")   /* compare */   \
89   OP(CPP_NOT_EQ,        "!=")                   \
90   OP(CPP_GREATER_EQ,    ">=")                   \
91   OP(CPP_LESS_EQ,       "<=")                   \
92 \
93   /* These two are unary + / - in preprocessor expressions.  */ \
94   OP(CPP_PLUS_EQ,       "+=")   /* math */      \
95   OP(CPP_MINUS_EQ,      "-=")                   \
96 \
97   OP(CPP_MULT_EQ,       "*=")                   \
98   OP(CPP_DIV_EQ,        "/=")                   \
99   OP(CPP_MOD_EQ,        "%=")                   \
100   OP(CPP_AND_EQ,        "&=")   /* bit ops */   \
101   OP(CPP_OR_EQ,         "|=")                   \
102   OP(CPP_XOR_EQ,        "^=")                   \
103   OP(CPP_RSHIFT_EQ,     ">>=")                  \
104   OP(CPP_LSHIFT_EQ,     "<<=")                  \
105   OP(CPP_MIN_EQ,        "<?=")  /* extension */ \
106   OP(CPP_MAX_EQ,        ">?=")                  \
107   /* Digraphs together, beginning with CPP_FIRST_DIGRAPH.  */   \
108   OP(CPP_HASH,          "#")    /* digraphs */  \
109   OP(CPP_PASTE,         "##")                   \
110   OP(CPP_OPEN_SQUARE,   "[")                    \
111   OP(CPP_CLOSE_SQUARE,  "]")                    \
112   OP(CPP_OPEN_BRACE,    "{")                    \
113   OP(CPP_CLOSE_BRACE,   "}")                    \
114   /* The remainder of the punctuation.  Order is not significant.  */   \
115   OP(CPP_SEMICOLON,     ";")    /* structure */ \
116   OP(CPP_ELLIPSIS,      "...")                  \
117   OP(CPP_PLUS_PLUS,     "++")   /* increment */ \
118   OP(CPP_MINUS_MINUS,   "--")                   \
119   OP(CPP_DEREF,         "->")   /* accessors */ \
120   OP(CPP_DOT,           ".")                    \
121   OP(CPP_SCOPE,         "::")                   \
122   OP(CPP_DEREF_STAR,    "->*")                  \
123   OP(CPP_DOT_STAR,      ".*")                   \
124   OP(CPP_ATSIGN,        "@")  /* used in Objective-C */ \
125 \
126   TK(CPP_NAME,          SPELL_IDENT)    /* word */                      \
127   TK(CPP_AT_NAME,       SPELL_IDENT)    /* @word - Objective-C */       \
128   TK(CPP_NUMBER,        SPELL_LITERAL)  /* 34_be+ta  */                 \
129 \
130   TK(CPP_CHAR,          SPELL_LITERAL)  /* 'char' */                    \
131   TK(CPP_WCHAR,         SPELL_LITERAL)  /* L'char' */                   \
132   TK(CPP_OTHER,         SPELL_LITERAL)  /* stray punctuation */         \
133 \
134   TK(CPP_STRING,        SPELL_LITERAL)  /* "string" */                  \
135   TK(CPP_WSTRING,       SPELL_LITERAL)  /* L"string" */                 \
136   TK(CPP_OBJC_STRING,   SPELL_LITERAL)  /* @"string" - Objective-C */   \
137   TK(CPP_HEADER_NAME,   SPELL_LITERAL)  /* <stdio.h> in #include */     \
138 \
139   TK(CPP_COMMENT,       SPELL_LITERAL)  /* Only if output comments.  */ \
140                                         /* SPELL_LITERAL happens to DTRT.  */ \
141   TK(CPP_MACRO_ARG,     SPELL_NONE)     /* Macro argument.  */          \
142   TK(CPP_PADDING,       SPELL_NONE)     /* Whitespace for cpp0.  */
143
144 #define OP(e, s) e,
145 #define TK(e, s) e,
146 enum cpp_ttype
147 {
148   TTYPE_TABLE
149   N_TTYPES
150 };
151 #undef OP
152 #undef TK
153
154 /* C language kind, used when calling cpp_reader_init.  */
155 enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
156              CLK_GNUCXX, CLK_CXX98, CLK_ASM};
157
158 /* Payload of a NUMBER, STRING, CHAR or COMMENT token.  */
159 struct cpp_string
160 {
161   unsigned int len;
162   const unsigned char *text;
163 };
164
165 /* Flags for the cpp_token structure.  */
166 #define PREV_WHITE      (1 << 0) /* If whitespace before this token.  */
167 #define DIGRAPH         (1 << 1) /* If it was a digraph.  */
168 #define STRINGIFY_ARG   (1 << 2) /* If macro argument to be stringified.  */
169 #define PASTE_LEFT      (1 << 3) /* If on LHS of a ## operator.  */
170 #define NAMED_OP        (1 << 4) /* C++ named operators.  */
171 #define NO_EXPAND       (1 << 5) /* Do not macro-expand this token.  */
172 #define BOL             (1 << 6) /* Token at beginning of line.  */
173
174 /* A preprocessing token.  This has been carefully packed and should
175    occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts.  */
176 struct cpp_token
177 {
178   source_location src_loc;      /* Location of first char of token.  */
179   ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT;  /* token type */
180   unsigned char flags;          /* flags - see above */
181
182   union
183   {
184     cpp_hashnode *node;         /* An identifier.  */
185     const cpp_token *source;    /* Inherit padding from this token.  */
186     struct cpp_string str;      /* A string, or number.  */
187     unsigned int arg_no;        /* Argument no. for a CPP_MACRO_ARG.  */
188   } val;
189 };
190
191 /* A type wide enough to hold any multibyte source character.
192    cpplib's character constant interpreter requires an unsigned type.
193    Also, a typedef for the signed equivalent.
194    The width of this type is capped at 32 bits; there do exist targets
195    where wchar_t is 64 bits, but only in a non-default mode, and there
196    would be no meaningful interpretation for a wchar_t value greater
197    than 2^32 anyway -- the widest wide-character encoding around is
198    ISO 10646, which stops at 2^31.  */
199 #if CHAR_BIT * SIZEOF_INT >= 32
200 # define CPPCHAR_SIGNED_T int
201 #elif CHAR_BIT * SIZEOF_LONG >= 32
202 # define CPPCHAR_SIGNED_T long
203 #else
204 # error "Cannot find a least-32-bit signed integer type"
205 #endif
206 typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
207 typedef CPPCHAR_SIGNED_T cppchar_signed_t;
208
209 /* This structure is nested inside struct cpp_reader, and
210    carries all the options visible to the command line.  */
211 struct cpp_options
212 {
213   /* Characters between tab stops.  */
214   unsigned int tabstop;
215
216   /* The language we're preprocessing.  */
217   enum c_lang lang;
218
219   /* Nonzero means use extra default include directories for C++.  */
220   unsigned char cplusplus;
221
222   /* Nonzero means handle cplusplus style comments.  */
223   unsigned char cplusplus_comments;
224
225   /* Nonzero means define __OBJC__, treat @ as a special token, and
226      use the OBJC[PLUS]_INCLUDE_PATH environment variable.  */
227   unsigned char objc;
228
229   /* Nonzero means don't copy comments into the output file.  */
230   unsigned char discard_comments;
231
232   /* Nonzero means don't copy comments into the output file during
233      macro expansion.  */
234   unsigned char discard_comments_in_macro_exp;
235
236   /* Nonzero means process the ISO trigraph sequences.  */
237   unsigned char trigraphs;
238
239   /* Nonzero means process the ISO digraph sequences.  */
240   unsigned char digraphs;
241
242   /* Nonzero means to allow hexadecimal floats and LL suffixes.  */
243   unsigned char extended_numbers;
244
245   /* Nonzero means print names of header files (-H).  */
246   unsigned char print_include_names;
247
248   /* Nonzero means cpp_pedwarn causes a hard error.  */
249   unsigned char pedantic_errors;
250
251   /* Nonzero means don't print warning messages.  */
252   unsigned char inhibit_warnings;
253
254   /* Nonzero means complain about deprecated features.  */
255   unsigned char warn_deprecated;
256
257   /* Nonzero means don't suppress warnings from system headers.  */
258   unsigned char warn_system_headers;
259
260   /* Nonzero means don't print error messages.  Has no option to
261      select it, but can be set by a user of cpplib (e.g. fix-header).  */
262   unsigned char inhibit_errors;
263
264   /* Nonzero means warn if slash-star appears in a comment.  */
265   unsigned char warn_comments;
266
267   /* Nonzero means warn if there are any trigraphs.  */
268   unsigned char warn_trigraphs;
269
270   /* Nonzero means warn about multicharacter charconsts.  */
271   unsigned char warn_multichar;
272
273   /* Nonzero means warn about various incompatibilities with
274      traditional C.  */
275   unsigned char warn_traditional;
276
277   /* Nonzero means warn about long long numeric constants.  */
278   unsigned char warn_long_long;
279
280   /* Nonzero means warn about text after an #endif (or #else).  */
281   unsigned char warn_endif_labels;
282
283   /* Nonzero means warn about implicit sign changes owing to integer
284      promotions.  */
285   unsigned char warn_num_sign_change;
286
287   /* Zero means don't warn about __VA_ARGS__ usage in c89 pedantic mode.
288      Presumably the usage is protected by the appropriate #ifdef.  */
289   unsigned char warn_variadic_macros;
290
291   /* Nonzero means turn warnings into errors.  */
292   unsigned char warnings_are_errors;
293
294   /* Nonzero means we should look for header.gcc files that remap file
295      names.  */
296   unsigned char remap;
297
298   /* Zero means dollar signs are punctuation.  */
299   unsigned char dollars_in_ident;
300
301   /* True if we should warn about dollars in identifiers or numbers
302      for this translation unit.  */
303   unsigned char warn_dollars;
304
305   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
306   unsigned char warn_undef;
307
308   /* Nonzero means warn of unused macros from the main file.  */
309   unsigned char warn_unused_macros;
310
311   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
312   unsigned char c99;
313
314   /* Nonzero if we are conforming to a specific C or C++ standard.  */
315   unsigned char std;
316
317   /* Nonzero means give all the error messages the ANSI standard requires.  */
318   unsigned char pedantic;
319
320   /* Nonzero means we're looking at already preprocessed code, so don't
321      bother trying to do macro expansion and whatnot.  */
322   unsigned char preprocessed;
323
324   /* Print column number in error messages.  */
325   unsigned char show_column;
326
327   /* Nonzero means handle C++ alternate operator names.  */
328   unsigned char operator_names;
329
330   /* True for traditional preprocessing.  */
331   unsigned char traditional;
332
333   /* Holds the name of the target (execution) character set.  */
334   const char *narrow_charset;
335
336   /* Holds the name of the target wide character set.  */
337   const char *wide_charset;
338
339   /* Holds the name of the input character set.  */
340   const char *input_charset;
341
342   /* True to warn about precompiled header files we couldn't use.  */
343   bool warn_invalid_pch;
344
345   /* True if dependencies should be restored from a precompiled header.  */
346   bool restore_pch_deps;
347
348   /* Dependency generation.  */
349   struct
350   {
351     /* Style of header dependencies to generate.  */
352     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
353
354     /* Assume missing files are generated files.  */
355     bool missing_files;
356
357     /* Generate phony targets for each dependency apart from the first
358        one.  */
359     bool phony_targets;
360
361     /* If true, no dependency is generated on the main file.  */
362     bool ignore_main_file;
363   } deps;
364
365   /* Target-specific features set by the front end or client.  */
366
367   /* Precision for target CPP arithmetic, target characters, target
368      ints and target wide characters, respectively.  */
369   size_t precision, char_precision, int_precision, wchar_precision;
370
371   /* True means chars (wide chars) are unsigned.  */
372   bool unsigned_char, unsigned_wchar;
373
374   /* True if the most significant byte in a word has the lowest
375      address in memory.  */
376   bool bytes_big_endian;
377
378   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
379   unsigned char stdc_0_in_system_headers;
380 };
381
382 /* Callback for header lookup for HEADER, which is the name of a
383    source file.  It is used as a method of last resort to find headers
384    that are not otherwise found during the normal include processing.
385    The return value is the malloced name of a header to try and open,
386    if any, or NULL otherwise.  This callback is called only if the
387    header is otherwise unfound.  */
388 typedef const char *(*missing_header_cb)(cpp_reader *, const char *header);
389
390 /* Call backs to cpplib client.  */
391 struct cpp_callbacks
392 {
393   /* Called when a new line of preprocessed output is started.  */
394   void (*line_change) (cpp_reader *, const cpp_token *, int);
395
396   /* Called when switching to/from a new file.
397      The line_map is for the new file.  It is NULL if there is no new file.
398      (In C this happens when done with <built-in>+<command line> and also
399      when done with a main file.)  This can be used for resource cleanup.  */
400   void (*file_change) (cpp_reader *, const struct line_map *);
401
402   void (*dir_change) (cpp_reader *, const char *);
403   void (*include) (cpp_reader *, unsigned int, const unsigned char *,
404                    const char *, int);
405   void (*define) (cpp_reader *, unsigned int, cpp_hashnode *);
406   void (*undef) (cpp_reader *, unsigned int, cpp_hashnode *);
407   void (*ident) (cpp_reader *, unsigned int, const cpp_string *);
408   void (*def_pragma) (cpp_reader *, unsigned int);
409   int (*valid_pch) (cpp_reader *, const char *, int);
410   void (*read_pch) (cpp_reader *, const char *, int, const char *);
411   missing_header_cb missing_header;
412 };
413
414 /* Chain of directories to look for include files in.  */
415 struct cpp_dir
416 {
417   /* NULL-terminated singly-linked list.  */
418   struct cpp_dir *next;
419
420   /* NAME of the directory, NUL-terminated.  */
421   char *name;
422   unsigned int len;
423
424   /* One if a system header, two if a system header that has extern
425      "C" guards for C++.  */
426   unsigned char sysp;
427
428   /* Mapping of file names for this directory for MS-DOS and related
429      platforms.  A NULL-terminated array of (from, to) pairs.  */
430   const char **name_map;
431
432   /* Routine to construct pathname, given the search path name and the
433      HEADER we are trying to find, return a constructed pathname to
434      try and open.  If this is NULL, the constructed pathname is as
435      constructed by append_file_to_dir.  */
436   char *(*construct) (const char *header, cpp_dir *dir);
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                                       struct line_maps *);
529
530 /* Call this to change the selected language standard (e.g. because of
531    command line options).  */
532 extern void cpp_set_lang (cpp_reader *, enum c_lang);
533
534 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
535    called any number of times before cpp_read_main_file().  If no
536    targets have been added before cpp_read_main_file(), then the
537    default target is used.  */
538 extern void cpp_add_dependency_target (cpp_reader *, const char *, int);
539
540 /* Set the include paths.  */
541 extern void cpp_set_include_chains (cpp_reader *, cpp_dir *, cpp_dir *, int);
542
543 /* Call these to get pointers to the options and callback structures
544    for a given reader.  These pointers are good until you call
545    cpp_finish on that reader.  You can either edit the callbacks
546    through the pointer returned from cpp_get_callbacks, or set them
547    with cpp_set_callbacks.  */
548 extern cpp_options *cpp_get_options (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 extern bool cpp_interpret_string_notranslate (cpp_reader *,
605                                               const cpp_string *, size_t,
606                                               cpp_string *, bool);
607
608 /* Used to register macros and assertions, perhaps from the command line.
609    The text is the same as the command line argument.  */
610 extern void cpp_define (cpp_reader *, const char *);
611 extern void cpp_assert (cpp_reader *, const char *);
612 extern void cpp_undef (cpp_reader *, const char *);
613 extern void cpp_unassert (cpp_reader *, const char *);
614
615 /* Undefine all macros and assertions.  */
616 extern void cpp_undef_all (cpp_reader *);
617
618 extern cpp_buffer *cpp_push_buffer (cpp_reader *, const unsigned char *,
619                                     size_t, int);
620 extern int cpp_defined (cpp_reader *, const unsigned char *, int);
621
622 /* A preprocessing number.  Code assumes that any unused high bits of
623    the double integer are set to zero.  */
624 typedef unsigned HOST_WIDE_INT cpp_num_part;
625 typedef struct cpp_num cpp_num;
626 struct cpp_num
627 {
628   cpp_num_part high;
629   cpp_num_part low;
630   bool unsignedp;  /* True if value should be treated as unsigned.  */
631   bool overflow;   /* True if the most recent calculation overflowed.  */
632 };
633
634 /* cpplib provides two interfaces for interpretation of preprocessing
635    numbers.
636
637    cpp_classify_number categorizes numeric constants according to
638    their field (integer, floating point, or invalid), radix (decimal,
639    octal, hexadecimal), and type suffixes.  */
640
641 #define CPP_N_CATEGORY  0x000F
642 #define CPP_N_INVALID   0x0000
643 #define CPP_N_INTEGER   0x0001
644 #define CPP_N_FLOATING  0x0002
645
646 #define CPP_N_WIDTH     0x00F0
647 #define CPP_N_SMALL     0x0010  /* int, float.  */
648 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
649 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
650
651 #define CPP_N_RADIX     0x0F00
652 #define CPP_N_DECIMAL   0x0100
653 #define CPP_N_HEX       0x0200
654 #define CPP_N_OCTAL     0x0400
655
656 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
657 #define CPP_N_IMAGINARY 0x2000
658
659 /* Classify a CPP_NUMBER token.  The return value is a combination of
660    the flags from the above sets.  */
661 extern unsigned cpp_classify_number (cpp_reader *, const cpp_token *);
662
663 /* Evaluate a token classified as category CPP_N_INTEGER.  */
664 extern cpp_num cpp_interpret_integer (cpp_reader *, const cpp_token *,
665                                       unsigned int type);
666
667 /* Sign extend a number, with PRECISION significant bits and all
668    others assumed clear, to fill out a cpp_num structure.  */
669 cpp_num cpp_num_sign_extend (cpp_num, size_t);
670
671 /* Diagnostic levels.  To get a diagnostic without associating a
672    position in the translation unit with it, use cpp_error_with_line
673    with a line number of zero.  */
674
675 /* Warning, an error with -Werror.  */
676 #define CPP_DL_WARNING          0x00
677 /* Same as CPP_DL_WARNING, except it is not suppressed in system headers.  */
678 #define CPP_DL_WARNING_SYSHDR   0x01
679 /* Warning, an error with -pedantic-errors or -Werror.  */
680 #define CPP_DL_PEDWARN          0x02
681 /* An error.  */
682 #define CPP_DL_ERROR            0x03
683 /* An internal consistency check failed.  Prints "internal error: ",
684    otherwise the same as CPP_DL_ERROR.  */
685 #define CPP_DL_ICE              0x04
686 /* Extracts a diagnostic level from an int.  */
687 #define CPP_DL_EXTRACT(l)       (l & 0xf)
688 /* Nonzero if a diagnostic level is one of the warnings.  */
689 #define CPP_DL_WARNING_P(l)     (CPP_DL_EXTRACT (l) >= CPP_DL_WARNING \
690                                  && CPP_DL_EXTRACT (l) <= CPP_DL_PEDWARN)
691
692 /* N.B. The error-message-printer prototypes have not been nicely
693    formatted because exgettext needs to see 'msgid' on the same line
694    as the name of the function in order to work properly.  Only the
695    string argument gets a name in an effort to keep the lines from
696    getting ridiculously oversized.  */
697
698 /* Output a diagnostic of some kind.  */
699 extern void cpp_error (cpp_reader *, int, const char *msgid, ...)
700   ATTRIBUTE_PRINTF_3;
701
702 /* Output a diagnostic with "MSGID: " preceding the
703    error string of errno.  No location is printed.  */
704 extern void cpp_errno (cpp_reader *, int, const char *msgid);
705
706 /* Same as cpp_error, except additionally specifies a position as a
707    (translation unit) physical line and physical column.  If the line is
708    zero, then no location is printed.  */
709 extern void cpp_error_with_line (cpp_reader *, int, source_location, unsigned,
710                                  const char *msgid, ...) ATTRIBUTE_PRINTF_5;
711
712 /* In cpplex.c */
713 extern int cpp_ideq (const cpp_token *, const char *);
714 extern void cpp_output_line (cpp_reader *, FILE *);
715 extern void cpp_output_token (const cpp_token *, FILE *);
716 extern const char *cpp_type2name (enum cpp_ttype);
717 /* Returns the value of an escape sequence, truncated to the correct
718    target precision.  PSTR points to the input pointer, which is just
719    after the backslash.  LIMIT is how much text we have.  WIDE is true
720    if the escape sequence is part of a wide character constant or
721    string literal.  Handles all relevant diagnostics.  */
722 extern cppchar_t cpp_parse_escape (cpp_reader *, const unsigned char ** pstr,
723                                    const unsigned char *limit, int wide);
724
725 /* In cpphash.c */
726
727 /* Lookup an identifier in the hashtable.  Puts the identifier in the
728    table if it is not already there.  */
729 extern cpp_hashnode *cpp_lookup (cpp_reader *, const unsigned char *,
730                                  unsigned int);
731
732 typedef int (*cpp_cb) (cpp_reader *, cpp_hashnode *, void *);
733 extern void cpp_forall_identifiers (cpp_reader *, cpp_cb, void *);
734
735 /* In cppmacro.c */
736 extern void cpp_scan_nooutput (cpp_reader *);
737 extern int  cpp_sys_macro_p (cpp_reader *);
738 extern unsigned char *cpp_quote_string (unsigned char *, const unsigned char *,
739                                         unsigned int);
740
741 /* In cppfiles.c */
742 extern bool cpp_included (cpp_reader *, const char *);
743 extern void cpp_make_system_header (cpp_reader *, int, int);
744 extern bool cpp_push_include (cpp_reader *, const char *);
745 extern void cpp_change_file (cpp_reader *, enum lc_reason, const char *);
746 extern const char *cpp_get_path (struct _cpp_file *);
747 extern cpp_buffer *cpp_get_buffer (cpp_reader *);
748 extern struct _cpp_file *cpp_get_file (cpp_buffer *);
749 extern cpp_buffer *cpp_get_prev (cpp_buffer *);
750
751 /* In cpppch.c */
752 struct save_macro_data;
753 extern int cpp_save_state (cpp_reader *, FILE *);
754 extern int cpp_write_pch_deps (cpp_reader *, FILE *);
755 extern int cpp_write_pch_state (cpp_reader *, FILE *);
756 extern int cpp_valid_state (cpp_reader *, const char *, int);
757 extern void cpp_prepare_state (cpp_reader *, struct save_macro_data **);
758 extern int cpp_read_state (cpp_reader *, const char *, FILE *,
759                            struct save_macro_data *);
760
761 #ifdef __cplusplus
762 }
763 #endif
764
765 #endif /* ! GCC_CPPLIB_H */