1 /* std::unique_ptr specializations for GDB. 2 3 Copyright (C) 2016-2023 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 <string> 25 #include "gdbsupport/gdb-xfree.h" 26 27 namespace gdb 28 { 29 /* Define gdb::unique_xmalloc_ptr, a std::unique_ptr that manages 30 xmalloc'ed memory. */ 31 32 /* The deleter for std::unique_xmalloc_ptr. Uses xfree. */ 33 template <typename T> 34 struct xfree_deleter 35 { 36 void operator() (T *ptr) const { xfree (ptr); } 37 }; 38 39 /* Same, for arrays. */ 40 template <typename T> 41 struct xfree_deleter<T[]> 42 { 43 void operator() (T *ptr) const { xfree (ptr); } 44 }; 45 46 /* Import the standard unique_ptr to our namespace with a custom 47 deleter. */ 48 49 template<typename T> using unique_xmalloc_ptr 50 = std::unique_ptr<T, xfree_deleter<T>>; 51 52 /* A no-op deleter. */ 53 template<typename T> 54 struct noop_deleter 55 { 56 void operator() (T *ptr) const { } 57 }; 58 59 } /* namespace gdb */ 60 61 /* Dup STR and return a unique_xmalloc_ptr for the result. */ 62 63 static inline gdb::unique_xmalloc_ptr<char> 64 make_unique_xstrdup (const char *str) 65 { 66 return gdb::unique_xmalloc_ptr<char> (xstrdup (str)); 67 } 68 69 /* Dup the first N characters of STR and return a unique_xmalloc_ptr 70 for the result. The result is always \0-terminated. */ 71 72 static inline gdb::unique_xmalloc_ptr<char> 73 make_unique_xstrndup (const char *str, size_t n) 74 { 75 return gdb::unique_xmalloc_ptr<char> (xstrndup (str, n)); 76 } 77 78 /* An overload of operator+= fo adding gdb::unique_xmalloc_ptr<char> to a 79 std::string. */ 80 81 static inline std::string & 82 operator+= (std::string &lhs, const gdb::unique_xmalloc_ptr<char> &rhs) 83 { 84 return lhs += rhs.get (); 85 } 86 87 /* An overload of operator+ for adding gdb::unique_xmalloc_ptr<char> to a 88 std::string. */ 89 90 static inline std::string 91 operator+ (const std::string &lhs, const gdb::unique_xmalloc_ptr<char> &rhs) 92 { 93 return lhs + rhs.get (); 94 } 95 96 #endif /* COMMON_GDB_UNIQUE_PTR_H */ 97