src/gromacs/utility/scoped_cptr.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015, 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 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::scoped_cptr and gmx::scoped_guard_sfree.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_SCOPED_PTR_SFREE_H
  44 #define GMX_UTILITY_SCOPED_PTR_SFREE_H
  45
  46 #include "gromacs/utility/classhelpers.h"
  47 #include "gromacs/utility/smalloc.h"
  48
  49 namespace gmx
  50 {
  51
  52 //! sfree wrapper to be used as scoped_cptr deleter
  53 template <class T>
  54 inline void sfree_wrapper(T *p)
  55 {
  56     sfree(p);
  57 }
  58
  59 /*! \libinternal \brief
  60  * Stripped-down version of scoped_ptr that uses sfree() or custom deleter.
  61  *
  62  * Currently only implements some operations; other operations can be added
  63  * if they become necessary.
  64  * The presence of a release() method is not strictly according to `scoped_ptr`
  65  * design, but makes it easier to make existing C code exception-safe, and does
  66  * not really warrant a separate class for such a purpose.
  67  *
  68  * This class provides a basic guard/smart pointer for C pointers.
  69  *
  70  * Methods in this class do not throw.
  71  *
  72  * \inlibraryapi
  73  * \ingroup module_utility
  74  */
  75 template <class T, void D(T *) = sfree_wrapper>
  76 class scoped_cptr
  77 {
  78     public:
  79         /*! \brief
  80          * Initializes a scoped_cptr that frees \p ptr on scope exit.
  81          *
  82          * \param[in] ptr  Pointer to use for initialization.
  83          */
  84         explicit scoped_cptr(T *ptr = NULL) : ptr_(ptr) {}
  85         //! Frees the pointer passed to the constructor.
  86         ~scoped_cptr() { D(ptr_); }
  87         //! Returns the stored pointer.
  88         T *get() const { return ptr_; }
  89         //! Check for non-null pointer in boolean context.
  90         explicit operator bool () const { return ptr_ != 0; }
  91         //! Sets the pointer and frees previous pointer if necessary.
  92         void reset(T *ptr) { D(ptr_); ptr_ = ptr; }
  93         //! Clears the pointer without freeing the memory, and returns the old value.
  94         T *release() { T *ptr = ptr_; ptr_ = NULL; return ptr; }
  95
  96     private:
  97         T                    *ptr_;
  98
  99         GMX_DISALLOW_COPY_AND_ASSIGN(scoped_cptr);
 100 };
 101
 102 //! Simple guard which calls sfree. See scoped_cptr for details.
 103 typedef scoped_cptr<void> scoped_guard_sfree;
 104
 105 }      // namespace gmx
 106
 107 #endif