Create scoped_cptr to replace scoped_ptr_sfree

[alexxy/gromacs.git] / src / gromacs / utility / scoped_cptr.h

diff --git a/src/gromacs/utility/scoped_ptr_sfree.h b/src/gromacs/utility/scoped_cptr.h
similarity index 70%
rename from src/gromacs/utility/scoped_ptr_sfree.h
rename to src/gromacs/utility/scoped_cptr.h
index 7078a80aebfd6b9958df7838bac473d002d5baa2..f4b9ada399c4ec5ed2650597fdaf1e9439b76dce 100644 (file)
--- a/src/gromacs/utility/scoped_ptr_sfree.h
+++ b/src/gromacs/utility/scoped_cptr.h
@@ -34,7 +34,7 @@
  */
 /*! \libinternal \file
  * \brief
- * Declares gmx::scoped_ptr_sfree.
+ * Declares gmx::scoped_cptr and gmx::scoped_guard_sfree.
  *
  * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inlibraryapi
@@ -43,30 +43,36 @@
 #ifndef GMX_UTILITY_SCOPED_PTR_SFREE_H
 #define GMX_UTILITY_SCOPED_PTR_SFREE_H
 
+#include "config.h"
+
 #include "gromacs/utility/common.h"
 #include "gromacs/utility/smalloc.h"
 
 namespace gmx
 {
 
+//! sfree wrapper to be used as scoped_cptr deleter
+template <class T>
+inline void sfree_wrapper(T *p)
+{
+    sfree(p);
+}
+
 /*! \libinternal \brief
- * Stripped-down version of scoped_ptr that uses sfree().
+ * Stripped-down version of scoped_ptr that uses sfree() or custom deleter.
  *
- * Currently only implements constructor from a pointer value and destructor;
- * other operations can be added if they become necessary.
+ * Currently only implements some operations; other operations can be added
+ * if they become necessary.
  *
- * This class provides a very basic guard/smart pointer for C pointers.
- * Currently, boost::shared_ptr is used in a few locations that require more
- * flexibility, but is not suitable for all cases either.  A scoped_ptr with
- * deleter support would be a general enough implementation for all uses.
- * C++11 unique_ptr has this, but for non-C++11 support we need something else.
+ * This class provides a basic guard/smart pointer for C pointers.
  *
  * Methods in this class do not throw.
  *
  * \inlibraryapi
  * \ingroup module_utility
  */
-class scoped_ptr_sfree
+template <class T, void D(T *) = sfree_wrapper>
+class scoped_cptr
 {
     public:
         /*! \brief
@@ -74,16 +80,26 @@ class scoped_ptr_sfree
          *
          * \param[in] ptr  Pointer to use for initialization.
          */
-        explicit scoped_ptr_sfree(void *ptr) : ptr_(ptr) {}
+        explicit scoped_cptr(T *ptr) : ptr_(ptr) {}
         //! Frees the pointer passed to the constructor.
-        ~scoped_ptr_sfree() { sfree(ptr_); }
+        ~scoped_cptr() { D(ptr_); }
+        //! Returns the stored pointer.
+        T * get() const { return ptr_; }
+        //! Check for non-null pointer in boolean context.
+#ifdef GMX_CXX11
+        explicit
+#endif
+        operator bool () const { return ptr_ != 0; }
 
     private:
-        void                   *ptr_;
+        T                    *ptr_;
 
-        GMX_DISALLOW_COPY_AND_ASSIGN(scoped_ptr_sfree);
+        GMX_DISALLOW_COPY_AND_ASSIGN(scoped_cptr);
 };
 
+//! Simple guard which calls sfree. See scoped_cptr for details.
+typedef scoped_cptr<void> scoped_guard_sfree;
+
 }      // namespace gmx
 
 #endif