Files
binutils-gdb/gdbsupport/format.h
Simon Marchi bd21dd6807 gdbsupport: remove xmalloc in format_pieces
Remove the use of xmalloc (and the arbitrary allocation size) in
format_pieces.  This turned out a bit more involved than expected, but
not too bad.

format_pieces::m_storage is a buffer with multiple concatenated
null-terminated strings, referenced by format_piece::string.  Change
this to an std::string, while keeping its purpose (use the std::string
as a buffer with embedded null characters).

However, because the std::string's internal buffer can be reallocated as
it grows, and I do not want to hardcode a big reserved size like we have
now, it's not possible to store the direct pointer to the string in
format_piece::string.  Those pointers would become stale as the buffer
gets reallocated.  Therefore, change format_piece to hold an index into
the storage instead.  Add format_pieces::piece_str for the callers to be
able to access the piece's string.  This requires changing the few
callers, but in a trivial way.

The selftest also needs to be updated.  I want to keep the test cases
as-is, where the expected pieces contain the expected string, and not
hard-code an expected index.  To achieve this, add the
expected_format_piece structure.  Note that the previous
format_piece::operator== didn't compare the n_int_args fields, while the
test provides expected values for that field.  I guess that was a
mistake.  The new code checks it, and the test still passes.

Change-Id: I80630ff60e01c8caaa800ae22f69a9a7660bc9e9
Reviewed-By: Keith Seitz <keiths@redhat.com>
2025-09-15 10:40:52 -04:00

104 lines
2.9 KiB
C++

/* Parse a printf-style format string.
Copyright (C) 1986-2025 Free Software Foundation, Inc.
This file is part of GDB.
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 of the License, 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. If not, see <http://www.gnu.org/licenses/>. */
#ifndef GDBSUPPORT_FORMAT_H
#define GDBSUPPORT_FORMAT_H
#if defined(__MINGW32__) && !defined(PRINTF_HAS_LONG_LONG)
# define USE_PRINTF_I64 1
# define PRINTF_HAS_LONG_LONG
#else
# define USE_PRINTF_I64 0
#endif
/* The argclass represents the general type of data that goes with a
format directive; int_arg for %d, long_arg for %l, and so forth.
Note that these primarily distinguish types by size and need for
special handling, so for instance %u and %x are (at present) also
classed as int_arg. */
enum argclass
{
literal_piece,
int_arg, long_arg, long_long_arg, size_t_arg, ptr_arg,
string_arg, wide_string_arg, wide_char_arg,
double_arg, long_double_arg,
dec32float_arg, dec64float_arg, dec128float_arg,
value_arg
};
/* A format piece is a section of the format string that may include a
single print directive somewhere in it, and the associated class
for the argument. */
struct format_piece
{
format_piece (std::string::size_type start, enum argclass argc, int n)
: start (start),
argclass (argc),
n_int_args (n)
{}
/* Where this piece starts, within FORMAT_PIECES::M_STORAGE. */
std::string::size_type start;
enum argclass argclass;
/* Count the number of preceding 'int' arguments that must be passed
along. This is used for a width or precision of '*'. Note that
this feature is only available in "gdb_extensions" mode. */
int n_int_args;
};
class format_pieces
{
public:
format_pieces (const char **arg, bool gdb_extensions = false,
bool value_extension = false);
~format_pieces () = default;
DISABLE_COPY_AND_ASSIGN (format_pieces);
typedef std::vector<format_piece>::iterator iterator;
iterator begin ()
{
return m_pieces.begin ();
}
iterator end ()
{
return m_pieces.end ();
}
/* Return the string associated to PIECE. */
const char *piece_str (const format_piece &piece)
{ return &m_storage[piece.start]; }
private:
std::vector<format_piece> m_pieces;
/* This is used as a buffer of concatenated null-terminated strings. The
individual strings are referenced by FORMAT_PIECE::START. */
std::string m_storage;
};
#endif /* GDBSUPPORT_FORMAT_H */