/* * Copyright (c) 2018-2020, Andreas Kling * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #define OWNPTR_SCRUB_BYTE 0xf0 namespace AK { template class [[nodiscard]] OwnPtr { public: OwnPtr() = default; OwnPtr(decltype(nullptr)) : m_ptr(nullptr) { } OwnPtr(OwnPtr&& other) : m_ptr(other.leak_ptr()) { } template OwnPtr(NonnullOwnPtr&& other) : m_ptr(other.leak_ptr()) { } template OwnPtr(OwnPtr&& other) : m_ptr(other.leak_ptr()) { } ~OwnPtr() { clear(); #ifdef SANITIZE_PTRS m_ptr = (T*)(explode_byte(OWNPTR_SCRUB_BYTE)); #endif } OwnPtr(OwnPtr const&) = delete; template OwnPtr(OwnPtr const&) = delete; OwnPtr& operator=(OwnPtr const&) = delete; template OwnPtr& operator=(OwnPtr const&) = delete; template OwnPtr(NonnullOwnPtr const&) = delete; template OwnPtr& operator=(NonnullOwnPtr const&) = delete; template OwnPtr(RefPtr const&) = delete; template OwnPtr(NonnullRefPtr const&) = delete; template OwnPtr(WeakPtr const&) = delete; template OwnPtr& operator=(RefPtr const&) = delete; template OwnPtr& operator=(NonnullRefPtr const&) = delete; template OwnPtr& operator=(WeakPtr const&) = delete; OwnPtr& operator=(OwnPtr&& other) { OwnPtr ptr(move(other)); swap(ptr); return *this; } template OwnPtr& operator=(OwnPtr&& other) { OwnPtr ptr(move(other)); swap(ptr); return *this; } template OwnPtr& operator=(NonnullOwnPtr&& other) { OwnPtr ptr(move(other)); swap(ptr); VERIFY(m_ptr); return *this; } OwnPtr& operator=(T* ptr) = delete; OwnPtr& operator=(std::nullptr_t) { clear(); return *this; } void clear() { delete m_ptr; m_ptr = nullptr; } bool operator!() const { return !m_ptr; } [[nodiscard]] T* leak_ptr() { T* leaked_ptr = m_ptr; m_ptr = nullptr; return leaked_ptr; } NonnullOwnPtr release_nonnull() { VERIFY(m_ptr); return NonnullOwnPtr(NonnullOwnPtr::Adopt, *leak_ptr()); } template NonnullOwnPtr release_nonnull() { VERIFY(m_ptr); return NonnullOwnPtr(NonnullOwnPtr::Adopt, static_cast(*leak_ptr())); } T* ptr() const { return m_ptr; } T* operator->() const { VERIFY(m_ptr); return m_ptr; } T& operator*() const { VERIFY(m_ptr); return *m_ptr; } operator T*() const { return m_ptr; } operator bool() { return !!m_ptr; } void swap(OwnPtr& other) { ::swap(m_ptr, other.m_ptr); } template void swap(OwnPtr& other) { ::swap(m_ptr, other.m_ptr); } static OwnPtr lift(T* ptr) { return OwnPtr { ptr }; } protected: explicit OwnPtr(T* ptr) : m_ptr(ptr) { static_assert( requires { requires typename T::AllowOwnPtr()(); } || !requires { requires !typename T::AllowOwnPtr()(); declval().ref(); declval().unref(); }, "Use RefPtr<> for RefCounted types"); } private: T* m_ptr = nullptr; }; template inline void swap(OwnPtr& a, OwnPtr& b) { a.swap(b); } template inline OwnPtr adopt_own_if_nonnull(T* object) { if (object) return OwnPtr::lift(object); return {}; } template inline ErrorOr> adopt_nonnull_own_or_enomem(T* object) { auto result = adopt_own_if_nonnull(object); if (!result) return Error::from_errno(ENOMEM); return result.release_nonnull(); } template requires(IsConstructible) inline ErrorOr> try_make(Args&&... args) { return adopt_nonnull_own_or_enomem(new (nothrow) T(forward(args)...)); } // FIXME: Remove once P0960R3 is available in Clang. template inline ErrorOr> try_make(Args&&... args) { return adopt_nonnull_own_or_enomem(new (nothrow) T { forward(args)... }); } template struct Traits> : public GenericTraits> { using PeekType = T*; using ConstPeekType = const T*; static unsigned hash(OwnPtr const& p) { return ptr_hash(p.ptr()); } static bool equals(OwnPtr const& a, OwnPtr const& b) { return a.ptr() == b.ptr(); } }; } using AK::adopt_nonnull_own_or_enomem; using AK::adopt_own_if_nonnull; using AK::OwnPtr; using AK::try_make;