Files
gcc/libcpp/directives.cc
Jakub Jelinek eba6d2aa71 libcpp, c-family: Add (dumb) C23 N3017 #embed support [PR105863]
The following patch implements the C23 N3017 "#embed - a scannable,
tooling-friendly binary resource inclusion mechanism" paper.

The implementation is intentionally dumb, in that it doesn't significantly
speed up compilation of larger initializers and doesn't make it possible
to use huge #embeds (like several gigabytes large, that is compile time
and memory still infeasible).
There are 2 reasons for this.  One is that I think like it is implemented
now in the patch is how we should use it for the smaller #embed sizes,
dunno with which boundary, whether 32 bytes or 64 or something like that,
certainly handling the single byte cases which is something that can appear
anywhere in the source where constant integer literal can appear is
desirable and I think for a few bytes it isn't worth it to come up with
something smarter and users would like to e.g. see it in -E readably as
well (perhaps the slow vs. fast boundary should be determined by command
line option).  And the other one is to be able to more easily find
regressions in behavior caused by the optimizations, so we have something
to get back in git to compare against.
I'm definitely willing to work on the optimizations (likely introduce a new
CPP_* token type to refer to a range of libcpp owned memory (start + size)
and similarly some tree which can do the same, and can be at any time e.g.
split into 2 subparts + say INTEGER_CST in between if needed say for
const unsigned char d[] = {
 #embed "2GB.dat" prefix (0, 0, ) suffix (, [0x40000000] = 42)
}; still without having to copy around huge amounts of data; STRING_CST
owns the memory it points to and can be only 2GB in size), but would
like to do that incrementally.
And would like to first include some extensions also not included in
this patch, like gnu::offset (off) parameter to allow to skip certain
constant amount of bytes at the start of the files, plus
gnu::base64 ("base64_encoded_data") parameter to add something which can
store more efficiently large amounts of the #embed data in preprocessed
source.

I've been cross-checking all the tests also against the LLVM implementation
https://github.com/llvm/llvm-project/pull/68620
which has been for a few hours even committed to LLVM trunk but reverted
afterwards.  LLVM now has the support committed and I admit I haven't
rechecked whether the behavior on the below mentioned spots have been fixed
in it already or not yet.

The patch uses --embed-dir= option that clang plans to add above and doesn't
use other variants on the search directories yet, plus there are no
default directories at least for the time being where to search for embed
files.  So, #embed "..." works if it is found in the same directory (or
relative to the current file's directory) and #embed "/..." or #embed </...>
work always, but relative #embed <...> doesn't unless at least one
--embed-dir= is specified.  There is no reason to differentiate between
system and non-system directories, so we don't need -isystem like
counterpart, perhaps -iquote like counterpart could be useful in the future,
dunno what else.  It has --embed-directory=dir and --embed-directory dir
as aliases.

There are some differences beyond clang ICEs, so I'd like to point them out
to make sure there is agreement on the choices in the patch.  They are also
mentioned in the comments of the llvm pull request.

The most important is that the GCC patch (as well as the original thephd.dev
LLVM branch on godbolt) expands #embed (or acts as if it is expanded) into
a mere sequence of numbers like 123,2,35,26 rather then what clang
effectively treats as (unsigned char)123,(unsigned char)2,(unsigned
char)35,(unsigned char)26 but only does that when using integrated
preprocessor, not when using -save-temps where it acts as GCC.
JeanHeyd as the original author agrees that is how it is currently worded in
C23.

Another difference (not tested in the testsuite, not sure how to check for
effective target /dev/urandom nor am sure it is desirable to check that
during testsuite) is how to treat character devices, named pipes etc.
(block devices are errored on).  The original paper uses /dev/urandom
in various examples and seems to assume that unlike regular files the
devices aren't really cached, so
 #embed </dev/urandom> limit(1) prefix(int a = ) suffix(;)
 #embed </dev/urandom> limit(1) prefix(int b = ) suffix(;)
usually results in a != b.  That is what the godbolt thephd.dev branch
implements too and what this patch does as well, but clang actually seems
to just go from st.st_size == 0, ergo it must be zero-sized resource and
so just copies over if_empty if present.  It is really questionable
what to do about the character devices/named pipes with __has_embed, for
regular files the patch doesn't read anything from them, relies on
st.st_size + limit for whether it is empty or non-empty.  But I don't know
of a way to check if read on say a character device would read anything
or not (the </dev/null> limit (1) vs. </dev/zero> limit (1) cases), and
if we read something, that would be better cached for later because
 #embed later if it reads again could read no further data even when it
first read something.  So, the patch currently for __has_embed just
always returns 2 on the non-regular files, like the thephd.dev
branch does as well and like the clang pull request as well.
A question is also what to do for gnu::offset on the non-regular files
even for #embed, those aren't seekable and do we want to just read and throw
away the offset bytes each time we see it used?

clang also chokes on the
 #if __has_embed (__FILE__ __limit__ (1) __prefix__ () suffix (1 / 0) \
 __if_empty__ ((({{[0[0{0{0(0(0)1)1}1}]]}})))) != __STDC_EMBED_FOUND__
 #error "__has_embed fail"
 #endif
in embed-1.c, but thephd.dev branch accepts it and I don't see why
it shouldn't, (({{[0[0{0{0(0(0)1)1}1}]]}}))) is a balanced token
sequence and the file isn't empty, so it should just be parsed and
discarded.

clang also IMHO mishandles
 const unsigned char w[] = {
 #embed __FILE__ prefix([0] = 42, [15] =) limit(32)
 };
but again only without -save-temps, seems like it
treats it as
[0] = 42, [15] = (99,111,110,115,116,32,117,110,115,105,103,110,101,100,
32,99,104,97,114,32,119,91,93,32,61,32,123,10,35,101,109,98)
rather than
[0] = 42, [15] = 99,111,110,115,116,32,117,110,115,105,103,110,101,100,
32,99,104,97,114,32,119,91,93,32,61,32,123,10,35,101,109,98
and warns on it for -Wunused-value and just compiles it as
[0] = 42, [15] = 98

And also
 void foo (int, int, int, int);
 void bar (void) { foo (
 #embed __FILE__ limit (4) prefix (172 + ) suffix (+ 2)
 ); }
is treated as
172 + (118, 111, 105, 100) + 2
rather than
172 + 118, 111, 105, 100 + 2
which clang -save-temps or GCC treats it like, so results
in just one argument passed rather than 4.

if (!strstr ((const char *) magna_carta, "imprisonétur")) abort ();
in the testcase fails as well, but in that case calling it in gdb succeeds:
p ((char *(*)(char *, char *))__strstr_sse2) (magna_carta, "imprisonétur")
$2 = 0x555555558d3c <magna_carta+11564> "imprisonétur aut disseisiátur"...
so I guess they are just trying to constant evaluate strstr and do it
incorrectly.

They started with making the optimizations together in the initial patch
set, so they don't have the luxury to compare if it is just because of
the optimization they are trying to do or because that is how the
feature works for them.  At least unless they use -save-temps for now.

There is also different behavior between clang and gcc on -M or other
dependency generating options.  Seems clang includes the __has_embed
searched files in dependencies, while my patch doesn't.  But so does
clang for __has_include and GCC doesn't.  Emitting a hard dependency
on some header just because there was __has_include/__has_embed for it
seems wrong to me, because (at least when properly written) the source
likely doesn't mind if the file is missing, it will do something else,
so a hard error from make because of it doesn't seem right.  Does
make have some weaker dependencies, such that if some file can be remade
it is but if it doesn't exist, it isn't fatal?

I wonder whether #embed <non-existent-file> really needs to be fatal
or whether we could simply after diagnosing it pretend the file exists
and is empty.  For #include I think fatal errors make tons of sense,
but perhaps for #embed which is more localized we'd get better error
reporting if we didn't bail out immediately.  Note, both GCC and clang
currently treat those as fatal errors.

clang also added -dE option which with -E instead of preprocessing
the #embed directives keeps them as is, but the preprocessed source
then isn't self-contained.  That option looks more harmful than useful to
me.

Also, it isn't clear to me from C23 whether it is possible to have
__has_include/__has_c_attribute/__has_embed expressions inside of
the limit #embed/__has_embed argument.
6.10.3.2/2 says that defined should not appear there (and the patch
diagnoses it and testsuite tests), but for __has_include/__has_embed
etc. 6.10.1/11 says:
"The identifiers __has_include, __has_embed, and __has_c_attribute
shall not appear in any context not mentioned in this subclause."
If that subclause in that case means 6.10.1, then it presumably shouldn't
appear in #embed in 6.10.3, but __has_embed is in 6.10.1...
But 6.10.3.2/3 says that it should be parsed according to the 6.10.1
rules.  Haven't included tests like
 #if __has_embed (__FILE__ limit (__has_embed (__FILE__ limit (1))))
or
 #embed __FILE__ limit (__has_include (__FILE__))
into the testsuite because of the doubts but I think the patch should
handle those right now.

The reason I've used Magna Carta text in some of the testcases is that
I hope it shouldn't be copyrighted after the centuries and I'd strongly
prefer not to have binary blobs in git after the xz backdoor lesson
and wanted something larger which doesn't change all the time.

Oh, BTW, I see in C23 draft 6.10.3.2 in Example 4
if (f_source == NULL);
  return 1;
(note the spurious semicolon after closing paren), has that been fixed
already?

Like the thephd.dev and clang implementations, the patch always macro
expands the whole #embed and __has_embed directives except for the
embed keyword.  That is most likely not what C23 says, my limited
understanding right now is that in #embed one needs to parse the whole
directive line with macro expansion disabled and check if it satisfies the
grammar, if not, the whole directive is macro expanded, if yes, only
the limit parameter argument is macro expanded and the prefix/suffix/if_empty
arguments are maybe macro expanded when actually used (and not at all if
unused).  And I think __has_embed macro expansion has conflicting rules.

2024-09-12  Jakub Jelinek  <jakub@redhat.com>

	PR c/105863
libcpp/
	* include/cpplib.h: Implement C23 N3017 #embed - a scannable,
	tooling-friendly binary resource inclusion mechanism paper.
	(struct cpp_options): Add embed member.
	(enum cpp_builtin_type): Add BT_HAS_EMBED.
	(cpp_set_include_chains): Add another cpp_dir * argument to
	the declaration.
	* internal.h (enum include_type): Add IT_EMBED.
	(struct cpp_reader): Add embed_include member.
	(struct cpp_embed_params_tokens): New type.
	(struct cpp_embed_params): New type.
	(_cpp_get_token_no_padding): Declare.
	(enum _cpp_find_file_kind): Add _cpp_FFK_EMBED and _cpp_FFK_HAS_EMBED.
	(_cpp_stack_embed): Declare.
	(_cpp_parse_expr): Change return type to cpp_num_part instead of
	bool, change second argument from bool to const char * and add third
	argument.
	(_cpp_parse_embed_params): Declare.
	* directives.cc (DIRECTIVE_TABLE): Add embed entry.
	(end_directive): Don't call skip_rest_of_line for T_EMBED directive.
	(_cpp_handle_directive): Return 2 rather than 1 for T_EMBED in
	directives-only mode.
	(parse_include): Don't Call check_eol for T_EMBED directive.
	(skip_balanced_token_seq): New function.
	(EMBED_PARAMS): Define.
	(enum embed_param_kind): New type.
	(embed_params): New variable.
	(_cpp_parse_embed_params): New function.
	(do_embed): New function.
	(do_if): Adjust _cpp_parse_expr caller.
	(do_elif): Likewise.
	* expr.cc (parse_defined): Diagnose defined in #embed or __has_embed
	parameters.
	(_cpp_parse_expr): Change return type to cpp_num_part instead of
	bool, change second argument from bool to const char * and add third
	argument.  Adjust function comment.  For #embed/__has_embed parameters
	add an artificial CPP_OPEN_PAREN.  Use the second argument DIR
	directly instead of string literals conditional on IS_IF.
	For #embed/__has_embed parameter, stop on reaching CPP_CLOSE_PAREN
	matching the artificial one.  Diagnose negative or too large embed
	parameter operands.
	(num_binary_op): Use #embed instead of #if for diagnostics if inside
	#embed/__has_embed parameter.
	(num_div_op): Likewise.
	* files.cc (struct _cpp_file): Add limit member and embed bitfield.
	(search_cache): Add IS_EMBED argument, formatting fix.  Skip over
	files with different file->embed from the argument.
	(find_file_in_dir): Don't call pch_open_file if file->embed.
	(_cpp_find_file): Handle _cpp_FFK_EMBED and _cpp_FFK_HAS_EMBED.
	(read_file_guts): Formatting fix.
	(has_unique_contents): Ignore file->embed files.
	(search_path_head): Handle IT_EMBED type.
	(_cpp_stack_embed): New function.
	(_cpp_get_file_stat): Formatting fix.
	(cpp_set_include_chains): Add embed argument, save it to
	pfile->embed_include and compute lens for the chain.
	* init.cc (struct lang_flags): Add embed member.
	(lang_defaults): Add embed initializers.
	(cpp_set_lang): Initialize CPP_OPTION (pfile, embed).
	(builtin_array): Add __has_embed entry.
	(cpp_init_builtins): Predefine __STDC_EMBED_NOT_FOUND__,
	__STDC_EMBED_FOUND__ and __STDC_EMBED_EMPTY__.
	* lex.cc (cpp_directive_only_process): Handle #embed.
	* macro.cc (cpp_get_token_no_padding): Rename to ...
	(_cpp_get_token_no_padding): ... this.  No longer static.
	(builtin_has_include_1): New function.
	(builtin_has_include): Use it.  Use _cpp_get_token_no_padding
	instead of cpp_get_token_no_padding.
	(builtin_has_embed): New function.
	(_cpp_builtin_macro_text): Handle BT_HAS_EMBED.
gcc/
	* doc/cppdiropts.texi (--embed-dir=): Document.
	* doc/cpp.texi (Binary Resource Inclusion): New chapter.
	(__has_embed): Document.
	* doc/invoke.texi (Directory Options): Mention --embed-dir=.
	* gcc.cc (cpp_unique_options): Add %{-embed*}.
	* genmatch.cc (main): Adjust cpp_set_include_chains caller.
	* incpath.h (enum incpath_kind): Add INC_EMBED.
	* incpath.cc (merge_include_chains): Handle INC_EMBED.
	(register_include_chains): Adjust cpp_set_include_chains caller.
gcc/c-family/
	* c.opt (-embed-dir=): New option.
	(-embed-directory): New alias.
	(-embed-directory=): New alias.
	* c-opts.cc (c_common_handle_option): Handle OPT__embed_dir_.
gcc/testsuite/
	* c-c++-common/cpp/embed-1.c: New test.
	* c-c++-common/cpp/embed-2.c: New test.
	* c-c++-common/cpp/embed-3.c: New test.
	* c-c++-common/cpp/embed-4.c: New test.
	* c-c++-common/cpp/embed-5.c: New test.
	* c-c++-common/cpp/embed-6.c: New test.
	* c-c++-common/cpp/embed-7.c: New test.
	* c-c++-common/cpp/embed-8.c: New test.
	* c-c++-common/cpp/embed-9.c: New test.
	* c-c++-common/cpp/embed-10.c: New test.
	* c-c++-common/cpp/embed-11.c: New test.
	* c-c++-common/cpp/embed-12.c: New test.
	* c-c++-common/cpp/embed-13.c: New test.
	* c-c++-common/cpp/embed-14.c: New test.
	* c-c++-common/cpp/embed-25.c: New test.
	* c-c++-common/cpp/embed-26.c: New test.
	* c-c++-common/cpp/embed-dir/embed-1.inc: New test.
	* c-c++-common/cpp/embed-dir/embed-3.c: New test.
	* c-c++-common/cpp/embed-dir/embed-4.c: New test.
	* c-c++-common/cpp/embed-dir/magna-carta.txt: New test.
	* gcc.dg/cpp/embed-1.c: New test.
	* gcc.dg/cpp/embed-2.c: New test.
	* gcc.dg/cpp/embed-3.c: New test.
	* gcc.dg/cpp/embed-4.c: New test.
	* g++.dg/cpp/embed-1.C: New test.
	* g++.dg/cpp/embed-2.C: New test.
	* g++.dg/cpp/embed-3.C: New test.
2024-09-12 11:15:38 +02:00

3174 lines
91 KiB
C++

/* CPP Library. (Directive handling.)
Copyright (C) 1986-2024 Free Software Foundation, Inc.
Contributed by Per Bothner, 1994-95.
Based on CCCP program by Paul Rubin, June 1986
Adapted to ANSI C, Richard Stallman, Jan 1987
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3, or (at your option) any
later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; see the file COPYING3. If not see
<http://www.gnu.org/licenses/>. */
#include "config.h"
#include "system.h"
#include "cpplib.h"
#include "internal.h"
#include "mkdeps.h"
#include "obstack.h"
/* Stack of conditionals currently in progress
(including both successful and failing conditionals). */
struct if_stack
{
struct if_stack *next;
location_t line; /* Line where condition started. */
const cpp_hashnode *mi_cmacro;/* macro name for #ifndef around entire file */
bool skip_elses; /* Can future #else / #elif be skipped? */
bool was_skipping; /* If were skipping on entry. */
int type; /* Most recent conditional for diagnostics. */
};
/* Contains a registered pragma or pragma namespace. */
typedef void (*pragma_cb) (cpp_reader *);
struct pragma_entry
{
struct pragma_entry *next;
const cpp_hashnode *pragma; /* Name and length. */
bool is_nspace;
bool is_internal;
bool is_deferred;
bool allow_expansion;
union {
pragma_cb handler;
struct pragma_entry *space;
unsigned int ident;
} u;
};
/* Values for the origin field of struct directive. KANDR directives
come from traditional (K&R) C. STDC89 directives come from the
1989 C standard. STDC23 directives come from the C23 standard. EXTENSION
directives are extensions. */
#define KANDR 0
#define STDC89 1
#define STDC23 2
#define EXTENSION 3
/* Values for the flags field of struct directive. COND indicates a
conditional; IF_COND an opening conditional. INCL means to treat
"..." and <...> as q-char and h-char sequences respectively. IN_I
means this directive should be handled even if -fpreprocessed is in
effect (these are the directives with callback hooks).
EXPAND is set on directives that are always macro-expanded.
ELIFDEF is set on directives that are only handled for standards with the
#elifdef / #elifndef feature. */
#define COND (1 << 0)
#define IF_COND (1 << 1)
#define INCL (1 << 2)
#define IN_I (1 << 3)
#define EXPAND (1 << 4)
#define DEPRECATED (1 << 5)
#define ELIFDEF (1 << 6)
/* Defines one #-directive, including how to handle it. */
typedef void (*directive_handler) (cpp_reader *);
typedef struct directive directive;
struct directive
{
directive_handler handler; /* Function to handle directive. */
const uchar *name; /* Name of directive. */
unsigned short length; /* Length of name. */
unsigned char origin; /* Origin of directive. */
unsigned char flags; /* Flags describing this directive. */
};
/* Forward declarations. */
static void skip_rest_of_line (cpp_reader *);
static void check_eol (cpp_reader *, bool);
static void start_directive (cpp_reader *);
static void prepare_directive_trad (cpp_reader *);
static void end_directive (cpp_reader *, int);
static void directive_diagnostics (cpp_reader *, const directive *, int);
static void run_directive (cpp_reader *, int, const char *, size_t);
static char *glue_header_name (cpp_reader *);
static const char *parse_include (cpp_reader *, int *, const cpp_token ***,
location_t *);
static void push_conditional (cpp_reader *, int, int, const cpp_hashnode *);
static unsigned int read_flag (cpp_reader *, unsigned int);
static bool strtolinenum (const uchar *, size_t, linenum_type *, bool *);
static void do_diagnostic (cpp_reader *, enum cpp_diagnostic_level code,
enum cpp_warning_reason reason, int);
static cpp_hashnode *lex_macro_node (cpp_reader *, bool);
static int undefine_macros (cpp_reader *, cpp_hashnode *, void *);
static void do_include_common (cpp_reader *, enum include_type);
static struct pragma_entry *lookup_pragma_entry (struct pragma_entry *,
const cpp_hashnode *);
static int count_registered_pragmas (struct pragma_entry *);
static char ** save_registered_pragmas (struct pragma_entry *, char **);
static char ** restore_registered_pragmas (cpp_reader *, struct pragma_entry *,
char **);
static void do_pragma_once (cpp_reader *);
static void do_pragma_poison (cpp_reader *);
static void do_pragma_system_header (cpp_reader *);
static void do_pragma_dependency (cpp_reader *);
static void do_pragma_warning_or_error (cpp_reader *, bool error);
static void do_pragma_warning (cpp_reader *);
static void do_pragma_error (cpp_reader *);
static void do_linemarker (cpp_reader *);
static const cpp_token *get_token_no_padding (cpp_reader *);
static const cpp_token *get__Pragma_string (cpp_reader *);
static void destringize_and_run (cpp_reader *, const cpp_string *,
location_t);
static bool parse_answer (cpp_reader *, int, location_t, cpp_macro **);
static cpp_hashnode *parse_assertion (cpp_reader *, int, cpp_macro **);
static cpp_macro **find_answer (cpp_hashnode *, const cpp_macro *);
static void handle_assertion (cpp_reader *, const char *, int);
static void do_pragma_push_macro (cpp_reader *);
static void do_pragma_pop_macro (cpp_reader *);
static void cpp_pop_definition (cpp_reader *, struct def_pragma_macro *);
/* This is the table of directive handlers. All extensions other than
#warning, #include_next, and #import are deprecated. The name is
where the extension appears to have come from. */
#define DIRECTIVE_TABLE \
D(define, T_DEFINE = 0, KANDR, IN_I) \
D(include, T_INCLUDE, KANDR, INCL | EXPAND) \
D(endif, T_ENDIF, KANDR, COND) \
D(ifdef, T_IFDEF, KANDR, COND | IF_COND) \
D(if, T_IF, KANDR, COND | IF_COND | EXPAND) \
D(else, T_ELSE, KANDR, COND) \
D(ifndef, T_IFNDEF, KANDR, COND | IF_COND) \
D(undef, T_UNDEF, KANDR, IN_I) \
D(line, T_LINE, KANDR, EXPAND) \
D(elif, T_ELIF, STDC89, COND | EXPAND) \
D(elifdef, T_ELIFDEF, STDC23, COND | ELIFDEF) \
D(elifndef, T_ELIFNDEF, STDC23, COND | ELIFDEF) \
D(error, T_ERROR, STDC89, 0) \
D(pragma, T_PRAGMA, STDC89, IN_I) \
D(warning, T_WARNING, STDC23, 0) \
D(embed, T_EMBED, STDC23, INCL | EXPAND) \
D(include_next, T_INCLUDE_NEXT, EXTENSION, INCL | EXPAND) \
D(ident, T_IDENT, EXTENSION, IN_I) \
D(import, T_IMPORT, EXTENSION, INCL | EXPAND) /* ObjC */ \
D(assert, T_ASSERT, EXTENSION, DEPRECATED) /* SVR4 */ \
D(unassert, T_UNASSERT, EXTENSION, DEPRECATED) /* SVR4 */ \
D(sccs, T_SCCS, EXTENSION, IN_I) /* SVR4? */
/* #sccs is synonymous with #ident. */
#define do_sccs do_ident
/* Use the table to generate a series of prototypes, an enum for the
directive names, and an array of directive handlers. */
#define D(name, t, o, f) static void do_##name (cpp_reader *);
DIRECTIVE_TABLE
#undef D
#define D(n, tag, o, f) tag,
enum
{
DIRECTIVE_TABLE
N_DIRECTIVES
};
#undef D
#define D(name, t, origin, flags) \
{ do_##name, (const uchar *) #name, \
sizeof #name - 1, origin, flags },
static const directive dtable[] =
{
DIRECTIVE_TABLE
};
#undef D
/* A NULL-terminated array of directive names for use
when suggesting corrections for misspelled directives. */
#define D(name, t, origin, flags) #name,
static const char * const directive_names[] = {
DIRECTIVE_TABLE
NULL
};
#undef D
#undef DIRECTIVE_TABLE
/* Wrapper struct directive for linemarkers.
The origin is more or less true - the original K+R cpp
did use this notation in its preprocessed output. */
static const directive linemarker_dir =
{
do_linemarker, UC"#", 1, KANDR, IN_I
};
/* Skip any remaining tokens in a directive. */
static void
skip_rest_of_line (cpp_reader *pfile)
{
/* Discard all stacked contexts. */
while (pfile->context->prev)
_cpp_pop_context (pfile);
/* Sweep up all tokens remaining on the line. */
if (! SEEN_EOL ())
while (_cpp_lex_token (pfile)->type != CPP_EOF)
;
}
/* Helper function for check_oel. */
static void
check_eol_1 (cpp_reader *pfile, bool expand, enum cpp_warning_reason reason)
{
if (! SEEN_EOL () && (expand
? cpp_get_token (pfile)
: _cpp_lex_token (pfile))->type != CPP_EOF)
cpp_pedwarning (pfile, reason, "extra tokens at end of #%s directive",
pfile->directive->name);
}
/* Variant of check_eol used for Wendif-labels warnings. */
static void
check_eol_endif_labels (cpp_reader *pfile)
{
check_eol_1 (pfile, false, CPP_W_ENDIF_LABELS);
}
/* Ensure there are no stray tokens at the end of a directive. If
EXPAND is true, tokens macro-expanding to nothing are allowed. */
static void
check_eol (cpp_reader *pfile, bool expand)
{
check_eol_1 (pfile, expand, CPP_W_NONE);
}
/* Ensure there are no stray tokens other than comments at the end of
a directive, and gather the comments. */
static const cpp_token **
check_eol_return_comments (cpp_reader *pfile)
{
size_t c;
size_t capacity = 8;
const cpp_token **buf;
buf = XNEWVEC (const cpp_token *, capacity);
c = 0;
if (! SEEN_EOL ())
{
while (1)
{
const cpp_token *tok;
tok = _cpp_lex_token (pfile);
if (tok->type == CPP_EOF)
break;
if (tok->type != CPP_COMMENT)
cpp_error (pfile, CPP_DL_PEDWARN,
"extra tokens at end of #%s directive",
pfile->directive->name);
else
{
if (c + 1 >= capacity)
{
capacity *= 2;
buf = XRESIZEVEC (const cpp_token *, buf, capacity);
}
buf[c] = tok;
++c;
}
}
}
buf[c] = NULL;
return buf;
}
/* Called when entering a directive, _Pragma or command-line directive. */
static void
start_directive (cpp_reader *pfile)
{
/* Setup in-directive state. */
pfile->state.in_directive = 1;
pfile->state.save_comments = 0;
pfile->directive_result.type = CPP_PADDING;
/* Some handlers need the position of the # for diagnostics. */
pfile->directive_line = pfile->line_table->highest_line;
}
/* Called when leaving a directive, _Pragma or command-line directive. */
static void
end_directive (cpp_reader *pfile, int skip_line)
{
if (CPP_OPTION (pfile, traditional))
{
/* Revert change of prepare_directive_trad. */
if (!pfile->state.in_deferred_pragma)
pfile->state.prevent_expansion--;
if (pfile->directive != &dtable[T_DEFINE])
_cpp_remove_overlay (pfile);
}
else if (pfile->state.in_deferred_pragma)
;
/* We don't skip for an assembler #. */
else if (skip_line)
{
if (pfile->directive != &dtable[T_EMBED])
skip_rest_of_line (pfile);
if (!pfile->keep_tokens)
{
pfile->cur_run = &pfile->base_run;
pfile->cur_token = pfile->base_run.base;
}
}
/* Restore state. */
pfile->state.save_comments = ! CPP_OPTION (pfile, discard_comments);
pfile->state.in_directive = 0;
pfile->state.in_expression = 0;
pfile->state.angled_headers = 0;
pfile->directive = 0;
}
/* Prepare to handle the directive in pfile->directive. */
static void
prepare_directive_trad (cpp_reader *pfile)
{
if (pfile->directive != &dtable[T_DEFINE])
{
bool no_expand = (pfile->directive
&& ! (pfile->directive->flags & EXPAND));
bool was_skipping = pfile->state.skipping;
pfile->state.in_expression = (pfile->directive == &dtable[T_IF]
|| pfile->directive == &dtable[T_ELIF]);
if (pfile->state.in_expression)
pfile->state.skipping = false;
if (no_expand)
pfile->state.prevent_expansion++;
_cpp_scan_out_logical_line (pfile, NULL, false);
if (no_expand)
pfile->state.prevent_expansion--;
pfile->state.skipping = was_skipping;
_cpp_overlay_buffer (pfile, pfile->out.base,
pfile->out.cur - pfile->out.base);
}
/* Stop ISO C from expanding anything. */
pfile->state.prevent_expansion++;
}
/* Output diagnostics for a directive DIR. INDENTED is nonzero if
the '#' was indented. */
static void
directive_diagnostics (cpp_reader *pfile, const directive *dir, int indented)
{
/* Issue -pedantic or deprecated warnings for extensions. We let
-pedantic take precedence if both are applicable. */
if (! pfile->state.skipping)
{
if (dir->origin == EXTENSION
&& !(dir == &dtable[T_IMPORT] && CPP_OPTION (pfile, objc))
&& CPP_PEDANTIC (pfile))
cpp_error (pfile, CPP_DL_PEDWARN, "#%s is a GCC extension", dir->name);
else if (dir == &dtable[T_WARNING])
{
if (CPP_PEDANTIC (pfile) && !CPP_OPTION (pfile, warning_directive))
{
if (CPP_OPTION (pfile, cplusplus))
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C++23 is a GCC extension", dir->name);
else
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C23 is a GCC extension", dir->name);
}
else if (CPP_OPTION (pfile, cpp_warn_c11_c23_compat) > 0)
cpp_warning (pfile, CPP_W_C11_C23_COMPAT,
"#%s before C23 is a GCC extension", dir->name);
}
else if (((dir->flags & DEPRECATED) != 0
|| (dir == &dtable[T_IMPORT] && !CPP_OPTION (pfile, objc)))
&& CPP_OPTION (pfile, cpp_warn_deprecated))
cpp_warning (pfile, CPP_W_DEPRECATED,
"#%s is a deprecated GCC extension", dir->name);
}
/* Traditionally, a directive is ignored unless its # is in
column 1. Therefore in code intended to work with K+R
compilers, directives added by C89 must have their #
indented, and directives present in traditional C must not.
This is true even of directives in skipped conditional
blocks. #elif cannot be used at all. */
if (CPP_WTRADITIONAL (pfile))
{
if (dir == &dtable[T_ELIF])
cpp_warning (pfile, CPP_W_TRADITIONAL,
"suggest not using #elif in traditional C");
else if (indented && dir->origin == KANDR)
cpp_warning (pfile, CPP_W_TRADITIONAL,
"traditional C ignores #%s with the # indented",
dir->name);
else if (!indented && dir->origin != KANDR)
cpp_warning (pfile, CPP_W_TRADITIONAL,
"suggest hiding #%s from traditional C with an indented #",
dir->name);
}
}
/* Check if we have a known directive. INDENTED is true if the
'#' of the directive was indented. This function is in this file
to save unnecessarily exporting dtable etc. to lex.cc. Returns
nonzero if the line of tokens has been handled, zero if we should
continue processing the line. */
int
_cpp_handle_directive (cpp_reader *pfile, bool indented)
{
const directive *dir = 0;
const cpp_token *dname;
bool was_parsing_args = pfile->state.parsing_args;
bool was_discarding_output = pfile->state.discarding_output;
int skip = 1;
if (was_discarding_output)
pfile->state.prevent_expansion = 0;
if (was_parsing_args)
{
if (CPP_OPTION (pfile, cpp_pedantic))
cpp_error (pfile, CPP_DL_PEDWARN,
"embedding a directive within macro arguments is not portable");
pfile->state.parsing_args = 0;
pfile->state.prevent_expansion = 0;
}
start_directive (pfile);
dname = _cpp_lex_token (pfile);
if (dname->type == CPP_NAME)
{
if (dname->val.node.node->is_directive)
{
dir = &dtable[dname->val.node.node->directive_index];
if ((dir->flags & ELIFDEF)
&& !CPP_OPTION (pfile, elifdef)
/* For -std=gnu* modes elifdef is supported with
a pedwarn if pedantic. */
&& CPP_OPTION (pfile, std))
dir = 0;
}
}
/* We do not recognize the # followed by a number extension in
assembler code. */
else if (dname->type == CPP_NUMBER && CPP_OPTION (pfile, lang) != CLK_ASM)
{
dir = &linemarker_dir;
if (CPP_PEDANTIC (pfile) && ! CPP_OPTION (pfile, preprocessed)
&& ! pfile->state.skipping)
cpp_error (pfile, CPP_DL_PEDWARN,
"style of line directive is a GCC extension");
}
if (dir)
{
/* If we have a directive that is not an opening conditional,
invalidate any control macro. */
if (! (dir->flags & IF_COND))
pfile->mi_valid = false;
/* Kluge alert. In order to be sure that code like this
#define HASH #
HASH define foo bar
does not cause '#define foo bar' to get executed when
compiled with -save-temps, we recognize directives in
-fpreprocessed mode only if the # is in column 1. macro.cc
puts a space in front of any '#' at the start of a macro.
We exclude the -fdirectives-only case because macro expansion
has not been performed yet, and block comments can cause spaces
to precede the directive. */
if (CPP_OPTION (pfile, preprocessed)
&& !CPP_OPTION (pfile, directives_only)
&& (indented || !(dir->flags & IN_I)))
{
skip = 0;
dir = 0;
}
else
{
/* In failed conditional groups, all non-conditional
directives are ignored. Before doing that, whether
skipping or not, we should lex angle-bracketed headers
correctly, and maybe output some diagnostics. */
pfile->state.angled_headers = dir->flags & INCL;
pfile->state.directive_wants_padding = dir->flags & INCL;
if (! CPP_OPTION (pfile, preprocessed))
directive_diagnostics (pfile, dir, indented);
if (pfile->state.skipping && !(dir->flags & COND))
dir = 0;
}
}
else if (dname->type == CPP_EOF)
; /* CPP_EOF is the "null directive". */
else
{
/* An unknown directive. Don't complain about it in assembly
source: we don't know where the comments are, and # may
introduce assembler pseudo-ops. Don't complain about invalid
directives in skipped conditional groups (6.10 p4). */
if (CPP_OPTION (pfile, lang) == CLK_ASM)
skip = 0;
else if (!pfile->state.skipping)
{
const char *unrecognized
= (const char *)cpp_token_as_text (pfile, dname);
const char *hint = NULL;
/* Call back into gcc to get a spelling suggestion. Ideally
we'd just use best_match from gcc/spellcheck.h (and filter
out the uncommon directives), but that requires moving it
to a support library. */
if (pfile->cb.get_suggestion)
hint = pfile->cb.get_suggestion (pfile, unrecognized,
directive_names);
if (hint)
{
rich_location richloc (pfile->line_table, dname->src_loc);
source_range misspelled_token_range
= get_range_from_loc (pfile->line_table, dname->src_loc);
richloc.add_fixit_replace (misspelled_token_range, hint);
cpp_error_at (pfile, CPP_DL_ERROR, &richloc,
"invalid preprocessing directive #%s;"
" did you mean #%s?",
unrecognized, hint);
}
else
cpp_error (pfile, CPP_DL_ERROR,
"invalid preprocessing directive #%s",
unrecognized);
}
}
pfile->directive = dir;
if (CPP_OPTION (pfile, traditional))
prepare_directive_trad (pfile);
if (dir)
{
pfile->directive->handler (pfile);
if (pfile->directive == &dtable[T_EMBED]
&& skip
&& CPP_OPTION (pfile, directives_only))
/* Signal to cpp_directive_only_process it needs to emit
the #embed expansion. */
skip = 2;
}
else if (skip == 0)
_cpp_backup_tokens (pfile, 1);
end_directive (pfile, skip);
if (was_parsing_args && !pfile->state.in_deferred_pragma)
{
/* Restore state when within macro args. */
pfile->state.parsing_args = 2;
pfile->state.prevent_expansion = 1;
}
if (was_discarding_output)
pfile->state.prevent_expansion = 1;
return skip;
}
/* Directive handler wrapper used by the command line option
processor. BUF is \n terminated. */
static void
run_directive (cpp_reader *pfile, int dir_no, const char *buf, size_t count)
{
cpp_push_buffer (pfile, (const uchar *) buf, count,
/* from_stage3 */ true);
start_directive (pfile);
/* This is a short-term fix to prevent a leading '#' being
interpreted as a directive. */
_cpp_clean_line (pfile);
pfile->directive = &dtable[dir_no];
if (CPP_OPTION (pfile, traditional))
prepare_directive_trad (pfile);
pfile->directive->handler (pfile);
end_directive (pfile, 1);
_cpp_pop_buffer (pfile);
}
/* Checks for validity the macro name in #define, #undef, #ifdef and
#ifndef directives. IS_DEF_OR_UNDEF is true if this call is
processing a #define or #undefine directive, and false
otherwise. */
static cpp_hashnode *
lex_macro_node (cpp_reader *pfile, bool is_def_or_undef)
{
const cpp_token *token = _cpp_lex_token (pfile);
/* The token immediately after #define must be an identifier. That
identifier may not be "defined", per C99 6.10.8p4.
In C++, it may not be any of the "named operators" either,
per C++98 [lex.digraph], [lex.key].
Finally, the identifier may not have been poisoned. (In that case
the lexer has issued the error message for us.) */
if (token->type == CPP_NAME)
{
cpp_hashnode *node = token->val.node.node;
if (is_def_or_undef
&& node == pfile->spec_nodes.n_defined)
cpp_error (pfile, CPP_DL_ERROR,
"\"%s\" cannot be used as a macro name",
NODE_NAME (node));
else if (! (node->flags & NODE_POISONED))
return node;
}
else if (token->flags & NAMED_OP)
cpp_error (pfile, CPP_DL_ERROR,
"\"%s\" cannot be used as a macro name as it is an operator in C++",
NODE_NAME (token->val.node.node));
else if (token->type == CPP_EOF)
cpp_error (pfile, CPP_DL_ERROR, "no macro name given in #%s directive",
pfile->directive->name);
else
cpp_error (pfile, CPP_DL_ERROR, "macro names must be identifiers");
return NULL;
}
/* Process a #define directive. Most work is done in macro.cc. */
static void
do_define (cpp_reader *pfile)
{
cpp_hashnode *node = lex_macro_node (pfile, true);
if (node)
{
/* This is a better location than pfile->directive_line to store
as the macro location. */
const location_t name_loc = cpp_diagnostic_get_current_location (pfile);
/* If we have been requested to expand comments into macros,
then re-enable saving of comments. */
pfile->state.save_comments =
! CPP_OPTION (pfile, discard_comments_in_macro_exp);
if (pfile->cb.before_define)
pfile->cb.before_define (pfile);
if (_cpp_create_definition (pfile, node, name_loc))
if (pfile->cb.define)
pfile->cb.define (pfile, pfile->directive_line, node);
node->flags &= ~NODE_USED;
}
}
/* Handle #undef. Mark the identifier NT_VOID in the hash table. */
static void
do_undef (cpp_reader *pfile)
{
cpp_hashnode *node = lex_macro_node (pfile, true);
if (node)
{
if (pfile->cb.before_define)
pfile->cb.before_define (pfile);
if (pfile->cb.undef)
pfile->cb.undef (pfile, pfile->directive_line, node);
/* 6.10.3.5 paragraph 2: [#undef] is ignored if the specified
identifier is not currently defined as a macro name. */
if (cpp_macro_p (node))
{
if (node->flags & NODE_WARN)
cpp_error (pfile, CPP_DL_WARNING,
"undefining \"%s\"", NODE_NAME (node));
else if (cpp_builtin_macro_p (node)
&& CPP_OPTION (pfile, warn_builtin_macro_redefined))
cpp_warning (pfile, CPP_W_BUILTIN_MACRO_REDEFINED,
"undefining \"%s\"", NODE_NAME (node));
if (node->value.macro
&& CPP_OPTION (pfile, warn_unused_macros))
_cpp_warn_if_unused_macro (pfile, node, NULL);
_cpp_free_definition (node);
}
}
check_eol (pfile, false);
}
/* Undefine a single macro/assertion/whatever. */
static int
undefine_macros (cpp_reader *pfile ATTRIBUTE_UNUSED, cpp_hashnode *h,
void *data_p ATTRIBUTE_UNUSED)
{
/* Body of _cpp_free_definition inlined here for speed.
Macros and assertions no longer have anything to free. */
h->type = NT_VOID;
h->value.answers = NULL;
h->flags &= ~(NODE_POISONED|NODE_DISABLED|NODE_USED);
return 1;
}
/* Undefine all macros and assertions. */
void
cpp_undef_all (cpp_reader *pfile)
{
cpp_forall_identifiers (pfile, undefine_macros, NULL);
}
/* Helper routine used by parse_include. Reinterpret the current line
as an h-char-sequence (< ... >); we are looking at the first token
after the <. Returns a malloced filename. */
static char *
glue_header_name (cpp_reader *pfile)
{
const cpp_token *token;
char *buffer;
size_t len, total_len = 0, capacity = 1024;
/* To avoid lexed tokens overwriting our glued name, we can only
allocate from the string pool once we've lexed everything. */
buffer = XNEWVEC (char, capacity);
for (;;)
{
token = get_token_no_padding (pfile);
if (token->type == CPP_GREATER)
break;
if (token->type == CPP_EOF)
{
cpp_error (pfile, CPP_DL_ERROR, "missing terminating > character");
break;
}
len = cpp_token_len (token) + 2; /* Leading space, terminating \0. */
if (total_len + len > capacity)
{
capacity = (capacity + len) * 2;
buffer = XRESIZEVEC (char, buffer, capacity);
}
if (token->flags & PREV_WHITE)
buffer[total_len++] = ' ';
total_len = (cpp_spell_token (pfile, token, (uchar *) &buffer[total_len],
true)
- (uchar *) buffer);
}
buffer[total_len] = '\0';
return buffer;
}
/* Returns the file name of #include, #include_next, #import and
#pragma dependency. The string is malloced and the caller should
free it. Returns NULL on error. LOCATION is the source location
of the file name. */
static const char *
parse_include (cpp_reader *pfile, int *pangle_brackets,
const cpp_token ***buf, location_t *location)
{
char *fname;
const cpp_token *header;
/* Allow macro expansion. */
header = get_token_no_padding (pfile);
*location = header->src_loc;
if ((header->type == CPP_STRING && header->val.str.text[0] != 'R')
|| header->type == CPP_HEADER_NAME)
{
fname = XNEWVEC (char, header->val.str.len - 1);
memcpy (fname, header->val.str.text + 1, header->val.str.len - 2);
fname[header->val.str.len - 2] = '\0';
*pangle_brackets = header->type == CPP_HEADER_NAME;
}
else if (header->type == CPP_LESS)
{
fname = glue_header_name (pfile);
*pangle_brackets = 1;
}
else
{
const unsigned char *dir;
if (pfile->directive == &dtable[T_PRAGMA])
dir = UC"pragma dependency";
else
dir = pfile->directive->name;
cpp_error (pfile, CPP_DL_ERROR, "#%s expects \"FILENAME\" or <FILENAME>",
dir);
return NULL;
}
if (pfile->directive == &dtable[T_PRAGMA]
|| pfile->directive == &dtable[T_EMBED])
{
/* This pragma or #embed allows extra tokens after the file name. */
}
else if (buf == NULL || CPP_OPTION (pfile, discard_comments))
check_eol (pfile, true);
else
{
/* If we are not discarding comments, then gather them while
doing the eol check. */
*buf = check_eol_return_comments (pfile);
}
return fname;
}
/* Handle #include, #include_next and #import. */
static void
do_include_common (cpp_reader *pfile, enum include_type type)
{
const char *fname;
int angle_brackets;
const cpp_token **buf = NULL;
location_t location;
/* Re-enable saving of comments if requested, so that the include
callback can dump comments which follow #include. */
pfile->state.save_comments = ! CPP_OPTION (pfile, discard_comments);
/* Tell the lexer this is an include directive -- we want it to
increment the line number even if this is the last line of a file. */
pfile->state.in_directive = 2;
fname = parse_include (pfile, &angle_brackets, &buf, &location);
if (!fname)
goto done;
if (!*fname)
{
cpp_error_with_line (pfile, CPP_DL_ERROR, location, 0,
"empty filename in #%s",
pfile->directive->name);
goto done;
}
/* Prevent #include recursion. */
if (pfile->line_table->depth >= CPP_OPTION (pfile, max_include_depth))
cpp_error (pfile,
CPP_DL_ERROR,
"#include nested depth %u exceeds maximum of %u"
" (use -fmax-include-depth=DEPTH to increase the maximum)",
pfile->line_table->depth,
CPP_OPTION (pfile, max_include_depth));
else
{
/* Get out of macro context, if we are. */
skip_rest_of_line (pfile);
if (pfile->cb.include)
pfile->cb.include (pfile, pfile->directive_line,
pfile->directive->name, fname, angle_brackets,
buf);
_cpp_stack_include (pfile, fname, angle_brackets, type, location);
}
done:
XDELETEVEC (fname);
if (buf)
XDELETEVEC (buf);
}
static void
do_include (cpp_reader *pfile)
{
do_include_common (pfile, IT_INCLUDE);
}
static void
do_import (cpp_reader *pfile)
{
do_include_common (pfile, IT_IMPORT);
}
static void
do_include_next (cpp_reader *pfile)
{
enum include_type type = IT_INCLUDE_NEXT;
/* If this is the primary source file, warn and use the normal
search logic. */
if (_cpp_in_main_source_file (pfile))
{
cpp_error (pfile, CPP_DL_WARNING,
"#include_next in primary source file");
type = IT_INCLUDE;
}
do_include_common (pfile, type);
}
/* Skip over balanced preprocessing tokens until END is found.
If SAVE is non-NULL, remember the parsed tokens in it. NESTED is
false in the outermost invocation of the function and true
when called recursively. */
static void
skip_balanced_token_seq (cpp_reader *pfile, cpp_ttype end,
cpp_embed_params_tokens *save, bool nested)
{
do
{
const cpp_token *token = cpp_peek_token (pfile, 0);
if (token->type == CPP_EOF)
{
char c = 0;
switch (end)
{
case CPP_CLOSE_PAREN: c = '('; break;
case CPP_CLOSE_SQUARE: c = '['; break;
case CPP_CLOSE_BRACE: c = '{'; break;
default: abort ();
}
cpp_error (pfile, CPP_DL_ERROR, "unbalanced '%c'", c);
return;
}
token = cpp_get_token (pfile);
if (save
&& (token->type != CPP_PADDING || save->count)
&& (token->type != end || nested))
{
if (save->count == 0)
{
_cpp_init_tokenrun (&save->base_run, 4);
save->cur_run = &save->base_run;
save->cur_token = save->base_run.base;
}
else if (save->cur_token == save->cur_run->limit)
{
save->cur_run->next = XNEW (tokenrun);
save->cur_run->next->prev = save->cur_run;
_cpp_init_tokenrun (save->cur_run->next, 4);
save->cur_run = save->cur_run->next;
save->cur_token = save->cur_run->base;
}
*save->cur_token = *token;
save->cur_token->flags |= NO_EXPAND;
save->cur_token++;
save->count++;
}
if (token->type == end)
return;
switch (token->type)
{
case CPP_OPEN_PAREN:
skip_balanced_token_seq (pfile, CPP_CLOSE_PAREN, save, true);
break;
case CPP_OPEN_SQUARE:
skip_balanced_token_seq (pfile, CPP_CLOSE_SQUARE, save, true);
break;
case CPP_OPEN_BRACE:
skip_balanced_token_seq (pfile, CPP_CLOSE_BRACE, save, true);
break;
case CPP_CLOSE_PAREN:
cpp_error (pfile, CPP_DL_ERROR, "unbalanced '%c'", ')');
break;
case CPP_CLOSE_SQUARE:
cpp_error (pfile, CPP_DL_ERROR, "unbalanced '%c'", ']');
break;
case CPP_CLOSE_BRACE:
cpp_error (pfile, CPP_DL_ERROR, "unbalanced '%c'", '}');
break;
default:
break;
}
}
while (1);
}
#define EMBED_PARAMS \
EMBED_PARAM (LIMIT, "limit") \
EMBED_PARAM (PREFIX, "prefix") \
EMBED_PARAM (SUFFIX, "suffix") \
EMBED_PARAM (IF_EMPTY, "if_empty")
enum embed_param_kind {
#define EMBED_PARAM(c, s) EMBED_PARAM_##c,
EMBED_PARAMS
#undef EMBED_PARAM
NUM_EMBED_PARAMS
};
static struct { int len; const char *name; } embed_params[NUM_EMBED_PARAMS] = {
#define EMBED_PARAM(c, s) { sizeof (s) - 1, s },
EMBED_PARAMS
#undef EMBED_PARAM
};
/* Parse parameters of #embed directive or __has_embed expression.
Fills in details about parsed parameters in *PARAMS.
Returns true if all the parameters have been successfully parsed,
false on errors. */
bool
_cpp_parse_embed_params (cpp_reader *pfile, struct cpp_embed_params *params)
{
const cpp_token *token = _cpp_get_token_no_padding (pfile);
bool ret = true;
int seen = 0;
params->limit = -1;
do
{
const unsigned char *param_name = NULL;
const unsigned char *param_prefix = NULL;
int param_name_len = 0, param_prefix_len = 0;
bool has_scope = false;
if (token->type != CPP_NAME)
{
if (token->type == CPP_EOF)
{
if (params->has_embed)
{
cpp_error (pfile, CPP_DL_ERROR, "expected ')'");
return false;
}
return ret;
}
else if (token->type == CPP_CLOSE_PAREN && params->has_embed)
return ret;
cpp_error (pfile, CPP_DL_ERROR, "expected parameter name");
return false;
}
param_name = NODE_NAME (token->val.node.spelling);
param_name_len = NODE_LEN (token->val.node.spelling);
location_t loc = token->src_loc;
token = _cpp_get_token_no_padding (pfile);
if (token->type == CPP_SCOPE)
{
has_scope = true;
token = _cpp_get_token_no_padding (pfile);
}
else if (token->type == CPP_COLON
&& (token->flags & COLON_SCOPE) != 0)
{
has_scope = true;
token = _cpp_get_token_no_padding (pfile);
if (token->type != CPP_COLON)
{
cpp_error (pfile, CPP_DL_ERROR, "expected ':'");
return false;
}
token = _cpp_get_token_no_padding (pfile);
}
if (has_scope)
{
if (token->type != CPP_NAME)
{
cpp_error (pfile, CPP_DL_ERROR, "expected parameter name");
return false;
}
param_prefix = param_name;
param_prefix_len = param_name_len;
param_name = NODE_NAME (token->val.node.spelling);
param_name_len = NODE_LEN (token->val.node.spelling);
loc = token->src_loc;
token = _cpp_get_token_no_padding (pfile);
}
if (param_name_len > 4
&& param_name[0] == '_'
&& param_name[1] == '_'
&& param_name[param_name_len - 1] == '_'
&& param_name[param_name_len - 2] == '_')
{
param_name += 2;
param_name_len -= 4;
}
if (param_prefix
&& param_prefix_len > 4
&& param_prefix[0] == '_'
&& param_prefix[1] == '_'
&& param_prefix[param_prefix_len - 1] == '_'
&& param_prefix[param_prefix_len - 2] == '_')
{
param_prefix += 2;
param_prefix_len -= 4;
}
size_t param_kind = -1;
if (param_prefix == NULL)
{
for (size_t i = 0; i < NUM_EMBED_PARAMS; ++i)
if (param_name_len == embed_params[i].len
&& memcmp (param_name, embed_params[i].name,
param_name_len) == 0)
{
param_kind = i;
break;
}
}
if (param_kind != (size_t) -1)
{
if ((seen & (1 << param_kind)) == 0)
seen |= 1 << param_kind;
else
cpp_error_with_line (pfile, CPP_DL_ERROR, loc, 0,
"duplicate embed parameter '%.*s%s%.*s'",
param_prefix_len,
param_prefix
? (const char *) param_prefix : "",
param_prefix ? "::" : "",
param_name_len, param_name);
}
else
{
ret = false;
if (!params->has_embed)
cpp_error_with_line (pfile, CPP_DL_ERROR, loc, 0,
"unknown embed parameter '%.*s%s%.*s'",
param_prefix_len,
param_prefix
? (const char *) param_prefix : "",
param_prefix ? "::" : "",
param_name_len, param_name);
}
if (param_kind != (size_t) -1 && token->type != CPP_OPEN_PAREN)
cpp_error_with_line (pfile, CPP_DL_ERROR, loc, 0,
"expected '('");
else if (param_kind == EMBED_PARAM_LIMIT)
{
if (params->has_embed && pfile->op_stack == NULL)
_cpp_expand_op_stack (pfile);
params->limit = _cpp_parse_expr (pfile, "#embed", token);
token = _cpp_get_token_no_padding (pfile);
}
else if (token->type == CPP_OPEN_PAREN)
{
cpp_embed_params_tokens *save = NULL;
auto save_comments = pfile->state.save_comments;
switch (param_kind)
{
case EMBED_PARAM_PREFIX: save = &params->prefix; break;
case EMBED_PARAM_SUFFIX: save = &params->suffix; break;
case EMBED_PARAM_IF_EMPTY: save = &params->if_empty; break;
default: break;
}
if (params->has_embed)
save = NULL;
else if (save)
pfile->state.save_comments = !CPP_OPTION (pfile, discard_comments);
skip_balanced_token_seq (pfile, CPP_CLOSE_PAREN, save, false);
pfile->state.save_comments = save_comments;
token = _cpp_get_token_no_padding (pfile);
}
}
while (1);
}
/* Handle #embed directive. */
static void
do_embed (cpp_reader *pfile)
{
int angle_brackets;
struct cpp_embed_params params = {};
bool ok;
const char *fname = NULL;
/* Tell the lexer this is an embed directive. */
pfile->state.in_directive = 3;
if (CPP_OPTION (pfile, traditional))
{
cpp_error (pfile, CPP_DL_ERROR, /* FIXME should be DL_SORRY */
"#embed not supported in traditional C");
skip_rest_of_line (pfile);
goto done;
}
if (CPP_PEDANTIC (pfile) && !CPP_OPTION (pfile, embed))
{
if (CPP_OPTION (pfile, cplusplus))
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s is a GCC extension", "embed");
else
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C23 is a GCC extension", "embed");
}
fname = parse_include (pfile, &angle_brackets, NULL, &params.loc);
if (!fname)
{
skip_rest_of_line (pfile);
goto done;
}
if (!*fname)
{
cpp_error_with_line (pfile, CPP_DL_ERROR, params.loc, 0,
"empty filename in #%s",
pfile->directive->name);
skip_rest_of_line (pfile);
goto done;
}
pfile->state.angled_headers = false;
pfile->state.directive_wants_padding = false;
ok = _cpp_parse_embed_params (pfile, &params);
/* Get out of macro context, if we are. */
skip_rest_of_line (pfile);
if (ok)
_cpp_stack_embed (pfile, fname, angle_brackets, &params);
for (int i = 0; i < 3; ++i)
{
cpp_embed_params_tokens *p;
if (i == 0)
p = &params.prefix;
else if (i == 1)
p = &params.suffix;
else
p = &params.if_empty;
if (p->count == 0)
continue;
tokenrun *n;
for (tokenrun *t = &p->base_run; t; t = n)
{
n = t->next;
XDELETEVEC (t->base);
if (t != &p->base_run)
XDELETE (t);
}
}
done:
XDELETEVEC (fname);
}
/* Subroutine of do_linemarker. Read possible flags after file name.
LAST is the last flag seen; 0 if this is the first flag. Return the
flag if it is valid, 0 at the end of the directive. Otherwise
complain. */
static unsigned int
read_flag (cpp_reader *pfile, unsigned int last)
{
const cpp_token *token = _cpp_lex_token (pfile);
if (token->type == CPP_NUMBER && token->val.str.len == 1)
{
unsigned int flag = token->val.str.text[0] - '0';
if (flag > last && flag <= 4
&& (flag != 4 || last == 3)
&& (flag != 2 || last == 0))
return flag;
}
if (token->type != CPP_EOF)
cpp_error (pfile, CPP_DL_ERROR, "invalid flag \"%s\" in line directive",
cpp_token_as_text (pfile, token));
return 0;
}
/* Subroutine of do_line and do_linemarker. Convert a number in STR,
of length LEN, to binary; store it in NUMP, and return false if the
number was well-formed, true if not. WRAPPED is set to true if the
number did not fit into 'linenum_type'. */
static bool
strtolinenum (const uchar *str, size_t len, linenum_type *nump, bool *wrapped)
{
linenum_type reg = 0;
uchar c;
bool seen_digit_sep = false;
*wrapped = false;
while (len--)
{
c = *str++;
if (!seen_digit_sep && c == '\'' && len)
{
seen_digit_sep = true;
continue;
}
if (!ISDIGIT (c))
return true;
seen_digit_sep = false;
if (reg > ((linenum_type) -1) / 10)
*wrapped = true;
reg *= 10;
if (reg > ((linenum_type) -1) - (c - '0'))
*wrapped = true;
reg += c - '0';
}
*nump = reg;
return false;
}
/* Interpret #line command.
Note that the filename string (if any) is a true string constant
(escapes are interpreted). */
static void
do_line (cpp_reader *pfile)
{
class line_maps *line_table = pfile->line_table;
const line_map_ordinary *map = LINEMAPS_LAST_ORDINARY_MAP (line_table);
/* skip_rest_of_line() may cause line table to be realloc()ed so note down
sysp right now. */
unsigned char map_sysp = ORDINARY_MAP_IN_SYSTEM_HEADER_P (map);
const cpp_token *token;
const char *new_file = ORDINARY_MAP_FILE_NAME (map);
linenum_type new_lineno;
/* C99 raised the minimum limit on #line numbers. */
linenum_type cap = CPP_OPTION (pfile, c99) ? 2147483647 : 32767;
bool wrapped;
/* #line commands expand macros. */
token = cpp_get_token (pfile);
if (token->type != CPP_NUMBER
|| strtolinenum (token->val.str.text, token->val.str.len,
&new_lineno, &wrapped))
{
if (token->type == CPP_EOF)
cpp_error (pfile, CPP_DL_ERROR, "unexpected end of file after #line");
else
cpp_error (pfile, CPP_DL_ERROR,
"\"%s\" after #line is not a positive integer",
cpp_token_as_text (pfile, token));
return;
}
if (CPP_PEDANTIC (pfile) && (new_lineno == 0 || new_lineno > cap || wrapped))
cpp_error (pfile, CPP_DL_PEDWARN, "line number out of range");
else if (wrapped)
cpp_error (pfile, CPP_DL_WARNING, "line number out of range");
token = cpp_get_token (pfile);
if (token->type == CPP_STRING)
{
cpp_string s = { 0, 0 };
if (cpp_interpret_string_notranslate (pfile, &token->val.str, 1,
&s, CPP_STRING))
new_file = (const char *)s.text;
check_eol (pfile, true);
}
else if (token->type != CPP_EOF)
{
cpp_error (pfile, CPP_DL_ERROR, "\"%s\" is not a valid filename",
cpp_token_as_text (pfile, token));
return;
}
skip_rest_of_line (pfile);
_cpp_do_file_change (pfile, LC_RENAME_VERBATIM, new_file, new_lineno,
map_sysp);
line_table->seen_line_directive = true;
}
/* Interpret the # 44 "file" [flags] notation, which has slightly
different syntax and semantics from #line: Flags are allowed,
and we never complain about the line number being too big. */
static void
do_linemarker (cpp_reader *pfile)
{
class line_maps *line_table = pfile->line_table;
const line_map_ordinary *map = LINEMAPS_LAST_ORDINARY_MAP (line_table);
const cpp_token *token;
const char *new_file = ORDINARY_MAP_FILE_NAME (map);
linenum_type new_lineno;
unsigned int new_sysp = ORDINARY_MAP_IN_SYSTEM_HEADER_P (map);
enum lc_reason reason = LC_RENAME_VERBATIM;
int flag;
bool wrapped;
/* Back up so we can get the number again. Putting this in
_cpp_handle_directive risks two calls to _cpp_backup_tokens in
some circumstances, which can segfault. */
_cpp_backup_tokens (pfile, 1);
/* #line commands expand macros. */
token = cpp_get_token (pfile);
if (token->type != CPP_NUMBER
|| strtolinenum (token->val.str.text, token->val.str.len,
&new_lineno, &wrapped))
{
/* Unlike #line, there does not seem to be a way to get an EOF
here. So, it should be safe to always spell the token. */
cpp_error (pfile, CPP_DL_ERROR,
"\"%s\" after # is not a positive integer",
cpp_token_as_text (pfile, token));
return;
}
token = cpp_get_token (pfile);
if (token->type == CPP_STRING)
{
cpp_string s = { 0, 0 };
if (cpp_interpret_string_notranslate (pfile, &token->val.str,
1, &s, CPP_STRING))
new_file = (const char *)s.text;
new_sysp = 0;
flag = read_flag (pfile, 0);
if (flag == 1)
{
reason = LC_ENTER;
/* Fake an include for cpp_included (). */
_cpp_fake_include (pfile, new_file);
flag = read_flag (pfile, flag);
}
else if (flag == 2)
{
reason = LC_LEAVE;
flag = read_flag (pfile, flag);
}
if (flag == 3)
{
new_sysp = 1;
flag = read_flag (pfile, flag);
if (flag == 4)
new_sysp = 2;
}
pfile->buffer->sysp = new_sysp;
check_eol (pfile, false);
}
else if (token->type != CPP_EOF)
{
cpp_error (pfile, CPP_DL_ERROR, "\"%s\" is not a valid filename",
cpp_token_as_text (pfile, token));
return;
}
skip_rest_of_line (pfile);
if (reason == LC_LEAVE)
{
/* Reread map since cpp_get_token can invalidate it with a
reallocation. */
map = LINEMAPS_LAST_ORDINARY_MAP (line_table);
const line_map_ordinary *from
= linemap_included_from_linemap (line_table, map);
if (!from)
/* Not nested. */;
else if (!new_file[0])
/* Leaving to "" means fill in the popped-to name. */
new_file = ORDINARY_MAP_FILE_NAME (from);
else if (filename_cmp (ORDINARY_MAP_FILE_NAME (from), new_file) != 0)
/* It's the wrong name, Grommit! */
from = NULL;
if (!from)
{
cpp_warning (pfile, CPP_W_NONE,
"file \"%s\" linemarker ignored due to "
"incorrect nesting", new_file);
return;
}
}
/* Compensate for the increment in linemap_add that occurs in
_cpp_do_file_change. We're currently at the start of the line
*following* the #line directive. A separate location_t for this
location makes no sense (until we do the LC_LEAVE), and
complicates LAST_SOURCE_LINE_LOCATION. */
pfile->line_table->highest_location--;
_cpp_do_file_change (pfile, reason, new_file, new_lineno, new_sysp);
line_table->seen_line_directive = true;
}
/* Arrange the file_change callback. Changing to TO_FILE:TO_LINE for
REASON. SYSP is 1 for a system header, 2 for a system header that
needs to be extern "C" protected, and zero otherwise. */
void
_cpp_do_file_change (cpp_reader *pfile, enum lc_reason reason,
const char *to_file, linenum_type to_line,
unsigned int sysp)
{
linemap_assert (reason != LC_ENTER_MACRO);
const line_map_ordinary *ord_map = NULL;
if (!to_line && reason == LC_RENAME_VERBATIM)
{
/* A linemarker moving to line zero. If we're on the second
line of the current map, and it also starts at zero, just
rewind -- we're probably reading the builtins of a
preprocessed source. */
line_map_ordinary *last = LINEMAPS_LAST_ORDINARY_MAP (pfile->line_table);
if (!ORDINARY_MAP_STARTING_LINE_NUMBER (last)
&& 0 == filename_cmp (to_file, ORDINARY_MAP_FILE_NAME (last))
&& SOURCE_LINE (last, pfile->line_table->highest_line) == 2)
{
ord_map = last;
pfile->line_table->highest_location
= pfile->line_table->highest_line = MAP_START_LOCATION (last);
}
}
if (!ord_map)
if (const line_map *map = linemap_add (pfile->line_table, reason, sysp,
to_file, to_line))
{
ord_map = linemap_check_ordinary (map);
linemap_line_start (pfile->line_table,
ORDINARY_MAP_STARTING_LINE_NUMBER (ord_map),
127);
}
if (pfile->cb.file_change)
pfile->cb.file_change (pfile, ord_map);
}
/* Report a warning or error detected by the program we are
processing. Use the directive's tokens in the error message. */
static void
do_diagnostic (cpp_reader *pfile, enum cpp_diagnostic_level code,
enum cpp_warning_reason reason, int print_dir)
{
const unsigned char *dir_name;
unsigned char *line;
location_t src_loc = pfile->cur_token[-1].src_loc;
if (print_dir)
dir_name = pfile->directive->name;
else
dir_name = NULL;
pfile->state.prevent_expansion++;
line = cpp_output_line_to_string (pfile, dir_name);
pfile->state.prevent_expansion--;
if (code == CPP_DL_WARNING_SYSHDR && reason)
cpp_warning_with_line_syshdr (pfile, reason, src_loc, 0, "%s", line);
else if (code == CPP_DL_WARNING && reason)
cpp_warning_with_line (pfile, reason, src_loc, 0, "%s", line);
else
cpp_error_with_line (pfile, code, src_loc, 0, "%s", line);
free (line);
}
static void
do_error (cpp_reader *pfile)
{
do_diagnostic (pfile, CPP_DL_ERROR, CPP_W_NONE, 1);
}
static void
do_warning (cpp_reader *pfile)
{
/* We want #warning diagnostics to be emitted in system headers too. */
do_diagnostic (pfile, CPP_DL_WARNING_SYSHDR, CPP_W_WARNING_DIRECTIVE, 1);
}
/* Report program identification. */
static void
do_ident (cpp_reader *pfile)
{
const cpp_token *str = cpp_get_token (pfile);
if (str->type != CPP_STRING)
cpp_error (pfile, CPP_DL_ERROR, "invalid #%s directive",
pfile->directive->name);
else if (pfile->cb.ident)
pfile->cb.ident (pfile, pfile->directive_line, &str->val.str);
check_eol (pfile, false);
}
/* Lookup a PRAGMA name in a singly-linked CHAIN. Returns the
matching entry, or NULL if none is found. The returned entry could
be the start of a namespace chain, or a pragma. */
static struct pragma_entry *
lookup_pragma_entry (struct pragma_entry *chain, const cpp_hashnode *pragma)
{
while (chain && chain->pragma != pragma)
chain = chain->next;
return chain;
}
/* Create and insert a blank pragma entry at the beginning of a
singly-linked CHAIN. */
static struct pragma_entry *
new_pragma_entry (cpp_reader *pfile, struct pragma_entry **chain)
{
struct pragma_entry *new_entry;
new_entry = (struct pragma_entry *)
_cpp_aligned_alloc (pfile, sizeof (struct pragma_entry));
memset (new_entry, 0, sizeof (struct pragma_entry));
new_entry->next = *chain;
*chain = new_entry;
return new_entry;
}
/* Register a pragma NAME in namespace SPACE. If SPACE is null, it
goes in the global namespace. */
static struct pragma_entry *
register_pragma_1 (cpp_reader *pfile, const char *space, const char *name,
bool allow_name_expansion)
{
struct pragma_entry **chain = &pfile->pragmas;
struct pragma_entry *entry;
const cpp_hashnode *node;
if (space)
{
node = cpp_lookup (pfile, UC space, strlen (space));
entry = lookup_pragma_entry (*chain, node);
if (!entry)
{
entry = new_pragma_entry (pfile, chain);
entry->pragma = node;
entry->is_nspace = true;
entry->allow_expansion = allow_name_expansion;
}
else if (!entry->is_nspace)
goto clash;
else if (entry->allow_expansion != allow_name_expansion)
{
cpp_error (pfile, CPP_DL_ICE,
"registering pragmas in namespace \"%s\" with mismatched "
"name expansion", space);
return NULL;
}
chain = &entry->u.space;
}
else if (allow_name_expansion)
{
cpp_error (pfile, CPP_DL_ICE,
"registering pragma \"%s\" with name expansion "
"and no namespace", name);
return NULL;
}
/* Check for duplicates. */
node = cpp_lookup (pfile, UC name, strlen (name));
entry = lookup_pragma_entry (*chain, node);
if (entry == NULL)
{
entry = new_pragma_entry (pfile, chain);
entry->pragma = node;
return entry;
}
if (entry->is_nspace)
clash:
cpp_error (pfile, CPP_DL_ICE,
"registering \"%s\" as both a pragma and a pragma namespace",
NODE_NAME (node));
else if (space)
cpp_error (pfile, CPP_DL_ICE, "#pragma %s %s is already registered",
space, name);
else
cpp_error (pfile, CPP_DL_ICE, "#pragma %s is already registered", name);
return NULL;
}
/* Register a cpplib internal pragma SPACE NAME with HANDLER. */
static void
register_pragma_internal (cpp_reader *pfile, const char *space,
const char *name, pragma_cb handler)
{
struct pragma_entry *entry;
entry = register_pragma_1 (pfile, space, name, false);
entry->is_internal = true;
entry->u.handler = handler;
}
/* Register a pragma NAME in namespace SPACE. If SPACE is null, it
goes in the global namespace. HANDLER is the handler it will call,
which must be non-NULL. If ALLOW_EXPANSION is set, allow macro
expansion while parsing pragma NAME. This function is exported
from libcpp. */
void
cpp_register_pragma (cpp_reader *pfile, const char *space, const char *name,
pragma_cb handler, bool allow_expansion)
{
struct pragma_entry *entry;
if (!handler)
{
cpp_error (pfile, CPP_DL_ICE, "registering pragma with NULL handler");
return;
}
entry = register_pragma_1 (pfile, space, name, false);
if (entry)
{
entry->allow_expansion = allow_expansion;
entry->u.handler = handler;
}
}
/* Similarly, but create mark the pragma for deferred processing.
When found, a CPP_PRAGMA token will be insertted into the stream
with IDENT in the token->u.pragma slot. */
void
cpp_register_deferred_pragma (cpp_reader *pfile, const char *space,
const char *name, unsigned int ident,
bool allow_expansion, bool allow_name_expansion)
{
struct pragma_entry *entry;
entry = register_pragma_1 (pfile, space, name, allow_name_expansion);
if (entry)
{
entry->is_deferred = true;
entry->allow_expansion = allow_expansion;
entry->u.ident = ident;
}
}
/* Register the pragmas the preprocessor itself handles. */
void
_cpp_init_internal_pragmas (cpp_reader *pfile)
{
/* Pragmas in the global namespace. */
register_pragma_internal (pfile, 0, "once", do_pragma_once);
register_pragma_internal (pfile, 0, "push_macro", do_pragma_push_macro);
register_pragma_internal (pfile, 0, "pop_macro", do_pragma_pop_macro);
/* New GCC-specific pragmas should be put in the GCC namespace. */
register_pragma_internal (pfile, "GCC", "poison", do_pragma_poison);
register_pragma_internal (pfile, "GCC", "system_header",
do_pragma_system_header);
register_pragma_internal (pfile, "GCC", "dependency", do_pragma_dependency);
register_pragma_internal (pfile, "GCC", "warning", do_pragma_warning);
register_pragma_internal (pfile, "GCC", "error", do_pragma_error);
}
/* Return the number of registered pragmas in PE. */
static int
count_registered_pragmas (struct pragma_entry *pe)
{
int ct = 0;
for (; pe != NULL; pe = pe->next)
{
if (pe->is_nspace)
ct += count_registered_pragmas (pe->u.space);
ct++;
}
return ct;
}
/* Save into SD the names of the registered pragmas referenced by PE,
and return a pointer to the next free space in SD. */
static char **
save_registered_pragmas (struct pragma_entry *pe, char **sd)
{
for (; pe != NULL; pe = pe->next)
{
if (pe->is_nspace)
sd = save_registered_pragmas (pe->u.space, sd);
*sd++ = (char *) xmemdup (HT_STR (&pe->pragma->ident),
HT_LEN (&pe->pragma->ident),
HT_LEN (&pe->pragma->ident) + 1);
}
return sd;
}
/* Return a newly-allocated array which saves the names of the
registered pragmas. */
char **
_cpp_save_pragma_names (cpp_reader *pfile)
{
int ct = count_registered_pragmas (pfile->pragmas);
char **result = XNEWVEC (char *, ct);
(void) save_registered_pragmas (pfile->pragmas, result);
return result;
}
/* Restore from SD the names of the registered pragmas referenced by PE,
and return a pointer to the next unused name in SD. */
static char **
restore_registered_pragmas (cpp_reader *pfile, struct pragma_entry *pe,
char **sd)
{
for (; pe != NULL; pe = pe->next)
{
if (pe->is_nspace)
sd = restore_registered_pragmas (pfile, pe->u.space, sd);
pe->pragma = cpp_lookup (pfile, UC *sd, strlen (*sd));
free (*sd);
sd++;
}
return sd;
}
/* Restore the names of the registered pragmas from SAVED. */
void
_cpp_restore_pragma_names (cpp_reader *pfile, char **saved)
{
(void) restore_registered_pragmas (pfile, pfile->pragmas, saved);
free (saved);
}
/* Pragmata handling. We handle some, and pass the rest on to the
front end. C99 defines three pragmas and says that no macro
expansion is to be performed on them; whether or not macro
expansion happens for other pragmas is implementation defined.
This implementation allows for a mix of both, since GCC did not
traditionally macro expand its (few) pragmas, whereas OpenMP
specifies that macro expansion should happen. */
static void
do_pragma (cpp_reader *pfile)
{
const struct pragma_entry *p = NULL;
const cpp_token *token, *pragma_token;
location_t pragma_token_virt_loc = 0;
cpp_token ns_token;
unsigned int count = 1;
pfile->state.prevent_expansion++;
pragma_token = token = cpp_get_token_with_location (pfile,
&pragma_token_virt_loc);
ns_token = *token;
if (token->type == CPP_NAME)
{
p = lookup_pragma_entry (pfile->pragmas, token->val.node.node);
if (p && p->is_nspace)
{
bool allow_name_expansion = p->allow_expansion;
if (allow_name_expansion)
pfile->state.prevent_expansion--;
token = cpp_get_token (pfile);
if (token->type == CPP_NAME)
p = lookup_pragma_entry (p->u.space, token->val.node.node);
else
p = NULL;
if (allow_name_expansion)
pfile->state.prevent_expansion++;
count = 2;
}
}
if (p)
{
if (p->is_deferred)
{
pfile->directive_result.src_loc = pragma_token_virt_loc;
pfile->directive_result.type = CPP_PRAGMA;
pfile->directive_result.flags = pragma_token->flags;
pfile->directive_result.val.pragma = p->u.ident;
pfile->state.in_deferred_pragma = true;
pfile->state.pragma_allow_expansion = p->allow_expansion;
if (!p->allow_expansion)
pfile->state.prevent_expansion++;
}
else
{
/* Since the handler below doesn't get the line number, that
it might need for diagnostics, make sure it has the right
numbers in place. */
if (pfile->cb.line_change)
(*pfile->cb.line_change) (pfile, pragma_token, false);
if (p->allow_expansion)
pfile->state.prevent_expansion--;
(*p->u.handler) (pfile);
if (p->allow_expansion)
pfile->state.prevent_expansion++;
}
}
else if (pfile->cb.def_pragma)
{
if (count == 1 || pfile->context->prev == NULL)
_cpp_backup_tokens (pfile, count);
else
{
/* Invalid name comes from macro expansion, _cpp_backup_tokens
won't allow backing 2 tokens. */
const auto tok_buff = _cpp_get_buff (pfile, 2 * sizeof (cpp_token));
const auto toks = (cpp_token *)tok_buff->base;
toks[0] = ns_token;
toks[0].flags |= NO_EXPAND;
toks[1] = *token;
toks[1].flags |= NO_EXPAND | PREV_WHITE;
_cpp_push_token_context (pfile, NULL, toks, 2);
/* Arrange to free this buffer when no longer needed. */
pfile->context->buff = tok_buff;
}
pfile->cb.def_pragma (pfile, pfile->directive_line);
}
pfile->state.prevent_expansion--;
}
/* Handle #pragma once. */
static void
do_pragma_once (cpp_reader *pfile)
{
if (_cpp_in_main_source_file (pfile))
cpp_error (pfile, CPP_DL_WARNING, "#pragma once in main file");
check_eol (pfile, false);
_cpp_mark_file_once_only (pfile, pfile->buffer->file);
}
/* Handle #pragma push_macro(STRING). */
static void
do_pragma_push_macro (cpp_reader *pfile)
{
cpp_hashnode *node;
size_t defnlen;
const uchar *defn = NULL;
char *macroname, *dest;
const char *limit, *src;
const cpp_token *txt;
struct def_pragma_macro *c;
txt = get__Pragma_string (pfile);
if (!txt)
{
location_t src_loc = pfile->cur_token[-1].src_loc;
cpp_error_with_line (pfile, CPP_DL_ERROR, src_loc, 0,
"invalid #pragma push_macro directive");
check_eol (pfile, false);
skip_rest_of_line (pfile);
return;
}
dest = macroname = (char *) alloca (txt->val.str.len + 2);
src = (const char *) (txt->val.str.text + 1 + (txt->val.str.text[0] == 'L'));
limit = (const char *) (txt->val.str.text + txt->val.str.len - 1);
while (src < limit)
{
/* We know there is a character following the backslash. */
if (*src == '\\' && (src[1] == '\\' || src[1] == '"'))
src++;
*dest++ = *src++;
}
*dest = 0;
check_eol (pfile, false);
skip_rest_of_line (pfile);
c = XNEW (struct def_pragma_macro);
memset (c, 0, sizeof (struct def_pragma_macro));
c->name = XNEWVAR (char, strlen (macroname) + 1);
strcpy (c->name, macroname);
c->next = pfile->pushed_macros;
node = _cpp_lex_identifier (pfile, c->name);
if (node->type == NT_VOID)
c->is_undef = 1;
else if (node->type == NT_BUILTIN_MACRO)
c->is_builtin = 1;
else
{
defn = cpp_macro_definition (pfile, node);
defnlen = ustrlen (defn);
c->definition = XNEWVEC (uchar, defnlen + 2);
c->definition[defnlen] = '\n';
c->definition[defnlen + 1] = 0;
c->line = node->value.macro->line;
c->syshdr = node->value.macro->syshdr;
c->used = node->value.macro->used;
memcpy (c->definition, defn, defnlen);
}
pfile->pushed_macros = c;
}
/* Handle #pragma pop_macro(STRING). */
static void
do_pragma_pop_macro (cpp_reader *pfile)
{
char *macroname, *dest;
const char *limit, *src;
const cpp_token *txt;
struct def_pragma_macro *l = NULL, *c = pfile->pushed_macros;
txt = get__Pragma_string (pfile);
if (!txt)
{
location_t src_loc = pfile->cur_token[-1].src_loc;
cpp_error_with_line (pfile, CPP_DL_ERROR, src_loc, 0,
"invalid #pragma pop_macro directive");
check_eol (pfile, false);
skip_rest_of_line (pfile);
return;
}
dest = macroname = (char *) alloca (txt->val.str.len + 2);
src = (const char *) (txt->val.str.text + 1 + (txt->val.str.text[0] == 'L'));
limit = (const char *) (txt->val.str.text + txt->val.str.len - 1);
while (src < limit)
{
/* We know there is a character following the backslash. */
if (*src == '\\' && (src[1] == '\\' || src[1] == '"'))
src++;
*dest++ = *src++;
}
*dest = 0;
check_eol (pfile, false);
skip_rest_of_line (pfile);
while (c != NULL)
{
if (!strcmp (c->name, macroname))
{
if (!l)
pfile->pushed_macros = c->next;
else
l->next = c->next;
cpp_pop_definition (pfile, c);
free (c->definition);
free (c->name);
free (c);
break;
}
l = c;
c = c->next;
}
}
/* Handle #pragma GCC poison, to poison one or more identifiers so
that the lexer produces a hard error for each subsequent usage. */
static void
do_pragma_poison (cpp_reader *pfile)
{
const cpp_token *tok;
cpp_hashnode *hp;
pfile->state.poisoned_ok = 1;
for (;;)
{
tok = _cpp_lex_token (pfile);
if (tok->type == CPP_EOF)
break;
if (tok->type != CPP_NAME)
{
cpp_error (pfile, CPP_DL_ERROR,
"invalid #pragma GCC poison directive");
break;
}
hp = tok->val.node.node;
if (hp->flags & NODE_POISONED)
continue;
if (cpp_macro_p (hp))
cpp_error (pfile, CPP_DL_WARNING, "poisoning existing macro \"%s\"",
NODE_NAME (hp));
_cpp_free_definition (hp);
hp->flags |= NODE_POISONED | NODE_DIAGNOSTIC;
const auto data = (cpp_hashnode_extra *)
ht_lookup (pfile->extra_hash_table, hp->ident, HT_ALLOC);
data->poisoned_loc = tok->src_loc;
}
pfile->state.poisoned_ok = 0;
}
/* Mark the current header as a system header. This will suppress
some categories of warnings (notably those from -pedantic). It is
intended for use in system libraries that cannot be implemented in
conforming C, but cannot be certain that their headers appear in a
system include directory. To prevent abuse, it is rejected in the
primary source file. */
static void
do_pragma_system_header (cpp_reader *pfile)
{
if (_cpp_in_main_source_file (pfile))
cpp_error (pfile, CPP_DL_WARNING,
"#pragma system_header ignored outside include file");
else
{
check_eol (pfile, false);
skip_rest_of_line (pfile);
cpp_make_system_header (pfile, 1, 0);
}
}
/* Check the modified date of the current include file against a specified
file. Issue a diagnostic, if the specified file is newer. We use this to
determine if a fixed header should be refixed. */
static void
do_pragma_dependency (cpp_reader *pfile)
{
const char *fname;
int angle_brackets, ordering;
location_t location;
fname = parse_include (pfile, &angle_brackets, NULL, &location);
if (!fname)
return;
ordering = _cpp_compare_file_date (pfile, fname, angle_brackets);
if (ordering < 0)
cpp_error (pfile, CPP_DL_WARNING, "cannot find source file %s", fname);
else if (ordering > 0)
{
cpp_error (pfile, CPP_DL_WARNING,
"current file is older than %s", fname);
if (cpp_get_token (pfile)->type != CPP_EOF)
{
_cpp_backup_tokens (pfile, 1);
do_diagnostic (pfile, CPP_DL_WARNING, CPP_W_NONE, 0);
}
}
free ((void *) fname);
}
/* Issue a diagnostic with the message taken from the pragma. If
ERROR is true, the diagnostic is a warning, otherwise, it is an
error. */
static void
do_pragma_warning_or_error (cpp_reader *pfile, bool error)
{
const cpp_token *tok = _cpp_lex_token (pfile);
cpp_string str;
if (tok->type != CPP_STRING
|| !cpp_interpret_string_notranslate (pfile, &tok->val.str, 1, &str,
CPP_STRING)
|| str.len == 0)
{
cpp_error (pfile, CPP_DL_ERROR, "invalid \"#pragma GCC %s\" directive",
error ? "error" : "warning");
return;
}
cpp_error (pfile, error ? CPP_DL_ERROR : CPP_DL_WARNING,
"%s", str.text);
free ((void *)str.text);
}
/* Issue a warning diagnostic. */
static void
do_pragma_warning (cpp_reader *pfile)
{
do_pragma_warning_or_error (pfile, false);
}
/* Issue an error diagnostic. */
static void
do_pragma_error (cpp_reader *pfile)
{
do_pragma_warning_or_error (pfile, true);
}
/* Get a token but skip padding. */
static const cpp_token *
get_token_no_padding (cpp_reader *pfile)
{
for (;;)
{
const cpp_token *result = cpp_get_token (pfile);
if (result->type != CPP_PADDING)
return result;
}
}
/* Check syntax is "(string-literal)". Returns the string on success,
or NULL on failure. */
static const cpp_token *
get__Pragma_string (cpp_reader *pfile)
{
const cpp_token *string;
const cpp_token *paren;
paren = get_token_no_padding (pfile);
if (paren->type == CPP_EOF)
_cpp_backup_tokens (pfile, 1);
if (paren->type != CPP_OPEN_PAREN)
return NULL;
string = get_token_no_padding (pfile);
if (string->type == CPP_EOF)
_cpp_backup_tokens (pfile, 1);
if (string->type != CPP_STRING && string->type != CPP_WSTRING
&& string->type != CPP_STRING32 && string->type != CPP_STRING16
&& string->type != CPP_UTF8STRING)
return NULL;
paren = get_token_no_padding (pfile);
if (paren->type == CPP_EOF)
_cpp_backup_tokens (pfile, 1);
if (paren->type != CPP_CLOSE_PAREN)
return NULL;
return string;
}
/* Destringize IN into a temporary buffer, by removing the first \ of
\" and \\ sequences, and process the result as a #pragma directive. */
static void
destringize_and_run (cpp_reader *pfile, const cpp_string *in,
location_t expansion_loc)
{
const unsigned char *src, *limit;
char *dest, *result;
cpp_context *saved_context;
cpp_token *saved_cur_token;
tokenrun *saved_cur_run;
cpp_token *toks;
int count;
const struct directive *save_directive;
dest = result = (char *) alloca (in->len - 1);
src = in->text + 1 + (in->text[0] == 'L');
limit = in->text + in->len - 1;
while (src < limit)
{
/* We know there is a character following the backslash. */
if (*src == '\\' && (src[1] == '\\' || src[1] == '"'))
src++;
*dest++ = *src++;
}
*dest = '\n';
/* Ugh; an awful kludge. We are really not set up to be lexing
tokens when in the middle of a macro expansion. Use a new
context to force cpp_get_token to lex, and so skip_rest_of_line
doesn't go beyond the end of the text. Also, remember the
current lexing position so we can return to it later.
Something like line-at-a-time lexing should remove the need for
this. */
saved_context = pfile->context;
saved_cur_token = pfile->cur_token;
saved_cur_run = pfile->cur_run;
pfile->context = XCNEW (cpp_context);
/* Inline run_directive, since we need to delay the _cpp_pop_buffer
until we've read all of the tokens that we want. */
cpp_push_buffer (pfile, (const uchar *) result, dest - result,
/* from_stage3 */ true);
/* ??? Antique Disgusting Hack. What does this do? */
if (pfile->buffer->prev)
pfile->buffer->file = pfile->buffer->prev->file;
start_directive (pfile);
_cpp_clean_line (pfile);
save_directive = pfile->directive;
pfile->directive = &dtable[T_PRAGMA];
do_pragma (pfile);
if (pfile->directive_result.type == CPP_PRAGMA)
pfile->directive_result.flags |= PRAGMA_OP;
end_directive (pfile, 1);
pfile->directive = save_directive;
/* We always insert at least one token, the directive result. It'll
either be a CPP_PADDING or a CPP_PRAGMA. In the later case, we
need to insert *all* of the tokens, including the CPP_PRAGMA_EOL. */
/* If we're not handling the pragma internally, read all of the tokens from
the string buffer now, while the string buffer is still installed. */
/* ??? Note that the token buffer allocated here is leaked. It's not clear
to me what the true lifespan of the tokens are. It would appear that
the lifespan is the entire parse of the main input stream, in which case
this may not be wrong. */
if (pfile->directive_result.type == CPP_PRAGMA)
{
int maxcount;
count = 1;
maxcount = 50;
toks = XNEWVEC (cpp_token, maxcount);
toks[0] = pfile->directive_result;
toks[0].src_loc = expansion_loc;
do
{
if (count == maxcount)
{
maxcount = maxcount * 3 / 2;
toks = XRESIZEVEC (cpp_token, toks, maxcount);
}
toks[count] = *cpp_get_token (pfile);
/* _Pragma is a builtin, so we're not within a macro-map, and so
the token locations are set to bogus ordinary locations
near to, but after that of the "_Pragma".
Paper over this by setting them equal to the location of the
_Pragma itself (PR preprocessor/69126). */
toks[count].src_loc = expansion_loc;
/* Macros have been already expanded by cpp_get_token
if the pragma allowed expansion. */
toks[count++].flags |= NO_EXPAND;
}
while (toks[count-1].type != CPP_PRAGMA_EOL);
}
else
{
count = 1;
toks = &pfile->avoid_paste;
/* If we handled the entire pragma internally, make sure we get the
line number correct for the next token. */
if (pfile->cb.line_change)
pfile->cb.line_change (pfile, pfile->cur_token, false);
}
/* Finish inlining run_directive. */
pfile->buffer->file = NULL;
_cpp_pop_buffer (pfile);
/* Reset the old macro state before ... */
XDELETE (pfile->context);
pfile->context = saved_context;
pfile->cur_token = saved_cur_token;
pfile->cur_run = saved_cur_run;
/* ... inserting the new tokens we collected. */
_cpp_push_token_context (pfile, NULL, toks, count);
}
/* Handle the _Pragma operator. Return 0 on error, 1 if ok. */
int
_cpp_do__Pragma (cpp_reader *pfile, location_t expansion_loc)
{
/* Make sure we don't invalidate the string token, if the closing parenthesis
ended up on a different line. */
++pfile->keep_tokens;
const cpp_token *string = get__Pragma_string (pfile);
--pfile->keep_tokens;
pfile->directive_result.type = CPP_PADDING;
if (string)
{
destringize_and_run (pfile, &string->val.str, expansion_loc);
return 1;
}
cpp_error (pfile, CPP_DL_ERROR,
"_Pragma takes a parenthesized string literal");
return 0;
}
/* Handle #ifdef. */
static void
do_ifdef (cpp_reader *pfile)
{
int skip = 1;
if (! pfile->state.skipping)
{
cpp_hashnode *node = lex_macro_node (pfile, false);
if (node)
{
skip = !_cpp_defined_macro_p (node);
if (!_cpp_maybe_notify_macro_use (pfile, node, pfile->directive_line))
/* It wasn't a macro after all. */
skip = true;
_cpp_mark_macro_used (node);
if (pfile->cb.used)
pfile->cb.used (pfile, pfile->directive_line, node);
check_eol (pfile, false);
}
}
push_conditional (pfile, skip, T_IFDEF, 0);
}
/* Handle #ifndef. */
static void
do_ifndef (cpp_reader *pfile)
{
int skip = 1;
cpp_hashnode *node = 0;
if (! pfile->state.skipping)
{
node = lex_macro_node (pfile, false);
if (node)
{
skip = _cpp_defined_macro_p (node);
if (!_cpp_maybe_notify_macro_use (pfile, node, pfile->directive_line))
/* It wasn't a macro after all. */
skip = false;
_cpp_mark_macro_used (node);
if (pfile->cb.used)
pfile->cb.used (pfile, pfile->directive_line, node);
check_eol (pfile, false);
}
}
push_conditional (pfile, skip, T_IFNDEF, node);
}
/* _cpp_parse_expr puts a macro in a "#if !defined ()" expression in
pfile->mi_ind_cmacro so we can handle multiple-include
optimizations. If macro expansion occurs in the expression, we
cannot treat it as a controlling conditional, since the expansion
could change in the future. That is handled by cpp_get_token. */
static void
do_if (cpp_reader *pfile)
{
int skip = 1;
if (! pfile->state.skipping)
skip = _cpp_parse_expr (pfile, "#if", NULL) == false;
push_conditional (pfile, skip, T_IF, pfile->mi_ind_cmacro);
}
/* Flip skipping state if appropriate and continue without changing
if_stack; this is so that the error message for missing #endif's
etc. will point to the original #if. */
static void
do_else (cpp_reader *pfile)
{
cpp_buffer *buffer = pfile->buffer;
struct if_stack *ifs = buffer->if_stack;
if (ifs == NULL)
cpp_error (pfile, CPP_DL_ERROR, "#else without #if");
else
{
if (ifs->type == T_ELSE)
{
cpp_error (pfile, CPP_DL_ERROR, "#else after #else");
cpp_error_with_line (pfile, CPP_DL_ERROR, ifs->line, 0,
"the conditional began here");
}
ifs->type = T_ELSE;
/* Skip any future (erroneous) #elses or #elifs. */
pfile->state.skipping = ifs->skip_elses;
ifs->skip_elses = true;
/* Invalidate any controlling macro. */
ifs->mi_cmacro = 0;
/* Only check EOL if was not originally skipping. */
if (!ifs->was_skipping && CPP_OPTION (pfile, warn_endif_labels))
check_eol_endif_labels (pfile);
}
}
/* Handle a #elif, #elifdef or #elifndef directive by not changing if_stack
either. See the comment above do_else. */
static void
do_elif (cpp_reader *pfile)
{
cpp_buffer *buffer = pfile->buffer;
struct if_stack *ifs = buffer->if_stack;
if (ifs == NULL)
cpp_error (pfile, CPP_DL_ERROR, "#%s without #if", pfile->directive->name);
else
{
if (ifs->type == T_ELSE)
{
cpp_error (pfile, CPP_DL_ERROR, "#%s after #else",
pfile->directive->name);
cpp_error_with_line (pfile, CPP_DL_ERROR, ifs->line, 0,
"the conditional began here");
}
ifs->type = T_ELIF;
/* See DR#412: "Only the first group whose control condition
evaluates to true (nonzero) is processed; any following groups
are skipped and their controlling directives are processed as
if they were in a group that is skipped." */
if (ifs->skip_elses)
{
/* In older GNU standards, #elifdef/#elifndef is supported
as an extension, but pedwarn if -pedantic if the presence
of the directive would be rejected. */
if (pfile->directive != &dtable[T_ELIF]
&& ! CPP_OPTION (pfile, elifdef)
&& CPP_PEDANTIC (pfile)
&& !pfile->state.skipping)
{
if (CPP_OPTION (pfile, cplusplus))
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C++23 is a GCC extension",
pfile->directive->name);
else
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C23 is a GCC extension",
pfile->directive->name);
}
pfile->state.skipping = 1;
}
else
{
if (pfile->directive == &dtable[T_ELIF])
pfile->state.skipping = !_cpp_parse_expr (pfile, "#elif", NULL);
else
{
cpp_hashnode *node = lex_macro_node (pfile, false);
if (node)
{
bool macro_defined = _cpp_defined_macro_p (node);
if (!_cpp_maybe_notify_macro_use (pfile, node,
pfile->directive_line))
/* It wasn't a macro after all. */
macro_defined = false;
bool skip = (pfile->directive == &dtable[T_ELIFDEF]
? !macro_defined
: macro_defined);
if (pfile->cb.used)
pfile->cb.used (pfile, pfile->directive_line, node);
check_eol (pfile, false);
/* In older GNU standards, #elifdef/#elifndef is supported
as an extension, but pedwarn if -pedantic if the presence
of the directive would change behavior. */
if (! CPP_OPTION (pfile, elifdef)
&& CPP_PEDANTIC (pfile)
&& pfile->state.skipping != skip)
{
if (CPP_OPTION (pfile, cplusplus))
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C++23 is a GCC extension",
pfile->directive->name);
else
cpp_error (pfile, CPP_DL_PEDWARN,
"#%s before C23 is a GCC extension",
pfile->directive->name);
}
pfile->state.skipping = skip;
}
}
ifs->skip_elses = !pfile->state.skipping;
}
/* Invalidate any controlling macro. */
ifs->mi_cmacro = 0;
}
}
/* Handle a #elifdef directive. */
static void
do_elifdef (cpp_reader *pfile)
{
do_elif (pfile);
}
/* Handle a #elifndef directive. */
static void
do_elifndef (cpp_reader *pfile)
{
do_elif (pfile);
}
/* #endif pops the if stack and resets pfile->state.skipping. */
static void
do_endif (cpp_reader *pfile)
{
cpp_buffer *buffer = pfile->buffer;
struct if_stack *ifs = buffer->if_stack;
if (ifs == NULL)
cpp_error (pfile, CPP_DL_ERROR, "#endif without #if");
else
{
/* Only check EOL if was not originally skipping. */
if (!ifs->was_skipping && CPP_OPTION (pfile, warn_endif_labels))
check_eol_endif_labels (pfile);
/* If potential control macro, we go back outside again. */
if (ifs->next == 0 && ifs->mi_cmacro)
{
pfile->mi_valid = true;
pfile->mi_cmacro = ifs->mi_cmacro;
}
buffer->if_stack = ifs->next;
pfile->state.skipping = ifs->was_skipping;
obstack_free (&pfile->buffer_ob, ifs);
}
}
/* Push an if_stack entry for a preprocessor conditional, and set
pfile->state.skipping to SKIP. If TYPE indicates the conditional
is #if or #ifndef, CMACRO is a potentially controlling macro, and
we need to check here that we are at the top of the file. */
static void
push_conditional (cpp_reader *pfile, int skip, int type,
const cpp_hashnode *cmacro)
{
struct if_stack *ifs;
cpp_buffer *buffer = pfile->buffer;
ifs = XOBNEW (&pfile->buffer_ob, struct if_stack);
ifs->line = pfile->directive_line;
ifs->next = buffer->if_stack;
ifs->skip_elses = pfile->state.skipping || !skip;
ifs->was_skipping = pfile->state.skipping;
ifs->type = type;
/* This condition is effectively a test for top-of-file. */
if (pfile->mi_valid && pfile->mi_cmacro == 0)
ifs->mi_cmacro = cmacro;
else
ifs->mi_cmacro = 0;
pfile->state.skipping = skip;
buffer->if_stack = ifs;
}
/* Read the tokens of the answer into the macro pool, in a directive
of type TYPE. Only commit the memory if we intend it as permanent
storage, i.e. the #assert case. Returns 0 on success, and sets
ANSWERP to point to the answer. PRED_LOC is the location of the
predicate. */
static bool
parse_answer (cpp_reader *pfile, int type, location_t pred_loc,
cpp_macro **answer_ptr)
{
/* In a conditional, it is legal to not have an open paren. We
should save the following token in this case. */
const cpp_token *paren = cpp_get_token (pfile);
/* If not a paren, see if we're OK. */
if (paren->type != CPP_OPEN_PAREN)
{
/* In a conditional no answer is a test for any answer. It
could be followed by any token. */
if (type == T_IF)
{
_cpp_backup_tokens (pfile, 1);
return true;
}
/* #unassert with no answer is valid - it removes all answers. */
if (type == T_UNASSERT && paren->type == CPP_EOF)
return true;
cpp_error_with_line (pfile, CPP_DL_ERROR, pred_loc, 0,
"missing '(' after predicate");
return false;
}
cpp_macro *answer = _cpp_new_macro (pfile, cmk_assert,
_cpp_reserve_room (pfile, 0,
sizeof (cpp_macro)));
answer->parm.next = NULL;
unsigned count = 0;
for (;;)
{
const cpp_token *token = cpp_get_token (pfile);
if (token->type == CPP_CLOSE_PAREN)
break;
if (token->type == CPP_EOF)
{
cpp_error (pfile, CPP_DL_ERROR, "missing ')' to complete answer");
return false;
}
answer = (cpp_macro *)_cpp_reserve_room
(pfile, sizeof (cpp_macro) + count * sizeof (cpp_token),
sizeof (cpp_token));
answer->exp.tokens[count++] = *token;
}
if (!count)
{
cpp_error (pfile, CPP_DL_ERROR, "predicate's answer is empty");
return false;
}
/* Drop whitespace at start, for answer equivalence purposes. */
answer->exp.tokens[0].flags &= ~PREV_WHITE;
answer->count = count;
*answer_ptr = answer;
return true;
}
/* Parses an assertion directive of type TYPE, returning a pointer to
the hash node of the predicate, or 0 on error. The node is
guaranteed to be disjoint from the macro namespace, so can only
have type 'NT_VOID'. If an answer was supplied, it is placed in
*ANSWER_PTR, which is otherwise set to 0. */
static cpp_hashnode *
parse_assertion (cpp_reader *pfile, int type, cpp_macro **answer_ptr)
{
cpp_hashnode *result = 0;
/* We don't expand predicates or answers. */
pfile->state.prevent_expansion++;
*answer_ptr = NULL;
const cpp_token *predicate = cpp_get_token (pfile);
if (predicate->type == CPP_EOF)
cpp_error (pfile, CPP_DL_ERROR, "assertion without predicate");
else if (predicate->type != CPP_NAME)
cpp_error_with_line (pfile, CPP_DL_ERROR, predicate->src_loc, 0,
"predicate must be an identifier");
else if (parse_answer (pfile, type, predicate->src_loc, answer_ptr))
{
unsigned int len = NODE_LEN (predicate->val.node.node);
unsigned char *sym = (unsigned char *) alloca (len + 1);
/* Prefix '#' to get it out of macro namespace. */
sym[0] = '#';
memcpy (sym + 1, NODE_NAME (predicate->val.node.node), len);
result = cpp_lookup (pfile, sym, len + 1);
}
pfile->state.prevent_expansion--;
return result;
}
/* Returns a pointer to the pointer to CANDIDATE in the answer chain,
or a pointer to NULL if the answer is not in the chain. */
static cpp_macro **
find_answer (cpp_hashnode *node, const cpp_macro *candidate)
{
unsigned int i;
cpp_macro **result = NULL;
for (result = &node->value.answers; *result; result = &(*result)->parm.next)
{
cpp_macro *answer = *result;
if (answer->count == candidate->count)
{
for (i = 0; i < answer->count; i++)
if (!_cpp_equiv_tokens (&answer->exp.tokens[i],
&candidate->exp.tokens[i]))
break;
if (i == answer->count)
break;
}
}
return result;
}
/* Test an assertion within a preprocessor conditional. Returns
nonzero on failure, zero on success. On success, the result of
the test is written into VALUE, otherwise the value 0. */
int
_cpp_test_assertion (cpp_reader *pfile, unsigned int *value)
{
cpp_macro *answer;
cpp_hashnode *node = parse_assertion (pfile, T_IF, &answer);
/* For recovery, an erroneous assertion expression is handled as a
failing assertion. */
*value = 0;
if (node)
{
if (node->value.answers)
*value = !answer || *find_answer (node, answer);
}
else if (pfile->cur_token[-1].type == CPP_EOF)
_cpp_backup_tokens (pfile, 1);
/* We don't commit the memory for the answer - it's temporary only. */
return node == 0;
}
/* Handle #assert. */
static void
do_assert (cpp_reader *pfile)
{
cpp_macro *answer;
cpp_hashnode *node = parse_assertion (pfile, T_ASSERT, &answer);
if (node)
{
/* Place the new answer in the answer list. First check there
is not a duplicate. */
if (*find_answer (node, answer))
{
cpp_error (pfile, CPP_DL_WARNING, "\"%s\" re-asserted",
NODE_NAME (node) + 1);
return;
}
/* Commit or allocate storage for the answer. */
answer = (cpp_macro *)_cpp_commit_buff
(pfile, sizeof (cpp_macro) - sizeof (cpp_token)
+ sizeof (cpp_token) * answer->count);
/* Chain into the list. */
answer->parm.next = node->value.answers;
node->value.answers = answer;
check_eol (pfile, false);
}
}
/* Handle #unassert. */
static void
do_unassert (cpp_reader *pfile)
{
cpp_macro *answer;
cpp_hashnode *node = parse_assertion (pfile, T_UNASSERT, &answer);
/* It isn't an error to #unassert something that isn't asserted. */
if (node)
{
if (answer)
{
cpp_macro **p = find_answer (node, answer);
/* Remove the assert from the list. */
if (cpp_macro *temp = *p)
*p = temp->parm.next;
check_eol (pfile, false);
}
else
_cpp_free_definition (node);
}
/* We don't commit the memory for the answer - it's temporary only. */
}
/* These are for -D, -U, -A. */
/* Process the string STR as if it appeared as the body of a #define.
If STR is just an identifier, define it with value 1.
If STR has anything after the identifier, then it should
be identifier=definition. */
void
cpp_define (cpp_reader *pfile, const char *str)
{
char *buf;
const char *p;
size_t count;
/* Copy the entire option so we can modify it.
Change the first "=" in the string to a space. If there is none,
tack " 1" on the end. */
count = strlen (str);
buf = (char *) alloca (count + 3);
memcpy (buf, str, count);
p = strchr (str, '=');
if (p)
buf[p - str] = ' ';
else
{
buf[count++] = ' ';
buf[count++] = '1';
}
buf[count] = '\n';
run_directive (pfile, T_DEFINE, buf, count);
}
/* Like cpp_define, but does not warn about unused macro. */
void
cpp_define_unused (cpp_reader *pfile, const char *str)
{
unsigned char warn_unused_macros = CPP_OPTION (pfile, warn_unused_macros);
CPP_OPTION (pfile, warn_unused_macros) = 0;
cpp_define (pfile, str);
CPP_OPTION (pfile, warn_unused_macros) = warn_unused_macros;
}
/* Use to build macros to be run through cpp_define() as
described above.
Example: cpp_define_formatted (pfile, "MACRO=%d", value); */
void
cpp_define_formatted (cpp_reader *pfile, const char *fmt, ...)
{
char *ptr;
va_list ap;
va_start (ap, fmt);
ptr = xvasprintf (fmt, ap);
va_end (ap);
cpp_define (pfile, ptr);
free (ptr);
}
/* Like cpp_define_formatted, but does not warn about unused macro. */
void
cpp_define_formatted_unused (cpp_reader *pfile, const char *fmt, ...)
{
char *ptr;
va_list ap;
va_start (ap, fmt);
ptr = xvasprintf (fmt, ap);
va_end (ap);
cpp_define_unused (pfile, ptr);
free (ptr);
}
/* Slight variant of the above for use by initialize_builtins. */
void
_cpp_define_builtin (cpp_reader *pfile, const char *str)
{
size_t len = strlen (str);
char *buf = (char *) alloca (len + 1);
memcpy (buf, str, len);
buf[len] = '\n';
run_directive (pfile, T_DEFINE, buf, len);
}
/* Process MACRO as if it appeared as the body of an #undef. */
void
cpp_undef (cpp_reader *pfile, const char *macro)
{
size_t len = strlen (macro);
char *buf = (char *) alloca (len + 1);
memcpy (buf, macro, len);
buf[len] = '\n';
run_directive (pfile, T_UNDEF, buf, len);
}
/* Replace a previous definition DEF of the macro STR. If DEF is NULL,
or first element is zero, then the macro should be undefined. */
static void
cpp_pop_definition (cpp_reader *pfile, struct def_pragma_macro *c)
{
cpp_hashnode *node = _cpp_lex_identifier (pfile, c->name);
if (node == NULL)
return;
if (pfile->cb.before_define)
pfile->cb.before_define (pfile);
if (cpp_macro_p (node))
{
if (pfile->cb.undef)
pfile->cb.undef (pfile, pfile->directive_line, node);
if (CPP_OPTION (pfile, warn_unused_macros))
_cpp_warn_if_unused_macro (pfile, node, NULL);
_cpp_free_definition (node);
}
if (c->is_undef)
return;
if (c->is_builtin)
{
_cpp_restore_special_builtin (pfile, c);
return;
}
{
size_t namelen;
const uchar *dn;
cpp_hashnode *h = NULL;
cpp_buffer *nbuf;
namelen = ustrcspn (c->definition, "( \n");
h = cpp_lookup (pfile, c->definition, namelen);
dn = c->definition + namelen;
nbuf = cpp_push_buffer (pfile, dn, ustrchr (dn, '\n') - dn, true);
if (nbuf != NULL)
{
_cpp_clean_line (pfile);
nbuf->sysp = 1;
if (!_cpp_create_definition (pfile, h, 0))
abort ();
_cpp_pop_buffer (pfile);
}
else
abort ();
h->value.macro->line = c->line;
h->value.macro->syshdr = c->syshdr;
h->value.macro->used = c->used;
}
}
/* Process the string STR as if it appeared as the body of a #assert. */
void
cpp_assert (cpp_reader *pfile, const char *str)
{
handle_assertion (pfile, str, T_ASSERT);
}
/* Process STR as if it appeared as the body of an #unassert. */
void
cpp_unassert (cpp_reader *pfile, const char *str)
{
handle_assertion (pfile, str, T_UNASSERT);
}
/* Common code for cpp_assert (-A) and cpp_unassert (-A-). */
static void
handle_assertion (cpp_reader *pfile, const char *str, int type)
{
size_t count = strlen (str);
const char *p = strchr (str, '=');
/* Copy the entire option so we can modify it. Change the first
"=" in the string to a '(', and tack a ')' on the end. */
char *buf = (char *) alloca (count + 2);
memcpy (buf, str, count);
if (p)
{
buf[p - str] = '(';
buf[count++] = ')';
}
buf[count] = '\n';
str = buf;
run_directive (pfile, type, str, count);
}
/* The options structure. */
cpp_options *
cpp_get_options (cpp_reader *pfile)
{
return &pfile->opts;
}
/* The callbacks structure. */
cpp_callbacks *
cpp_get_callbacks (cpp_reader *pfile)
{
return &pfile->cb;
}
/* Copy the given callbacks structure to our own. */
void
cpp_set_callbacks (cpp_reader *pfile, cpp_callbacks *cb)
{
pfile->cb = *cb;
}
/* The narrow character set identifier. */
const char *
cpp_get_narrow_charset_name (cpp_reader *pfile)
{
return pfile->narrow_cset_desc.to;
}
/* The wide character set identifier. */
const char *
cpp_get_wide_charset_name (cpp_reader *pfile)
{
return pfile->wide_cset_desc.to;
}
/* The dependencies structure. (Creates one if it hasn't already been.) */
class mkdeps *
cpp_get_deps (cpp_reader *pfile)
{
if (!pfile->deps && CPP_OPTION (pfile, deps.style) != DEPS_NONE)
pfile->deps = deps_init ();
return pfile->deps;
}
/* Push a new buffer on the buffer stack. Returns the new buffer; it
doesn't fail. It does not generate a file change call back; that
is the responsibility of the caller. */
cpp_buffer *
cpp_push_buffer (cpp_reader *pfile, const uchar *buffer, size_t len,
int from_stage3)
{
cpp_buffer *new_buffer = XOBNEW (&pfile->buffer_ob, cpp_buffer);
/* Clears, amongst other things, if_stack and mi_cmacro. */
memset (new_buffer, 0, sizeof (cpp_buffer));
new_buffer->next_line = new_buffer->buf = buffer;
new_buffer->rlimit = buffer + len;
new_buffer->from_stage3 = from_stage3;
new_buffer->prev = pfile->buffer;
new_buffer->need_line = true;
pfile->buffer = new_buffer;
return new_buffer;
}
/* Pops a single buffer, with a file change call-back if appropriate.
Then pushes the next -include file, if any remain. */
void
_cpp_pop_buffer (cpp_reader *pfile)
{
cpp_buffer *buffer = pfile->buffer;
struct _cpp_file *inc = buffer->file;
struct if_stack *ifs;
const unsigned char *to_free;
/* Walk back up the conditional stack till we reach its level at
entry to this file, issuing error messages. */
for (ifs = buffer->if_stack; ifs; ifs = ifs->next)
cpp_error_with_line (pfile, CPP_DL_ERROR, ifs->line, 0,
"unterminated #%s", dtable[ifs->type].name);
/* In case of a missing #endif. */
pfile->state.skipping = 0;
/* _cpp_do_file_change expects pfile->buffer to be the new one. */
pfile->buffer = buffer->prev;
to_free = buffer->to_free;
free (buffer->notes);
/* Free the buffer object now; we may want to push a new buffer
in _cpp_push_next_include_file. */
obstack_free (&pfile->buffer_ob, buffer);
if (inc)
{
_cpp_pop_file_buffer (pfile, inc, to_free);
_cpp_do_file_change (pfile, LC_LEAVE, 0, 0, 0);
}
else if (to_free)
free ((void *)to_free);
}
/* Enter all recognized directives in the hash table. */
void
_cpp_init_directives (cpp_reader *pfile)
{
for (int i = 0; i < N_DIRECTIVES; i++)
{
cpp_hashnode *node = cpp_lookup (pfile, dtable[i].name, dtable[i].length);
node->is_directive = 1;
node->directive_index = i;
}
}
/* Extract header file from a bracket include. Parsing starts after '<'.
The string is malloced and must be freed by the caller. */
char *
_cpp_bracket_include(cpp_reader *pfile)
{
return glue_header_name (pfile);
}