boost/boost/scoped_ptr.hpp

   1 #ifndef BOOST_SCOPED_PTR_HPP_INCLUDED
   2 #define BOOST_SCOPED_PTR_HPP_INCLUDED
   3
   4 //  (C) Copyright Greg Colvin and Beman Dawes 1998, 1999.
   5 //  Copyright (c) 2001, 2002 Peter Dimov
   6 //
   7 //  Permission to copy, use, modify, sell and distribute this software
   8 //  is granted provided this copyright notice appears in all copies.
   9 //  This software is provided "as is" without express or implied
  10 //  warranty, and with no claim as to its suitability for any purpose.
  11 //
  12 //  http://www.boost.org/libs/smart_ptr/scoped_ptr.htm
  13 //
  14
  15 #include <boost/assert.hpp>
  16 #include <boost/checked_delete.hpp>
  17
  18 #ifndef BOOST_NO_AUTO_PTR
  19 # include <memory>          // for std::auto_ptr
  20 #endif
  21
  22 namespace boost
  23 {
  24
  25 // Debug hooks
  26
  27 #if defined(BOOST_SP_ENABLE_DEBUG_HOOKS)
  28
  29 void sp_scalar_constructor_hook(void * p);
  30 void sp_scalar_destructor_hook(void * p);
  31
  32 #endif
  33
  34 //  scoped_ptr mimics a built-in pointer except that it guarantees deletion
  35 //  of the object pointed to, either on destruction of the scoped_ptr or via
  36 //  an explicit reset(). scoped_ptr is a simple solution for simple needs;
  37 //  use shared_ptr or std::auto_ptr if your needs are more complex.
  38
  39 template<class T> class scoped_ptr // noncopyable
  40 {
  41 private:
  42
  43     T * ptr;
  44
  45     scoped_ptr(scoped_ptr const &);
  46     scoped_ptr & operator=(scoped_ptr const &);
  47
  48     typedef scoped_ptr<T> this_type;
  49
  50 public:
  51
  52     typedef T element_type;
  53
  54     explicit scoped_ptr(T * p = 0): ptr(p) // never throws
  55     {
  56 #if defined(BOOST_SP_ENABLE_DEBUG_HOOKS)
  57         boost::sp_scalar_constructor_hook(ptr);
  58 #endif
  59     }
  60
  61 #ifndef BOOST_NO_AUTO_PTR
  62
  63     explicit scoped_ptr(std::auto_ptr<T> p): ptr(p.release()) // never throws
  64     {
  65 #if defined(BOOST_SP_ENABLE_DEBUG_HOOKS)
  66         boost::sp_scalar_constructor_hook(ptr);
  67 #endif
  68     }
  69
  70 #endif
  71
  72     ~scoped_ptr() // never throws
  73     {
  74 #if defined(BOOST_SP_ENABLE_DEBUG_HOOKS)
  75         boost::sp_scalar_destructor_hook(ptr);
  76 #endif
  77         boost::checked_delete(ptr);
  78     }
  79
  80     void reset(T * p = 0) // never throws
  81     {
  82         BOOST_ASSERT(p == 0 || p != ptr); // catch self-reset errors
  83         this_type(p).swap(*this);
  84     }
  85
  86     T & operator*() const // never throws
  87     {
  88         BOOST_ASSERT(ptr != 0);
  89         return *ptr;
  90     }
  91
  92     T * operator->() const // never throws
  93     {
  94         BOOST_ASSERT(ptr != 0);
  95         return ptr;
  96     }
  97
  98     T * get() const // never throws
  99     {
 100         return ptr;
 101     }
 102
 103     // implicit conversion to "bool"
 104
 105     typedef T * (this_type::*unspecified_bool_type)() const;
 106
 107     operator unspecified_bool_type() const // never throws
 108     {
 109         return ptr == 0? 0: &this_type::get;
 110     }
 111
 112     bool operator! () const // never throws
 113     {
 114         return ptr == 0;
 115     }
 116
 117     void swap(scoped_ptr & b) // never throws
 118     {
 119         T * tmp = b.ptr;
 120         b.ptr = ptr;
 121         ptr = tmp;
 122     }
 123 };
 124
 125 template<class T> inline void swap(scoped_ptr<T> & a, scoped_ptr<T> & b) // never throws
 126 {
 127     a.swap(b);
 128 }
 129
 130 // get_pointer(p) is a generic way to say p.get()
 131
 132 template<class T> inline T * get_pointer(scoped_ptr<T> const & p)
 133 {
 134     return p.get();
 135 }
 136
 137 } // namespace boost
 138
 139 #endif // #ifndef BOOST_SCOPED_PTR_HPP_INCLUDED