gcc/libcpp/errors.cc
Lewis Hyatt 998eb2a126
libcpp: Support extended characters for #pragma {push,pop}_macro [PR109704]
The implementation of #pragma push_macro and #pragma pop_macro has to date
made use of an ad-hoc function, _cpp_lex_identifier(), which lexes an
identifier out of a string. When support was added for extended characters
in identifiers ($, UCNs, or UTF-8), that support was added only for the
"normal" way of lexing identifiers out of a cpp_buffer (_cpp_lex_direct) and
not for the ad-hoc way. Consequently, extended identifiers are not usable
with these pragmas.

The logic for lexing identifiers has become more complicated than it was
when _cpp_lex_identifier() was written -- it now handles things like \N{}
escapes in C++, for instance -- and it no longer seems practical to maintain
a redundant code path for lexing identifiers. Address the issue by changing
the implementation of #pragma {push,pop}_macro to lex identifiers in the
expected way, i.e. by pushing a cpp_buffer and lexing the identifier from
there.

The existing implementation has some quirks because of the ad-hoc parsing
logic. For example:

 #pragma push_macro("X ")
 ...
 #pragma pop_macro("X")

will not restore macro X (note the extra space in the first string). However:

 #pragma push_macro("X ")
 ...
 #pragma pop_macro("X ")

actually does sucessfully restore "X". This is because the key for looking
up the saved macro on the push stack is the original string passed, so the
string passed to pop_macro needs to match it exactly. It is not that easy to
reproduce this logic in the world of extended characters, given that for
example it should be valid to pass a UCN to push_macro, and the
corresponding UTF-8 to pop_macro. Given that this aspect of the existing
behavior seems unintentional and has no tests (and does not match other
implementations), I opted to make the new logic more straightforward. The
string passed needs to lex to one token, which must be a valid identifier,
or else no action is taken and no error is generated. Any diagnostics
encountered during lexing (e.g., due to a UTF-8 character not permitted to
appear in an identifier) are also suppressed.

It could be nice (for GCC 15) to also add a warning if a pop_macro does not
match a previous push_macro.

libcpp/ChangeLog:

	PR preprocessor/109704
	* include/cpplib.h (class cpp_auto_suppress_diagnostics): New class.
	* errors.cc
	(cpp_auto_suppress_diagnostics::cpp_auto_suppress_diagnostics): New
	function.
	(cpp_auto_suppress_diagnostics::~cpp_auto_suppress_diagnostics): New
	function.
	* charset.cc (noop_diagnostic_cb): Remove.
	(cpp_interpret_string_ranges): Refactor diagnostic suppression logic
	into new class cpp_auto_suppress_diagnostics.
	(count_source_chars): Likewise.
	* directives.cc (cpp_pop_definition): Add cpp_hashnode argument.
	(lex_identifier_from_string): New static helper function.
	(push_pop_macro_common): Refactor common logic from
	do_pragma_push_macro and do_pragma_pop_macro; use
	lex_identifier_from_string instead of _cpp_lex_identifier.
	(do_pragma_push_macro): Reimplement using push_pop_macro_common.
	(do_pragma_pop_macro): Likewise.
	* internal.h (_cpp_lex_identifier): Remove.
	* lex.cc (lex_identifier_intern): Remove.
	(_cpp_lex_identifier): Remove.

gcc/testsuite/ChangeLog:

	PR preprocessor/109704
	* c-c++-common/cpp/pragma-push-pop-utf8.c: New test.
	* g++.dg/pch/pushpop-2.C: New test.
	* g++.dg/pch/pushpop-2.Hs: New test.
	* gcc.dg/pch/pushpop-2.c: New test.
	* gcc.dg/pch/pushpop-2.hs: New test.
2024-10-14 09:42:56 -04:00

368 lines
8.9 KiB
C++

/* Default error handlers for CPP Library.
Copyright (C) 1986-2024 Free Software Foundation, Inc.
Written by Per Bothner, 1994.
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/>.
In other words, you are welcome to use, share and improve this program.
You are forbidden to forbid anyone else to use, share and improve
what you give them. Help stamp out software-hoarding! */
#include "config.h"
#include "system.h"
#include "cpplib.h"
#include "internal.h"
/* Get a location_t for the current location in PFILE,
generally that of the previously lexed token. */
location_t
cpp_diagnostic_get_current_location (cpp_reader *pfile)
{
if (CPP_OPTION (pfile, traditional))
{
if (pfile->state.in_directive)
return pfile->directive_line;
else
return pfile->line_table->highest_line;
}
/* We don't want to refer to a token before the beginning of the
current run -- that is invalid. */
else if (pfile->cur_token == pfile->cur_run->base)
{
return 0;
}
else
{
return pfile->cur_token[-1].src_loc;
}
}
/* Print a diagnostic at the given location. */
ATTRIBUTE_CPP_PPDIAG (5, 0)
static bool
cpp_diagnostic_at (cpp_reader * pfile, enum cpp_diagnostic_level level,
enum cpp_warning_reason reason, rich_location *richloc,
const char *msgid, va_list *ap)
{
bool ret;
if (!pfile->cb.diagnostic)
abort ();
ret = pfile->cb.diagnostic (pfile, level, reason, richloc, _(msgid), ap);
return ret;
}
/* Print a diagnostic at the location of the previously lexed token. */
ATTRIBUTE_CPP_PPDIAG (4, 0)
static bool
cpp_diagnostic (cpp_reader * pfile, enum cpp_diagnostic_level level,
enum cpp_warning_reason reason,
const char *msgid, va_list *ap)
{
location_t src_loc = cpp_diagnostic_get_current_location (pfile);
rich_location richloc (pfile->line_table, src_loc);
return cpp_diagnostic_at (pfile, level, reason, &richloc, msgid, ap);
}
/* Print a warning or error, depending on the value of LEVEL. */
bool
cpp_error (cpp_reader * pfile, enum cpp_diagnostic_level level,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic (pfile, level, CPP_W_NONE, msgid, &ap);
va_end (ap);
return ret;
}
/* Print a warning. The warning reason may be given in REASON. */
bool
cpp_warning (cpp_reader * pfile, enum cpp_warning_reason reason,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic (pfile, CPP_DL_WARNING, reason, msgid, &ap);
va_end (ap);
return ret;
}
/* Print a pedantic warning. The warning reason may be given in REASON. */
bool
cpp_pedwarning (cpp_reader * pfile, enum cpp_warning_reason reason,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic (pfile, CPP_DL_PEDWARN, reason, msgid, &ap);
va_end (ap);
return ret;
}
/* Print a warning, including system headers. The warning reason may be
given in REASON. */
bool
cpp_warning_syshdr (cpp_reader * pfile, enum cpp_warning_reason reason,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic (pfile, CPP_DL_WARNING_SYSHDR, reason, msgid, &ap);
va_end (ap);
return ret;
}
/* As cpp_warning above, but use RICHLOC as the location of the diagnostic. */
bool cpp_warning_at (cpp_reader *pfile, enum cpp_warning_reason reason,
rich_location *richloc, const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_at (pfile, CPP_DL_WARNING, reason, richloc,
msgid, &ap);
va_end (ap);
return ret;
}
/* As cpp_pedwarning above, but use RICHLOC as the location of the
diagnostic. */
bool
cpp_pedwarning_at (cpp_reader * pfile, enum cpp_warning_reason reason,
rich_location *richloc, const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_at (pfile, CPP_DL_PEDWARN, reason, richloc,
msgid, &ap);
va_end (ap);
return ret;
}
/* Print a diagnostic at a specific location. */
ATTRIBUTE_CPP_PPDIAG (6, 0)
static bool
cpp_diagnostic_with_line (cpp_reader * pfile, enum cpp_diagnostic_level level,
enum cpp_warning_reason reason,
location_t src_loc, unsigned int column,
const char *msgid, va_list *ap)
{
bool ret;
if (!pfile->cb.diagnostic)
abort ();
rich_location richloc (pfile->line_table, src_loc);
if (column)
richloc.override_column (column);
ret = pfile->cb.diagnostic (pfile, level, reason, &richloc, _(msgid), ap);
return ret;
}
/* Print a warning or error, depending on the value of LEVEL. */
bool
cpp_error_with_line (cpp_reader *pfile, enum cpp_diagnostic_level level,
location_t src_loc, unsigned int column,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_with_line (pfile, level, CPP_W_NONE, src_loc,
column, msgid, &ap);
va_end (ap);
return ret;
}
/* Print a warning. The warning reason may be given in REASON. */
bool
cpp_warning_with_line (cpp_reader *pfile, enum cpp_warning_reason reason,
location_t src_loc, unsigned int column,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_with_line (pfile, CPP_DL_WARNING, reason, src_loc,
column, msgid, &ap);
va_end (ap);
return ret;
}
/* Print a pedantic warning. The warning reason may be given in REASON. */
bool
cpp_pedwarning_with_line (cpp_reader *pfile, enum cpp_warning_reason reason,
location_t src_loc, unsigned int column,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_with_line (pfile, CPP_DL_PEDWARN, reason, src_loc,
column, msgid, &ap);
va_end (ap);
return ret;
}
/* Print a warning, including system headers. The warning reason may be
given in REASON. */
bool
cpp_warning_with_line_syshdr (cpp_reader *pfile, enum cpp_warning_reason reason,
location_t src_loc, unsigned int column,
const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_with_line (pfile, CPP_DL_WARNING_SYSHDR, reason, src_loc,
column, msgid, &ap);
va_end (ap);
return ret;
}
/* As cpp_error, but use SRC_LOC as the location of the error, without
a column override. */
bool
cpp_error_at (cpp_reader * pfile, enum cpp_diagnostic_level level,
location_t src_loc, const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
rich_location richloc (pfile->line_table, src_loc);
ret = cpp_diagnostic_at (pfile, level, CPP_W_NONE, &richloc,
msgid, &ap);
va_end (ap);
return ret;
}
/* As cpp_error, but use RICHLOC as the location of the error, without
a column override. */
bool
cpp_error_at (cpp_reader * pfile, enum cpp_diagnostic_level level,
rich_location *richloc, const char *msgid, ...)
{
va_list ap;
bool ret;
va_start (ap, msgid);
ret = cpp_diagnostic_at (pfile, level, CPP_W_NONE, richloc,
msgid, &ap);
va_end (ap);
return ret;
}
/* Print a warning or error, depending on the value of LEVEL. Include
information from errno. */
bool
cpp_errno (cpp_reader *pfile, enum cpp_diagnostic_level level,
const char *msgid)
{
return cpp_error (pfile, level, "%s: %s", _(msgid), xstrerror (errno));
}
/* Print a warning or error, depending on the value of LEVEL. Include
information from errno. Unlike cpp_errno, the argument is a filename
that is not localized, but "" is replaced with localized "stdout". */
bool
cpp_errno_filename (cpp_reader *pfile, enum cpp_diagnostic_level level,
const char *filename,
location_t loc)
{
if (filename[0] == '\0')
filename = _("stdout");
return cpp_error_at (pfile, level, loc, "%s: %s", filename,
xstrerror (errno));
}
cpp_auto_suppress_diagnostics::cpp_auto_suppress_diagnostics (cpp_reader *pfile)
: m_pfile (pfile), m_cb (pfile->cb.diagnostic)
{
m_pfile->cb.diagnostic
= [] (cpp_reader *, cpp_diagnostic_level, cpp_warning_reason,
rich_location *, const char *, va_list *)
{
return true;
};
}
cpp_auto_suppress_diagnostics::~cpp_auto_suppress_diagnostics ()
{
m_pfile->cb.diagnostic = m_cb;
}