]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/cpplib.h
Standardize header guards.
[thirdparty/gcc.git] / gcc / cpplib.h
CommitLineData
7f2935c7 1/* Definitions for CPP library.
03b9ab42 2 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001
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"
7f2935c7
PB
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
8b97c5f8 33/* For complex reasons, cpp_reader is also typedefed in c-pragma.h. */
88657302 34#ifndef GCC_C_PRAGMA_H
7f2935c7 35typedef struct cpp_reader cpp_reader;
8b97c5f8 36#endif
7f2935c7
PB
37typedef struct cpp_buffer cpp_buffer;
38typedef struct cpp_options cpp_options;
1368ee70 39typedef struct cpp_token cpp_token;
bfb9dc7f 40typedef struct cpp_string cpp_string;
a50882dc 41typedef struct cpp_hashnode cpp_hashnode;
93c80368
NB
42typedef struct cpp_macro cpp_macro;
43typedef struct cpp_lexer_pos cpp_lexer_pos;
44typedef struct cpp_lookahead cpp_lookahead;
7e96d768 45typedef struct cpp_callbacks cpp_callbacks;
93c80368 46
93c80368 47struct answer;
93c80368 48struct file_name_map_list;
2a967f3d 49struct ht;
c5a04734
ZW
50
51/* The first two groups, apart from '=', can appear in preprocessor
52 expressions. This allows a lookup table to be implemented in
53 _cpp_parse_expr.
54
55 The first group, to CPP_LAST_EQ, can be immediately followed by an
56 '='. The lexer needs operators ending in '=', like ">>=", to be in
57 the same order as their counterparts without the '=', like ">>". */
58
59/* Positions in the table. */
6fee6033 60#define CPP_LAST_EQ CPP_MAX
c5a04734 61#define CPP_FIRST_DIGRAPH CPP_HASH
9ec7291f 62#define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
1368ee70 63
1368ee70 64#define TTYPE_TABLE \
96be6998
ZW
65 OP(CPP_EQ = 0, "=") \
66 OP(CPP_NOT, "!") \
67 OP(CPP_GREATER, ">") /* compare */ \
68 OP(CPP_LESS, "<") \
69 OP(CPP_PLUS, "+") /* math */ \
70 OP(CPP_MINUS, "-") \
71 OP(CPP_MULT, "*") \
72 OP(CPP_DIV, "/") \
73 OP(CPP_MOD, "%") \
74 OP(CPP_AND, "&") /* bit ops */ \
75 OP(CPP_OR, "|") \
76 OP(CPP_XOR, "^") \
77 OP(CPP_RSHIFT, ">>") \
78 OP(CPP_LSHIFT, "<<") \
92936ecf
ZW
79 OP(CPP_MIN, "<?") /* extension */ \
80 OP(CPP_MAX, ">?") \
c5a04734 81\
96be6998
ZW
82 OP(CPP_COMPL, "~") \
83 OP(CPP_AND_AND, "&&") /* logical */ \
84 OP(CPP_OR_OR, "||") \
85 OP(CPP_QUERY, "?") \
86 OP(CPP_COLON, ":") \
87 OP(CPP_COMMA, ",") /* grouping */ \
88 OP(CPP_OPEN_PAREN, "(") \
89 OP(CPP_CLOSE_PAREN, ")") \
90 OP(CPP_EQ_EQ, "==") /* compare */ \
91 OP(CPP_NOT_EQ, "!=") \
92 OP(CPP_GREATER_EQ, ">=") \
93 OP(CPP_LESS_EQ, "<=") \
1368ee70 94\
96be6998
ZW
95 OP(CPP_PLUS_EQ, "+=") /* math */ \
96 OP(CPP_MINUS_EQ, "-=") \
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, "<<=") \
92936ecf
ZW
105 OP(CPP_MIN_EQ, "<?=") /* extension */ \
106 OP(CPP_MAX_EQ, ">?=") \
c5a04734 107 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
96be6998
ZW
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, "...") \
96be6998
ZW
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, ".*") \
cc937581 124 OP(CPP_ATSIGN, "@") /* used in Objective C */ \
1368ee70 125\
96be6998
ZW
126 TK(CPP_NAME, SPELL_IDENT) /* word */ \
127 TK(CPP_INT, SPELL_STRING) /* 23 */ \
128 TK(CPP_FLOAT, SPELL_STRING) /* 3.14159 */ \
129 TK(CPP_NUMBER, SPELL_STRING) /* 34_be+ta */ \
1368ee70 130\
96be6998
ZW
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_STRING) /* Only if output comments. */ \
140 TK(CPP_MACRO_ARG, SPELL_NONE) /* Macro argument. */ \
93c80368 141 OP(CPP_EOF, "EOL") /* End of line or file. */
1368ee70 142
96be6998
ZW
143#define OP(e, s) e,
144#define TK(e, s) e,
3a2b2c7a 145enum cpp_ttype
c45da1ca 146{
1368ee70
ZW
147 TTYPE_TABLE
148 N_TTYPES
149};
96be6998
ZW
150#undef OP
151#undef TK
1368ee70 152
dd07b884
NB
153/* C language kind, used when calling cpp_reader_init. */
154enum c_lang {CLK_GNUC89 = 0, CLK_GNUC99, CLK_STDC89, CLK_STDC94, CLK_STDC99,
155 CLK_GNUCXX, CLK_CXX98, CLK_OBJC, CLK_OBJCXX, CLK_ASM};
156
bfb9dc7f
ZW
157/* Payload of a NUMBER, FLOAT, STRING, or COMMENT token. */
158struct cpp_string
1368ee70
ZW
159{
160 unsigned int len;
f617b8e2 161 const unsigned char *text;
1368ee70
ZW
162};
163
c5a04734 164/* Flags for the cpp_token structure. */
041c3194 165#define PREV_WHITE (1 << 0) /* If whitespace before this token. */
93c80368
NB
166#define DIGRAPH (1 << 1) /* If it was a digraph. */
167#define STRINGIFY_ARG (1 << 2) /* If macro argument to be stringified. */
168#define PASTE_LEFT (1 << 3) /* If on LHS of a ## operator. */
dd07b884 169#define NAMED_OP (1 << 4) /* C++ named operators. */
93c80368 170#define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
26ec42ee 171#define AVOID_LPASTE (1 << 6) /* Check left for accidental pastes. */
9e62c811 172
1920de47 173/* A preprocessing token. This has been carefully packed and should
93c80368 174 occupy 12 bytes on 32-bit hosts and 16 bytes on 64-bit hosts. */
1368ee70
ZW
175struct cpp_token
176{
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. */
6c53ebff
NB
183 struct cpp_string str; /* A string, or number. */
184 unsigned int arg_no; /* Argument no. for a CPP_MACRO_ARG. */
185 unsigned char c; /* Character represented by CPP_OTHER. */
1368ee70 186 } val;
7f2935c7
PB
187};
188
93c80368
NB
189/* The position of a token in the current file. */
190struct cpp_lexer_pos
191{
192 unsigned int line;
193 unsigned int output_line;
194 unsigned short col;
195};
1368ee70 196
93c80368
NB
197typedef struct cpp_token_with_pos cpp_token_with_pos;
198struct cpp_token_with_pos
1368ee70 199{
93c80368
NB
200 cpp_token token;
201 cpp_lexer_pos pos;
202};
1368ee70 203
93c80368
NB
204/* Token lookahead. */
205struct cpp_lookahead
206{
207 struct cpp_lookahead *next;
208 cpp_token_with_pos *tokens;
209 cpp_lexer_pos pos;
210 unsigned int cur, count, cap;
211};
1368ee70 212
0d9f234d
NB
213/* A standalone character. We may want to make it unsigned for the
214 same reason we use unsigned char - to avoid signedness issues. */
215typedef int cppchar_t;
216
ae79697b
ZW
217/* Values for opts.dump_macros.
218 dump_only means inhibit output of the preprocessed text
219 and instead output the definitions of all user-defined
86702e31 220 macros in a form suitable for use as input to cpp.
ae79697b
ZW
221 dump_names means pass #define and the macro name through to output.
222 dump_definitions means pass the whole definition (plus #define) through
223*/
224enum { dump_none = 0, dump_only, dump_names, dump_definitions };
7f2935c7 225
ae79697b
ZW
226/* This structure is nested inside struct cpp_reader, and
227 carries all the options visible to the command line. */
228struct cpp_options
c50bca08 229{
ae79697b
ZW
230 /* Name of input and output files. */
231 const char *in_fname;
232 const char *out_fname;
194d7493 233
6ab3e7dd
NB
234 /* Characters between tab stops. */
235 unsigned int tabstop;
236
ae79697b
ZW
237 /* Pending options - -D, -U, -A, -I, -ixxx. */
238 struct cpp_pending *pending;
7f2935c7 239
ae79697b
ZW
240 /* File name which deps are being written to. This is 0 if deps are
241 being written to stdout. */
242 const char *deps_file;
0b22d65c 243
ae79697b 244 /* Search paths for include files. */
591e15a1
NB
245 struct search_path *quote_include; /* "" */
246 struct search_path *bracket_include; /* <> */
7f2935c7 247
ae79697b
ZW
248 /* Map between header names and file names, used only on DOS where
249 file names are limited in length. */
7e2eb697
PB
250 struct file_name_map_list *map_list;
251
ae79697b
ZW
252 /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
253 in the standard include file directories. */
254 const char *include_prefix;
255 unsigned int include_prefix_len;
256
6db83155
ZW
257 /* -fleading_underscore sets this to "_". */
258 const char *user_label_prefix;
259
bdb05a7b
NB
260 /* The language we're preprocessing. */
261 enum c_lang lang;
262
7f2935c7 263 /* Non-0 means -v, so print the full set of include dirs. */
ae79697b 264 unsigned char verbose;
7f2935c7
PB
265
266 /* Nonzero means use extra default include directories for C++. */
ae79697b 267 unsigned char cplusplus;
7f2935c7
PB
268
269 /* Nonzero means handle cplusplus style comments */
ae79697b 270 unsigned char cplusplus_comments;
7f2935c7
PB
271
272 /* Nonzero means handle #import, for objective C. */
ae79697b 273 unsigned char objc;
7f2935c7 274
564ad5f4 275 /* Nonzero means don't copy comments into the output file. */
ae79697b 276 unsigned char discard_comments;
7f2935c7 277
041c3194 278 /* Nonzero means process the ISO trigraph sequences. */
ae79697b 279 unsigned char trigraphs;
7f2935c7 280
9b55f29a
NB
281 /* Nonzero means process the ISO digraph sequences. */
282 unsigned char digraphs;
283
bdb05a7b
NB
284 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
285 unsigned char extended_numbers;
286
ae79697b
ZW
287 /* Nonzero means print the names of included files rather than the
288 preprocessed output. 1 means just the #include "...", 2 means
289 #include <...> as well. */
290 unsigned char print_deps;
7f2935c7 291
a5a4ce3c
NB
292 /* Nonzero if phony targets are created for each header. */
293 unsigned char deps_phony_targets;
294
ae79697b
ZW
295 /* Nonzero if missing .h files in -M output are assumed to be
296 generated files and not errors. */
297 unsigned char print_deps_missing_files;
7f2935c7
PB
298
299 /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
ae79697b 300 unsigned char print_deps_append;
7f2935c7
PB
301
302 /* Nonzero means print names of header files (-H). */
ae79697b 303 unsigned char print_include_names;
7f2935c7 304
ae79697b
ZW
305 /* Nonzero means cpp_pedwarn causes a hard error. */
306 unsigned char pedantic_errors;
7f2935c7 307
c1212d2f 308 /* Nonzero means don't print warning messages. */
ae79697b 309 unsigned char inhibit_warnings;
7f2935c7 310
317639a8
BC
311 /* Nonzero means don't suppress warnings from system headers. */
312 unsigned char warn_system_headers;
313
ae79697b
ZW
314 /* Nonzero means don't print error messages. Has no option to
315 select it, but can be set by a user of cpplib (e.g. fix-header). */
316 unsigned char inhibit_errors;
c1212d2f 317
7f2935c7 318 /* Nonzero means warn if slash-star appears in a comment. */
ae79697b 319 unsigned char warn_comments;
7f2935c7
PB
320
321 /* Nonzero means warn if there are any trigraphs. */
ae79697b 322 unsigned char warn_trigraphs;
7f2935c7
PB
323
324 /* Nonzero means warn if #import is used. */
ae79697b 325 unsigned char warn_import;
7f2935c7 326
f9a0e96c
ZW
327 /* Nonzero means warn about various incompatibilities with
328 traditional C. */
07aa0b04 329 unsigned char warn_traditional;
7f2935c7
PB
330
331 /* Nonzero means turn warnings into errors. */
ae79697b 332 unsigned char warnings_are_errors;
7f2935c7 333
ae79697b
ZW
334 /* Nonzero causes output not to be done, but directives such as
335 #define that have side effects are still obeyed. */
336 unsigned char no_output;
7f2935c7 337
31031edd
JL
338 /* Nonzero means we should look for header.gcc files that remap file
339 names. */
ae79697b 340 unsigned char remap;
31031edd 341
7f2935c7 342 /* Nonzero means don't output line number information. */
ae79697b 343 unsigned char no_line_commands;
7f2935c7 344
ae79697b
ZW
345 /* Nonzero means -I- has been seen, so don't look for #include "foo"
346 the source-file directory. */
347 unsigned char ignore_srcdir;
7f2935c7 348
ae79697b
ZW
349 /* Zero means dollar signs are punctuation. */
350 unsigned char dollars_in_ident;
7f2935c7 351
6ac34fdc 352 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
ae79697b 353 unsigned char warn_undef;
6ac34fdc 354
31948547 355 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
ae79697b 356 unsigned char c99;
31948547 357
7f2935c7 358 /* Nonzero means give all the error messages the ANSI standard requires. */
ae79697b 359 unsigned char pedantic;
7f2935c7 360
3773a46b
JM
361 /* Nonzero means we're looking at already preprocessed code, so don't
362 bother trying to do macro expansion and whatnot. */
ae79697b 363 unsigned char preprocessed;
3773a46b 364
ae79697b
ZW
365 /* Nonzero disables all the standard directories for headers. */
366 unsigned char no_standard_includes;
7f2935c7 367
ae79697b
ZW
368 /* Nonzero disables the C++-specific standard directories for headers. */
369 unsigned char no_standard_cplusplus_includes;
7f2935c7 370
ae79697b
ZW
371 /* Nonzero means dump macros in some fashion - see above. */
372 unsigned char dump_macros;
7f2935c7 373
ae79697b
ZW
374 /* Nonzero means pass #include lines through to the output. */
375 unsigned char dump_includes;
7f2935c7 376
ae79697b
ZW
377 /* Print column number in error messages. */
378 unsigned char show_column;
be768055
JJ
379
380 /* Treat C++ alternate operator names special. */
381 unsigned char operator_names;
7e96d768
NB
382
383 /* True if --help, --version or --target-help appeared in the
384 options. Stand-alone CPP should then bail out after option
385 parsing; drivers might want to continue printing help. */
386 unsigned char help_only;
ae79697b 387};
7f2935c7 388
27e2564a
NB
389/* This structure is passed to the call back when changing file. */
390enum cpp_fc_reason {FC_ENTER = 0, FC_LEAVE, FC_RENAME};
391
392struct cpp_file_loc
393{
394 const char *filename;
395 unsigned int lineno;
396};
397
398typedef struct cpp_file_change cpp_file_change;
399struct cpp_file_change
400{
401 struct cpp_file_loc from; /* Line of #include or #line. */
402 struct cpp_file_loc to; /* Line after #include or #line, or start. */
403 enum cpp_fc_reason reason; /* Reason for change. */
404 unsigned char sysp; /* Nonzero if system header. */
405 unsigned char externc; /* Nonzero if wrapper needed. */
406};
407
7e96d768
NB
408/* Call backs. */
409struct cpp_callbacks
410{
411 void (*file_change) PARAMS ((cpp_reader *, const cpp_file_change *));
412 void (*include) PARAMS ((cpp_reader *, const unsigned char *,
413 const cpp_token *));
414 void (*define) PARAMS ((cpp_reader *, cpp_hashnode *));
415 void (*undef) PARAMS ((cpp_reader *, cpp_hashnode *));
416 void (*poison) PARAMS ((cpp_reader *));
417 void (*ident) PARAMS ((cpp_reader *, const cpp_string *));
418 void (*def_pragma) PARAMS ((cpp_reader *));
419};
420
ae79697b
ZW
421#define CPP_FATAL_LIMIT 1000
422/* True if we have seen a "fatal" error. */
7e96d768 423#define CPP_FATAL_ERRORS(PFILE) (cpp_errors (PFILE) >= CPP_FATAL_LIMIT)
ae79697b 424
7f2935c7 425/* Name under which this program was invoked. */
bcc5cac9 426extern const char *progname;
7f2935c7 427
ad2a084d
NB
428/* Where does this buffer come from? A faked include, a source file,
429 a builtin macro, a command-line option, or a _Pragma operator. */
430enum cpp_buffer_type {BUF_FAKE, BUF_FILE, BUF_BUILTIN,
431 BUF_CL_OPTION, BUF_PRAGMA};
0bda4760 432
93c80368
NB
433/* The structure of a node in the hash table. The hash table has
434 entries for all identifiers: either macros defined by #define
435 commands (type NT_MACRO), assertions created with #assert
436 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
437 like __LINE__ are flagged NODE_BUILTIN. Poisioned identifiers are
438 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
439 identifier that behaves like an operator such as "xor".
440 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
441 diagnostic may be required for this node. Currently this only
442 applies to __VA_ARGS__ and poisoned identifiers. */
443
444/* Hash node flags. */
445#define NODE_OPERATOR (1 << 0) /* C++ named operator. */
446#define NODE_POISONED (1 << 1) /* Poisoned identifier. */
447#define NODE_BUILTIN (1 << 2) /* Builtin macro. */
448#define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
618cdda7 449#define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
93c80368
NB
450
451/* Different flavors of hash node. */
f8f769ea
ZW
452enum node_type
453{
93c80368
NB
454 NT_VOID = 0, /* No definition yet. */
455 NT_MACRO, /* A macro of some form. */
456 NT_ASSERTION /* Predicate for #assert. */
457};
458
459/* Different flavors of builtin macro. */
460enum builtin_type
461{
462 BT_SPECLINE = 0, /* `__LINE__' */
463 BT_DATE, /* `__DATE__' */
464 BT_FILE, /* `__FILE__' */
465 BT_BASE_FILE, /* `__BASE_FILE__' */
466 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
467 BT_TIME, /* `__TIME__' */
7868b4a2 468 BT_STDC /* `__STDC__' */
f8f769ea
ZW
469};
470
2a967f3d
NB
471#define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
472#define HT_NODE(NODE) ((ht_identifier *) (NODE))
473#define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
474#define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
f8f769ea 475
2a967f3d
NB
476/* The common part of an identifier node shared amongst all 3 C front
477 ends. Also used to store CPP identifiers, which are a superset of
478 identifiers in the grammatical sense. */
a50882dc 479struct cpp_hashnode
f8f769ea 480{
2a967f3d 481 struct ht_identifier ident;
dd07b884
NB
482 unsigned short arg_index; /* Macro argument index. */
483 unsigned char directive_index; /* Index into directive table. */
2a967f3d
NB
484 unsigned char rid_code; /* Rid code - for front ends. */
485 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */
486 unsigned char flags; /* CPP flags. */
f8f769ea 487
041c3194
ZW
488 union
489 {
dd07b884
NB
490 cpp_macro *macro; /* If a macro. */
491 struct answer *answers; /* Answers to an assertion. */
492 enum cpp_ttype operator; /* Code for a named operator. */
493 enum builtin_type builtin; /* Code for a builtin macro. */
f8f769ea 494 } value;
f8f769ea
ZW
495};
496
2a967f3d
NB
497/* Call this first to get a handle to pass to other functions. If you
498 want cpplib to manage its own hashtable, pass in a NULL pointer.
499 Or you can pass in an initialised hash table that cpplib will use;
500 this technique is used by the C front ends. */
501extern cpp_reader *cpp_create_reader PARAMS ((struct ht *,
502 enum c_lang));
96302433 503
400023a3
NB
504/* Call this to release the handle. Any use of the handle after this
505 function returns is invalid. Returns cpp_errors (pfile). */
506extern int cpp_destroy PARAMS ((cpp_reader *));
507
7e96d768
NB
508/* Call these to get pointers to the options and callback structures
509 for a given reader. These pointers are good until you call
510 cpp_finish on that reader. You can either edit the callbacks
511 through the pointer returned from cpp_get_callbacks, or set them
512 with cpp_set_callbacks. */
513extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
514extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
515extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
516
96302433
NB
517/* Now call cpp_handle_option[s] to handle 1[or more] switches. The
518 return value is the number of arguments used. If
519 cpp_handle_options returns without using all arguments, it couldn't
520 understand the next switch. When there are no switches left, you
521 must call cpp_post_options before calling cpp_start_read. Only
522 after cpp_post_options are the contents of the cpp_options
523 structure reliable. */
524extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
525extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
526extern void cpp_post_options PARAMS ((cpp_reader *));
527
7e96d768
NB
528/* Error count. */
529extern unsigned int cpp_errors PARAMS ((cpp_reader *));
530
93c80368 531extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
dd07b884
NB
532extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
533 const cpp_token *));
93c80368
NB
534extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
535 unsigned char *));
58fea6af
ZW
536extern void cpp_register_pragma PARAMS ((cpp_reader *,
537 const char *, const char *,
538 void (*) PARAMS ((cpp_reader *))));
539extern void cpp_register_pragma_space PARAMS ((cpp_reader *, const char *));
540
93c80368
NB
541extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
542extern void cpp_finish PARAMS ((cpp_reader *));
93c80368
NB
543extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
544 const cpp_token *));
545extern enum cpp_ttype cpp_can_paste PARAMS ((cpp_reader *, const cpp_token *,
546 const cpp_token *, int *));
547extern void cpp_get_token PARAMS ((cpp_reader *, cpp_token *));
548extern const cpp_lexer_pos *cpp_get_line PARAMS ((cpp_reader *));
549extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
550 const cpp_hashnode *));
041c3194 551
c8a96070
NB
552/* Evaluate a CPP_CHAR or CPP_WCHAR token. */
553extern HOST_WIDE_INT
554cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
555 int, int, unsigned int *));
556
7ceb3598
NB
557extern void cpp_define PARAMS ((cpp_reader *, const char *));
558extern void cpp_assert PARAMS ((cpp_reader *, const char *));
559extern void cpp_undef PARAMS ((cpp_reader *, const char *));
560extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
7f2935c7 561
711b8824 562extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
0bda4760
NB
563 const unsigned char *, size_t,
564 enum cpp_buffer_type,
565 const char *));
711b8824
ZW
566extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
567extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
c5a04734 568
c1212d2f
ZW
569/* N.B. The error-message-printer prototypes have not been nicely
570 formatted because exgettext needs to see 'msgid' on the same line
571 as the name of the function in order to work properly. Only the
572 string argument gets a name in an effort to keep the lines from
573 getting ridiculously oversized. */
574
575extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
487a6e06 576 ATTRIBUTE_PRINTF_2;
c1212d2f 577extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
487a6e06 578 ATTRIBUTE_PRINTF_2;
c1212d2f 579extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
487a6e06 580 ATTRIBUTE_PRINTF_2;
c1212d2f
ZW
581extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
582 ATTRIBUTE_PRINTF_2;
583extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
584 ATTRIBUTE_PRINTF_2;
585extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
586 ATTRIBUTE_PRINTF_2;
587extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
554fbeef 588 ATTRIBUTE_PRINTF_4;
c1212d2f 589extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
487a6e06 590 ATTRIBUTE_PRINTF_4;
c1212d2f 591extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
487a6e06 592 ATTRIBUTE_PRINTF_4;
c1212d2f
ZW
593extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
594 ATTRIBUTE_PRINTF_5;
711b8824
ZW
595extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
596extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
f2d5f0cc
ZW
597
598/* In cpplex.c */
bfb9dc7f
ZW
599extern int cpp_ideq PARAMS ((const cpp_token *,
600 const char *));
93c80368
NB
601extern void cpp_output_line PARAMS ((cpp_reader *, FILE *));
602extern void cpp_output_token PARAMS ((const cpp_token *, FILE *));
603extern const char *cpp_type2name PARAMS ((enum cpp_ttype));
62729350
NB
604extern unsigned int cpp_parse_escape PARAMS ((cpp_reader *,
605 const unsigned char **,
606 const unsigned char *,
607 unsigned HOST_WIDE_INT, int));
1368ee70 608
f2d5f0cc 609/* In cpphash.c */
2a967f3d
NB
610
611/* Lookup an identifier in the hashtable. Puts the identifier in the
612 table if it is not already there. */
93c80368 613extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
2a967f3d
NB
614 const unsigned char *,
615 unsigned int));
616
617typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
93c80368 618extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
2a967f3d 619 cpp_cb, void *));
926c5678 620
58fea6af 621/* In cppmacro.c */
8dc4676d 622extern void cpp_scan_buffer_nooutput PARAMS ((cpp_reader *, int));
93c80368
NB
623extern void cpp_start_lookahead PARAMS ((cpp_reader *));
624extern void cpp_stop_lookahead PARAMS ((cpp_reader *, int));
c691145a 625extern int cpp_sys_macro_p PARAMS ((cpp_reader *));
6de1e2a9 626
add7091b 627/* In cppfiles.c */
711b8824 628extern int cpp_included PARAMS ((cpp_reader *, const char *));
614c7d37 629extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
b0699dad 630
7f2935c7
PB
631#ifdef __cplusplus
632}
633#endif
88657302
RH
634
635#endif /* ! GCC_CPPLIB_H */