* support/cpp2/cpphash.h, support/cpp2/cpplex.c,
[fw/sdcc] / 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   /* SDCC specific
407      pedantic_parse_number */
408   unsigned char pedantic_parse_number;
409
410   /* Dependency generation.  */
411   struct
412   {
413     /* Style of header dependencies to generate.  */
414     enum {DEPS_NONE = 0, DEPS_USER, DEPS_SYSTEM } style;
415
416     /* Assume missing files are generated files.  */
417     bool missing_files;
418
419     /* Generate phony targets for each dependency apart from the first
420        one.  */
421     bool phony_targets;
422
423     /* If true, fopen (deps_file, "a") else fopen (deps_file, "w").  */
424     unsigned char append;
425
426     /* If true, no dependency is generated on the main file.  */
427     bool ignore_main_file;
428
429     /* File name which deps are being written to.  This is 0 if deps are
430        being written to stdout.  */
431     const char *file;
432   } deps;
433
434   /* Target-specific features set by the front end or client.  */
435
436   /* Precision for target CPP arithmetic, target characters, target
437      ints and target wide characters, respectively.  */
438   size_t precision, char_precision, int_precision, wchar_precision;
439
440   /* True means chars (wide chars) are unsigned.  */
441   bool unsigned_char, unsigned_wchar;
442
443   /* Nonzero means __STDC__ should have the value 0 in system headers.  */
444   unsigned char stdc_0_in_system_headers;
445 };
446
447 /* Call backs.  */
448 struct cpp_callbacks
449 {
450   /* Called when a new line of preprocessed output is started.  */
451   void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
452   void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
453   void (*include) PARAMS ((cpp_reader *, unsigned int,
454                            const unsigned char *, const cpp_token *));
455   void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
456   void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
457   void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
458   void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
459   /* Called when the client has a chance to properly register
460      built-ins with cpp_define() and cpp_assert().  */
461   void (*register_builtins) PARAMS ((cpp_reader *));
462 };
463
464 /* Name under which this program was invoked.  */
465 extern const char *progname;
466
467 /* The structure of a node in the hash table.  The hash table has
468    entries for all identifiers: either macros defined by #define
469    commands (type NT_MACRO), assertions created with #assert
470    (NT_ASSERTION), or neither of the above (NT_VOID).  Builtin macros
471    like __LINE__ are flagged NODE_BUILTIN.  Poisioned identifiers are
472    flagged NODE_POISONED.  NODE_OPERATOR (C++ only) indicates an
473    identifier that behaves like an operator such as "xor".
474    NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
475    diagnostic may be required for this node.  Currently this only
476    applies to __VA_ARGS__ and poisoned identifiers.  */
477
478 /* Hash node flags.  */
479 #define NODE_OPERATOR   (1 << 0)        /* C++ named operator.  */
480 #define NODE_POISONED   (1 << 1)        /* Poisoned identifier.  */
481 #define NODE_BUILTIN    (1 << 2)        /* Builtin macro.  */
482 #define NODE_DIAGNOSTIC (1 << 3)        /* Possible diagnostic when lexed.  */
483 #define NODE_WARN       (1 << 4)        /* Warn if redefined or undefined.  */
484 #define NODE_DISABLED   (1 << 5)        /* A disabled macro.  */
485
486 /* Different flavors of hash node.  */
487 enum node_type
488 {
489   NT_VOID = 0,     /* No definition yet.  */
490   NT_MACRO,        /* A macro of some form.  */
491   NT_ASSERTION     /* Predicate for #assert.  */
492 };
493
494 /* Different flavors of builtin macro.  _Pragma is an operator, but we
495    handle it with the builtin code for efficiency reasons.  */
496 enum builtin_type
497 {
498   BT_SPECLINE = 0,              /* `__LINE__' */
499   BT_DATE,                      /* `__DATE__' */
500   BT_FILE,                      /* `__FILE__' */
501   BT_BASE_FILE,                 /* `__BASE_FILE__' */
502   BT_INCLUDE_LEVEL,             /* `__INCLUDE_LEVEL__' */
503   BT_TIME,                      /* `__TIME__' */
504   BT_STDC,                      /* `__STDC__' */
505   BT_PRAGMA                     /* `_Pragma' operator */
506 };
507
508 #define CPP_HASHNODE(HNODE)     ((cpp_hashnode *) (HNODE))
509 #define HT_NODE(NODE)           ((ht_identifier *) (NODE))
510 #define NODE_LEN(NODE)          HT_LEN (&(NODE)->ident)
511 #define NODE_NAME(NODE)         HT_STR (&(NODE)->ident)
512
513 /* The common part of an identifier node shared amongst all 3 C front
514    ends.  Also used to store CPP identifiers, which are a superset of
515    identifiers in the grammatical sense.  */
516 struct cpp_hashnode
517 {
518   struct ht_identifier ident;
519   unsigned short arg_index;             /* Macro argument index.  */
520   unsigned char directive_index;        /* Index into directive table.  */
521   unsigned char rid_code;               /* Rid code - for front ends.  */
522   ENUM_BITFIELD(node_type) type : 8;    /* CPP node type.  */
523   unsigned char flags;                  /* CPP flags.  */
524
525   union
526   {
527     cpp_macro *macro;                   /* If a macro.  */
528     struct answer *answers;             /* Answers to an assertion.  */
529     enum cpp_ttype operator;            /* Code for a named operator.  */
530     enum builtin_type builtin;          /* Code for a builtin macro.  */
531   } value;
532 };
533
534 /* Call this first to get a handle to pass to other functions.  */
535 extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
536
537 /* Call this to change the selected language standard (e.g. because of
538    command line options).  */
539 extern void cpp_set_lang PARAMS ((cpp_reader *, enum c_lang));
540
541 /* Add a dependency TARGET.  Quote it for "make" if QUOTE.  Can be
542    called any number of times before cpp_read_main_file().  If no
543    targets have been added before cpp_read_main_file(), then the
544    default target is used.  */
545 extern void cpp_add_dependency_target PARAMS ((cpp_reader *,
546                                                const char * target,
547                                                int quote));
548
549 /* Call these to get pointers to the options and callback structures
550    for a given reader.  These pointers are good until you call
551    cpp_finish on that reader.  You can either edit the callbacks
552    through the pointer returned from cpp_get_callbacks, or set them
553    with cpp_set_callbacks.  */
554 extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
555 extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
556 extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
557 extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
558
559 /* Now call cpp_handle_option[s] to handle 1[or more] switches.  The
560    return value is the number of arguments used.  If
561    cpp_handle_options returns without using all arguments, it couldn't
562    understand the next switch.  Options processing is not completed
563    until you call cpp_finish_options.  */
564 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
565 extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
566
567 /* This function reads the file, but does not start preprocessing.  It
568    returns the name of the original file; this is the same as the
569    input file, except for preprocessed input.  This will generate at
570    least one file change callback, and possibly a line change callback
571    too.  If there was an error opening the file, it returns NULL.
572
573    If you want cpplib to manage its own hashtable, pass in a NULL
574    pointer.  Otherise you should pass in an initialized hash table
575    that cpplib will share; this technique is used by the C front
576    ends.  */
577 extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
578                                                struct ht *));
579
580 /* Deferred handling of command line options that can generate debug
581    callbacks, such as -D and -imacros.  Call this after
582    cpp_read_main_file.  The front ends need this separation so they
583    can initialize debug output with the original file name, returned
584    from cpp_read_main_file, before they get debug callbacks.  */
585 extern void cpp_finish_options PARAMS ((cpp_reader *));
586
587 /* Call this to finish preprocessing.  If you requested dependency
588    generation, pass an open stream to write the information to,
589    otherwise NULL.  It is your responsibility to close the stream.
590
591    Returns cpp_errors (pfile).  */
592 extern int cpp_finish PARAMS ((cpp_reader *, FILE *deps_stream));
593
594 /* Call this to release the handle at the end of preprocessing.  Any
595    use of the handle after this function returns is invalid.  Returns
596    cpp_errors (pfile).  */
597 extern void cpp_destroy PARAMS ((cpp_reader *));
598
599 /* Error count.  */
600 extern unsigned int cpp_errors PARAMS ((cpp_reader *));
601
602 extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
603 extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
604                                                  const cpp_token *));
605 extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
606                                                unsigned char *));
607 extern void cpp_register_pragma PARAMS ((cpp_reader *,
608                                          const char *, const char *,
609                                          void (*) PARAMS ((cpp_reader *))));
610
611 extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
612                                     const cpp_token *));
613 extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
614 extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
615                                                   const cpp_hashnode *));
616 extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
617
618 /* Evaluate a CPP_CHAR or CPP_WCHAR token.  */
619 extern cppchar_t
620 cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
621                                  unsigned int *, int *));
622
623 /* Used to register builtins during the register_builtins callback.
624    The text is the same as the command line argument.  */
625 extern void cpp_define PARAMS ((cpp_reader *, const char *));
626 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
627 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
628 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
629
630 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
631                                             const unsigned char *, size_t,
632                                             int, int));
633 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
634
635 /* A preprocessing number.  Code assumes that any unused high bits of
636    the double integer are set to zero.  */
637 typedef unsigned HOST_WIDE_INT cpp_num_part;
638 typedef struct cpp_num cpp_num;
639 struct cpp_num
640 {
641   cpp_num_part high;
642   cpp_num_part low;
643   bool unsignedp;  /* True if value should be treated as unsigned.  */
644   bool overflow;   /* True if the most recent calculation overflowed.  */
645 };
646
647 /* cpplib provides two interfaces for interpretation of preprocessing
648    numbers.
649
650    cpp_classify_number categorizes numeric constants according to
651    their field (integer, floating point, or invalid), radix (decimal,
652    octal, hexadecimal), and type suffixes.  */
653
654 #define CPP_N_CATEGORY  0x000F
655 #define CPP_N_INVALID   0x0000
656 #define CPP_N_INTEGER   0x0001
657 #define CPP_N_FLOATING  0x0002
658
659 #define CPP_N_WIDTH     0x00F0
660 #define CPP_N_SMALL     0x0010  /* int, float.  */
661 #define CPP_N_MEDIUM    0x0020  /* long, double.  */
662 #define CPP_N_LARGE     0x0040  /* long long, long double.  */
663
664 #define CPP_N_RADIX     0x0F00
665 #define CPP_N_DECIMAL   0x0100
666 #define CPP_N_HEX       0x0200
667 #define CPP_N_OCTAL     0x0400
668
669 #define CPP_N_UNSIGNED  0x1000  /* Properties.  */
670 #define CPP_N_IMAGINARY 0x2000
671
672 /* Classify a CPP_NUMBER token.  The return value is a combination of
673    the flags from the above sets.  */
674 extern unsigned cpp_classify_number PARAMS ((cpp_reader *, const cpp_token *));
675
676 /* Evaluate a token classified as category CPP_N_INTEGER.  */
677 extern cpp_num cpp_interpret_integer PARAMS ((cpp_reader *, const cpp_token *,
678                                               unsigned int type));
679
680 /* Sign extend a number, with PRECISION significant bits and all
681    others assumed clear, to fill out a cpp_num structure.  */
682 cpp_num cpp_num_sign_extend PARAMS ((cpp_num, size_t));
683
684 /* Diagnostic levels.  To get a dianostic without associating a
685    position in the translation unit with it, use cpp_error_with_line
686    with a line number of zero.  */
687
688 /* Warning, an error with -Werror.  */
689 #define DL_WARNING              0x00
690 /* Same as DL_WARNING, except it is not suppressed in system headers.  */
691 #define DL_WARNING_SYSHDR       0x01
692 /* Warning, an error with -pedantic-errors or -Werror.  */
693 #define DL_PEDWARN              0x02
694 /* An error.  */
695 #define DL_ERROR                0x03
696 /* An internal consistency check failed.  Prints "internal error: ",
697    otherwise the same as DL_ERROR.  */
698 #define DL_ICE                  0x04
699 /* Extracts a diagnostic level from an int.  */
700 #define DL_EXTRACT(l)           (l & 0xf)
701 /* Nonzero if a diagnostic level is one of the warnings.  */
702 #define DL_WARNING_P(l)         (DL_EXTRACT (l) >= DL_WARNING \
703                                  && DL_EXTRACT (l) <= DL_PEDWARN)
704
705 /* N.B. The error-message-printer prototypes have not been nicely
706    formatted because exgettext needs to see 'msgid' on the same line
707    as the name of the function in order to work properly.  Only the
708    string argument gets a name in an effort to keep the lines from
709    getting ridiculously oversized.  */
710
711 /* Output a diagnostic of some kind.  */
712 extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
713   ATTRIBUTE_PRINTF_3;
714
715 /* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
716    error string of errno.  No location is printed.  */
717 extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
718
719 /* Same as cpp_error, except additionally specifies a position as a
720    (translation unit) physical line and physical column.  If the line is
721    zero, then no location is printed.  */
722 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
723   ATTRIBUTE_PRINTF_5;
724
725 /* In cpplex.c */
726 extern int cpp_ideq                     PARAMS ((const cpp_token *,
727                                                  const char *));
728 extern void cpp_output_line             PARAMS ((cpp_reader *, FILE *));
729 extern void cpp_output_token            PARAMS ((const cpp_token *, FILE *));
730 extern const char *cpp_type2name        PARAMS ((enum cpp_ttype));
731 /* Returns the value of an escape sequence, truncated to the correct
732    target precision.  PSTR points to the input pointer, which is just
733    after the backslash.  LIMIT is how much text we have.  WIDE is true
734    if the escape sequence is part of a wide character constant or
735    string literal.  Handles all relevant diagnostics.  */
736 extern cppchar_t cpp_parse_escape       PARAMS ((cpp_reader *,
737                                                  const unsigned char ** pstr,
738                                                  const unsigned char *limit,
739                                                  int wide));
740
741 /* In cpphash.c */
742
743 /* Lookup an identifier in the hashtable.  Puts the identifier in the
744    table if it is not already there.  */
745 extern cpp_hashnode *cpp_lookup         PARAMS ((cpp_reader *,
746                                                  const unsigned char *,
747                                                  unsigned int));
748
749 typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
750 extern void cpp_forall_identifiers      PARAMS ((cpp_reader *,
751                                                  cpp_cb, void *));
752
753 /* In cppmacro.c */
754 extern void cpp_scan_nooutput           PARAMS ((cpp_reader *));
755 extern int  cpp_sys_macro_p             PARAMS ((cpp_reader *));
756 extern unsigned char *cpp_quote_string  PARAMS ((unsigned char *,
757                                                  const unsigned char *,
758                                                  unsigned int));
759
760 /* In cppfiles.c */
761 extern int cpp_included PARAMS ((cpp_reader *, const char *));
762 extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
763
764 /* In cppmain.c */
765 extern void cpp_preprocess_file PARAMS ((cpp_reader *, const char *, FILE *));
766
767 #ifdef __cplusplus
768 }
769 #endif
770
771 #endif /* ! GCC_CPPLIB_H */