Remove home-brewed nullptr
[WebKit-https.git] / 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/Noncopyable.h>
26 #include <wtf/OwnPtrCommon.h>
27 #include <algorithm>
28 #include <cstddef>
29 #include <memory>
30
31 namespace WTF {
32
33     template<typename T> class PassOwnPtr;
34     template<typename T> PassOwnPtr<T> adoptPtr(T*);
35
36     template<typename T> class OwnPtr {
37     public:
38         typedef T ValueType;
39         typedef ValueType* PtrType;
40
41         OwnPtr() : m_ptr(0) { }
42         OwnPtr(std::nullptr_t) : m_ptr(0) { }
43
44         // See comment in PassOwnPtr.h for why this takes a const reference.
45         template<typename U> OwnPtr(const PassOwnPtr<U>& o);
46
47 #if !COMPILER_SUPPORTS(CXX_RVALUE_REFERENCES)
48         // This copy constructor is used implicitly by gcc when it generates
49         // transients for assigning a PassOwnPtr<T> object to a stack-allocated
50         // OwnPtr<T> object. It should never be called explicitly and gcc
51         // should optimize away the constructor when generating code.
52         OwnPtr(const OwnPtr<ValueType>&);
53 #endif
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 #if COMPILER_SUPPORTS(CXX_RVALUE_REFERENCES)
77         OwnPtr(OwnPtr&&);
78         template<typename U> OwnPtr(OwnPtr<U>&&);
79
80         OwnPtr& operator=(OwnPtr&&);
81         template<typename U> OwnPtr& operator=(OwnPtr<U>&&);
82 #endif
83
84         void swap(OwnPtr& o) { std::swap(m_ptr, o.m_ptr); }
85
86     private:
87         explicit OwnPtr(PtrType ptr) : m_ptr(ptr) { }
88
89         template<typename U> friend OwnPtr<U> createOwned();
90         template<typename U, typename A1> friend OwnPtr<U> createOwned(A1&&);
91         template<typename U, typename A1, typename A2> friend OwnPtr<U> createOwned(A1&&, A2&&);
92
93 #if !COMPILER_SUPPORTS(CXX_RVALUE_REFERENCES)
94         // If rvalue references are supported, noncopyable takes care of this.
95         OwnPtr& operator=(const OwnPtr&);
96 #endif
97
98         // We should never have two OwnPtrs for the same underlying object (otherwise we'll get
99         // double-destruction), so these equality operators should never be needed.
100         template<typename U> bool operator==(const OwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
101         template<typename U> bool operator!=(const OwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
102         template<typename U> bool operator==(const PassOwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
103         template<typename U> bool operator!=(const PassOwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; }
104
105         PtrType m_ptr;
106     };
107
108     template<typename T> template<typename U> inline OwnPtr<T>::OwnPtr(const PassOwnPtr<U>& o)
109         : m_ptr(o.leakPtr())
110     {
111     }
112
113     template<typename T> inline void OwnPtr<T>::clear()
114     {
115         PtrType ptr = m_ptr;
116         m_ptr = 0;
117         deleteOwnedPtr(ptr);
118     }
119
120     template<typename T> inline PassOwnPtr<T> OwnPtr<T>::release()
121     {
122         PtrType ptr = m_ptr;
123         m_ptr = 0;
124         return adoptPtr(ptr);
125     }
126
127     template<typename T> inline typename OwnPtr<T>::PtrType OwnPtr<T>::leakPtr()
128     {
129         PtrType ptr = m_ptr;
130         m_ptr = 0;
131         return ptr;
132     }
133
134     template<typename T> inline OwnPtr<T>& OwnPtr<T>::operator=(const PassOwnPtr<T>& o)
135     {
136         PtrType ptr = m_ptr;
137         m_ptr = o.leakPtr();
138         ASSERT(!ptr || m_ptr != ptr);
139         deleteOwnedPtr(ptr);
140         return *this;
141     }
142
143     template<typename T> template<typename U> inline OwnPtr<T>& OwnPtr<T>::operator=(const PassOwnPtr<U>& o)
144     {
145         PtrType ptr = m_ptr;
146         m_ptr = o.leakPtr();
147         ASSERT(!ptr || m_ptr != ptr);
148         deleteOwnedPtr(ptr);
149         return *this;
150     }
151
152 #if COMPILER_SUPPORTS(CXX_RVALUE_REFERENCES)
153     template<typename T> inline OwnPtr<T>::OwnPtr(OwnPtr<T>&& o)
154         : m_ptr(o.leakPtr())
155     {
156     }
157
158     template<typename T> template<typename U> inline OwnPtr<T>::OwnPtr(OwnPtr<U>&& o)
159         : m_ptr(o.leakPtr())
160     {
161     }
162
163     template<typename T> inline OwnPtr<T>& OwnPtr<T>::operator=(OwnPtr<T>&& o)
164     {
165         ASSERT(!o || o != m_ptr);
166         auto ptr = std::move(o);
167         swap(ptr);
168         return *this;
169     }
170
171     template<typename T> template<typename U> inline OwnPtr<T>& OwnPtr<T>::operator=(OwnPtr<U>&& o)
172     {
173         ASSERT(!o || o != m_ptr);
174         auto ptr = std::move(o);
175         swap(ptr);
176         return *this;
177     }
178 #endif
179
180     template<typename T> inline void swap(OwnPtr<T>& a, OwnPtr<T>& b)
181     {
182         a.swap(b);
183     }
184
185     template<typename T, typename U> inline bool operator==(const OwnPtr<T>& a, U* b)
186     {
187         return a.get() == b; 
188     }
189
190     template<typename T, typename U> inline bool operator==(T* a, const OwnPtr<U>& b) 
191     {
192         return a == b.get(); 
193     }
194
195     template<typename T, typename U> inline bool operator!=(const OwnPtr<T>& a, U* b)
196     {
197         return a.get() != b; 
198     }
199
200     template<typename T, typename U> inline bool operator!=(T* a, const OwnPtr<U>& b)
201     {
202         return a != b.get(); 
203     }
204
205     template<typename T> inline typename OwnPtr<T>::PtrType getPtr(const OwnPtr<T>& p)
206     {
207         return p.get();
208     }
209
210 template<typename T>
211 inline OwnPtr<T> createOwned()
212 {
213     return OwnPtr<T>(new T);
214 }
215
216 template<typename T, typename A1>
217 inline OwnPtr<T> createOwned(A1&& a1)
218 {
219     return OwnPtr<T>(new T(std::forward<A1>(a1)));
220 }
221
222 template<typename T, typename A1, typename A2>
223 inline OwnPtr<T> createOwned(A1&& a1, A2&& a2)
224 {
225     return OwnPtr<T>(new T(std::forward<A1>(a1), std::forward<A2>(a2)));
226 }
227
228 } // namespace WTF
229
230 using WTF::OwnPtr;
231 using WTF::createOwned;
232
233 #endif // WTF_OwnPtr_h