5c8b3f2be8ad23b413eee102e57dabd8a4c87ae8
[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 "PassRef.h"
25
26 namespace WTF {
27
28     template<typename T> PassRefPtr<T> adoptRef(T*);
29
30     template<typename T> ALWAYS_INLINE void refIfNotNull(T* ptr)
31     {
32         if (LIKELY(ptr != nullptr))
33             ptr->ref();
34     }
35
36     template<typename T> ALWAYS_INLINE void derefIfNotNull(T* ptr)
37     {
38         if (LIKELY(ptr != nullptr))
39             ptr->deref();
40     }
41
42     template<typename T> class PassRefPtr {
43     public:
44         PassRefPtr() : m_ptr(nullptr) { }
45         PassRefPtr(T* ptr) : m_ptr(ptr) { refIfNotNull(ptr); }
46         // It somewhat breaks the type system to allow transfer of ownership out of
47         // a const PassRefPtr. However, it makes it much easier to work with PassRefPtr
48         // temporaries, and we don't have a need to use real const PassRefPtrs anyway.
49         PassRefPtr(const PassRefPtr& o) : m_ptr(o.leakRef()) { }
50         template<typename U> PassRefPtr(const PassRefPtr<U>& o) : m_ptr(o.leakRef()) { }
51
52         ALWAYS_INLINE ~PassRefPtr() { derefIfNotNull(m_ptr); }
53
54         template<typename U> PassRefPtr(const RefPtr<U>&);
55         template<typename U> PassRefPtr(PassRef<U> reference) : m_ptr(&reference.takeReference()) { }
56
57         T* get() const { return m_ptr; }
58
59         T* leakRef() const WARN_UNUSED_RETURN;
60
61         T& operator*() const { return *m_ptr; }
62         T* operator->() const { return m_ptr; }
63
64         bool operator!() const { return !m_ptr; }
65
66         // This conversion operator allows implicit conversion to bool but not to other integer types.
67         typedef T* (PassRefPtr::*UnspecifiedBoolType);
68         operator UnspecifiedBoolType() const { return m_ptr ? &PassRefPtr::m_ptr : nullptr; }
69
70         friend PassRefPtr adoptRef<T>(T*);
71
72     private:
73         PassRefPtr& operator=(const PassRefPtr&) WTF_DELETED_FUNCTION;
74
75         enum AdoptTag { Adopt };
76         PassRefPtr(T* ptr, AdoptTag) : m_ptr(ptr) { }
77
78         mutable T* m_ptr;
79     };
80     
81     template<typename T> template<typename U> inline PassRefPtr<T>::PassRefPtr(const RefPtr<U>& o)
82         : m_ptr(o.get())
83     {
84         T* ptr = m_ptr;
85         refIfNotNull(ptr);
86     }
87
88     template<typename T> inline T* PassRefPtr<T>::leakRef() const
89     {
90         T* ptr = m_ptr;
91         m_ptr = nullptr;
92         return ptr;
93     }
94
95     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
96     { 
97         return a.get() == b.get(); 
98     }
99
100     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const RefPtr<U>& b) 
101     { 
102         return a.get() == b.get(); 
103     }
104
105     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, const PassRefPtr<U>& b) 
106     { 
107         return a.get() == b.get(); 
108     }
109
110     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, U* b) 
111     { 
112         return a.get() == b; 
113     }
114     
115     template<typename T, typename U> inline bool operator==(T* a, const PassRefPtr<U>& b) 
116     {
117         return a == b.get(); 
118     }
119     
120     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
121     { 
122         return a.get() != b.get(); 
123     }
124
125     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const RefPtr<U>& b) 
126     { 
127         return a.get() != b.get(); 
128     }
129
130     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, const PassRefPtr<U>& b) 
131     { 
132         return a.get() != b.get(); 
133     }
134
135     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, U* b)
136     {
137         return a.get() != b; 
138     }
139
140     template<typename T, typename U> inline bool operator!=(T* a, const PassRefPtr<U>& b) 
141     { 
142         return a != b.get(); 
143     }
144     
145     template<typename T> inline PassRefPtr<T> adoptRef(T* p)
146     {
147         adopted(p);
148         return PassRefPtr<T>(p, PassRefPtr<T>::Adopt);
149     }
150
151     template<typename T, typename U> inline PassRefPtr<T> static_pointer_cast(const PassRefPtr<U>& p) 
152     { 
153         return adoptRef(static_cast<T*>(p.leakRef())); 
154     }
155
156     template<typename T> inline T* getPtr(const PassRefPtr<T>& p)
157     {
158         return p.get();
159     }
160
161 } // namespace WTF
162
163 using WTF::PassRefPtr;
164 using WTF::adoptRef;
165 using WTF::static_pointer_cast;
166
167 #endif // WTF_PassRefPtr_h