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