Source/WTF/wtf/OwnPtr.h

   1 /*
   2  *  Copyright (C) 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
   3  *
   4  *  This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  *  This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU Library General Public License
  15  *  along with this library; see the file COPYING.LIB.  If not, write to
  16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  *  Boston, MA 02110-1301, USA.
  18  *
  19  */
  20
  21 #ifndef WTF_OwnPtr_h
  22 #define WTF_OwnPtr_h
  23
  24 #include <wtf/Assertions.h>
  25 #include <wtf/NullPtr.h>
  26 #include <wtf/OwnPtrCommon.h>
  27 #include <wtf/TypeTraits.h>
  28 #include <algorithm>
  29 #include <memory>
  30
  31 namespace WTF {
  32
  33     // Unlike most of our smart pointers, OwnPtr can take either the pointer type or the pointed-to type.
  34
  35     template<typename T> class PassOwnPtr;
  36     template<typename T> PassOwnPtr<T> adoptPtr(T*);
  37
  38     template<typename T> class OwnPtr {
  39     public:
  40         typedef typename RemovePointer<T>::Type ValueType;
  41         typedef ValueType* PtrType;
  42
  43         OwnPtr() : m_ptr(0) { }
  44         OwnPtr(std::nullptr_t) : m_ptr(0) { }
  45
  46         // See comment in PassOwnPtr.h for why this takes a const reference.
  47         template<typename U> OwnPtr(const PassOwnPtr<U>& o);
  48
  49         // This copy constructor is used implicitly by gcc when it generates
  50         // transients for assigning a PassOwnPtr<T> object to a stack-allocated
  51         // OwnPtr<T> object. It should never be called explicitly and gcc
  52         // should optimize away the constructor when generating code.
  53         OwnPtr(const OwnPtr<ValueType>&);
  54
  55         ~OwnPtr() { deleteOwnedPtr(m_ptr); }
  56
  57         PtrType get() const { return m_ptr; }
  58
  59         void clear();
  60         PassOwnPtr<T> release();
  61         PtrType leakPtr() WARN_UNUSED_RETURN;
  62
  63         ValueType& operator*() const { ASSERT(m_ptr); return *m_ptr; }
  64         PtrType operator->() const { ASSERT(m_ptr); return m_ptr; }
  65
  66         bool operator!() const { return !m_ptr; }
  67
  68         // This conversion operator allows implicit conversion to bool but not to other integer types.
  69         typedef PtrType OwnPtr::*UnspecifiedBoolType;
  70         operator UnspecifiedBoolType() const { return m_ptr ? &OwnPtr::m_ptr : 0; }
  71
  72         OwnPtr& operator=(const PassOwnPtr<T>&);
  73         OwnPtr& operator=(std::nullptr_t) { clear(); return *this; }
  74         template<typename U> OwnPtr& operator=(const PassOwnPtr<U>&);
  75
  76         void swap(OwnPtr& o) { std::swap(m_ptr, o.m_ptr); }
  77
  78     private:
  79         OwnPtr& operator=(const OwnPtr<T>&);
  80
  81         // We should never have two OwnPtrs for the same underlying object (otherwise we'll get
  82         // double-destruction), so these equality operators should never be needed.
  83         template<typename U> bool operator==(const OwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
  84         template<typename U> bool operator!=(const OwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
  85         template<typename U> bool operator==(const PassOwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
  86         template<typename U> bool operator!=(const PassOwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
  87
  88         PtrType m_ptr;
  89     };
  90
  91     template<typename T> template<typename U> inline OwnPtr<T>::OwnPtr(const PassOwnPtr<U>& o)
  92         : m_ptr(o.leakPtr())
  93     {
  94     }
  95
  96     template<typename T> inline void OwnPtr<T>::clear()
  97     {
  98         PtrType ptr = m_ptr;
  99         m_ptr = 0;
 100         deleteOwnedPtr(ptr);
 101     }
 102
 103     template<typename T> inline PassOwnPtr<T> OwnPtr<T>::release()
 104     {
 105         PtrType ptr = m_ptr;
 106         m_ptr = 0;
 107         return adoptPtr(ptr);
 108     }
 109
 110     template<typename T> inline typename OwnPtr<T>::PtrType OwnPtr<T>::leakPtr()
 111     {
 112         PtrType ptr = m_ptr;
 113         m_ptr = 0;
 114         return ptr;
 115     }
 116
 117     template<typename T> inline OwnPtr<T>& OwnPtr<T>::operator=(const PassOwnPtr<T>& o)
 118     {
 119         PtrType ptr = m_ptr;
 120         m_ptr = o.leakPtr();
 121         ASSERT(!ptr || m_ptr != ptr);
 122         deleteOwnedPtr(ptr);
 123         return *this;
 124     }
 125
 126     template<typename T> template<typename U> inline OwnPtr<T>& OwnPtr<T>::operator=(const PassOwnPtr<U>& o)
 127     {
 128         PtrType ptr = m_ptr;
 129         m_ptr = o.leakPtr();
 130         ASSERT(!ptr || m_ptr != ptr);
 131         deleteOwnedPtr(ptr);
 132         return *this;
 133     }
 134
 135     template<typename T> inline void swap(OwnPtr<T>& a, OwnPtr<T>& b)
 136     {
 137         a.swap(b);
 138     }
 139
 140     template<typename T, typename U> inline bool operator==(const OwnPtr<T>& a, U* b)
 141     {
 142         return a.get() == b;
 143     }
 144
 145     template<typename T, typename U> inline bool operator==(T* a, const OwnPtr<U>& b)
 146     {
 147         return a == b.get();
 148     }
 149
 150     template<typename T, typename U> inline bool operator!=(const OwnPtr<T>& a, U* b)
 151     {
 152         return a.get() != b;
 153     }
 154
 155     template<typename T, typename U> inline bool operator!=(T* a, const OwnPtr<U>& b)
 156     {
 157         return a != b.get();
 158     }
 159
 160     template<typename T> inline typename OwnPtr<T>::PtrType getPtr(const OwnPtr<T>& p)
 161     {
 162         return p.get();
 163     }
 164
 165 } // namespace WTF
 166
 167 using WTF::OwnPtr;
 168
 169 #endif // WTF_OwnPtr_h