blob: ca0eee2bd639dbce1412e43b42744b4c08dfd677 [file] [log] [blame]
Per Bothner7f2935c1995-03-16 13:59:07 -08001/* Definitions for CPP library.
Neil Booth5d8ebbd2002-01-03 21:43:09 +00002 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
Rodney Brown2398fb2a2000-12-07 01:58:25 +00003 Free Software Foundation, Inc.
Per Bothner7f2935c1995-03-16 13:59:07 -08004 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
Richard Kenner940d9d61995-06-15 07:33:25 -040018Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
Per Bothner7f2935c1995-03-16 13:59:07 -080019
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! */
Neil Booth2a967f32001-05-20 06:26:45 +000023#ifndef GCC_CPPLIB_H
24#define GCC_CPPLIB_H
Per Bothner7f2935c1995-03-16 13:59:07 -080025
26#include <sys/types.h>
Neil Booth2a967f32001-05-20 06:26:45 +000027#include "hashtable.h"
Neil Boothd82fc102001-08-02 23:03:31 +000028#include "line-map.h"
Per Bothner7f2935c1995-03-16 13:59:07 -080029
30#ifdef __cplusplus
31extern "C" {
32#endif
33
Zack Weinberg8b97c5f2000-09-07 22:24:34 +000034/* For complex reasons, cpp_reader is also typedefed in c-pragma.h. */
Richard Henderson88657302001-05-25 18:31:47 -070035#ifndef GCC_C_PRAGMA_H
Per Bothner7f2935c1995-03-16 13:59:07 -080036typedef struct cpp_reader cpp_reader;
Zack Weinberg8b97c5f2000-09-07 22:24:34 +000037#endif
Per Bothner7f2935c1995-03-16 13:59:07 -080038typedef struct cpp_buffer cpp_buffer;
39typedef struct cpp_options cpp_options;
Zack Weinberg1368ee72000-04-20 19:33:11 +000040typedef struct cpp_token cpp_token;
Zack Weinbergbfb9dc72000-07-08 19:00:39 +000041typedef struct cpp_string cpp_string;
Neil Bootha50882d2001-05-16 21:55:14 +000042typedef struct cpp_hashnode cpp_hashnode;
Neil Booth93c803682000-10-28 17:59:06 +000043typedef struct cpp_macro cpp_macro;
Neil Booth7e96d762001-01-13 01:00:01 +000044typedef struct cpp_callbacks cpp_callbacks;
Neil Booth93c803682000-10-28 17:59:06 +000045
Neil Booth93c803682000-10-28 17:59:06 +000046struct answer;
Neil Booth93c803682000-10-28 17:59:06 +000047struct file_name_map_list;
Per Bothner7f2935c1995-03-16 13:59:07 -080048
Neil Boothf8b954f2002-04-26 06:32:50 +000049/* 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.
Zack Weinbergc5a04732000-04-25 19:32:36 +000052
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. */
Zack Weinberg6fee6032000-07-20 17:57:38 +000058#define CPP_LAST_EQ CPP_MAX
Zack Weinbergc5a04732000-04-25 19:32:36 +000059#define CPP_FIRST_DIGRAPH CPP_HASH
Zack Weinberg9ec72912000-08-09 19:41:12 +000060#define CPP_LAST_PUNCTUATOR CPP_DOT_STAR
Neil Booth87ed1092002-04-28 19:42:54 +000061#define CPP_LAST_CPP_OP CPP_LESS_EQ
Zack Weinbergc5a04732000-04-25 19:32:36 +000062
Zack Weinberg1368ee72000-04-20 19:33:11 +000063#define TTYPE_TABLE \
Zack Weinberg96be6992000-07-18 23:25:06 +000064 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, "<<") \
Zack Weinberg92936ec2000-07-19 20:18:08 +000078 OP(CPP_MIN, "<?") /* extension */ \
79 OP(CPP_MAX, ">?") \
Zack Weinbergc5a04732000-04-25 19:32:36 +000080\
Zack Weinberg96be6992000-07-18 23:25:06 +000081 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, ")") \
Neil Booth87ed1092002-04-28 19:42:54 +000089 TK(CPP_EOF, SPELL_NONE) \
Zack Weinberg96be6992000-07-18 23:25:06 +000090 OP(CPP_EQ_EQ, "==") /* compare */ \
91 OP(CPP_NOT_EQ, "!=") \
92 OP(CPP_GREATER_EQ, ">=") \
93 OP(CPP_LESS_EQ, "<=") \
Zack Weinberg1368ee72000-04-20 19:33:11 +000094\
Neil Booth87ed1092002-04-28 19:42:54 +000095 /* These two are unary + / - in preprocessor expressions. */ \
Zack Weinberg96be6992000-07-18 23:25:06 +000096 OP(CPP_PLUS_EQ, "+=") /* math */ \
97 OP(CPP_MINUS_EQ, "-=") \
Neil Boothf8b954f2002-04-26 06:32:50 +000098\
Zack Weinberg96be6992000-07-18 23:25:06 +000099 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, "<<=") \
Zack Weinberg92936ec2000-07-19 20:18:08 +0000107 OP(CPP_MIN_EQ, "<?=") /* extension */ \
108 OP(CPP_MAX_EQ, ">?=") \
Zack Weinbergc5a04732000-04-25 19:32:36 +0000109 /* Digraphs together, beginning with CPP_FIRST_DIGRAPH. */ \
Zack Weinberg96be6992000-07-18 23:25:06 +0000110 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, "...") \
Zack Weinberg96be6992000-07-18 23:25:06 +0000119 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, ".*") \
Zack Weinbergcc937582001-03-07 01:32:01 +0000126 OP(CPP_ATSIGN, "@") /* used in Objective C */ \
Zack Weinberg1368ee72000-04-20 19:33:11 +0000127\
Zack Weinberg96be6992000-07-18 23:25:06 +0000128 TK(CPP_NAME, SPELL_IDENT) /* word */ \
Zack Weinberg47ad4132001-10-06 23:11:27 +0000129 TK(CPP_NUMBER, SPELL_NUMBER) /* 34_be+ta */ \
Zack Weinberg1368ee72000-04-20 19:33:11 +0000130\
Zack Weinberg96be6992000-07-18 23:25:06 +0000131 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\
Zack Weinberg47ad4132001-10-06 23:11:27 +0000139 TK(CPP_COMMENT, SPELL_NUMBER) /* Only if output comments. */ \
140 /* SPELL_NUMBER happens to DTRT. */ \
Zack Weinberg96be6992000-07-18 23:25:06 +0000141 TK(CPP_MACRO_ARG, SPELL_NONE) /* Macro argument. */ \
Neil Boothf8b954f2002-04-26 06:32:50 +0000142 TK(CPP_PADDING, SPELL_NONE) /* Whitespace for cpp0. */
Zack Weinberg1368ee72000-04-20 19:33:11 +0000143
Zack Weinberg96be6992000-07-18 23:25:06 +0000144#define OP(e, s) e,
145#define TK(e, s) e,
Zack Weinberg3a2b2c72000-04-11 08:29:34 +0000146enum cpp_ttype
Zack Weinbergc45da1c2000-03-02 20:14:32 +0000147{
Zack Weinberg1368ee72000-04-20 19:33:11 +0000148 TTYPE_TABLE
149 N_TTYPES
150};
Zack Weinberg96be6992000-07-18 23:25:06 +0000151#undef OP
152#undef TK
Zack Weinberg1368ee72000-04-20 19:33:11 +0000153
Neil Boothdd07b882000-11-20 18:27:32 +0000154/* 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
Neil Booth5d8ebbd2002-01-03 21:43:09 +0000158/* Payload of a NUMBER, STRING, CHAR or COMMENT token. */
Zack Weinbergbfb9dc72000-07-08 19:00:39 +0000159struct cpp_string
Zack Weinberg1368ee72000-04-20 19:33:11 +0000160{
161 unsigned int len;
Neil Boothf617b8e2000-05-14 22:42:58 +0000162 const unsigned char *text;
Per Bothner7f2935c1995-03-16 13:59:07 -0800163};
164
Zack Weinbergc5a04732000-04-25 19:32:36 +0000165/* Flags for the cpp_token structure. */
Zack Weinberg041c3192000-07-04 01:58:21 +0000166#define PREV_WHITE (1 << 0) /* If whitespace before this token. */
Neil Booth93c803682000-10-28 17:59:06 +0000167#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. */
Neil Boothdd07b882000-11-20 18:27:32 +0000170#define NAMED_OP (1 << 4) /* C++ named operators. */
Neil Booth93c803682000-10-28 17:59:06 +0000171#define NO_EXPAND (1 << 5) /* Do not macro-expand this token. */
Neil Booth4ed5bcf2001-09-24 22:53:12 +0000172#define BOL (1 << 6) /* Token at beginning of line. */
Zack Weinberg9e62c812000-04-21 17:18:50 +0000173
Zack Weinberg1920de42000-05-03 15:35:47 +0000174/* A preprocessing token. This has been carefully packed and should
Neil Booth644edda2001-10-02 12:57:24 +0000175 occupy 16 bytes on 32-bit hosts and 24 bytes on 64-bit hosts. */
Zack Weinberg1368ee72000-04-20 19:33:11 +0000176struct cpp_token
177{
Neil Booth1444f2e2001-08-01 06:19:39 +0000178 unsigned int line; /* Logical line of first char of token. */
179 unsigned short col; /* Column of first char of token. */
Zack Weinberg041c3192000-07-04 01:58:21 +0000180 ENUM_BITFIELD(cpp_ttype) type : CHAR_BIT; /* token type */
181 unsigned char flags; /* flags - see above */
182
Zack Weinberg1368ee72000-04-20 19:33:11 +0000183 union
184 {
Neil Booth2a967f32001-05-20 06:26:45 +0000185 cpp_hashnode *node; /* An identifier. */
Neil Booth4ed5bcf2001-09-24 22:53:12 +0000186 const cpp_token *source; /* Inherit padding from this token. */
Neil Booth6c53ebf2000-11-06 18:43:32 +0000187 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. */
Zack Weinberg1368ee72000-04-20 19:33:11 +0000190 } val;
191};
192
Neil Booth4268e8b2002-05-04 07:30:32 +0000193/* A type wide enough to hold any multibyte source character.
Neil Booth625458d2002-05-04 19:42:01 +0000194 cpplib's character constant interpreter requires an unsigned type.
195 Also, a typedef for the signed equivalent. */
196#ifndef MAX_WCHAR_TYPE_SIZE
197# define MAX_WCHAR_TYPE_SIZE WCHAR_TYPE_SIZE
198#endif
Neil Bootha5a49442002-05-06 22:53:10 +0000199#if CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
Neil Booth625458d2002-05-04 19:42:01 +0000200# define CPPCHAR_SIGNED_T int
201#else
Neil Bootha5a49442002-05-06 22:53:10 +0000202# if CHAR_BIT * SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG
Neil Booth625458d2002-05-04 19:42:01 +0000203# define CPPCHAR_SIGNED_T long
204# else
205# define CPPCHAR_SIGNED_T long long
206# endif
207#endif
208typedef unsigned CPPCHAR_SIGNED_T cppchar_t;
209typedef CPPCHAR_SIGNED_T cppchar_signed_t;
Neil Booth0d9f2342000-09-18 18:43:05 +0000210
Zack Weinbergae796972000-03-31 23:16:11 +0000211/* Values for opts.dump_macros.
212 dump_only means inhibit output of the preprocessed text
213 and instead output the definitions of all user-defined
Zack Weinberg86702e32000-04-18 22:34:13 +0000214 macros in a form suitable for use as input to cpp.
Zack Weinbergae796972000-03-31 23:16:11 +0000215 dump_names means pass #define and the macro name through to output.
216 dump_definitions means pass the whole definition (plus #define) through
217*/
218enum { dump_none = 0, dump_only, dump_names, dump_definitions };
219
220/* This structure is nested inside struct cpp_reader, and
221 carries all the options visible to the command line. */
222struct cpp_options
223{
224 /* Name of input and output files. */
225 const char *in_fname;
226 const char *out_fname;
227
Neil Booth6ab3e7d2000-05-18 11:09:27 +0000228 /* Characters between tab stops. */
229 unsigned int tabstop;
230
Kazu Hirataeebedaa2001-10-11 12:43:43 +0000231 /* Pending options - -D, -U, -A, -I, -ixxx. */
Zack Weinbergae796972000-03-31 23:16:11 +0000232 struct cpp_pending *pending;
233
234 /* File name which deps are being written to. This is 0 if deps are
235 being written to stdout. */
236 const char *deps_file;
237
Zack Weinbergae796972000-03-31 23:16:11 +0000238 /* Search paths for include files. */
Neil Booth591e15a2001-03-02 07:35:12 +0000239 struct search_path *quote_include; /* "" */
240 struct search_path *bracket_include; /* <> */
Zack Weinbergae796972000-03-31 23:16:11 +0000241
242 /* Map between header names and file names, used only on DOS where
243 file names are limited in length. */
244 struct file_name_map_list *map_list;
245
246 /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
247 in the standard include file directories. */
248 const char *include_prefix;
249 unsigned int include_prefix_len;
250
Zack Weinberg6db83152000-09-08 01:29:56 +0000251 /* -fleading_underscore sets this to "_". */
252 const char *user_label_prefix;
253
Neil Booth2443d4e2002-05-05 17:05:09 +0000254 /* Precision for target CPP arithmetic, target characters, target
255 ints and target wide characters, respectively. */
256 size_t precision, char_precision, int_precision, wchar_precision;
Neil Booth4268e8b2002-05-04 07:30:32 +0000257
Neil Boothbdb05a72000-11-26 17:31:13 +0000258 /* The language we're preprocessing. */
259 enum c_lang lang;
260
Zack Weinbergae796972000-03-31 23:16:11 +0000261 /* Non-0 means -v, so print the full set of include dirs. */
262 unsigned char verbose;
263
Neil Booth0fef3fd2002-02-02 18:56:37 +0000264 /* Nonzero means chars are signed. */
265 unsigned char signed_char;
266
Zack Weinbergae796972000-03-31 23:16:11 +0000267 /* Nonzero means use extra default include directories for C++. */
268 unsigned char cplusplus;
269
270 /* Nonzero means handle cplusplus style comments */
271 unsigned char cplusplus_comments;
272
273 /* Nonzero means handle #import, for objective C. */
274 unsigned char objc;
275
Zack Weinbergae796972000-03-31 23:16:11 +0000276 /* Nonzero means don't copy comments into the output file. */
277 unsigned char discard_comments;
278
Jason Thorpe477cdac2002-04-07 03:12:23 +0000279 /* Nonzero means don't copy comments into the output file during
280 macro expansion. */
281 unsigned char discard_comments_in_macro_exp;
282
Zack Weinberg041c3192000-07-04 01:58:21 +0000283 /* Nonzero means process the ISO trigraph sequences. */
Zack Weinbergae796972000-03-31 23:16:11 +0000284 unsigned char trigraphs;
285
Neil Booth9b55f292000-07-11 08:58:28 +0000286 /* Nonzero means process the ISO digraph sequences. */
287 unsigned char digraphs;
288
Neil Boothbdb05a72000-11-26 17:31:13 +0000289 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
290 unsigned char extended_numbers;
291
Zack Weinbergae796972000-03-31 23:16:11 +0000292 /* Nonzero means print the names of included files rather than the
293 preprocessed output. 1 means just the #include "...", 2 means
294 #include <...> as well. */
295 unsigned char print_deps;
296
Neil Bootha5a4ce32001-01-05 07:50:24 +0000297 /* Nonzero if phony targets are created for each header. */
298 unsigned char deps_phony_targets;
299
Zack Weinbergae796972000-03-31 23:16:11 +0000300 /* Nonzero if missing .h files in -M output are assumed to be
301 generated files and not errors. */
302 unsigned char print_deps_missing_files;
303
Kazu Hirataeebedaa2001-10-11 12:43:43 +0000304 /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
Zack Weinbergae796972000-03-31 23:16:11 +0000305 unsigned char print_deps_append;
306
307 /* Nonzero means print names of header files (-H). */
308 unsigned char print_include_names;
309
310 /* Nonzero means cpp_pedwarn causes a hard error. */
311 unsigned char pedantic_errors;
312
313 /* Nonzero means don't print warning messages. */
314 unsigned char inhibit_warnings;
315
Branko Cibej317639a2000-09-26 00:54:04 +0200316 /* Nonzero means don't suppress warnings from system headers. */
317 unsigned char warn_system_headers;
318
Zack Weinbergae796972000-03-31 23:16:11 +0000319 /* Nonzero means don't print error messages. Has no option to
320 select it, but can be set by a user of cpplib (e.g. fix-header). */
321 unsigned char inhibit_errors;
322
323 /* Nonzero means warn if slash-star appears in a comment. */
324 unsigned char warn_comments;
325
326 /* Nonzero means warn if there are any trigraphs. */
327 unsigned char warn_trigraphs;
328
329 /* Nonzero means warn if #import is used. */
330 unsigned char warn_import;
331
Neil Bootha5a49442002-05-06 22:53:10 +0000332 /* Nonzero means warn about multicharacter charconsts. */
333 unsigned char warn_multichar;
334
Zack Weinbergf9a0e962000-07-13 02:32:41 +0000335 /* Nonzero means warn about various incompatibilities with
336 traditional C. */
Zack Weinberg07aa0b02000-04-01 22:55:25 +0000337 unsigned char warn_traditional;
Zack Weinbergae796972000-03-31 23:16:11 +0000338
Phil Edwards909de5d2002-03-22 21:59:04 +0000339 /* Nonzero means warn about text after an #endif (or #else). */
340 unsigned char warn_endif_labels;
341
Zack Weinbergae796972000-03-31 23:16:11 +0000342 /* Nonzero means turn warnings into errors. */
343 unsigned char warnings_are_errors;
344
345 /* Nonzero causes output not to be done, but directives such as
346 #define that have side effects are still obeyed. */
347 unsigned char no_output;
348
349 /* Nonzero means we should look for header.gcc files that remap file
350 names. */
351 unsigned char remap;
352
353 /* Nonzero means don't output line number information. */
354 unsigned char no_line_commands;
355
356 /* Nonzero means -I- has been seen, so don't look for #include "foo"
357 the source-file directory. */
358 unsigned char ignore_srcdir;
359
Kazu Hirataeebedaa2001-10-11 12:43:43 +0000360 /* Zero means dollar signs are punctuation. */
Zack Weinbergae796972000-03-31 23:16:11 +0000361 unsigned char dollars_in_ident;
362
Zack Weinbergae796972000-03-31 23:16:11 +0000363 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
364 unsigned char warn_undef;
365
Zack Weinbergae796972000-03-31 23:16:11 +0000366 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
367 unsigned char c99;
368
369 /* Nonzero means give all the error messages the ANSI standard requires. */
370 unsigned char pedantic;
371
372 /* Nonzero means we're looking at already preprocessed code, so don't
373 bother trying to do macro expansion and whatnot. */
374 unsigned char preprocessed;
375
376 /* Nonzero disables all the standard directories for headers. */
377 unsigned char no_standard_includes;
378
379 /* Nonzero disables the C++-specific standard directories for headers. */
380 unsigned char no_standard_cplusplus_includes;
381
382 /* Nonzero means dump macros in some fashion - see above. */
383 unsigned char dump_macros;
384
Zack Weinbergae796972000-03-31 23:16:11 +0000385 /* Nonzero means pass #include lines through to the output. */
386 unsigned char dump_includes;
387
388 /* Print column number in error messages. */
389 unsigned char show_column;
Jakub Jelinekbe768052000-12-15 16:49:28 +0100390
Neil Booth644edda2001-10-02 12:57:24 +0000391 /* Nonzero means handle C++ alternate operator names. */
Jakub Jelinekbe768052000-12-15 16:49:28 +0100392 unsigned char operator_names;
Neil Booth7e96d762001-01-13 01:00:01 +0000393
394 /* True if --help, --version or --target-help appeared in the
395 options. Stand-alone CPP should then bail out after option
396 parsing; drivers might want to continue printing help. */
397 unsigned char help_only;
Zack Weinbergae796972000-03-31 23:16:11 +0000398};
399
Neil Booth7e96d762001-01-13 01:00:01 +0000400/* Call backs. */
401struct cpp_callbacks
402{
Neil Booth97293892001-09-14 22:04:46 +0000403 /* Called when a new line of preprocessed output is started. */
404 void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
405 void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
406 void (*include) PARAMS ((cpp_reader *, unsigned int,
407 const unsigned char *, const cpp_token *));
408 void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
409 void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
410 void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
411 void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
Neil Booth3d90d292002-05-04 20:15:00 +0000412 /* Called when the client has a chance to properly register
413 built-ins with cpp_define() and cpp_assert(). */
414 void (*register_builtins) PARAMS ((cpp_reader *));
Neil Booth7e96d762001-01-13 01:00:01 +0000415};
416
Per Bothner194d7491996-06-06 20:04:04 -0700417#define CPP_FATAL_LIMIT 1000
Kazu Hirataeebedaa2001-10-11 12:43:43 +0000418/* True if we have seen a "fatal" error. */
Neil Booth7e96d762001-01-13 01:00:01 +0000419#define CPP_FATAL_ERRORS(PFILE) (cpp_errors (PFILE) >= CPP_FATAL_LIMIT)
Per Bothner194d7491996-06-06 20:04:04 -0700420
Per Bothner7f2935c1995-03-16 13:59:07 -0800421/* Name under which this program was invoked. */
Kaveh R. Ghazibcc5cac1999-09-07 15:41:26 +0000422extern const char *progname;
Per Bothner7f2935c1995-03-16 13:59:07 -0800423
Neil Booth93c803682000-10-28 17:59:06 +0000424/* The structure of a node in the hash table. The hash table has
425 entries for all identifiers: either macros defined by #define
426 commands (type NT_MACRO), assertions created with #assert
427 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
428 like __LINE__ are flagged NODE_BUILTIN. Poisioned identifiers are
429 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
430 identifier that behaves like an operator such as "xor".
431 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
432 diagnostic may be required for this node. Currently this only
433 applies to __VA_ARGS__ and poisoned identifiers. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000434
Neil Booth93c803682000-10-28 17:59:06 +0000435/* Hash node flags. */
436#define NODE_OPERATOR (1 << 0) /* C++ named operator. */
437#define NODE_POISONED (1 << 1) /* Poisoned identifier. */
438#define NODE_BUILTIN (1 << 2) /* Builtin macro. */
439#define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
Neil Booth618cdda2001-02-25 09:43:03 +0000440#define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
Neil Booth644edda2001-10-02 12:57:24 +0000441#define NODE_DISABLED (1 << 5) /* A disabled macro. */
Neil Booth93c803682000-10-28 17:59:06 +0000442
443/* Different flavors of hash node. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000444enum node_type
445{
Neil Booth93c803682000-10-28 17:59:06 +0000446 NT_VOID = 0, /* No definition yet. */
447 NT_MACRO, /* A macro of some form. */
448 NT_ASSERTION /* Predicate for #assert. */
449};
450
Neil Booth644edda2001-10-02 12:57:24 +0000451/* Different flavors of builtin macro. _Pragma is an operator, but we
452 handle it with the builtin code for efficiency reasons. */
Neil Booth93c803682000-10-28 17:59:06 +0000453enum builtin_type
454{
455 BT_SPECLINE = 0, /* `__LINE__' */
456 BT_DATE, /* `__DATE__' */
457 BT_FILE, /* `__FILE__' */
458 BT_BASE_FILE, /* `__BASE_FILE__' */
459 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
460 BT_TIME, /* `__TIME__' */
Neil Booth644edda2001-10-02 12:57:24 +0000461 BT_STDC, /* `__STDC__' */
462 BT_PRAGMA /* `_Pragma' operator */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000463};
464
Neil Booth2a967f32001-05-20 06:26:45 +0000465#define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
466#define HT_NODE(NODE) ((ht_identifier *) (NODE))
467#define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
468#define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000469
Neil Booth2a967f32001-05-20 06:26:45 +0000470/* The common part of an identifier node shared amongst all 3 C front
471 ends. Also used to store CPP identifiers, which are a superset of
472 identifiers in the grammatical sense. */
Neil Bootha50882d2001-05-16 21:55:14 +0000473struct cpp_hashnode
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000474{
Neil Booth2a967f32001-05-20 06:26:45 +0000475 struct ht_identifier ident;
Neil Boothdd07b882000-11-20 18:27:32 +0000476 unsigned short arg_index; /* Macro argument index. */
477 unsigned char directive_index; /* Index into directive table. */
Neil Booth2a967f32001-05-20 06:26:45 +0000478 unsigned char rid_code; /* Rid code - for front ends. */
479 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */
480 unsigned char flags; /* CPP flags. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000481
Zack Weinberg041c3192000-07-04 01:58:21 +0000482 union
483 {
Neil Boothdd07b882000-11-20 18:27:32 +0000484 cpp_macro *macro; /* If a macro. */
485 struct answer *answers; /* Answers to an assertion. */
486 enum cpp_ttype operator; /* Code for a named operator. */
487 enum builtin_type builtin; /* Code for a builtin macro. */
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000488 } value;
Zack Weinbergf8f769e2000-05-28 05:56:38 +0000489};
490
Neil Boothf5e99452001-11-15 10:01:10 +0000491/* Call this first to get a handle to pass to other functions. */
492extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
Neil Booth400023a2001-01-14 22:00:20 +0000493
Neil Booth7e96d762001-01-13 01:00:01 +0000494/* Call these to get pointers to the options and callback structures
495 for a given reader. These pointers are good until you call
496 cpp_finish on that reader. You can either edit the callbacks
497 through the pointer returned from cpp_get_callbacks, or set them
498 with cpp_set_callbacks. */
499extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
Neil Booth47d89cf2001-08-11 07:33:39 +0000500extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
Neil Booth7e96d762001-01-13 01:00:01 +0000501extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
502extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
503
Neil Booth96302432001-01-07 15:17:07 +0000504/* Now call cpp_handle_option[s] to handle 1[or more] switches. The
505 return value is the number of arguments used. If
506 cpp_handle_options returns without using all arguments, it couldn't
507 understand the next switch. When there are no switches left, you
Neil Boothf5e99452001-11-15 10:01:10 +0000508 must call cpp_post_options before calling cpp_read_main_file. Only
Neil Booth96302432001-01-07 15:17:07 +0000509 after cpp_post_options are the contents of the cpp_options
Neil Boothf5e99452001-11-15 10:01:10 +0000510 structure reliable. Options processing is not completed until you
511 call cpp_finish_options. */
Neil Booth96302432001-01-07 15:17:07 +0000512extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
Jakub Jelinekffdeea42002-01-29 13:09:37 +0100513extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **, int));
Neil Booth96302432001-01-07 15:17:07 +0000514extern void cpp_post_options PARAMS ((cpp_reader *));
515
Neil Boothf5e99452001-11-15 10:01:10 +0000516/* This function reads the file, but does not start preprocessing. It
517 returns the name of the original file; this is the same as the
518 input file, except for preprocessed input. This will generate at
519 least one file change callback, and possibly a line change callback
520 too. If there was an error opening the file, it returns NULL.
521
522 If you want cpplib to manage its own hashtable, pass in a NULL
523 pointer. Otherise you should pass in an initialised hash table
524 that cpplib will share; this technique is used by the C front
525 ends. */
526extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
527 struct ht *));
528
529/* Deferred handling of command line options that can generate debug
530 callbacks, such as -D and -imacros. Call this after
531 cpp_read_main_file. The front ends need this separation so they
532 can initialize debug output with the original file name, returned
533 from cpp_read_main_file, before they get debug callbacks. */
534extern void cpp_finish_options PARAMS ((cpp_reader *));
535
536/* Call this to release the handle at the end of preprocessing. Any
537 use of the handle after this function returns is invalid. Returns
538 cpp_errors (pfile). */
539extern int cpp_destroy PARAMS ((cpp_reader *));
540
Neil Booth7e96d762001-01-13 01:00:01 +0000541/* Error count. */
542extern unsigned int cpp_errors PARAMS ((cpp_reader *));
543
Neil Booth93c803682000-10-28 17:59:06 +0000544extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
Neil Boothdd07b882000-11-20 18:27:32 +0000545extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
546 const cpp_token *));
Neil Booth93c803682000-10-28 17:59:06 +0000547extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
548 unsigned char *));
Zack Weinberg58fea6a2000-08-02 01:13:45 +0000549extern void cpp_register_pragma PARAMS ((cpp_reader *,
550 const char *, const char *,
551 void (*) PARAMS ((cpp_reader *))));
Zack Weinberg58fea6a2000-08-02 01:13:45 +0000552
Neil Booth93c803682000-10-28 17:59:06 +0000553extern void cpp_finish PARAMS ((cpp_reader *));
Neil Booth93c803682000-10-28 17:59:06 +0000554extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
555 const cpp_token *));
Neil Booth4ed5bcf2001-09-24 22:53:12 +0000556extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
Neil Booth93c803682000-10-28 17:59:06 +0000557extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
558 const cpp_hashnode *));
Neil Boothbdcbe492001-09-13 20:05:17 +0000559extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
Zack Weinberg041c3192000-07-04 01:58:21 +0000560
Neil Boothc8a96072001-05-11 23:48:21 +0000561/* Evaluate a CPP_CHAR or CPP_WCHAR token. */
Neil Booth4268e8b2002-05-04 07:30:32 +0000562extern cppchar_t
Neil Boothc8a96072001-05-11 23:48:21 +0000563cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
Neil Bootha5a49442002-05-06 22:53:10 +0000564 unsigned int *, int *));
Neil Boothc8a96072001-05-11 23:48:21 +0000565
Neil Booth3d90d292002-05-04 20:15:00 +0000566/* Used to register builtins during the register_builtins callback.
567 The text is the same as the command line argument. */
Neil Booth7ceb3592000-03-11 00:49:44 +0000568extern void cpp_define PARAMS ((cpp_reader *, const char *));
569extern void cpp_assert PARAMS ((cpp_reader *, const char *));
570extern void cpp_undef PARAMS ((cpp_reader *, const char *));
571extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
Per Bothner7f2935c1995-03-16 13:59:07 -0800572
Zack Weinberg711b8822000-07-18 00:59:49 +0000573extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
Neil Booth0bda4762000-12-11 07:45:16 +0000574 const unsigned char *, size_t,
Neil Booth29401c32001-08-22 20:37:20 +0000575 int, int));
Zack Weinberg711b8822000-07-18 00:59:49 +0000576extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
Zack Weinbergc5a04732000-04-25 19:32:36 +0000577
Neil Boothebef4e82002-04-14 18:42:47 +0000578/* Diagnostic levels. To get a dianostic without associating a
579 position in the translation unit with it, use cpp_error_with_line
580 with a line number of zero. */
581
582/* Warning, an error with -Werror. */
583#define DL_WARNING 0x00
584/* Same as DL_WARNING, except it is not suppressed in system headers. */
585#define DL_WARNING_SYSHDR 0x01
586/* Warning, an error with -pedantic-errors or -Werror. */
587#define DL_PEDWARN 0x02
588/* An error. */
589#define DL_ERROR 0x03
590/* A fatal error. We do not exit, to support use of cpplib as a
591 library, but may only return CPP_EOF tokens thereon. It is the
592 caller's responsibility to check CPP_FATAL_ERRORS. */
593#define DL_FATAL 0x04
594/* An internal consistency check failed. Prints "internal error: ",
595 otherwise the same as DL_FATAL. */
596#define DL_ICE 0x05
597/* Extracts a diagnostic level from an int. */
598#define DL_EXTRACT(l) (l & 0xf)
599/* Non-zero if a diagnostic level is one of the warnings. */
600#define DL_WARNING_P(l) (DL_EXTRACT (l) >= DL_WARNING \
601 && DL_EXTRACT (l) <= DL_PEDWARN)
602
Zack Weinbergc1212d22000-02-06 23:46:18 +0000603/* N.B. The error-message-printer prototypes have not been nicely
604 formatted because exgettext needs to see 'msgid' on the same line
605 as the name of the function in order to work properly. Only the
606 string argument gets a name in an effort to keep the lines from
607 getting ridiculously oversized. */
608
Neil Boothebef4e82002-04-14 18:42:47 +0000609/* Output a diagnostic of some kind. */
610extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
611 ATTRIBUTE_PRINTF_3;
612
613/* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
614 error string of errno. No location is printed. */
615extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
616
617/* Same as cpp_error, except additionally specifies a position as a
618 (translation unit) physical line and physical column. If the line is
619 zero, then no location is printed. */
620extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
621 ATTRIBUTE_PRINTF_5;
Per Bothner7f2935c1995-03-16 13:59:07 -0800622
Zack Weinbergf2d5f0c2000-04-14 23:29:45 +0000623/* In cpplex.c */
Zack Weinbergbfb9dc72000-07-08 19:00:39 +0000624extern int cpp_ideq PARAMS ((const cpp_token *,
625 const char *));
Neil Booth93c803682000-10-28 17:59:06 +0000626extern void cpp_output_line PARAMS ((cpp_reader *, FILE *));
627extern void cpp_output_token PARAMS ((const cpp_token *, FILE *));
628extern const char *cpp_type2name PARAMS ((enum cpp_ttype));
Neil Booth4268e8b2002-05-04 07:30:32 +0000629/* Returns the value of an escape sequence, truncated to the correct
630 target precision. PSTR points to the input pointer, which is just
631 after the backslash. LIMIT is how much text we have. WIDE is true
632 if the escape sequence is part of a wide character constant or
633 string literal. Handles all relevant diagnostics. */
634extern cppchar_t cpp_parse_escape PARAMS ((cpp_reader *,
635 const unsigned char ** pstr,
636 const unsigned char *limit,
637 int wide));
Zack Weinberg1368ee72000-04-20 19:33:11 +0000638
Zack Weinbergf2d5f0c2000-04-14 23:29:45 +0000639/* In cpphash.c */
Neil Booth2a967f32001-05-20 06:26:45 +0000640
641/* Lookup an identifier in the hashtable. Puts the identifier in the
642 table if it is not already there. */
Neil Booth93c803682000-10-28 17:59:06 +0000643extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
Neil Booth2a967f32001-05-20 06:26:45 +0000644 const unsigned char *,
645 unsigned int));
646
647typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
Neil Booth93c803682000-10-28 17:59:06 +0000648extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
Neil Booth2a967f32001-05-20 06:26:45 +0000649 cpp_cb, void *));
Geoff Keating926c5672000-10-29 07:07:20 +0000650
Zack Weinberg58fea6a2000-08-02 01:13:45 +0000651/* In cppmacro.c */
Neil Boothef6e9582001-08-04 12:01:59 +0000652extern void cpp_scan_nooutput PARAMS ((cpp_reader *));
Neil Boothc6911452001-03-03 11:32:32 +0000653extern int cpp_sys_macro_p PARAMS ((cpp_reader *));
Zack Weinbergdcc229e2002-03-14 18:17:18 +0000654extern unsigned char *cpp_quote_string PARAMS ((unsigned char *,
655 const unsigned char *,
656 unsigned int));
Zack Weinberg6de1e2a1999-02-18 15:35:49 +0000657
Zack Weinbergadd70911998-10-29 11:54:13 +0000658/* In cppfiles.c */
Zack Weinberg711b8822000-07-18 00:59:49 +0000659extern int cpp_included PARAMS ((cpp_reader *, const char *));
Neil Booth614c7d32000-12-04 07:32:04 +0000660extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
Zack Weinbergb0699da2000-03-07 20:58:47 +0000661
Neil Boothaaf93202002-03-24 12:27:45 +0000662/* In cppmain.c */
663extern void cpp_preprocess_file PARAMS ((cpp_reader *));
664
Per Bothner7f2935c1995-03-16 13:59:07 -0800665#ifdef __cplusplus
666}
667#endif
Richard Henderson88657302001-05-25 18:31:47 -0700668
669#endif /* ! GCC_CPPLIB_H */