1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Assertions.h>
#include <AK/Format.h>
#include <AK/RefCounted.h>
#include <AK/StdLibExtras.h>
#include <AK/Traits.h>
#include <AK/Types.h>
#define NONNULLOWNPTR_SCRUB_BYTE 0xf1
namespace AK {
template<typename T>
class WeakPtr;
template<typename T>
class [[nodiscard]] NonnullOwnPtr {
public:
using ElementType = T;
enum AdoptTag { Adopt };
NonnullOwnPtr(AdoptTag, T& ptr)
: m_ptr(&ptr)
{
static_assert(
requires { requires typename T::AllowOwnPtr()(); } || !requires { requires !typename T::AllowOwnPtr()(); declval<T>().ref(); declval<T>().unref(); },
"Use NonnullRefPtr<> for RefCounted types");
}
NonnullOwnPtr(NonnullOwnPtr&& other)
: m_ptr(other.leak_ptr())
{
VERIFY(m_ptr);
}
template<typename U>
NonnullOwnPtr(NonnullOwnPtr<U>&& other)
: m_ptr(other.leak_ptr())
{
VERIFY(m_ptr);
}
~NonnullOwnPtr()
{
clear();
#ifdef SANITIZE_PTRS
m_ptr = (T*)(explode_byte(NONNULLOWNPTR_SCRUB_BYTE));
#endif
}
NonnullOwnPtr(NonnullOwnPtr const&) = delete;
template<typename U>
NonnullOwnPtr(NonnullOwnPtr<U> const&) = delete;
NonnullOwnPtr& operator=(NonnullOwnPtr const&) = delete;
template<typename U>
NonnullOwnPtr& operator=(NonnullOwnPtr<U> const&) = delete;
template<typename U>
NonnullOwnPtr(RefPtr<U> const&) = delete;
template<typename U>
NonnullOwnPtr(NonnullRefPtr<U> const&) = delete;
template<typename U>
NonnullOwnPtr(WeakPtr<U> const&) = delete;
template<typename U>
NonnullOwnPtr& operator=(RefPtr<U> const&) = delete;
template<typename U>
NonnullOwnPtr& operator=(NonnullRefPtr<U> const&) = delete;
template<typename U>
NonnullOwnPtr& operator=(WeakPtr<U> const&) = delete;
NonnullOwnPtr& operator=(NonnullOwnPtr&& other)
{
NonnullOwnPtr ptr(move(other));
swap(ptr);
return *this;
}
template<typename U>
NonnullOwnPtr& operator=(NonnullOwnPtr<U>&& other)
{
NonnullOwnPtr ptr(move(other));
swap(ptr);
return *this;
}
[[nodiscard]] T* leak_ptr()
{
return exchange(m_ptr, nullptr);
}
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;
}
ALWAYS_INLINE RETURNS_NONNULL T* operator->() { return ptr(); }
ALWAYS_INLINE RETURNS_NONNULL const T* operator->() const { return ptr(); }
ALWAYS_INLINE T& operator*() { return *ptr(); }
ALWAYS_INLINE const T& operator*() const { return *ptr(); }
ALWAYS_INLINE RETURNS_NONNULL operator const T*() const { return ptr(); }
ALWAYS_INLINE RETURNS_NONNULL operator T*() { return ptr(); }
operator bool() const = delete;
bool operator!() const = delete;
void swap(NonnullOwnPtr& other)
{
::swap(m_ptr, other.m_ptr);
}
template<typename U>
void swap(NonnullOwnPtr<U>& other)
{
::swap(m_ptr, other.m_ptr);
}
template<typename U>
NonnullOwnPtr<U> release_nonnull()
{
VERIFY(m_ptr);
return NonnullOwnPtr<U>(NonnullOwnPtr<U>::Adopt, static_cast<U&>(*leak_ptr()));
}
private:
void clear()
{
if (!m_ptr)
return;
delete m_ptr;
m_ptr = nullptr;
}
T* m_ptr = nullptr;
};
#if !defined(KERNEL)
template<typename T>
inline NonnullOwnPtr<T> adopt_own(T& object)
{
return NonnullOwnPtr<T>(NonnullOwnPtr<T>::Adopt, object);
}
template<class T, class... Args>
requires(IsConstructible<T, Args...>) inline NonnullOwnPtr<T> make(Args&&... args)
{
return NonnullOwnPtr<T>(NonnullOwnPtr<T>::Adopt, *new T(forward<Args>(args)...));
}
// 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)... });
}
#endif
template<typename T>
struct Traits<NonnullOwnPtr<T>> : public GenericTraits<NonnullOwnPtr<T>> {
using PeekType = T*;
using ConstPeekType = const T*;
static unsigned hash(NonnullOwnPtr<T> const& p) { return ptr_hash((FlatPtr)p.ptr()); }
static bool equals(NonnullOwnPtr<T> const& a, NonnullOwnPtr<T> const& b) { return a.ptr() == b.ptr(); }
};
template<typename T, typename U>
inline void swap(NonnullOwnPtr<T>& a, NonnullOwnPtr<U>& b)
{
a.swap(b);
}
template<typename T>
struct Formatter<NonnullOwnPtr<T>> : Formatter<const T*> {
ErrorOr<void> format(FormatBuilder& builder, NonnullOwnPtr<T> const& value)
{
return Formatter<const T*>::format(builder, value.ptr());
}
};
}
#if !defined(KERNEL)
using AK::adopt_own;
using AK::make;
#endif
using AK::NonnullOwnPtr;
|
