207721c967f31321a299a51263e4fa2149fed016
[WebKit-https.git] / Source / WTF / wtf / PassRefPtr.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 #ifndef WTF_PassRefPtr_h
22 #define WTF_PassRefPtr_h
23
24 #include <wtf/AlwaysInline.h>
25 #include <wtf/NullPtr.h>
26
27 namespace WTF {
28
29     template<typename T> class RefPtr;
30     template<typename T> class PassRefPtr;
31     template<typename T> PassRefPtr<T> adoptRef(T*);
32
33     inline void adopted(const void*) { }
34
35 #if !PLATFORM(QT)
36     #define REF_DEREF_INLINE ALWAYS_INLINE
37 #else
38     // Using ALWAYS_INLINE broke the Qt build. This may be a GCC bug.
39     // See https://bugs.webkit.org/show_bug.cgi?id=37253 for details.
40     #define REF_DEREF_INLINE inline
41 #endif
42
43     template<typename T> REF_DEREF_INLINE void refIfNotNull(T* ptr)
44     {
45         if (LIKELY(ptr != 0))
46             ptr->ref();
47     }
48
49     template<typename T> REF_DEREF_INLINE void derefIfNotNull(T* ptr)
50     {
51         if (LIKELY(ptr != 0))
52             ptr->deref();
53     }
54
55     #undef REF_DEREF_INLINE
56
57     template<typename T> class PassRefPtr {
58     public:
59         PassRefPtr() : m_ptr(0) { }
60         PassRefPtr(T* ptr) : m_ptr(ptr) { refIfNotNull(ptr); }
61         // It somewhat breaks the type system to allow transfer of ownership out of
62         // a const PassRefPtr. However, it makes it much easier to work with PassRefPtr
63         // temporaries, and we don't have a need to use real const PassRefPtrs anyway.
64         PassRefPtr(const PassRefPtr& o) : m_ptr(o.leakRef()) { }
65         template<typename U> PassRefPtr(const PassRefPtr<U>& o) : m_ptr(o.leakRef()) { }
66
67         ALWAYS_INLINE ~PassRefPtr() { derefIfNotNull(m_ptr); }
68
69         template<typename U> PassRefPtr(const RefPtr<U>&);
70         
71         T* get() const { return m_ptr; }
72
73         T* leakRef() const WARN_UNUSED_RETURN;
74
75         T& operator*() const { return *m_ptr; }
76         T* operator->() const { return m_ptr; }
77
78         bool operator!() const { return !m_ptr; }
79
80         // This conversion operator allows implicit conversion to bool but not to other integer types.
81         typedef T* (PassRefPtr::*UnspecifiedBoolType);
82         operator UnspecifiedBoolType() const { return m_ptr ? &PassRefPtr::m_ptr : 0; }
83
84         PassRefPtr& operator=(const PassRefPtr&) { COMPILE_ASSERT(!sizeof(T*), PassRefPtr_should_never_be_assigned_to); return *this; }
85
86         friend PassRefPtr adoptRef<T>(T*);
87
88     private:
89         // adopting constructor
90         PassRefPtr(T* ptr, bool) : m_ptr(ptr) { }
91
92         mutable T* m_ptr;
93     };
94     
95     // NonNullPassRefPtr: Optimized for passing non-null pointers. A NonNullPassRefPtr
96     // begins life non-null, and can only become null through a call to leakRef()
97     // or clear().
98
99     // FIXME: NonNullPassRefPtr could just inherit from PassRefPtr. However,
100     // if we use inheritance, GCC's optimizer fails to realize that destruction
101     // of a released NonNullPassRefPtr is a no-op. So, for now, just copy the
102     // most important code from PassRefPtr.
103     template<typename T> class NonNullPassRefPtr {
104     public:
105         NonNullPassRefPtr(T* ptr)
106             : m_ptr(ptr)
107         {
108             ASSERT(m_ptr);
109             m_ptr->ref();
110         }
111
112         template<typename U> NonNullPassRefPtr(const RefPtr<U>& o)
113             : m_ptr(o.get())
114         {
115             ASSERT(m_ptr);
116             m_ptr->ref();
117         }
118
119         NonNullPassRefPtr(const NonNullPassRefPtr& o)
120             : m_ptr(o.leakRef())
121         {
122             ASSERT(m_ptr);
123         }
124
125         template<typename U> NonNullPassRefPtr(const NonNullPassRefPtr<U>& o)
126             : m_ptr(o.leakRef())
127         {
128             ASSERT(m_ptr);
129         }
130
131         template<typename U> NonNullPassRefPtr(const PassRefPtr<U>& o)
132             : m_ptr(o.leakRef())
133         {
134             ASSERT(m_ptr);
135         }
136
137         ALWAYS_INLINE ~NonNullPassRefPtr() { derefIfNotNull(m_ptr); }
138
139         T* get() const { return m_ptr; }
140
141         T* leakRef() const WARN_UNUSED_RETURN { T* tmp = m_ptr; m_ptr = 0; return tmp; }
142
143         T& operator*() const { return *m_ptr; }
144         T* operator->() const { return m_ptr; }
145
146         NonNullPassRefPtr& operator=(const NonNullPassRefPtr&) { COMPILE_ASSERT(!sizeof(T*), NonNullPassRefPtr_should_never_be_assigned_to); return *this; }
147
148     private:
149         mutable T* m_ptr;
150     };
151
152     template<typename T> template<typename U> inline PassRefPtr<T>::PassRefPtr(const RefPtr<U>& o)
153         : m_ptr(o.get())
154     {
155         T* ptr = m_ptr;
156         refIfNotNull(ptr);
157     }
158
159     template<typename T> inline T* PassRefPtr<T>::leakRef() const
160     {
161         T* ptr = m_ptr;
162         m_ptr = 0;
163         return ptr;
164     }
165
166     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
167     { 
168         return a.get() == b.get(); 
169     }
170
171     template<typename T, typename U> inline bool operator==(const PassRefPtr<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, const PassRefPtr<U>& b) 
177     { 
178         return a.get() == b.get(); 
179     }
180
181     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, U* b) 
182     { 
183         return a.get() == b; 
184     }
185     
186     template<typename T, typename U> inline bool operator==(T* a, const PassRefPtr<U>& b) 
187     {
188         return a == b.get(); 
189     }
190     
191     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
192     { 
193         return a.get() != b.get(); 
194     }
195
196     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const RefPtr<U>& b) 
197     { 
198         return a.get() != b.get(); 
199     }
200
201     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, const PassRefPtr<U>& b) 
202     { 
203         return a.get() != b.get(); 
204     }
205
206     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, U* b)
207     {
208         return a.get() != b; 
209     }
210
211     template<typename T, typename U> inline bool operator!=(T* a, const PassRefPtr<U>& b) 
212     { 
213         return a != b.get(); 
214     }
215     
216     template<typename T> inline PassRefPtr<T> adoptRef(T* p)
217     {
218         adopted(p);
219         return PassRefPtr<T>(p, true);
220     }
221
222     template<typename T, typename U> inline PassRefPtr<T> static_pointer_cast(const PassRefPtr<U>& p) 
223     { 
224         return adoptRef(static_cast<T*>(p.leakRef())); 
225     }
226
227     template<typename T, typename U> inline PassRefPtr<T> const_pointer_cast(const PassRefPtr<U>& p) 
228     { 
229         return adoptRef(const_cast<T*>(p.leakRef())); 
230     }
231
232     template<typename T> inline T* getPtr(const PassRefPtr<T>& p)
233     {
234         return p.get();
235     }
236
237 } // namespace WTF
238
239 using WTF::PassRefPtr;
240 using WTF::NonNullPassRefPtr;
241 using WTF::adoptRef;
242 using WTF::static_pointer_cast;
243 using WTF::const_pointer_cast;
244
245 #endif // WTF_PassRefPtr_h