Replace PassRef with Ref/Ref&& across the board.
[WebKit-https.git] / Source / WTF / wtf / RefPtr.h
1 /*
2  *  Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2013 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 <utility>
28 #include <wtf/FastMalloc.h>
29 #include <wtf/GetPtr.h>
30 #include <wtf/PassRefPtr.h>
31
32 namespace WTF {
33
34     enum HashTableDeletedValueType { HashTableDeletedValue };
35
36     template<typename T> class RefPtr {
37         WTF_MAKE_FAST_ALLOCATED;
38     public:
39         typedef T ValueType;
40         typedef ValueType* PtrType;
41
42         ALWAYS_INLINE RefPtr() : m_ptr(nullptr) { }
43         ALWAYS_INLINE RefPtr(T* ptr) : m_ptr(ptr) { refIfNotNull(ptr); }
44         ALWAYS_INLINE RefPtr(const RefPtr& o) : m_ptr(o.m_ptr) { refIfNotNull(m_ptr); }
45         template<typename U> RefPtr(const RefPtr<U>& o) : m_ptr(o.get()) { refIfNotNull(m_ptr); }
46
47         ALWAYS_INLINE RefPtr(RefPtr&& o) : m_ptr(o.release().leakRef()) { }
48         template<typename U> RefPtr(RefPtr<U>&& o) : m_ptr(o.release().leakRef()) { }
49
50         // See comments in PassRefPtr.h for an explanation of why this takes a const reference.
51         template<typename U> RefPtr(const PassRefPtr<U>&);
52
53         template<typename U> RefPtr(Ref<U>&&);
54
55         // Hash table deleted values, which are only constructed and never copied or destroyed.
56         RefPtr(HashTableDeletedValueType) : m_ptr(hashTableDeletedValue()) { }
57         bool isHashTableDeletedValue() const { return m_ptr == hashTableDeletedValue(); }
58
59         ALWAYS_INLINE ~RefPtr() { derefIfNotNull(m_ptr); }
60
61         T* get() const { return m_ptr; }
62         
63         void clear();
64         PassRefPtr<T> release() { PassRefPtr<T> tmp = adoptRef(m_ptr); m_ptr = nullptr; return tmp; }
65         Ref<T> releaseNonNull() { ASSERT(m_ptr); Ref<T> tmp(adoptRef(*m_ptr)); m_ptr = nullptr; return tmp; }
66
67         T* leakRef() WARN_UNUSED_RETURN;
68
69         T& operator*() const { return *m_ptr; }
70         ALWAYS_INLINE T* operator->() const { return m_ptr; }
71         
72         bool operator!() const { return !m_ptr; }
73     
74         // This conversion operator allows implicit conversion to bool but not to other integer types.
75         typedef T* (RefPtr::*UnspecifiedBoolType);
76         operator UnspecifiedBoolType() const { return m_ptr ? &RefPtr::m_ptr : nullptr; }
77         
78         RefPtr& operator=(const RefPtr&);
79         RefPtr& operator=(T*);
80         RefPtr& operator=(const PassRefPtr<T>&);
81         template<typename U> RefPtr& operator=(const RefPtr<U>&);
82         template<typename U> RefPtr& operator=(const PassRefPtr<U>&);
83         RefPtr& operator=(RefPtr&&);
84         template<typename U> RefPtr& operator=(RefPtr<U>&&);
85         template<typename U> RefPtr& operator=(Ref<U>&&);
86
87         void swap(RefPtr&);
88
89         static T* hashTableDeletedValue() { return reinterpret_cast<T*>(-1); }
90
91     private:
92         T* m_ptr;
93     };
94     
95     template<typename T> template<typename U> inline RefPtr<T>::RefPtr(const PassRefPtr<U>& o)
96         : m_ptr(o.leakRef())
97     {
98     }
99
100     template<typename T> template<typename U> inline RefPtr<T>::RefPtr(Ref<U>&& reference)
101         : m_ptr(&reference.leakRef())
102     {
103     }
104
105     template<typename T> inline void RefPtr<T>::clear()
106     {
107         T* ptr = m_ptr;
108         m_ptr = nullptr;
109         derefIfNotNull(ptr);
110     }
111
112     template<typename T>
113     inline T* RefPtr<T>::leakRef()
114     {
115         T* ptr = m_ptr;
116         m_ptr = nullptr;
117
118         return ptr;
119     }
120
121     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(const RefPtr& o)
122     {
123         RefPtr ptr = o;
124         swap(ptr);
125         return *this;
126     }
127     
128     template<typename T> template<typename U> inline RefPtr<T>& RefPtr<T>::operator=(const RefPtr<U>& o)
129     {
130         RefPtr ptr = o;
131         swap(ptr);
132         return *this;
133     }
134     
135     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(T* optr)
136     {
137         RefPtr ptr = optr;
138         swap(ptr);
139         return *this;
140     }
141
142     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(const PassRefPtr<T>& o)
143     {
144         RefPtr ptr = o;
145         swap(ptr);
146         return *this;
147     }
148
149     template<typename T> template<typename U> inline RefPtr<T>& RefPtr<T>::operator=(const PassRefPtr<U>& o)
150     {
151         RefPtr ptr = o;
152         swap(ptr);
153         return *this;
154     }
155
156     template<typename T> inline RefPtr<T>& RefPtr<T>::operator=(RefPtr&& o)
157     {
158         RefPtr ptr = WTF::move(o);
159         swap(ptr);
160         return *this;
161     }
162
163     template<typename T> template<typename U> inline RefPtr<T>& RefPtr<T>::operator=(RefPtr<U>&& o)
164     {
165         RefPtr ptr = WTF::move(o);
166         swap(ptr);
167         return *this;
168     }
169
170     template<typename T> template<typename U> inline RefPtr<T>& RefPtr<T>::operator=(Ref<U>&& reference)
171     {
172         RefPtr ptr = WTF::move(reference);
173         swap(ptr);
174         return *this;
175     }
176
177     template<class T> inline void RefPtr<T>::swap(RefPtr& o)
178     {
179         std::swap(m_ptr, o.m_ptr);
180     }
181
182     template<class T> inline void swap(RefPtr<T>& a, RefPtr<T>& b)
183     {
184         a.swap(b);
185     }
186
187     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, const RefPtr<U>& b)
188     { 
189         return a.get() == b.get(); 
190     }
191
192     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, U* b)
193     { 
194         return a.get() == b; 
195     }
196     
197     template<typename T, typename U> inline bool operator==(T* a, const RefPtr<U>& b) 
198     {
199         return a == b.get(); 
200     }
201     
202     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, const RefPtr<U>& b)
203     { 
204         return a.get() != b.get(); 
205     }
206
207     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, U* b)
208     {
209         return a.get() != b; 
210     }
211
212     template<typename T, typename U> inline bool operator!=(T* a, const RefPtr<U>& b)
213     { 
214         return a != b.get(); 
215     }
216     
217     template<typename T, typename U> inline RefPtr<T> static_pointer_cast(const RefPtr<U>& p)
218     { 
219         return RefPtr<T>(static_cast<T*>(p.get())); 
220     }
221
222     template <typename T> struct IsSmartPtr<RefPtr<T>> {
223         static const bool value = true;
224     };
225
226 } // namespace WTF
227
228 using WTF::RefPtr;
229 using WTF::static_pointer_cast;
230
231 #endif // WTF_RefPtr_h