src/gromacs/utility/unique_cptr.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2016,2017 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \file
  37  * \brief
  38  * Declares gmx::unique_cptr and gmx::sfree_guard.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_UNIQUE_PTR_SFREE_H
  45 #define GMX_UTILITY_UNIQUE_PTR_SFREE_H
  46
  47 #include <cstdlib>
  48
  49 #include <memory>
  50
  51 #include "gromacs/utility/smalloc.h"
  52
  53 namespace gmx
  54 {
  55
  56 /*! \brief Wrapper of standard library free(), to be used as
  57  * unique_cptr deleter for memory allocated by malloc, e.g. by an
  58  * external library such as TNG. */
  59 template<class T>
  60 inline void free_wrapper(T* p)
  61 {
  62     free(p);
  63 }
  64
  65 //! sfree wrapper to be used as unique_cptr deleter
  66 template<class T>
  67 inline void sfree_wrapper(T* p)
  68 {
  69     sfree(p);
  70 }
  71
  72 //! \internal \brief wrap function into functor to be used as deleter
  73 template<class T, void D(T*)>
  74 struct functor_wrapper
  75 {
  76     //! call wrapped function
  77     void operator()(T* t) { D(t); }
  78 };
  79
  80 //! unique_ptr which takes function pointer (has to return void) as template argument
  81 template<typename T, void D(T*) = sfree_wrapper>
  82 using unique_cptr = std::unique_ptr<T, functor_wrapper<T, D>>;
  83
  84 //! Simple guard which calls sfree. See unique_cptr for details.
  85 typedef unique_cptr<void> sfree_guard;
  86
  87
  88 //! Create unique_ptr with any deleter function or lambda
  89 template<typename T, typename D>
  90 std::unique_ptr<T, D> create_unique_with_deleter(T* t, D d)
  91 {
  92     return std::unique_ptr<T, D>(t, d);
  93 }
  94
  95 } // namespace gmx
  96
  97 #endif