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