2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2014, 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.
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.
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.
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.
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.
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.
35 /*! \libinternal \file
37 * Declares gmx::scoped_ptr_sfree.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_utility
43 #ifndef GMX_UTILITY_SCOPED_PTR_SFREE_H
44 #define GMX_UTILITY_SCOPED_PTR_SFREE_H
47 #include "gromacs/utility/smalloc.h"
52 /*! \libinternal \brief
53 * Stripped-down version of scoped_ptr that uses sfree().
55 * Currently only implements constructor from a pointer value and destructor;
56 * other operations can be added if they become necessary.
58 * This class provides a very basic guard/smart pointer for C pointers.
59 * Currently, boost::shared_ptr is used in a few locations that require more
60 * flexibility, but is not suitable for all cases either. A scoped_ptr with
61 * deleter support would be a general enough implementation for all uses.
62 * C++11 unique_ptr has this, but for non-C++11 support we need something else.
64 * Methods in this class do not throw.
67 * \ingroup module_utility
69 class scoped_ptr_sfree
73 * Initializes a scoped_ptr that frees \p ptr on scope exit.
75 * \param[in] ptr Pointer to use for initialization.
77 explicit scoped_ptr_sfree(void *ptr) : ptr_(ptr) {}
78 //! Frees the pointer passed to the constructor.
79 ~scoped_ptr_sfree() { sfree(ptr_); }
84 GMX_DISALLOW_COPY_AND_ASSIGN(scoped_ptr_sfree);