15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Copyright (C) 2009, 2010 Apple Inc. All rights reserved. 31e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) * Copyright (C) 2013 Intel Corporation. All rights reserved. 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Redistribution and use in source and binary forms, with or without 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * modification, are permitted provided that the following conditions 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * are met: 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 1. Redistributions of source code must retain the above copyright 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 2. Redistributions in binary form must reproduce the above copyright 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * notice, this list of conditions and the following disclaimer in the 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * documentation and/or other materials provided with the distribution. 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#ifndef WTF_PassOwnPtr_h 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define WTF_PassOwnPtr_h 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 30591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch#include "wtf/NullPtr.h" 31591b958dee2cf159d33a0b931e6231072eaf38d5Ben Murdoch#include "wtf/OwnPtrCommon.h" 325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)namespace WTF { 345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> class OwnPtr; 365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> class PassOwnPtr; 375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> PassOwnPtr<T> adoptPtr(T*); 381e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename T> PassOwnPtr<T[]> adoptArrayPtr(T*); 395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> class PassOwnPtr { 41e69819bd8e388ea4ad1636a19aa6b2eed4952191Ben Murdoch WTF_DISALLOW_CONSTRUCTION_FROM_ZERO(PassOwnPtr); 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) public: 431e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) typedef typename RemoveExtent<T>::Type ValueType; 445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) typedef ValueType* PtrType; 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PassOwnPtr() : m_ptr(0) { } 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PassOwnPtr(std::nullptr_t) : m_ptr(0) { } 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // It somewhat breaks the type system to allow transfer of ownership out of 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // a const PassOwnPtr. However, it makes it much easier to work with PassOwnPtr 515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // temporaries, and we don't have a need to use real const PassOwnPtrs anyway. 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PassOwnPtr(const PassOwnPtr& o) : m_ptr(o.leakPtr()) { } 531e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename U> PassOwnPtr(const PassOwnPtr<U>&, EnsurePtrConvertibleArgDecl(U, T)); 545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 551e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) ~PassOwnPtr() { OwnedPtrDeleter<T>::deletePtr(m_ptr); } 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PtrType get() const { return m_ptr; } 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PtrType leakPtr() const WARN_UNUSED_RETURN; 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) ValueType& operator*() const { ASSERT(m_ptr); return *m_ptr; } 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PtrType operator->() const { ASSERT(m_ptr); return m_ptr; } 635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) bool operator!() const { return !m_ptr; } 655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // This conversion operator allows implicit conversion to bool but not to other integer types. 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) typedef PtrType PassOwnPtr::*UnspecifiedBoolType; 685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) operator UnspecifiedBoolType() const { return m_ptr ? &PassOwnPtr::m_ptr : 0; } 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename U> friend PassOwnPtr<U> adoptPtr(U*); 711e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename U> friend PassOwnPtr<U[]> adoptArrayPtr(U*); 721e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename U> friend class OwnPtr; 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) private: 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) explicit PassOwnPtr(PtrType ptr) : m_ptr(ptr) { } 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 771e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) PassOwnPtr& operator=(const PassOwnPtr&) { COMPILE_ASSERT(!sizeof(T*), PassOwnPtr_should_never_be_assigned_to); return *this; } 7806f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles) 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // We should never have two OwnPtrs for the same underlying object (otherwise we'll get 805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) // double-destruction), so these equality operators should never be needed. 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename U> bool operator==(const PassOwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; } 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename U> bool operator!=(const PassOwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; } 835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename U> bool operator==(const OwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; } 845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename U> bool operator!=(const OwnPtr<U>&) { COMPILE_ASSERT(!sizeof(U*), OwnPtrs_should_never_be_equal); return false; } 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) mutable PtrType m_ptr; 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) }; 885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 891e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename T> template<typename U> inline PassOwnPtr<T>::PassOwnPtr(const PassOwnPtr<U>& o, EnsurePtrConvertibleArgDefn(U, T)) 901e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) : m_ptr(o.leakPtr()) 911e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) { 921e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) COMPILE_ASSERT(!IsArray<T>::value, Pointers_to_array_must_never_be_converted); 931e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) } 941e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) 955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> inline typename PassOwnPtr<T>::PtrType PassOwnPtr<T>::leakPtr() const 965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) PtrType ptr = m_ptr; 985c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) m_ptr = 0; 995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return ptr; 1005c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 10202772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch template<typename T, typename U> inline bool operator==(const PassOwnPtr<T>& a, U* b) 1035c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 10402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch return a.get() == b; 1055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 10602772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch 10702772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch template<typename T, typename U> inline bool operator==(T* a, const PassOwnPtr<U>& b) 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 10902772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch return a == b.get(); 1105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 11102772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch 1125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T, typename U> inline bool operator!=(const PassOwnPtr<T>& a, U* b) 1135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 11402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch return a.get() != b; 1155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 11602772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch 11702772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch template<typename T, typename U> inline bool operator!=(T* a, const PassOwnPtr<U>& b) 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 11902772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch return a != b.get(); 1205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> inline PassOwnPtr<T> adoptPtr(T* ptr) 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return PassOwnPtr<T>(ptr); 1255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1271e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename T> inline PassOwnPtr<T[]> adoptArrayPtr(T* ptr) 1285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1291e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) return PassOwnPtr<T[]>(ptr); 1305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1321e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) template<typename T, typename U> inline PassOwnPtr<T> static_pointer_cast(const PassOwnPtr<U>& p) 1335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1341e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) COMPILE_ASSERT(!IsArray<T>::value, Pointers_to_array_must_never_be_converted); 1351e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) return adoptPtr(static_cast<T*>(p.leakPtr())); 1365c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) template<typename T> inline T* getPtr(const PassOwnPtr<T>& p) 1395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) { 1405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) return p.get(); 1415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) } 1425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} // namespace WTF 1445c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)using WTF::PassOwnPtr; 1465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)using WTF::adoptPtr; 1471e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)using WTF::adoptArrayPtr; 1485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)using WTF::static_pointer_cast; 1495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif // WTF_PassOwnPtr_h 151