gdbsupport/gdb_unique_ptr.h

   1 /* std::unique_ptr specializations for GDB.
   2
   3    Copyright (C) 2016-2022 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef COMMON_GDB_UNIQUE_PTR_H
  21 #define COMMON_GDB_UNIQUE_PTR_H
  22
  23 #include <memory>
  24 #include "gdbsupport/gdb-xfree.h"
  25
  26 namespace gdb
  27 {
  28 /* Define gdb::unique_xmalloc_ptr, a std::unique_ptr that manages
  29    xmalloc'ed memory.  */
  30
  31 /* The deleter for std::unique_xmalloc_ptr.  Uses xfree.  */
  32 template <typename T>
  33 struct xfree_deleter
  34 {
  35   void operator() (T *ptr) const { xfree (ptr); }
  36 };
  37
  38 /* Same, for arrays.  */
  39 template <typename T>
  40 struct xfree_deleter<T[]>
  41 {
  42   void operator() (T *ptr) const { xfree (ptr); }
  43 };
  44
  45 /* Import the standard unique_ptr to our namespace with a custom
  46    deleter.  */
  47
  48 template<typename T> using unique_xmalloc_ptr
  49   = std::unique_ptr<T, xfree_deleter<T>>;
  50
  51 /* A no-op deleter.  */
  52 template<typename T>
  53 struct noop_deleter
  54 {
  55   void operator() (T *ptr) const { }
  56 };
  57
  58 } /* namespace gdb */
  59
  60 /* Dup STR and return a unique_xmalloc_ptr for the result.  */
  61
  62 static inline gdb::unique_xmalloc_ptr<char>
  63 make_unique_xstrdup (const char *str)
  64 {
  65   return gdb::unique_xmalloc_ptr<char> (xstrdup (str));
  66 }
  67
  68 /* Dup the first N characters of STR and return a unique_xmalloc_ptr
  69    for the result.  The result is always \0-terminated.  */
  70
  71 static inline gdb::unique_xmalloc_ptr<char>
  72 make_unique_xstrndup (const char *str, size_t n)
  73 {
  74   return gdb::unique_xmalloc_ptr<char> (xstrndup (str, n));
  75 }
  76
  77 #endif /* COMMON_GDB_UNIQUE_PTR_H */