]> gcc.gnu.org Git - gcc.git/blame - gcc/cpplib.h
Makefile.in: Update cppmain.o.
[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,
bdcae02b 156 CLK_GNUCXX, CLK_CXX98, CLK_ASM};
dd07b884 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 193/* A type wide enough to hold any multibyte source character.
625458d0
NB
194 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
a5a49440 199#if CHAR_BIT * SIZEOF_INT >= MAX_WCHAR_TYPE_SIZE
625458d0
NB
200# define CPPCHAR_SIGNED_T int
201#else
a5a49440 202# if CHAR_BIT * SIZEOF_LONG >= MAX_WCHAR_TYPE_SIZE || !HAVE_LONG_LONG
625458d0
NB
203# 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;
0d9f234d 210
ae79697b
ZW
211/* 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
86702e31 214 macros in a form suitable for use as input to cpp.
ae79697b
ZW
215 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 };
7f2935c7 219
ae79697b
ZW
220/* This structure is nested inside struct cpp_reader, and
221 carries all the options visible to the command line. */
222struct cpp_options
c50bca08 223{
ae79697b
ZW
224 /* Name of input and output files. */
225 const char *in_fname;
226 const char *out_fname;
194d7493 227
6ab3e7dd
NB
228 /* Characters between tab stops. */
229 unsigned int tabstop;
230
eebedaa5 231 /* Pending options - -D, -U, -A, -I, -ixxx. */
ae79697b 232 struct cpp_pending *pending;
7f2935c7 233
ae79697b
ZW
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;
0b22d65c 237
ae79697b 238 /* Search paths for include files. */
591e15a1
NB
239 struct search_path *quote_include; /* "" */
240 struct search_path *bracket_include; /* <> */
7f2935c7 241
ae79697b
ZW
242 /* Map between header names and file names, used only on DOS where
243 file names are limited in length. */
7e2eb697
PB
244 struct file_name_map_list *map_list;
245
ae79697b
ZW
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
bdb05a7b
NB
251 /* The language we're preprocessing. */
252 enum c_lang lang;
253
7f2935c7 254 /* Non-0 means -v, so print the full set of include dirs. */
ae79697b 255 unsigned char verbose;
7f2935c7
PB
256
257 /* Nonzero means use extra default include directories for C++. */
ae79697b 258 unsigned char cplusplus;
7f2935c7
PB
259
260 /* Nonzero means handle cplusplus style comments */
ae79697b 261 unsigned char cplusplus_comments;
7f2935c7 262
bdcae02b
NB
263 /* Nonzero means define __OBJC__, treat @ as a special token, and
264 use the OBJC[PLUS]_INCLUDE_PATH environment variable. */
ae79697b 265 unsigned char objc;
7f2935c7 266
564ad5f4 267 /* Nonzero means don't copy comments into the output file. */
ae79697b 268 unsigned char discard_comments;
7f2935c7 269
477cdac7
JT
270 /* Nonzero means don't copy comments into the output file during
271 macro expansion. */
272 unsigned char discard_comments_in_macro_exp;
273
041c3194 274 /* Nonzero means process the ISO trigraph sequences. */
ae79697b 275 unsigned char trigraphs;
7f2935c7 276
9b55f29a
NB
277 /* Nonzero means process the ISO digraph sequences. */
278 unsigned char digraphs;
279
bdb05a7b
NB
280 /* Nonzero means to allow hexadecimal floats and LL suffixes. */
281 unsigned char extended_numbers;
282
ae79697b
ZW
283 /* Nonzero means print the names of included files rather than the
284 preprocessed output. 1 means just the #include "...", 2 means
285 #include <...> as well. */
286 unsigned char print_deps;
7f2935c7 287
a5a4ce3c
NB
288 /* Nonzero if phony targets are created for each header. */
289 unsigned char deps_phony_targets;
290
ae79697b
ZW
291 /* Nonzero if missing .h files in -M output are assumed to be
292 generated files and not errors. */
293 unsigned char print_deps_missing_files;
7f2935c7 294
eebedaa5 295 /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
ae79697b 296 unsigned char print_deps_append;
7f2935c7
PB
297
298 /* Nonzero means print names of header files (-H). */
ae79697b 299 unsigned char print_include_names;
7f2935c7 300
ae79697b
ZW
301 /* Nonzero means cpp_pedwarn causes a hard error. */
302 unsigned char pedantic_errors;
7f2935c7 303
c1212d2f 304 /* Nonzero means don't print warning messages. */
ae79697b 305 unsigned char inhibit_warnings;
7f2935c7 306
317639a8
BC
307 /* Nonzero means don't suppress warnings from system headers. */
308 unsigned char warn_system_headers;
309
ae79697b
ZW
310 /* Nonzero means don't print error messages. Has no option to
311 select it, but can be set by a user of cpplib (e.g. fix-header). */
312 unsigned char inhibit_errors;
c1212d2f 313
7f2935c7 314 /* Nonzero means warn if slash-star appears in a comment. */
ae79697b 315 unsigned char warn_comments;
7f2935c7
PB
316
317 /* Nonzero means warn if there are any trigraphs. */
ae79697b 318 unsigned char warn_trigraphs;
7f2935c7
PB
319
320 /* Nonzero means warn if #import is used. */
ae79697b 321 unsigned char warn_import;
7f2935c7 322
a5a49440
NB
323 /* Nonzero means warn about multicharacter charconsts. */
324 unsigned char warn_multichar;
325
f9a0e96c
ZW
326 /* Nonzero means warn about various incompatibilities with
327 traditional C. */
07aa0b04 328 unsigned char warn_traditional;
7f2935c7 329
cd7ab83f
NB
330 /* Nonzero means warn about long long numeric constants. */
331 unsigned char warn_long_long;
332
909de5da
PE
333 /* Nonzero means warn about text after an #endif (or #else). */
334 unsigned char warn_endif_labels;
335
7f2935c7 336 /* Nonzero means turn warnings into errors. */
ae79697b 337 unsigned char warnings_are_errors;
7f2935c7 338
ae79697b
ZW
339 /* Nonzero causes output not to be done, but directives such as
340 #define that have side effects are still obeyed. */
341 unsigned char no_output;
7f2935c7 342
31031edd
JL
343 /* Nonzero means we should look for header.gcc files that remap file
344 names. */
ae79697b 345 unsigned char remap;
31031edd 346
7f2935c7 347 /* Nonzero means don't output line number information. */
ae79697b 348 unsigned char no_line_commands;
7f2935c7 349
ae79697b
ZW
350 /* Nonzero means -I- has been seen, so don't look for #include "foo"
351 the source-file directory. */
352 unsigned char ignore_srcdir;
7f2935c7 353
eebedaa5 354 /* Zero means dollar signs are punctuation. */
ae79697b 355 unsigned char dollars_in_ident;
7f2935c7 356
6ac34fdc 357 /* Nonzero means warn if undefined identifiers are evaluated in an #if. */
ae79697b 358 unsigned char warn_undef;
6ac34fdc 359
31948547 360 /* Nonzero for the 1999 C Standard, including corrigenda and amendments. */
ae79697b 361 unsigned char c99;
31948547 362
7f2935c7 363 /* Nonzero means give all the error messages the ANSI standard requires. */
ae79697b 364 unsigned char pedantic;
7f2935c7 365
3773a46b
JM
366 /* Nonzero means we're looking at already preprocessed code, so don't
367 bother trying to do macro expansion and whatnot. */
ae79697b 368 unsigned char preprocessed;
3773a46b 369
ae79697b
ZW
370 /* Nonzero disables all the standard directories for headers. */
371 unsigned char no_standard_includes;
7f2935c7 372
ae79697b
ZW
373 /* Nonzero disables the C++-specific standard directories for headers. */
374 unsigned char no_standard_cplusplus_includes;
7f2935c7 375
ae79697b
ZW
376 /* Nonzero means dump macros in some fashion - see above. */
377 unsigned char dump_macros;
7f2935c7 378
ae79697b
ZW
379 /* Nonzero means pass #include lines through to the output. */
380 unsigned char dump_includes;
7f2935c7 381
ae79697b
ZW
382 /* Print column number in error messages. */
383 unsigned char show_column;
be768055 384
644eddaa 385 /* Nonzero means handle C++ alternate operator names. */
be768055 386 unsigned char operator_names;
7e96d768
NB
387
388 /* True if --help, --version or --target-help appeared in the
389 options. Stand-alone CPP should then bail out after option
390 parsing; drivers might want to continue printing help. */
391 unsigned char help_only;
44a147ad 392
004cb263
NB
393 /* True for traditional preprocessing. */
394 unsigned char traditional;
395
1a76916c
NB
396 /* True if only preprocessing and not compiling. */
397 unsigned char preprocess_only;
398
44a147ad
NB
399 /* Target-specific features set by the front end or client. */
400
401 /* Precision for target CPP arithmetic, target characters, target
402 ints and target wide characters, respectively. */
403 size_t precision, char_precision, int_precision, wchar_precision;
404
405 /* Nonzero means chars (wide chars) are unsigned. */
406 unsigned char unsigned_char, unsigned_wchar;
5279d739
ZW
407
408 /* Nonzero means __STDC__ should have the value 0 in system headers. */
409 unsigned char stdc_0_in_system_headers;
ae79697b 410};
7f2935c7 411
7e96d768
NB
412/* Call backs. */
413struct cpp_callbacks
414{
97293897
NB
415 /* Called when a new line of preprocessed output is started. */
416 void (*line_change) PARAMS ((cpp_reader *, const cpp_token *, int));
417 void (*file_change) PARAMS ((cpp_reader *, const struct line_map *));
418 void (*include) PARAMS ((cpp_reader *, unsigned int,
419 const unsigned char *, const cpp_token *));
420 void (*define) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
421 void (*undef) PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
422 void (*ident) PARAMS ((cpp_reader *, unsigned int, const cpp_string *));
423 void (*def_pragma) PARAMS ((cpp_reader *, unsigned int));
3d90d290
NB
424 /* Called when the client has a chance to properly register
425 built-ins with cpp_define() and cpp_assert(). */
426 void (*register_builtins) PARAMS ((cpp_reader *));
7e96d768
NB
427};
428
7f2935c7 429/* Name under which this program was invoked. */
bcc5cac9 430extern const char *progname;
7f2935c7 431
93c80368
NB
432/* The structure of a node in the hash table. The hash table has
433 entries for all identifiers: either macros defined by #define
434 commands (type NT_MACRO), assertions created with #assert
435 (NT_ASSERTION), or neither of the above (NT_VOID). Builtin macros
436 like __LINE__ are flagged NODE_BUILTIN. Poisioned identifiers are
437 flagged NODE_POISONED. NODE_OPERATOR (C++ only) indicates an
438 identifier that behaves like an operator such as "xor".
439 NODE_DIAGNOSTIC is for speed in lex_token: it indicates a
440 diagnostic may be required for this node. Currently this only
441 applies to __VA_ARGS__ and poisoned identifiers. */
442
443/* Hash node flags. */
444#define NODE_OPERATOR (1 << 0) /* C++ named operator. */
445#define NODE_POISONED (1 << 1) /* Poisoned identifier. */
446#define NODE_BUILTIN (1 << 2) /* Builtin macro. */
447#define NODE_DIAGNOSTIC (1 << 3) /* Possible diagnostic when lexed. */
618cdda7 448#define NODE_WARN (1 << 4) /* Warn if redefined or undefined. */
644eddaa 449#define NODE_DISABLED (1 << 5) /* A disabled macro. */
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
644eddaa
NB
459/* Different flavors of builtin macro. _Pragma is an operator, but we
460 handle it with the builtin code for efficiency reasons. */
93c80368
NB
461enum builtin_type
462{
463 BT_SPECLINE = 0, /* `__LINE__' */
464 BT_DATE, /* `__DATE__' */
465 BT_FILE, /* `__FILE__' */
466 BT_BASE_FILE, /* `__BASE_FILE__' */
467 BT_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
468 BT_TIME, /* `__TIME__' */
644eddaa
NB
469 BT_STDC, /* `__STDC__' */
470 BT_PRAGMA /* `_Pragma' operator */
f8f769ea
ZW
471};
472
2a967f3d
NB
473#define CPP_HASHNODE(HNODE) ((cpp_hashnode *) (HNODE))
474#define HT_NODE(NODE) ((ht_identifier *) (NODE))
475#define NODE_LEN(NODE) HT_LEN (&(NODE)->ident)
476#define NODE_NAME(NODE) HT_STR (&(NODE)->ident)
f8f769ea 477
2a967f3d
NB
478/* The common part of an identifier node shared amongst all 3 C front
479 ends. Also used to store CPP identifiers, which are a superset of
480 identifiers in the grammatical sense. */
a50882dc 481struct cpp_hashnode
f8f769ea 482{
2a967f3d 483 struct ht_identifier ident;
dd07b884
NB
484 unsigned short arg_index; /* Macro argument index. */
485 unsigned char directive_index; /* Index into directive table. */
2a967f3d
NB
486 unsigned char rid_code; /* Rid code - for front ends. */
487 ENUM_BITFIELD(node_type) type : 8; /* CPP node type. */
488 unsigned char flags; /* CPP flags. */
f8f769ea 489
041c3194
ZW
490 union
491 {
dd07b884
NB
492 cpp_macro *macro; /* If a macro. */
493 struct answer *answers; /* Answers to an assertion. */
494 enum cpp_ttype operator; /* Code for a named operator. */
495 enum builtin_type builtin; /* Code for a builtin macro. */
f8f769ea 496 } value;
f8f769ea
ZW
497};
498
f5e99456
NB
499/* Call this first to get a handle to pass to other functions. */
500extern cpp_reader *cpp_create_reader PARAMS ((enum c_lang));
400023a3 501
7e96d768
NB
502/* Call these to get pointers to the options and callback structures
503 for a given reader. These pointers are good until you call
504 cpp_finish on that reader. You can either edit the callbacks
505 through the pointer returned from cpp_get_callbacks, or set them
506 with cpp_set_callbacks. */
507extern cpp_options *cpp_get_options PARAMS ((cpp_reader *));
47d89cf3 508extern const struct line_maps *cpp_get_line_maps PARAMS ((cpp_reader *));
7e96d768
NB
509extern cpp_callbacks *cpp_get_callbacks PARAMS ((cpp_reader *));
510extern void cpp_set_callbacks PARAMS ((cpp_reader *, cpp_callbacks *));
511
96302433
NB
512/* Now call cpp_handle_option[s] to handle 1[or more] switches. The
513 return value is the number of arguments used. If
514 cpp_handle_options returns without using all arguments, it couldn't
515 understand the next switch. When there are no switches left, you
f5e99456 516 must call cpp_post_options before calling cpp_read_main_file. Only
96302433 517 after cpp_post_options are the contents of the cpp_options
f5e99456
NB
518 structure reliable. Options processing is not completed until you
519 call cpp_finish_options. */
96302433 520extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
09e77dee 521extern int cpp_handle_option PARAMS ((cpp_reader *, int, char **));
96302433
NB
522extern void cpp_post_options PARAMS ((cpp_reader *));
523
f5e99456
NB
524/* This function reads the file, but does not start preprocessing. It
525 returns the name of the original file; this is the same as the
526 input file, except for preprocessed input. This will generate at
527 least one file change callback, and possibly a line change callback
528 too. If there was an error opening the file, it returns NULL.
529
530 If you want cpplib to manage its own hashtable, pass in a NULL
531 pointer. Otherise you should pass in an initialised hash table
532 that cpplib will share; this technique is used by the C front
533 ends. */
534extern const char *cpp_read_main_file PARAMS ((cpp_reader *, const char *,
535 struct ht *));
536
537/* Deferred handling of command line options that can generate debug
538 callbacks, such as -D and -imacros. Call this after
539 cpp_read_main_file. The front ends need this separation so they
540 can initialize debug output with the original file name, returned
541 from cpp_read_main_file, before they get debug callbacks. */
542extern void cpp_finish_options PARAMS ((cpp_reader *));
543
544/* Call this to release the handle at the end of preprocessing. Any
545 use of the handle after this function returns is invalid. Returns
546 cpp_errors (pfile). */
547extern int cpp_destroy PARAMS ((cpp_reader *));
548
7e96d768
NB
549/* Error count. */
550extern unsigned int cpp_errors PARAMS ((cpp_reader *));
551
93c80368 552extern unsigned int cpp_token_len PARAMS ((const cpp_token *));
dd07b884
NB
553extern unsigned char *cpp_token_as_text PARAMS ((cpp_reader *,
554 const cpp_token *));
93c80368
NB
555extern unsigned char *cpp_spell_token PARAMS ((cpp_reader *, const cpp_token *,
556 unsigned char *));
58fea6af
ZW
557extern void cpp_register_pragma PARAMS ((cpp_reader *,
558 const char *, const char *,
559 void (*) PARAMS ((cpp_reader *))));
58fea6af 560
93c80368 561extern void cpp_finish PARAMS ((cpp_reader *));
93c80368
NB
562extern int cpp_avoid_paste PARAMS ((cpp_reader *, const cpp_token *,
563 const cpp_token *));
4ed5bcfb 564extern const cpp_token *cpp_get_token PARAMS ((cpp_reader *));
93c80368
NB
565extern const unsigned char *cpp_macro_definition PARAMS ((cpp_reader *,
566 const cpp_hashnode *));
bdcbe496 567extern void _cpp_backup_tokens PARAMS ((cpp_reader *, unsigned int));
041c3194 568
c8a96070 569/* Evaluate a CPP_CHAR or CPP_WCHAR token. */
4268e8bb 570extern cppchar_t
c8a96070 571cpp_interpret_charconst PARAMS ((cpp_reader *, const cpp_token *,
a5a49440 572 unsigned int *, int *));
c8a96070 573
3d90d290
NB
574/* Used to register builtins during the register_builtins callback.
575 The text is the same as the command line argument. */
7ceb3598
NB
576extern void cpp_define PARAMS ((cpp_reader *, const char *));
577extern void cpp_assert PARAMS ((cpp_reader *, const char *));
578extern void cpp_undef PARAMS ((cpp_reader *, const char *));
579extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
7f2935c7 580
711b8824 581extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
0bda4760 582 const unsigned char *, size_t,
29401c30 583 int, int));
711b8824 584extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
c5a04734 585
cd7ab83f
NB
586/* A preprocessing number. Code assumes that any unused high bits of
587 the double integer are set to zero. */
588typedef unsigned HOST_WIDE_INT cpp_num_part;
589typedef struct cpp_num cpp_num;
590struct cpp_num
591{
592 cpp_num_part high;
593 cpp_num_part low;
594 bool unsignedp; /* True if value should be treated as unsigned. */
595 bool overflow; /* True if the most recent calculation overflowed. */
596};
597
598/* cpplib provides two interfaces for interpretation of preprocessing
599 numbers.
600
601 cpp_classify_number categorizes numeric constants according to
602 their field (integer, floating point, or invalid), radix (decimal,
603 octal, hexadecimal), and type suffixes. */
604
605#define CPP_N_CATEGORY 0x000F
606#define CPP_N_INVALID 0x0000
607#define CPP_N_INTEGER 0x0001
608#define CPP_N_FLOATING 0x0002
609
610#define CPP_N_WIDTH 0x00F0
611#define CPP_N_SMALL 0x0010 /* int, float. */
612#define CPP_N_MEDIUM 0x0020 /* long, double. */
613#define CPP_N_LARGE 0x0040 /* long long, long double. */
614
615#define CPP_N_RADIX 0x0F00
616#define CPP_N_DECIMAL 0x0100
617#define CPP_N_HEX 0x0200
618#define CPP_N_OCTAL 0x0400
619
620#define CPP_N_UNSIGNED 0x1000 /* Properties. */
621#define CPP_N_IMAGINARY 0x2000
622
623/* Classify a CPP_NUMBER token. The return value is a combination of
624 the flags from the above sets. */
625extern unsigned cpp_classify_number PARAMS ((cpp_reader *, const cpp_token *));
626
627/* Evaluate a token classified as category CPP_N_INTEGER. */
628extern cpp_num cpp_interpret_integer PARAMS ((cpp_reader *, const cpp_token *,
629 unsigned int type));
630
ceeedfc1
NB
631/* Sign extend a number, with PRECISION significant bits and all
632 others assumed clear, to fill out a cpp_num structure. */
633cpp_num cpp_num_sign_extend PARAMS ((cpp_num, size_t));
634
ebef4e8c
NB
635/* Diagnostic levels. To get a dianostic without associating a
636 position in the translation unit with it, use cpp_error_with_line
637 with a line number of zero. */
638
639/* Warning, an error with -Werror. */
640#define DL_WARNING 0x00
641/* Same as DL_WARNING, except it is not suppressed in system headers. */
642#define DL_WARNING_SYSHDR 0x01
643/* Warning, an error with -pedantic-errors or -Werror. */
644#define DL_PEDWARN 0x02
645/* An error. */
646#define DL_ERROR 0x03
ebef4e8c 647/* An internal consistency check failed. Prints "internal error: ",
bdee42b1
NB
648 otherwise the same as DL_ERROR. */
649#define DL_ICE 0x04
ebef4e8c
NB
650/* Extracts a diagnostic level from an int. */
651#define DL_EXTRACT(l) (l & 0xf)
652/* Non-zero if a diagnostic level is one of the warnings. */
653#define DL_WARNING_P(l) (DL_EXTRACT (l) >= DL_WARNING \
654 && DL_EXTRACT (l) <= DL_PEDWARN)
655
c1212d2f
ZW
656/* N.B. The error-message-printer prototypes have not been nicely
657 formatted because exgettext needs to see 'msgid' on the same line
658 as the name of the function in order to work properly. Only the
659 string argument gets a name in an effort to keep the lines from
660 getting ridiculously oversized. */
661
ebef4e8c
NB
662/* Output a diagnostic of some kind. */
663extern void cpp_error PARAMS ((cpp_reader *, int, const char *msgid, ...))
664 ATTRIBUTE_PRINTF_3;
665
666/* Output a diagnostic of severity LEVEL, with "MSG: " preceding the
667 error string of errno. No location is printed. */
668extern void cpp_errno PARAMS ((cpp_reader *, int level, const char *msg));
669
670/* Same as cpp_error, except additionally specifies a position as a
671 (translation unit) physical line and physical column. If the line is
672 zero, then no location is printed. */
673extern void cpp_error_with_line PARAMS ((cpp_reader *, int, unsigned, unsigned, const char *msgid, ...))
674 ATTRIBUTE_PRINTF_5;
f2d5f0cc
ZW
675
676/* In cpplex.c */
bfb9dc7f
ZW
677extern int cpp_ideq PARAMS ((const cpp_token *,
678 const char *));
93c80368
NB
679extern void cpp_output_line PARAMS ((cpp_reader *, FILE *));
680extern void cpp_output_token PARAMS ((const cpp_token *, FILE *));
681extern const char *cpp_type2name PARAMS ((enum cpp_ttype));
4268e8bb
NB
682/* Returns the value of an escape sequence, truncated to the correct
683 target precision. PSTR points to the input pointer, which is just
684 after the backslash. LIMIT is how much text we have. WIDE is true
685 if the escape sequence is part of a wide character constant or
686 string literal. Handles all relevant diagnostics. */
687extern cppchar_t cpp_parse_escape PARAMS ((cpp_reader *,
688 const unsigned char ** pstr,
689 const unsigned char *limit,
690 int wide));
1368ee70 691
f2d5f0cc 692/* In cpphash.c */
2a967f3d
NB
693
694/* Lookup an identifier in the hashtable. Puts the identifier in the
695 table if it is not already there. */
93c80368 696extern cpp_hashnode *cpp_lookup PARAMS ((cpp_reader *,
2a967f3d
NB
697 const unsigned char *,
698 unsigned int));
699
700typedef int (*cpp_cb) PARAMS ((cpp_reader *, cpp_hashnode *, void *));
93c80368 701extern void cpp_forall_identifiers PARAMS ((cpp_reader *,
2a967f3d 702 cpp_cb, void *));
926c5678 703
58fea6af 704/* In cppmacro.c */
ef6e958a 705extern void cpp_scan_nooutput PARAMS ((cpp_reader *));
c691145a 706extern int cpp_sys_macro_p PARAMS ((cpp_reader *));
dcc229e5
ZW
707extern unsigned char *cpp_quote_string PARAMS ((unsigned char *,
708 const unsigned char *,
709 unsigned int));
6de1e2a9 710
add7091b 711/* In cppfiles.c */
711b8824 712extern int cpp_included PARAMS ((cpp_reader *, const char *));
614c7d37 713extern void cpp_make_system_header PARAMS ((cpp_reader *, int, int));
b0699dad 714
aaf93206
NB
715/* In cppmain.c */
716extern void cpp_preprocess_file PARAMS ((cpp_reader *));
717
7f2935c7
PB
718#ifdef __cplusplus
719}
720#endif
88657302
RH
721
722#endif /* ! GCC_CPPLIB_H */
This page took 0.948012 seconds and 5 git commands to generate.