binutils-gdb/gdbsupport/gdb_unique_ptr.h
Andrew Burgess 2bb7589ddf gdbsupport: move xfree into its own file
In the next commit I'd like to reference gdb_unique_ptr within the
common-utils.h file.  However, this requires that I include
gdb_unique_ptr.h, which requires that xfree be defined.

Interestingly, gdb_unique_ptr.h doesn't actually include anything that
defines xfree, but I was finding that when I added a gdb_unique_ptr.h
include to common-utils.h I was getting a dependency cycle; before my
change xfree was defined when gdb_unique_ptr.h was processed, while
after my change it was not, and this made g++ unhappy.

To break this cycle, I propose to move xfree into its own header file,
gdb-xfree.h, which I'll then include into gdb_unique_ptr.h and
common-utils.cc.
2021-11-16 17:45:44 +00:00

78 lines
2.1 KiB
C++

/* std::unique_ptr specializations for GDB.
Copyright (C) 2016-2021 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 COMMON_GDB_UNIQUE_PTR_H
#define COMMON_GDB_UNIQUE_PTR_H
#include <memory>
#include "gdbsupport/gdb-xfree.h"
namespace gdb
{
/* Define gdb::unique_xmalloc_ptr, a std::unique_ptr that manages
xmalloc'ed memory. */
/* The deleter for std::unique_xmalloc_ptr. Uses xfree. */
template <typename T>
struct xfree_deleter
{
void operator() (T *ptr) const { xfree (ptr); }
};
/* Same, for arrays. */
template <typename T>
struct xfree_deleter<T[]>
{
void operator() (T *ptr) const { xfree (ptr); }
};
/* Import the standard unique_ptr to our namespace with a custom
deleter. */
template<typename T> using unique_xmalloc_ptr
= std::unique_ptr<T, xfree_deleter<T>>;
/* A no-op deleter. */
template<typename T>
struct noop_deleter
{
void operator() (T *ptr) const { }
};
} /* namespace gdb */
/* Dup STR and return a unique_xmalloc_ptr for the result. */
static inline gdb::unique_xmalloc_ptr<char>
make_unique_xstrdup (const char *str)
{
return gdb::unique_xmalloc_ptr<char> (xstrdup (str));
}
/* Dup the first N characters of STR and return a unique_xmalloc_ptr
for the result. The result is always \0-terminated. */
static inline gdb::unique_xmalloc_ptr<char>
make_unique_xstrndup (const char *str, size_t n)
{
return gdb::unique_xmalloc_ptr<char> (xstrndup (str, n));
}
#endif /* COMMON_GDB_UNIQUE_PTR_H */