2020-01-18 11:38:21 +03:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
|
|
*
|
2021-04-22 11:24:48 +03:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-01-18 11:38:21 +03:00
|
|
|
*/
|
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <AK/Assertions.h>
|
2021-03-12 19:29:37 +03:00
|
|
|
#include <AK/Format.h>
|
2020-06-12 16:30:30 +03:00
|
|
|
#include <AK/RefCounted.h>
|
2019-07-24 09:25:27 +03:00
|
|
|
#include <AK/StdLibExtras.h>
|
|
|
|
#include <AK/Traits.h>
|
|
|
|
#include <AK/Types.h>
|
|
|
|
|
2021-10-07 22:10:56 +03:00
|
|
|
#define NONNULLOWNPTR_SCRUB_BYTE 0xf1
|
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
namespace AK {
|
|
|
|
|
2020-09-23 19:17:43 +03:00
|
|
|
template<typename T, typename PtrTraits>
|
2019-07-24 09:25:27 +03:00
|
|
|
class RefPtr;
|
|
|
|
template<typename T>
|
|
|
|
class NonnullRefPtr;
|
|
|
|
template<typename T>
|
|
|
|
class WeakPtr;
|
|
|
|
|
|
|
|
template<typename T>
|
2021-12-02 00:05:13 +03:00
|
|
|
class [[nodiscard]] NonnullOwnPtr {
|
2019-07-24 09:25:27 +03:00
|
|
|
public:
|
2020-11-12 01:21:01 +03:00
|
|
|
using ElementType = T;
|
2019-07-25 12:10:28 +03:00
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
enum AdoptTag { Adopt };
|
|
|
|
|
|
|
|
NonnullOwnPtr(AdoptTag, T& ptr)
|
|
|
|
: m_ptr(&ptr)
|
|
|
|
{
|
2020-11-03 17:51:56 +03:00
|
|
|
static_assert(
|
2021-06-25 08:33:15 +03:00
|
|
|
requires { requires typename T::AllowOwnPtr()(); } || !requires { requires !typename T::AllowOwnPtr()(); declval<T>().ref(); declval<T>().unref(); },
|
2020-11-03 17:51:56 +03:00
|
|
|
"Use NonnullRefPtr<> for RefCounted types");
|
2019-07-24 09:25:27 +03:00
|
|
|
}
|
|
|
|
NonnullOwnPtr(NonnullOwnPtr&& other)
|
|
|
|
: m_ptr(other.leak_ptr())
|
|
|
|
{
|
2021-02-23 22:42:32 +03:00
|
|
|
VERIFY(m_ptr);
|
2019-07-24 09:25:27 +03:00
|
|
|
}
|
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr(NonnullOwnPtr<U>&& other)
|
2020-04-05 12:32:30 +03:00
|
|
|
: m_ptr(other.leak_ptr())
|
2019-07-24 09:25:27 +03:00
|
|
|
{
|
2021-02-23 22:42:32 +03:00
|
|
|
VERIFY(m_ptr);
|
2019-07-24 09:25:27 +03:00
|
|
|
}
|
|
|
|
~NonnullOwnPtr()
|
|
|
|
{
|
|
|
|
clear();
|
|
|
|
#ifdef SANITIZE_PTRS
|
2021-10-07 22:10:56 +03:00
|
|
|
m_ptr = (T*)(explode_byte(NONNULLOWNPTR_SCRUB_BYTE));
|
2019-07-24 09:25:27 +03:00
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
NonnullOwnPtr(const NonnullOwnPtr&) = delete;
|
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr(const NonnullOwnPtr<U>&) = delete;
|
|
|
|
NonnullOwnPtr& operator=(const NonnullOwnPtr&) = delete;
|
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr& operator=(const NonnullOwnPtr<U>&) = delete;
|
|
|
|
|
2020-09-23 19:17:43 +03:00
|
|
|
template<typename U, typename PtrTraits = RefPtrTraits<U>>
|
|
|
|
NonnullOwnPtr(const RefPtr<U, PtrTraits>&) = delete;
|
2019-07-24 09:25:27 +03:00
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr(const NonnullRefPtr<U>&) = delete;
|
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr(const WeakPtr<U>&) = delete;
|
2020-09-23 19:17:43 +03:00
|
|
|
template<typename U, typename PtrTraits = RefPtrTraits<U>>
|
|
|
|
NonnullOwnPtr& operator=(const RefPtr<U, PtrTraits>&) = delete;
|
2019-07-24 09:25:27 +03:00
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr& operator=(const NonnullRefPtr<U>&) = delete;
|
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr& operator=(const WeakPtr<U>&) = delete;
|
|
|
|
|
|
|
|
NonnullOwnPtr& operator=(NonnullOwnPtr&& other)
|
|
|
|
{
|
2020-01-19 18:03:57 +03:00
|
|
|
NonnullOwnPtr ptr(move(other));
|
|
|
|
swap(ptr);
|
2019-07-24 09:25:27 +03:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr& operator=(NonnullOwnPtr<U>&& other)
|
|
|
|
{
|
2020-01-19 18:03:57 +03:00
|
|
|
NonnullOwnPtr ptr(move(other));
|
|
|
|
swap(ptr);
|
2019-07-24 09:25:27 +03:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2020-08-05 16:51:36 +03:00
|
|
|
[[nodiscard]] T* leak_ptr()
|
2019-07-24 09:25:27 +03:00
|
|
|
{
|
|
|
|
return exchange(m_ptr, nullptr);
|
|
|
|
}
|
|
|
|
|
2021-06-29 16:45:24 +03:00
|
|
|
ALWAYS_INLINE RETURNS_NONNULL T* ptr()
|
|
|
|
{
|
|
|
|
VERIFY(m_ptr);
|
|
|
|
return m_ptr;
|
|
|
|
}
|
|
|
|
|
|
|
|
ALWAYS_INLINE RETURNS_NONNULL const T* ptr() const
|
|
|
|
{
|
|
|
|
VERIFY(m_ptr);
|
|
|
|
return m_ptr;
|
|
|
|
}
|
2019-07-24 09:25:27 +03:00
|
|
|
|
2021-06-29 16:45:24 +03:00
|
|
|
ALWAYS_INLINE RETURNS_NONNULL T* operator->() { return ptr(); }
|
|
|
|
ALWAYS_INLINE RETURNS_NONNULL const T* operator->() const { return ptr(); }
|
2019-07-24 09:25:27 +03:00
|
|
|
|
2021-06-29 16:45:24 +03:00
|
|
|
ALWAYS_INLINE T& operator*() { return *ptr(); }
|
|
|
|
ALWAYS_INLINE const T& operator*() const { return *ptr(); }
|
2019-07-24 09:25:27 +03:00
|
|
|
|
2021-06-29 16:45:24 +03:00
|
|
|
ALWAYS_INLINE RETURNS_NONNULL operator const T*() const { return ptr(); }
|
|
|
|
ALWAYS_INLINE RETURNS_NONNULL operator T*() { return ptr(); }
|
2019-07-24 09:25:27 +03:00
|
|
|
|
2019-11-07 20:00:05 +03:00
|
|
|
operator bool() const = delete;
|
|
|
|
bool operator!() const = delete;
|
|
|
|
|
2020-01-19 18:03:57 +03:00
|
|
|
void swap(NonnullOwnPtr& other)
|
|
|
|
{
|
|
|
|
::swap(m_ptr, other.m_ptr);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename U>
|
|
|
|
void swap(NonnullOwnPtr<U>& other)
|
|
|
|
{
|
|
|
|
::swap(m_ptr, other.m_ptr);
|
|
|
|
}
|
|
|
|
|
2020-05-08 22:38:47 +03:00
|
|
|
template<typename U>
|
|
|
|
NonnullOwnPtr<U> release_nonnull()
|
|
|
|
{
|
2021-02-23 22:42:32 +03:00
|
|
|
VERIFY(m_ptr);
|
2020-05-08 22:38:47 +03:00
|
|
|
return NonnullOwnPtr<U>(NonnullOwnPtr<U>::Adopt, static_cast<U&>(*leak_ptr()));
|
|
|
|
}
|
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
private:
|
|
|
|
void clear()
|
|
|
|
{
|
|
|
|
if (!m_ptr)
|
|
|
|
return;
|
|
|
|
delete m_ptr;
|
|
|
|
m_ptr = nullptr;
|
|
|
|
}
|
|
|
|
|
|
|
|
T* m_ptr = nullptr;
|
|
|
|
};
|
|
|
|
|
2021-05-28 15:09:00 +03:00
|
|
|
#if !defined(KERNEL)
|
|
|
|
|
2020-04-01 22:04:10 +03:00
|
|
|
template<typename T>
|
|
|
|
inline NonnullOwnPtr<T> adopt_own(T& object)
|
|
|
|
{
|
|
|
|
return NonnullOwnPtr<T>(NonnullOwnPtr<T>::Adopt, object);
|
|
|
|
}
|
|
|
|
|
2021-05-28 15:09:00 +03:00
|
|
|
#endif
|
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
template<class T, class... Args>
|
2021-07-01 11:21:14 +03:00
|
|
|
requires(IsConstructible<T, Args...>) inline NonnullOwnPtr<T> make(Args&&... args)
|
2019-07-24 09:25:27 +03:00
|
|
|
{
|
|
|
|
return NonnullOwnPtr<T>(NonnullOwnPtr<T>::Adopt, *new T(forward<Args>(args)...));
|
|
|
|
}
|
|
|
|
|
2021-07-01 11:21:14 +03:00
|
|
|
// FIXME: Remove once P0960R3 is available in Clang.
|
|
|
|
template<class T, class... Args>
|
|
|
|
inline NonnullOwnPtr<T> make(Args&&... args)
|
|
|
|
{
|
|
|
|
return NonnullOwnPtr<T>(NonnullOwnPtr<T>::Adopt, *new T { forward<Args>(args)... });
|
|
|
|
}
|
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
template<typename T>
|
|
|
|
struct Traits<NonnullOwnPtr<T>> : public GenericTraits<NonnullOwnPtr<T>> {
|
2021-05-08 12:11:37 +03:00
|
|
|
using PeekType = T*;
|
|
|
|
using ConstPeekType = const T*;
|
2021-09-11 15:15:04 +03:00
|
|
|
static unsigned hash(const NonnullOwnPtr<T>& p) { return ptr_hash((FlatPtr)p.ptr()); }
|
2019-07-24 09:25:27 +03:00
|
|
|
static bool equals(const NonnullOwnPtr<T>& a, const NonnullOwnPtr<T>& b) { return a.ptr() == b.ptr(); }
|
|
|
|
};
|
|
|
|
|
2020-01-19 18:03:57 +03:00
|
|
|
template<typename T, typename U>
|
|
|
|
inline void swap(NonnullOwnPtr<T>& a, NonnullOwnPtr<U>& b)
|
|
|
|
{
|
|
|
|
a.swap(b);
|
|
|
|
}
|
|
|
|
|
2020-10-15 16:24:01 +03:00
|
|
|
template<typename T>
|
|
|
|
struct Formatter<NonnullOwnPtr<T>> : Formatter<const T*> {
|
2021-11-16 03:15:21 +03:00
|
|
|
ErrorOr<void> format(FormatBuilder& builder, NonnullOwnPtr<T> const& value)
|
2020-10-15 16:24:01 +03:00
|
|
|
{
|
2021-11-16 03:15:21 +03:00
|
|
|
return Formatter<const T*>::format(builder, value.ptr());
|
2020-10-15 16:24:01 +03:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2019-07-24 09:25:27 +03:00
|
|
|
}
|
|
|
|
|
2021-05-28 15:09:00 +03:00
|
|
|
#if !defined(KERNEL)
|
2020-04-01 22:04:10 +03:00
|
|
|
using AK::adopt_own;
|
2021-05-28 15:09:00 +03:00
|
|
|
#endif
|
2019-07-24 09:25:27 +03:00
|
|
|
using AK::make;
|
|
|
|
using AK::NonnullOwnPtr;
|