]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/cpplib.h
c-parse.in (yyoverflow): New.
[thirdparty/gcc.git] / gcc / cpplib.h
CommitLineData
7f2935c7 1/* Definitions for CPP library.
5d8ebbd8 2 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
2398fb2a 3 Free Software Foundation, Inc.
7f2935c7
PB
4 Written by Per Bothner, 1994-95.
5
6This program is free software; you can redistribute it and/or modify it
7under the terms of the GNU General Public License as published by the
8Free Software Foundation; either version 2, or (at your option) any
9later version.
10
11This program is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with this program; if not, write to the Free Software
940d9d63 18Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
7f2935c7
PB
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! */
2a967f3d
NB
23#ifndef GCC_CPPLIB_H
24#define GCC_CPPLIB_H
7f2935c7
PB
25
26#include <sys/types.h>
2a967f3d 27#include "hashtable.h"
d82fc108 28#include "line-map.h"
7f2935c7
PB
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
8b97c5f8 34/* For complex reasons, cpp_reader is also typedefed in c-pragma.h. */
88657302 35#ifndef GCC_C_PRAGMA_H
7f2935c7 36typedef struct cpp_reader cpp_reader;
8b97c5f8 37#endif
7f2935c7
PB
38typedef struct cpp_buffer cpp_buffer;
39typedef struct cpp_options cpp_options;
1368ee70 40typedef struct cpp_token cpp_token;
bfb9dc7f 41typedef struct cpp_string cpp_string;
a50882dc 42typedef struct cpp_hashnode cpp_hashnode;
93c80368 43typedef struct cpp_macro cpp_macro;
7e96d768 44typedef struct cpp_callbacks cpp_callbacks;
93c80368 45
93c80368 46struct answer;
93c80368 47struct file_name_map_list;
c5a04734
ZW
48
49/* The first two groups, apart from '=', can appear in preprocessor
50 expressions. This allows a lookup table to be implemented in
51 _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. */
6fee6033 58#define CPP_LAST_EQ CPP_MAX
c5a04734 59#define CPP_FIRST_DIGRAPH CPP_HASH
9ec7291f 60#define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
1368ee70 61
1368ee70 62#define TTYPE_TABLE \
96be6998
ZW
63 OP(CPP_EQ = 0, "=") \
64 OP(CPP_NOT, "!") \
65 OP(CPP_GREATER, ">") /* compare */ \
66 OP(CPP_LESS, "<") \
67 OP(CPP_PLUS, "+") /* math */ \
68 OP(CPP_MINUS, "-") \
69 OP(CPP_MULT, "*") \
70 OP(CPP_DIV, "/") \
71 OP(CPP_MOD, "%") \
72 OP(CPP_AND, "&") /* bit ops */ \
73 OP(CPP_OR, "|") \
74 OP(CPP_XOR, "^") \
75 OP(CPP_RSHIFT, ">>") \
76 OP(CPP_LSHIFT, "<<") \
92936ecf
ZW
77 OP(CPP_MIN, "<?") /* extension */ \
78 OP(CPP_MAX, ">?") \
c5a04734 79\
96be6998
ZW
80 OP(CPP_COMPL, "~") \
81 OP(CPP_AND_AND, "&&") /* logical */ \
82 OP(CPP_OR_OR, "||") \
83 OP(CPP_QUERY, "?") \
84 OP(CPP_COLON, ":") \
85 OP(CPP_COMMA, ",") /* grouping */ \
86 OP(CPP_OPEN_PAREN, "(") \
87 OP(CPP_CLOSE_PAREN, ")") \
88 OP(CPP_EQ_EQ, "==") /* compare */ \
89 OP(CPP_NOT_EQ, "!=") \
90 OP(CPP_GREATER_EQ, ">=") \
91 OP(CPP_LESS_EQ, "<=") \
1368ee70 92\
96be6998
ZW
93 OP(CPP_PLUS_EQ, "+=") /* math */ \
94 OP(CPP_MINUS_EQ, "-=") \
95 OP(CPP_MULT_EQ, "*=") \
96 OP(CPP_DIV_EQ, "/=") \
97 OP(CPP_MOD_EQ, "%=") \
98 OP(CPP_AND_EQ, "&=") /* bit ops */ \
99 OP(CPP_OR_EQ, "|=") \
100 OP(CPP_XOR_EQ, "^=") \
101 OP(CPP_RSHIFT_EQ, ">>=") \
102 OP(CPP_LSHIFT_EQ, "<<=") \
92936ecf
ZW
103 OP(CPP_MIN_EQ, "<?=") /* extension */ \
104 OP(CPP_MAX_EQ, ">?=") \
c5a04734 105 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
96be6998
ZW
106 OP(CPP_HASH, "#") /* digraphs */ \
107 OP(CPP_PASTE, "##") \
108 OP(CPP_OPEN_SQUARE, "[") \
109 OP(CPP_CLOSE_SQUARE, "]") \
110 OP(CPP_OPEN_BRACE, "{") \
111 OP(CPP_CLOSE_BRACE, "}") \
112 /* The remainder of the punctuation. Order is not significant. */ \
113 OP(CPP_SEMICOLON, ";") /* structure */ \
114 OP(CPP_ELLIPSIS, "...") \
96be6998
ZW
115 OP(CPP_PLUS_PLUS, "++") /* increment */ \
116 OP(CPP_MINUS_MINUS, "--") \
117 OP(CPP_DEREF, "->") /* accessors */ \
118 OP(CPP_DOT, ".") \
119 OP(CPP_SCOPE, "::") \
120 OP(CPP_DEREF_STAR, "->*") \
121 OP(CPP_DOT_STAR, ".*") \
cc937581 122 OP(CPP_ATSIGN, "@") /* used in Objective C */ \
1368ee70 123\
96be6998 124 TK(CPP_NAME, SPELL_IDENT) /* word */ \
47ad4138 125 TK(CPP_NUMBER, SPELL_NUMBER) /* 34_be+ta */ \
1368ee70 126\
96be6998
ZW
127 TK(CPP_CHAR, SPELL_STRING) /* 'char' */ \
128 TK(CPP_WCHAR, SPELL_STRING) /* L'char' */ \
129 TK(CPP_OTHER, SPELL_CHAR) /* stray punctuation */ \
130\
131 TK(CPP_STRING, SPELL_STRING) /* "string" */ \
132 TK(CPP_WSTRING, SPELL_STRING) /* L"string" */ \
133 TK(CPP_HEADER_NAME, SPELL_STRING) /* <stdio.h> in #include */ \
134\
47ad4138
ZW
135 TK(CPP_COMMENT, SPELL_NUMBER) /* Only if output comments. */ \
136 /* SPELL_NUMBER happens to DTRT. */ \
96be6998 137 TK(CPP_MACRO_ARG, SPELL_NONE) /* Macro argument. */ \
47ad4138
ZW
138 TK(CPP_PADDING, SPELL_NONE) /* Whitespace for cpp0. */ \
139 TK(CPP_EOF, SPELL_NONE) /* End of line or file. */
1368ee70 140
96be6998
ZW
141#define OP(e, s) e,
142#define TK(e, s) e,
3a2b2c7a 143enum cpp_ttype
c45da1ca 144{
1368ee70
ZW
145 TTYPE_TABLE
146 N_TTYPES
147};
96be6998
ZW
148#undef OP
149#undef TK
1368ee70 150
dd07b884
NB
151/* C language kind, used when calling cpp_reader_init. */
152enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
153 CLK_GNUCXX, CLK_CXX98, CLK_OBJC, CLK_OBJCXX, CLK_ASM};
154
5d8ebbd8 155/* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
bfb9dc7f 156struct cpp_string
1368ee70
ZW
157{
158 unsigned int len;
f617b8e2 159 const unsigned char *text;
1368ee70
ZW
160};
161
c5a04734 162/* Flags for the cpp_token structure. */
041c3194 163#define PREV_WHITE (1 << 0) /* If whitespace before this token. */
93c80368
NB
164#define DIGRAPH (1 << 1) /* If it was a digraph. */
165#define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
166#define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
dd07b884 167#define NAMED_OP (1 << 4) /* C++ named operators. */
93c80368 168#define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
4ed5bcfb 169#define BOL (1 << 6) /* Token at beginning of line. */
9e62c811 170
1920de47 171/* A preprocessing token. This has been carefully packed and should
644eddaa 172 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
1368ee70
ZW
173struct cpp_token
174{
1444f2ed
NB
175 unsigned int line; /* Logical line of first char of token. */
176 unsigned short col; /* Column of first char of token. */
041c3194
ZW
177 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
178 unsigned char flags; /* flags - see above */
179
1368ee70
ZW
180 union
181 {
2a967f3d 182 cpp_hashnode *node; /* An identifier. */
4ed5bcfb 183 const cpp_token *source; /* Inherit padding from this token. */
6c53ebff
NB
184 struct cpp_string str; /* A string, or number. */
185 unsigned int arg_no; /* Argument no. for a CPP_MACRO_ARG. */
186 unsigned char c; /* Character represented by CPP_OTHER. */
1368ee70 187 } val;
7f2935c7
PB
188};
189
64cdc383
MH
190/* A standalone character. It is unsigned for the same reason we use
191 unsigned char - to avoid signedness issues. */
192typedef unsigned int cppchar_t;
0d9f234d 193
ae79697b
ZW
194/* Values for opts.dump_macros.
195 dump_only means inhibit output of the preprocessed text
196 and instead output the definitions of all user-defined
86702e31 197 macros in a form suitable for use as input to cpp.
ae79697b
ZW
198 dump_names means pass #define and the macro name through to output.
199 dump_definitions means pass the whole definition (plus #define) through
200*/
201enum { dump_none = 0, dump_only, dump_names, dump_definitions };
7f2935c7 202
ae79697b
ZW
203/* This structure is nested inside struct cpp_reader, and
204 carries all the options visible to the command line. */
205struct cpp_options
c50bca08 206{
ae79697b
ZW
207 /* Name of input and output files. */
208 const char *in_fname;
209 const char *out_fname;
194d7493 210
6ab3e7dd
NB
211 /* Characters between tab stops. */
212 unsigned int tabstop;
213
eebedaa5 214 /* Pending options - -D, -U, -A, -I, -ixxx. */
ae79697b 215 struct cpp_pending *pending;
7f2935c7 216
ae79697b
ZW
217 /* File name which deps are being written to. This is 0 if deps are
218 being written to stdout. */
219 const char *deps_file;
0b22d65c 220
ae79697b 221 /* Search paths for include files. */
591e15a1
NB
222 struct search_path *quote_include; /* "" */
223 struct search_path *bracket_include; /* <> */
7f2935c7 224
ae79697b
ZW
225 /* Map between header names and file names, used only on DOS where
226 file names are limited in length. */
7e2eb697
PB
227 struct file_name_map_list *map_list;
228
ae79697b
ZW
229 /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
230 in the standard include file directories. */
231 const char *include_prefix;
232 unsigned int include_prefix_len;
233
6db83155
ZW
234 /* -fleading_underscore sets this to "_". */
235 const char *user_label_prefix;
236
bdb05a7b
NB
237 /* The language we're preprocessing. */
238 enum c_lang lang;
239
7f2935c7 240 /* Non-0 means -v, so print the full set of include dirs. */
ae79697b 241 unsigned char verbose;
7f2935c7 242
0fef3fd0
NB
243 /* Nonzero means chars are signed. */
244 unsigned char signed_char;
245
7f2935c7 246 /* Nonzero means use extra default include directories for C++. */
ae79697b 247 unsigned char cplusplus;
7f2935c7
PB
248
249 /* Nonzero means handle cplusplus style comments */
ae79697b 250 unsigned char cplusplus_comments;
7f2935c7
PB
251
252 /* Nonzero means handle #import, for objective C. */
ae79697b 253 unsigned char objc;
7f2935c7 254
564ad5f4 255 /* Nonzero means don't copy comments into the output file. */
ae79697b 256 unsigned char discard_comments;
7f2935c7 257
477cdac7
JT
258 /* Nonzero means don't copy comments into the output file during
259 macro expansion. */
260 unsigned char discard_comments_in_macro_exp;
261
041c3194 262 /* Nonzero means process the ISO trigraph sequences. */
ae79697b 263 unsigned char trigraphs;
7f2935c7 264
9b55f29a
NB
265 /* Nonzero means process the ISO digraph sequences. */
266 unsigned char digraphs;
267
bdb05a7b
NB
268 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
269 unsigned char extended_numbers;
270
ae79697b
ZW
271 /* Nonzero means print the names of included files rather than the
272 preprocessed output. 1 means just the #include "...", 2 means
273 #include <...> as well. */
274 unsigned char print_deps;
7f2935c7 275
a5a4ce3c
NB
276 /* Nonzero if phony targets are created for each header. */
277 unsigned char deps_phony_targets;
278
ae79697b
ZW
279 /* Nonzero if missing .h files in -M output are assumed to be
280 generated files and not errors. */
281 unsigned char print_deps_missing_files;
7f2935c7 282
eebedaa5 283 /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
ae79697b 284 unsigned char print_deps_append;
7f2935c7
PB
285
286 /* Nonzero means print names of header files (-H). */
ae79697b 287 unsigned char print_include_names;
7f2935c7 288
ae79697b
ZW
289 /* Nonzero means cpp_pedwarn causes a hard error. */
290 unsigned char pedantic_errors;
7f2935c7 291
c1212d2f 292 /* Nonzero means don't print warning messages. */
ae79697b 293 unsigned char inhibit_warnings;
7f2935c7 294
317639a8
BC
295 /* Nonzero means don't suppress warnings from system headers. */
296 unsigned char warn_system_headers;
297
ae79697b
ZW
298 /* Nonzero means don't print error messages. Has no option to
299 select it, but can be set by a user of cpplib (e.g. fix-header). */
300 unsigned char inhibit_errors;
c1212d2f 301
7f2935c7 302 /* Nonzero means warn if slash-star appears in a comment. */
ae79697b 303 unsigned char warn_comments;
7f2935c7
PB
304
305 /* Nonzero means warn if there are any trigraphs. */
ae79697b 306 unsigned char warn_trigraphs;
7f2935c7
PB
307
308 /* Nonzero means warn if #import is used. */
ae79697b 309 unsigned char warn_import;
7f2935c7 310
f9a0e96c
ZW
311 /* Nonzero means warn about various incompatibilities with
312 traditional C. */
07aa0b04 313 unsigned char warn_traditional;
7f2935c7 314
909de5da
PE
315 /* Nonzero means warn about text after an #endif (or #else). */
316 unsigned char warn_endif_labels;
317
7f2935c7 318 /* Nonzero means turn warnings into errors. */
ae79697b 319 unsigned char warnings_are_errors;
7f2935c7 320
ae79697b
ZW
321 /* Nonzero causes output not to be done, but directives such as
322 #define that have side effects are still obeyed. */
323 unsigned char no_output;
7f2935c7 324
31031edd
JL
325 /* Nonzero means we should look for header.gcc files that remap file
326 names. */
ae79697b 327 unsigned char remap;
31031edd 328
7f2935c7 329 /* Nonzero means don't output line number information. */
ae79697b 330 unsigned char no_line_commands;
7f2935c7 331
ae79697b
ZW
332 /* Nonzero means -I- has been seen, so don't look for #include "foo"
333 the source-file directory. */
334 unsigned char ignore_srcdir;
7f2935c7 335
eebedaa5 336 /* Zero means dollar signs are punctuation. */
ae79697b 337 unsigned char dollars_in_ident;
7f2935c7 338
6ac34fdc 339 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
ae79697b 340 unsigned char warn_undef;
6ac34fdc 341
31948547 342 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
ae79697b 343 unsigned char c99;
31948547 344
7f2935c7 345 /* Nonzero means give all the error messages the ANSI standard requires. */
ae79697b 346 unsigned char pedantic;
7f2935c7 347
3773a46b
JM
348 /* Nonzero means we're looking at already preprocessed code, so don't
349 bother trying to do macro expansion and whatnot. */
ae79697b 350 unsigned char preprocessed;
3773a46b 351
ae79697b
ZW
352 /* Nonzero disables all the standard directories for headers. */
353 unsigned char no_standard_includes;
7f2935c7 354
ae79697b
ZW
355 /* Nonzero disables the C++-specific standard directories for headers. */
356 unsigned char no_standard_cplusplus_includes;
7f2935c7 357
ae79697b
ZW
358 /* Nonzero means dump macros in some fashion - see above. */
359 unsigned char dump_macros;
7f2935c7 360
ae79697b
ZW
361 /* Nonzero means pass #include lines through to the output. */
362 unsigned char dump_includes;
7f2935c7 363
ae79697b
ZW
364 /* Print column number in error messages. */
365 unsigned char show_column;
be768055 366
644eddaa 367 /* Nonzero means handle C++ alternate operator names. */
be768055 368 unsigned char operator_names;
7e96d768
NB
369
370 /* True if --help, --version or --target-help appeared in the
371 options. Stand-alone CPP should then bail out after option
372 parsing; drivers might want to continue printing help. */
373 unsigned char help_only;
ae79697b 374};
7f2935c7 375
7e96d768
NB
376/* Call backs. */
377struct cpp_callbacks
378{
97293897
NB
379 /* Called when a new line of preprocessed output is started. */
380 void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
381 void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
382 void (*include) PARAMS ((cpp_reader *, unsigned int,
383 const unsigned char *, const cpp_token *));
384 void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
385 void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
386 void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
387 void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
7e96d768
NB
388};
389
ae79697b 390#define CPP_FATAL_LIMIT 1000
eebedaa5 391/* True if we have seen a "fatal" error. */
7e96d768 392#define CPP_FATAL_ERRORS(PFILE) (cpp_errors (PFILE) >= CPP_FATAL_LIMIT)
ae79697b 393
7f2935c7 394/* Name under which this program was invoked. */
bcc5cac9 395extern const char *progname;
7f2935c7 396
93c80368
NB
397/* The structure of a node in the hash table. The hash table has
398 entries for all identifiers: either macros defined by #define
399 commands (type NT_MACRO), assertions created with #assert
400 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
401 like __LINE__ are flagged NODE_BUILTIN. Poisioned identifiers are
402 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
403 identifier that behaves like an operator such as "xor".
404 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
405 diagnostic may be required for this node. Currently this only
406 applies to __VA_ARGS__ and poisoned identifiers. */
407
408/* Hash node flags. */
409#define NODE_OPERATOR (1 << 0) /* C++ named operator. */
410#define NODE_POISONED (1 << 1) /* Poisoned identifier. */
411#define NODE_BUILTIN (1 << 2) /* Builtin macro. */
412#define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
618cdda7 413#define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
644eddaa 414#define NODE_DISABLED (1 << 5) /* A disabled macro. */
93c80368
NB
415
416/* Different flavors of hash node. */
f8f769ea
ZW
417enum node_type
418{
93c80368
NB
419 NT_VOID = 0, /* No definition yet. */
420 NT_MACRO, /* A macro of some form. */
421 NT_ASSERTION /* Predicate for #assert. */
422};
423
644eddaa
NB
424/* Different flavors of builtin macro. _Pragma is an operator, but we
425 handle it with the builtin code for efficiency reasons. */
93c80368
NB
426enum builtin_type
427{
428 BT_SPECLINE = 0, /* `__LINE__' */
429 BT_DATE, /* `__DATE__' */
430 BT_FILE, /* `__FILE__' */
431 BT_BASE_FILE, /* `__BASE_FILE__' */
432 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
433 BT_TIME, /* `__TIME__' */
644eddaa
NB
434 BT_STDC, /* `__STDC__' */
435 BT_PRAGMA /* `_Pragma' operator */
f8f769ea
ZW
436};
437
2a967f3d
NB
438#define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
439#define HT_NODE(NODE) ((ht_identifier *) (NODE))
440#define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
441#define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
f8f769ea 442
2a967f3d
NB
443/* The common part of an identifier node shared amongst all 3 C front
444 ends. Also used to store CPP identifiers, which are a superset of
445 identifiers in the grammatical sense. */
a50882dc 446struct cpp_hashnode
f8f769ea 447{
2a967f3d 448 struct ht_identifier ident;
dd07b884
NB
449 unsigned short arg_index; /* Macro argument index. */
450 unsigned char directive_index; /* Index into directive table. */
2a967f3d
NB
451 unsigned char rid_code; /* Rid code - for front ends. */
452 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */
453 unsigned char flags; /* CPP flags. */
f8f769ea 454
041c3194
ZW
455 union
456 {
dd07b884
NB
457 cpp_macro *macro; /* If a macro. */
458 struct answer *answers; /* Answers to an assertion. */
459 enum cpp_ttype operator; /* Code for a named operator. */
460 enum builtin_type builtin; /* Code for a builtin macro. */
f8f769ea 461 } value;
f8f769ea
ZW
462};
463
f5e99456
NB
464/* Call this first to get a handle to pass to other functions. */
465extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
400023a3 466
7e96d768
NB
467/* Call these to get pointers to the options and callback structures
468 for a given reader. These pointers are good until you call
469 cpp_finish on that reader. You can either edit the callbacks
470 through the pointer returned from cpp_get_callbacks, or set them
471 with cpp_set_callbacks. */
472extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
47d89cf3 473extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
7e96d768
NB
474extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
475extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
476
96302433
NB
477/* Now call cpp_handle_option[s] to handle 1[or more] switches. The
478 return value is the number of arguments used. If
479 cpp_handle_options returns without using all arguments, it couldn't
480 understand the next switch. When there are no switches left, you
f5e99456 481 must call cpp_post_options before calling cpp_read_main_file. Only
96302433 482 after cpp_post_options are the contents of the cpp_options
f5e99456
NB
483 structure reliable. Options processing is not completed until you
484 call cpp_finish_options. */
96302433 485extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
ffdeea47 486extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **, int));
96302433
NB
487extern void cpp_post_options PARAMS ((cpp_reader *));
488
f5e99456
NB
489/* This function reads the file, but does not start preprocessing. It
490 returns the name of the original file; this is the same as the
491 input file, except for preprocessed input. This will generate at
492 least one file change callback, and possibly a line change callback
493 too. If there was an error opening the file, it returns NULL.
494
495 If you want cpplib to manage its own hashtable, pass in a NULL
496 pointer. Otherise you should pass in an initialised hash table
497 that cpplib will share; this technique is used by the C front
498 ends. */
499extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
500 struct ht *));
501
502/* Deferred handling of command line options that can generate debug
503 callbacks, such as -D and -imacros. Call this after
504 cpp_read_main_file. The front ends need this separation so they
505 can initialize debug output with the original file name, returned
506 from cpp_read_main_file, before they get debug callbacks. */
507extern void cpp_finish_options PARAMS ((cpp_reader *));
508
509/* Call this to release the handle at the end of preprocessing. Any
510 use of the handle after this function returns is invalid. Returns
511 cpp_errors (pfile). */
512extern int cpp_destroy PARAMS ((cpp_reader *));
513
7e96d768
NB
514/* Error count. */
515extern unsigned int cpp_errors PARAMS ((cpp_reader *));
516
93c80368 517extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
dd07b884
NB
518extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
519 const cpp_token *));
93c80368
NB
520extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
521 unsigned char *));
58fea6af
ZW
522extern void cpp_register_pragma PARAMS ((cpp_reader *,
523 const char *, const char *,
524 void (*) PARAMS ((cpp_reader *))));
58fea6af 525
93c80368 526extern void cpp_finish PARAMS ((cpp_reader *));
93c80368
NB
527extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
528 const cpp_token *));
4ed5bcfb 529extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
93c80368
NB
530extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
531 const cpp_hashnode *));
bdcbe496 532extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
041c3194 533
c8a96070
NB
534/* Evaluate a CPP_CHAR or CPP_WCHAR token. */
535extern HOST_WIDE_INT
536cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
f458d1d5 537 int, unsigned int *));
c8a96070 538
7ceb3598
NB
539extern void cpp_define PARAMS ((cpp_reader *, const char *));
540extern void cpp_assert PARAMS ((cpp_reader *, const char *));
541extern void cpp_undef PARAMS ((cpp_reader *, const char *));
542extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
7f2935c7 543
711b8824 544extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
0bda4760 545 const unsigned char *, size_t,
29401c30 546 int, int));
711b8824 547extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
c5a04734 548
ebef4e8c
NB
549/* Diagnostic levels. To get a dianostic without associating a
550 position in the translation unit with it, use cpp_error_with_line
551 with a line number of zero. */
552
553/* Warning, an error with -Werror. */
554#define DL_WARNING 0x00
555/* Same as DL_WARNING, except it is not suppressed in system headers. */
556#define DL_WARNING_SYSHDR 0x01
557/* Warning, an error with -pedantic-errors or -Werror. */
558#define DL_PEDWARN 0x02
559/* An error. */
560#define DL_ERROR 0x03
561/* A fatal error. We do not exit, to support use of cpplib as a
562 library, but may only return CPP_EOF tokens thereon. It is the
563 caller's responsibility to check CPP_FATAL_ERRORS. */
564#define DL_FATAL 0x04
565/* An internal consistency check failed. Prints "internal error: ",
566 otherwise the same as DL_FATAL. */
567#define DL_ICE 0x05
568/* Extracts a diagnostic level from an int. */
569#define DL_EXTRACT(l) (l & 0xf)
570/* Non-zero if a diagnostic level is one of the warnings. */
571#define DL_WARNING_P(l) (DL_EXTRACT (l) >= DL_WARNING \
572 && DL_EXTRACT (l) <= DL_PEDWARN)
573
c1212d2f
ZW
574/* N.B. The error-message-printer prototypes have not been nicely
575 formatted because exgettext needs to see 'msgid' on the same line
576 as the name of the function in order to work properly. Only the
577 string argument gets a name in an effort to keep the lines from
578 getting ridiculously oversized. */
579
ebef4e8c
NB
580/* Output a diagnostic of some kind. */
581extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
582 ATTRIBUTE_PRINTF_3;
583
584/* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
585 error string of errno. No location is printed. */
586extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
587
588/* Same as cpp_error, except additionally specifies a position as a
589 (translation unit) physical line and physical column. If the line is
590 zero, then no location is printed. */
591extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
592 ATTRIBUTE_PRINTF_5;
f2d5f0cc
ZW
593
594/* In cpplex.c */
bfb9dc7f
ZW
595extern int cpp_ideq PARAMS ((const cpp_token *,
596 const char *));
93c80368
NB
597extern void cpp_output_line PARAMS ((cpp_reader *, FILE *));
598extern void cpp_output_token PARAMS ((const cpp_token *, FILE *));
599extern const char *cpp_type2name PARAMS ((enum cpp_ttype));
62729350
NB
600extern unsigned int cpp_parse_escape PARAMS ((cpp_reader *,
601 const unsigned char **,
602 const unsigned char *,
f458d1d5 603 unsigned HOST_WIDE_INT));
1368ee70 604
f2d5f0cc 605/* In cpphash.c */
2a967f3d
NB
606
607/* Lookup an identifier in the hashtable. Puts the identifier in the
608 table if it is not already there. */
93c80368 609extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
2a967f3d
NB
610 const unsigned char *,
611 unsigned int));
612
613typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
93c80368 614extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
2a967f3d 615 cpp_cb, void *));
926c5678 616
58fea6af 617/* In cppmacro.c */
ef6e958a 618extern void cpp_scan_nooutput PARAMS ((cpp_reader *));
c691145a 619extern int cpp_sys_macro_p PARAMS ((cpp_reader *));
dcc229e5
ZW
620extern unsigned char *cpp_quote_string PARAMS ((unsigned char *,
621 const unsigned char *,
622 unsigned int));
6de1e2a9 623
add7091b 624/* In cppfiles.c */
711b8824 625extern int cpp_included PARAMS ((cpp_reader *, const char *));
614c7d37 626extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
b0699dad 627
aaf93206
NB
628/* In cppmain.c */
629extern void cpp_preprocess_file PARAMS ((cpp_reader *));
630
7f2935c7
PB
631#ifdef __cplusplus
632}
633#endif
88657302
RH
634
635#endif /* ! GCC_CPPLIB_H */