Source/WTF/wtf/RefPtr.h

   1 /*
   2  *  Copyright (C) 2005, 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 // RefPtr and PassRefPtr are documented at http://webkit.org/coding/RefPtr.html
  22
  23 #ifndef WTF_RefPtr_h
  24 #define WTF_RefPtr_h
  25
  26 #include <algorithm>
  27 #include <wtf/FastAllocBase.h>
  28 #include <wtf/PassRefPtr.h>
  29
  30 namespace WTF {
  31
  32     enum PlacementNewAdoptType { PlacementNewAdopt };
  33
  34     template<typename T> class PassRefPtr;
  35
  36     enum HashTableDeletedValueType { HashTableDeletedValue };
  37
  38     template<typename T> class RefPtr {
  39         WTF_MAKE_FAST_ALLOCATED;
  40     public:
  41         ALWAYS_INLINE RefPtr() : m_ptr(0) { }
  42         ALWAYS_INLINE RefPtr(T* ptr) : m_ptr(ptr) { refIfNotNull(ptr); }
  43         ALWAYS_INLINE RefPtr(const RefPtr& o) : m_ptr(o.m_ptr) { refIfNotNull(m_ptr); }
  44         template<typename U> RefPtr(const RefPtr<U>& o) : m_ptr(o.get()) { refIfNotNull(m_ptr); }
  45
  46         // See comments in PassRefPtr.h for an explanation of why this takes a const reference.
  47         template<typename U> RefPtr(const PassRefPtr<U>&);
  48
  49         // Special constructor for cases where we overwrite an object in place.
  50         ALWAYS_INLINE RefPtr(PlacementNewAdoptType) { }
  51
  52         // Hash table deleted values, which are only constructed and never copied or destroyed.
  53         RefPtr(HashTableDeletedValueType) : m_ptr(hashTableDeletedValue()) { }
  54         bool isHashTableDeletedValue() const { return m_ptr == hashTableDeletedValue(); }
  55
  56         ALWAYS_INLINE ~RefPtr() { derefIfNotNull(m_ptr); }
  57
  58         T* get() const { return m_ptr; }
  59
  60         void clear();
  61         PassRefPtr<T> release() { PassRefPtr<T> tmp = adoptRef(m_ptr); m_ptr = 0; return tmp; }
  62
  63         T& operator*() const { return *m_ptr; }
  64         ALWAYS_INLINE T* operator->() const { 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 T* (RefPtr::*UnspecifiedBoolType);
  70         operator UnspecifiedBoolType() const { return m_ptr ? &RefPtr::m_ptr : 0; }
  71
  72         RefPtr& operator=(const RefPtr&);
  73         RefPtr& operator=(T*);
  74         RefPtr& operator=(const PassRefPtr<T>&);
  75 #if !COMPILER_SUPPORTS(CXX_NULLPTR)
  76         RefPtr& operator=(std::nullptr_t) { clear(); return *this; }
  77 #endif
  78         template<typename U> RefPtr& operator=(const RefPtr<U>&);
  79         template<typename U> RefPtr& operator=(const PassRefPtr<U>&);
  80
  81         void swap(RefPtr&);
  82
  83         static T* hashTableDeletedValue() { return reinterpret_cast<T*>(-1); }
  84
  85     private:
  86         T* m_ptr;
  87     };
  88
  89     template<typename T> template<typename U> inline RefPtr<T>::RefPtr(const PassRefPtr<U>& o)
  90         : m_ptr(o.leakRef())
  91     {
  92     }
  93
  94     template<typename T> inline void RefPtr<T>::clear()
  95     {
  96         T* ptr = m_ptr;
  97         m_ptr = 0;
  98         derefIfNotNull(ptr);
  99     }
 100
 101     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(const RefPtr<T>& o)
 102     {
 103         T* optr = o.get();
 104         refIfNotNull(optr);
 105         T* ptr = m_ptr;
 106         m_ptr = optr;
 107         derefIfNotNull(ptr);
 108         return *this;
 109     }
 110
 111     template<typename T> template<typename U> inline RefPtr<T>& RefPtr<T>::operator=(const RefPtr<U>& o)
 112     {
 113         T* optr = o.get();
 114         refIfNotNull(optr);
 115         T* ptr = m_ptr;
 116         m_ptr = optr;
 117         derefIfNotNull(ptr);
 118         return *this;
 119     }
 120
 121     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(T* optr)
 122     {
 123         refIfNotNull(optr);
 124         T* ptr = m_ptr;
 125         m_ptr = optr;
 126         derefIfNotNull(ptr);
 127         return *this;
 128     }
 129
 130     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(const PassRefPtr<T>& o)
 131     {
 132         T* ptr = m_ptr;
 133         m_ptr = o.leakRef();
 134         derefIfNotNull(ptr);
 135         return *this;
 136     }
 137
 138     template<typename T> template<typename U> inline RefPtr<T>& RefPtr<T>::operator=(const PassRefPtr<U>& o)
 139     {
 140         T* ptr = m_ptr;
 141         m_ptr = o.leakRef();
 142         derefIfNotNull(ptr);
 143         return *this;
 144     }
 145
 146     template<class T> inline void RefPtr<T>::swap(RefPtr<T>& o)
 147     {
 148         std::swap(m_ptr, o.m_ptr);
 149     }
 150
 151     template<class T> inline void swap(RefPtr<T>& a, RefPtr<T>& b)
 152     {
 153         a.swap(b);
 154     }
 155
 156     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, const RefPtr<U>& b)
 157     {
 158         return a.get() == b.get();
 159     }
 160
 161     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, U* b)
 162     {
 163         return a.get() == b;
 164     }
 165
 166     template<typename T, typename U> inline bool operator==(T* a, const RefPtr<U>& b)
 167     {
 168         return a == b.get();
 169     }
 170
 171     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, const RefPtr<U>& b)
 172     {
 173         return a.get() != b.get();
 174     }
 175
 176     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, U* b)
 177     {
 178         return a.get() != b;
 179     }
 180
 181     template<typename T, typename U> inline bool operator!=(T* a, const RefPtr<U>& b)
 182     {
 183         return a != b.get();
 184     }
 185
 186     template<typename T, typename U> inline RefPtr<T> static_pointer_cast(const RefPtr<U>& p)
 187     {
 188         return RefPtr<T>(static_cast<T*>(p.get()));
 189     }
 190
 191     template<typename T, typename U> inline RefPtr<T> const_pointer_cast(const RefPtr<U>& p)
 192     {
 193         return RefPtr<T>(const_cast<T*>(p.get()));
 194     }
 195
 196     template<typename T> inline T* getPtr(const RefPtr<T>& p)
 197     {
 198         return p.get();
 199     }
 200
 201 } // namespace WTF
 202
 203 using WTF::RefPtr;
 204 using WTF::static_pointer_cast;
 205 using WTF::const_pointer_cast;
 206
 207 #endif // WTF_RefPtr_h