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
|
/*
* Copyright (C) 2014-2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <os/object.h>
#include <wtf/Forward.h>
#include <wtf/HashFunctions.h>
#include <wtf/HashTraits.h>
#include <wtf/StdLibExtras.h>
#include <wtf/TypeTraits.h>
// Because ARC enablement is a compile-time choice, and we compile this header
// both ways, we need a separate copy of our code when ARC is enabled.
#if __has_feature(objc_arc)
#define adoptOSObject adoptOSObjectArc
#endif
namespace WTF {
template<typename T, typename arcEnabled = ARCEnabled> struct DefaultOSObjectRetainTraits {
static ALWAYS_INLINE void retain(T ptr)
{
#if __has_feature(objc_arc)
UNUSED_PARAM(ptr);
#else
os_retain(ptr);
#endif
}
static ALWAYS_INLINE void release(T ptr)
{
#if __has_feature(objc_arc)
UNUSED_PARAM(ptr);
#else
os_release(ptr);
#endif
}
};
template<typename T, typename RetainTraits = DefaultOSObjectRetainTraits<T, ARCEnabled>> OSObjectPtr<T, RetainTraits> adoptOSObject(T) WARN_UNUSED_RETURN;
template<typename T, typename RetainTraits> class OSObjectPtr {
public:
using ValueType = std::remove_pointer_t<T>;
using PtrType = ValueType*;
OSObjectPtr()
: m_ptr(nullptr)
{
}
~OSObjectPtr()
{
if (m_ptr)
RetainTraits::release(m_ptr);
}
// Hash table deleted values, which are only constructed and never copied or destroyed.
constexpr OSObjectPtr(HashTableDeletedValueType) : m_ptr(hashTableDeletedValue()) { }
constexpr bool isHashTableDeletedValue() const { return m_ptr == hashTableDeletedValue(); }
T get() const LIFETIME_BOUND { return m_ptr; }
explicit operator bool() const { return m_ptr; }
bool operator!() const { return !m_ptr; }
OSObjectPtr(const OSObjectPtr& other)
: m_ptr(other.m_ptr)
{
if (m_ptr)
RetainTraits::retain(m_ptr);
}
OSObjectPtr(OSObjectPtr&& other)
: m_ptr(WTFMove(other.m_ptr))
{
other.m_ptr = nullptr;
}
OSObjectPtr(T ptr)
: m_ptr(WTFMove(ptr))
{
if (m_ptr)
RetainTraits::retain(m_ptr);
}
OSObjectPtr& operator=(const OSObjectPtr& other)
{
OSObjectPtr ptr = other;
swap(ptr);
return *this;
}
OSObjectPtr& operator=(OSObjectPtr&& other)
{
OSObjectPtr ptr = WTFMove(other);
swap(ptr);
return *this;
}
OSObjectPtr& operator=(std::nullptr_t)
{
if (m_ptr)
RetainTraits::release(m_ptr);
m_ptr = nullptr;
return *this;
}
OSObjectPtr& operator=(T other)
{
OSObjectPtr ptr = WTFMove(other);
swap(ptr);
return *this;
}
void swap(OSObjectPtr& other)
{
std::swap(m_ptr, other.m_ptr);
}
T leakRef() WARN_UNUSED_RETURN
{
return std::exchange(m_ptr, nullptr);
}
friend OSObjectPtr adoptOSObject<T, RetainTraits>(T) WARN_UNUSED_RETURN;
private:
struct AdoptOSObject { };
OSObjectPtr(AdoptOSObject, T ptr)
: m_ptr(WTFMove(ptr))
{
}
static constexpr T hashTableDeletedValue() { return reinterpret_cast<T>(-1); }
T m_ptr;
};
template<typename T, typename U, typename V> constexpr bool operator==(const OSObjectPtr<T, V>& a, const OSObjectPtr<U, V>& b)
{
return a.get() == b.get();
}
template<typename T, typename RetainTraits> inline OSObjectPtr<T, RetainTraits> adoptOSObject(T ptr)
{
return OSObjectPtr<T, RetainTraits> { typename OSObjectPtr<T, RetainTraits>::AdoptOSObject { }, WTFMove(ptr) };
}
template<typename T, typename U, typename RetainTraits>
ALWAYS_INLINE void lazyInitialize(const OSObjectPtr<T, RetainTraits>& ptr, OSObjectPtr<U, RetainTraits>&& obj)
{
RELEASE_ASSERT(!ptr);
const_cast<OSObjectPtr<T, RetainTraits>&>(ptr) = std::move(obj); // NOLINT
}
template<typename T, typename RetainTraits> struct IsSmartPtr<OSObjectPtr<T, RetainTraits>> {
static constexpr bool value = true;
static constexpr bool isNullable = true;
};
template<typename T, typename RetainTraits> struct HashTraits<OSObjectPtr<T, RetainTraits>> : SimpleClassHashTraits<OSObjectPtr<T, RetainTraits>> { };
template<typename T, typename RetainTraits> struct DefaultHash<OSObjectPtr<T, RetainTraits>> : PtrHash<OSObjectPtr<T, RetainTraits>> { };
} // namespace WTF
using WTF::OSObjectPtr;
using WTF::adoptOSObject;
using WTF::lazyInitialize;
|
