src/gromacs/utility/scoped_cptr.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   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 "config.h"
  47
  48 #include "gromacs/utility/common.h"
  49 #include "gromacs/utility/smalloc.h"
  50
  51 namespace gmx
  52 {
  53
  54 //! sfree wrapper to be used as scoped_cptr deleter
  55 template <class T>
  56 inline void sfree_wrapper(T *p)
  57 {
  58     sfree(p);
  59 }
  60
  61 /*! \libinternal \brief
  62  * Stripped-down version of scoped_ptr that uses sfree() or custom deleter.
  63  *
  64  * Currently only implements some operations; other operations can be added
  65  * if they become necessary.
  66  *
  67  * This class provides a basic guard/smart pointer for C pointers.
  68  *
  69  * Methods in this class do not throw.
  70  *
  71  * \inlibraryapi
  72  * \ingroup module_utility
  73  */
  74 template <class T, void D(T *) = sfree_wrapper>
  75 class scoped_cptr
  76 {
  77     public:
  78         /*! \brief
  79          * Initializes a scoped_ptr that frees \p ptr on scope exit.
  80          *
  81          * \param[in] ptr  Pointer to use for initialization.
  82          */
  83         explicit scoped_cptr(T *ptr) : ptr_(ptr) {}
  84         //! Frees the pointer passed to the constructor.
  85         ~scoped_cptr() { D(ptr_); }
  86         //! Returns the stored pointer.
  87         T * get() const { return ptr_; }
  88         //! Check for non-null pointer in boolean context.
  89 #ifdef GMX_CXX11
  90         explicit
  91 #endif
  92         operator bool () const { return ptr_ != 0; }
  93
  94     private:
  95         T                    *ptr_;
  96
  97         GMX_DISALLOW_COPY_AND_ASSIGN(scoped_cptr);
  98 };
  99
 100 //! Simple guard which calls sfree. See scoped_cptr for details.
 101 typedef scoped_cptr<void> scoped_guard_sfree;
 102
 103 }      // namespace gmx
 104
 105 #endif