2 * Copyright (C) 2010 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #ifndef WTF_PassOwnArrayPtr_h
27 #define WTF_PassOwnArrayPtr_h
29 #include "Assertions.h"
31 #include "TypeTraits.h"
35 template<typename T> class OwnArrayPtr;
36 template<typename T> class PassOwnArrayPtr;
37 template<typename T> PassOwnArrayPtr<T> adoptArrayPtr(T*);
38 template<typename T> void deleteOwnedArrayPtr(T* ptr);
40 template<typename T> class PassOwnArrayPtr {
44 PassOwnArrayPtr() : m_ptr(0) { }
45 PassOwnArrayPtr(std::nullptr_t) : m_ptr(0) { }
47 // It somewhat breaks the type system to allow transfer of ownership out of
48 // a const PassOwnArrayPtr. However, it makes it much easier to work with PassOwnArrayPtr
49 // temporaries, and we don't have a need to use real const PassOwnArrayPtrs anyway.
50 PassOwnArrayPtr(const PassOwnArrayPtr& o) : m_ptr(o.leakPtr()) { }
51 template<typename U> PassOwnArrayPtr(const PassOwnArrayPtr<U>& o) : m_ptr(o.leakPtr()) { }
53 ~PassOwnArrayPtr() { deleteOwnedArrayPtr(m_ptr); }
55 PtrType get() const { return m_ptr; }
57 PtrType leakPtr() const WARN_UNUSED_RETURN;
59 T& operator*() const { ASSERT(m_ptr); return *m_ptr; }
60 PtrType operator->() const { ASSERT(m_ptr); return m_ptr; }
62 bool operator!() const { return !m_ptr; }
64 // This conversion operator allows implicit conversion to bool but not to other integer types.
66 operator bool() const { return m_ptr; }
68 typedef PtrType PassOwnArrayPtr::*UnspecifiedBoolType;
69 operator UnspecifiedBoolType() const { return m_ptr ? &PassOwnArrayPtr::m_ptr : 0; }
72 PassOwnArrayPtr& operator=(const PassOwnArrayPtr&) { COMPILE_ASSERT(!sizeof(T*), PassOwnArrayPtr_should_never_be_assigned_to); return *this; }
74 template<typename U> friend PassOwnArrayPtr<U> adoptArrayPtr(U*);
77 explicit PassOwnArrayPtr(PtrType ptr) : m_ptr(ptr) { }
79 mutable PtrType m_ptr;
82 template<typename T> inline typename PassOwnArrayPtr<T>::PtrType PassOwnArrayPtr<T>::leakPtr() const
89 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
91 return a.get() == b.get();
94 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, const OwnArrayPtr<U>& b)
96 return a.get() == b.get();
99 template<typename T, typename U> inline bool operator==(const OwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
101 return a.get() == b.get();
104 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, U* b)
109 template<typename T, typename U> inline bool operator==(T* a, const PassOwnArrayPtr<U>& b)
114 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
116 return a.get() != b.get();
119 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, const OwnArrayPtr<U>& b)
121 return a.get() != b.get();
124 template<typename T, typename U> inline bool operator!=(const OwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
126 return a.get() != b.get();
129 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, U* b)
134 template<typename T, typename U> inline bool operator!=(T* a, const PassOwnArrayPtr<U>& b)
139 template<typename T> inline PassOwnArrayPtr<T> adoptArrayPtr(T* ptr)
141 return PassOwnArrayPtr<T>(ptr);
144 template<typename T> inline void deleteOwnedArrayPtr(T* ptr)
146 typedef char known[sizeof(T) ? 1 : -1];
151 template<typename T, typename U> inline PassOwnArrayPtr<T> static_pointer_cast(const PassOwnArrayPtr<U>& p)
153 return adoptArrayPtr(static_cast<T*>(p.leakPtr()));
156 template<typename T, typename U> inline PassOwnArrayPtr<T> const_pointer_cast(const PassOwnArrayPtr<U>& p)
158 return adoptArrayPtr(const_cast<T*>(p.leakPtr()));
161 template<typename T> inline T* getPtr(const PassOwnArrayPtr<T>& p)
168 using WTF::PassOwnArrayPtr;
169 using WTF::adoptArrayPtr;
170 using WTF::const_pointer_cast;
171 using WTF::static_pointer_cast;
173 #endif // WTF_PassOwnArrayPtr_h