|
danderson@0
|
1 |
// vim: set sts=8 ts=2 sw=2 tw=99 et: |
|
danderson@0
|
2 |
// |
|
danderson@0
|
3 |
// Copyright (C) 2013, David Anderson and AlliedModders LLC |
|
danderson@0
|
4 |
// All rights reserved. |
|
danderson@0
|
5 |
// |
|
danderson@0
|
6 |
// Redistribution and use in source and binary forms, with or without |
|
danderson@0
|
7 |
// modification, are permitted provided that the following conditions are met: |
|
danderson@0
|
8 |
// |
|
danderson@0
|
9 |
// * Redistributions of source code must retain the above copyright notice, this |
|
danderson@0
|
10 |
// list of conditions and the following disclaimer. |
|
danderson@0
|
11 |
// * Redistributions in binary form must reproduce the above copyright notice, |
|
danderson@0
|
12 |
// this list of conditions and the following disclaimer in the documentation |
|
danderson@0
|
13 |
// and/or other materials provided with the distribution. |
|
danderson@0
|
14 |
// * Neither the name of AlliedModders LLC nor the names of its contributors |
|
danderson@0
|
15 |
// may be used to endorse or promote products derived from this software |
|
danderson@0
|
16 |
// without specific prior written permission. |
|
danderson@0
|
17 |
// |
|
danderson@0
|
18 |
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
danderson@0
|
19 |
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
danderson@0
|
20 |
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
danderson@0
|
21 |
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
|
danderson@0
|
22 |
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
|
danderson@0
|
23 |
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
|
danderson@0
|
24 |
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
|
danderson@0
|
25 |
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
danderson@0
|
26 |
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
|
danderson@0
|
27 |
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
danderson@0
|
28 |
// POSSIBILITY OF SUCH DAMAGE. |
|
danderson@0
|
29 |
|
|
danderson@0
|
30 |
#ifndef _include_amtl_refcounting_h_ |
|
danderson@0
|
31 |
#define _include_amtl_refcounting_h_ |
|
danderson@0
|
32 |
|
|
danderson@0
|
33 |
#include <am-utility.h> |
|
danderson@0
|
34 |
|
|
danderson@0
|
35 |
namespace ke { |
|
danderson@0
|
36 |
|
|
danderson@0
|
37 |
template <typename T> class Ref; |
|
danderson@0
|
38 |
|
|
danderson@0
|
39 |
// Holds a refcounted T without addrefing it. This is similar to PassRef<> |
|
danderson@0
|
40 |
// below, but is intended only for freshly allocated objects which start |
|
danderson@0
|
41 |
// with reference count 1, and we don't want to add an extra ref just by |
|
danderson@0
|
42 |
// assigning to PassRef<> or Ref<>. |
|
danderson@0
|
43 |
template <typename T> |
|
danderson@0
|
44 |
class Newborn |
|
danderson@0
|
45 |
{ |
|
danderson@0
|
46 |
public: |
|
danderson@0
|
47 |
Newborn(T *t) |
|
danderson@0
|
48 |
: thing_(t) |
|
danderson@0
|
49 |
{ |
|
danderson@0
|
50 |
} |
|
danderson@0
|
51 |
|
|
danderson@0
|
52 |
T *release() const { |
|
danderson@0
|
53 |
return ReturnAndVoid(thing_); |
|
danderson@0
|
54 |
} |
|
danderson@0
|
55 |
|
|
danderson@0
|
56 |
private: |
|
danderson@0
|
57 |
mutable T *thing_; |
|
danderson@0
|
58 |
}; |
|
danderson@0
|
59 |
|
|
danderson@0
|
60 |
// When returning a value, we'd rather not be needlessly changing the refcount, |
|
danderson@0
|
61 |
// so we have a special type to use for returns. |
|
danderson@0
|
62 |
template <typename T> |
|
danderson@0
|
63 |
class PassRef |
|
danderson@0
|
64 |
{ |
|
danderson@0
|
65 |
public: |
|
danderson@0
|
66 |
PassRef(T *thing) |
|
danderson@0
|
67 |
: thing_(thing) |
|
danderson@0
|
68 |
{ |
|
danderson@0
|
69 |
AddRef(); |
|
danderson@0
|
70 |
} |
|
danderson@0
|
71 |
PassRef() |
|
danderson@0
|
72 |
: thing_(NULL) |
|
danderson@0
|
73 |
{ |
|
danderson@0
|
74 |
} |
|
danderson@0
|
75 |
|
|
danderson@0
|
76 |
PassRef(const Newborn<T *> &other) |
|
danderson@0
|
77 |
: thing_(other.release()) |
|
danderson@0
|
78 |
{ |
|
danderson@0
|
79 |
// Don't addref, newborn means already addref'd. |
|
danderson@0
|
80 |
} |
|
danderson@0
|
81 |
|
|
danderson@0
|
82 |
template <typename S> |
|
danderson@0
|
83 |
inline PassRef(const Ref<S> &other); |
|
danderson@0
|
84 |
|
|
danderson@0
|
85 |
PassRef(const PassRef &other) |
|
danderson@0
|
86 |
: thing_(other.release()) |
|
danderson@0
|
87 |
{ |
|
danderson@0
|
88 |
} |
|
danderson@0
|
89 |
template <typename S> |
|
danderson@0
|
90 |
PassRef(const PassRef<S> &other) |
|
danderson@0
|
91 |
: thing_(other.release()) |
|
danderson@0
|
92 |
{ |
|
danderson@0
|
93 |
} |
|
danderson@0
|
94 |
~PassRef() |
|
danderson@0
|
95 |
{ |
|
danderson@0
|
96 |
Release(); |
|
danderson@0
|
97 |
} |
|
danderson@0
|
98 |
|
|
danderson@0
|
99 |
operator T &() { |
|
danderson@0
|
100 |
return *thing_; |
|
danderson@0
|
101 |
} |
|
danderson@0
|
102 |
operator T *() const { |
|
danderson@0
|
103 |
return thing_; |
|
danderson@0
|
104 |
} |
|
danderson@0
|
105 |
T *operator ->() const { |
|
danderson@0
|
106 |
return operator *(); |
|
danderson@0
|
107 |
} |
|
danderson@0
|
108 |
T *operator *() const { |
|
danderson@0
|
109 |
return thing_; |
|
danderson@0
|
110 |
} |
|
danderson@0
|
111 |
bool operator !() const { |
|
danderson@0
|
112 |
return !thing_; |
|
danderson@0
|
113 |
} |
|
danderson@0
|
114 |
|
|
danderson@0
|
115 |
T *release() const { |
|
danderson@0
|
116 |
return ReturnAndVoid(thing_); |
|
danderson@0
|
117 |
} |
|
danderson@0
|
118 |
|
|
danderson@0
|
119 |
template <typename S> |
|
danderson@0
|
120 |
PassRef &operator =(const PassRef<S> &other) { |
|
danderson@0
|
121 |
Release(); |
|
danderson@0
|
122 |
thing_ = other.release(); |
|
danderson@0
|
123 |
return *this; |
|
danderson@0
|
124 |
} |
|
danderson@0
|
125 |
|
|
danderson@0
|
126 |
private: |
|
danderson@0
|
127 |
// Disallowed operators. |
|
danderson@0
|
128 |
PassRef &operator =(T *other); |
|
danderson@0
|
129 |
PassRef &operator =(Newborn<T> &other); |
|
danderson@0
|
130 |
|
|
danderson@0
|
131 |
void AddRef() { |
|
danderson@0
|
132 |
if (thing_) |
|
danderson@0
|
133 |
thing_->AddRef(); |
|
danderson@0
|
134 |
} |
|
danderson@0
|
135 |
void Release() { |
|
danderson@0
|
136 |
if (thing_) |
|
danderson@0
|
137 |
thing_->Release(); |
|
danderson@0
|
138 |
} |
|
danderson@0
|
139 |
|
|
danderson@0
|
140 |
private: |
|
danderson@0
|
141 |
mutable T *thing_; |
|
danderson@0
|
142 |
}; |
|
danderson@0
|
143 |
|
|
danderson@0
|
144 |
// Classes which are refcounted should inherit from this. |
|
danderson@0
|
145 |
template <typename T> |
|
danderson@0
|
146 |
class Refcounted |
|
danderson@0
|
147 |
{ |
|
danderson@0
|
148 |
public: |
|
danderson@0
|
149 |
Refcounted() |
|
danderson@0
|
150 |
: refcount_(1) |
|
danderson@0
|
151 |
{ |
|
danderson@0
|
152 |
} |
|
danderson@0
|
153 |
|
|
danderson@0
|
154 |
void AddRef() { |
|
danderson@0
|
155 |
refcount_++; |
|
danderson@0
|
156 |
} |
|
danderson@0
|
157 |
void Release() { |
|
danderson@0
|
158 |
assert(refcount_ > 0); |
|
danderson@0
|
159 |
if (--refcount_ == 0) |
|
danderson@0
|
160 |
delete static_cast<T *>(this); |
|
danderson@0
|
161 |
} |
|
danderson@0
|
162 |
|
|
danderson@0
|
163 |
protected: |
|
danderson@0
|
164 |
~Refcounted() { |
|
danderson@0
|
165 |
} |
|
danderson@0
|
166 |
|
|
danderson@0
|
167 |
private: |
|
danderson@0
|
168 |
uintptr_t refcount_; |
|
danderson@0
|
169 |
}; |
|
danderson@0
|
170 |
|
|
danderson@0
|
171 |
// Simple class for automatic refcounting. |
|
danderson@0
|
172 |
template <typename T> |
|
danderson@0
|
173 |
class Ref |
|
danderson@0
|
174 |
{ |
|
danderson@0
|
175 |
public: |
|
danderson@0
|
176 |
Ref(T *thing) |
|
danderson@0
|
177 |
: thing_(thing) |
|
danderson@0
|
178 |
{ |
|
danderson@0
|
179 |
AddRef(); |
|
danderson@0
|
180 |
} |
|
danderson@0
|
181 |
|
|
danderson@0
|
182 |
Ref() |
|
danderson@0
|
183 |
: thing_(NULL) |
|
danderson@0
|
184 |
{ |
|
danderson@0
|
185 |
} |
|
danderson@0
|
186 |
|
|
danderson@0
|
187 |
Ref(const Ref &other) |
|
danderson@0
|
188 |
: thing_(other.thing_) |
|
danderson@0
|
189 |
{ |
|
danderson@0
|
190 |
AddRef(); |
|
danderson@0
|
191 |
} |
|
danderson@0
|
192 |
template <typename S> |
|
danderson@0
|
193 |
Ref(const Ref<S> &other) |
|
danderson@0
|
194 |
: thing_(*other) |
|
danderson@0
|
195 |
{ |
|
danderson@0
|
196 |
AddRef(); |
|
danderson@0
|
197 |
} |
|
danderson@0
|
198 |
Ref(const PassRef<T> &other) |
|
danderson@0
|
199 |
: thing_(other.release()) |
|
danderson@0
|
200 |
{ |
|
danderson@0
|
201 |
} |
|
danderson@0
|
202 |
template <typename S> |
|
danderson@0
|
203 |
Ref(const PassRef<S> &other) |
|
danderson@0
|
204 |
: thing_(other.release()) |
|
danderson@0
|
205 |
{ |
|
danderson@0
|
206 |
} |
|
danderson@0
|
207 |
Ref(const Newborn<T> &other) |
|
danderson@0
|
208 |
: thing_(other.release()) |
|
danderson@0
|
209 |
{ |
|
danderson@0
|
210 |
} |
|
danderson@0
|
211 |
~Ref() |
|
danderson@0
|
212 |
{ |
|
danderson@0
|
213 |
Release(); |
|
danderson@0
|
214 |
} |
|
danderson@0
|
215 |
|
|
danderson@0
|
216 |
T *operator ->() const { |
|
danderson@0
|
217 |
return operator *(); |
|
danderson@0
|
218 |
} |
|
danderson@0
|
219 |
T *operator *() const { |
|
danderson@0
|
220 |
return thing_; |
|
danderson@0
|
221 |
} |
|
danderson@0
|
222 |
operator T *() { |
|
danderson@0
|
223 |
return thing_; |
|
danderson@0
|
224 |
} |
|
danderson@0
|
225 |
bool operator !() const { |
|
danderson@0
|
226 |
return !thing_; |
|
danderson@0
|
227 |
} |
|
danderson@0
|
228 |
|
|
danderson@0
|
229 |
template <typename S> |
|
danderson@0
|
230 |
Ref &operator =(S *thing) { |
|
danderson@0
|
231 |
Release(); |
|
danderson@0
|
232 |
thing_ = thing; |
|
danderson@0
|
233 |
AddRef(); |
|
danderson@0
|
234 |
return *this; |
|
danderson@0
|
235 |
} |
|
danderson@0
|
236 |
|
|
danderson@0
|
237 |
template <typename S> |
|
danderson@0
|
238 |
Ref &operator =(const PassRef<S> &other) { |
|
danderson@0
|
239 |
Release(); |
|
danderson@0
|
240 |
thing_ = other.release(); |
|
danderson@0
|
241 |
return *this; |
|
danderson@0
|
242 |
} |
|
danderson@0
|
243 |
|
|
danderson@0
|
244 |
template <typename S> |
|
danderson@0
|
245 |
Ref &operator =(const Newborn<S> &other) { |
|
danderson@0
|
246 |
Release(); |
|
danderson@0
|
247 |
thing_ = other.release(); |
|
danderson@0
|
248 |
return *this; |
|
danderson@0
|
249 |
} |
|
danderson@0
|
250 |
|
|
danderson@0
|
251 |
Ref &operator =(const Ref &other) { |
|
danderson@0
|
252 |
Release(); |
|
danderson@0
|
253 |
thing_ = other.thing_; |
|
danderson@0
|
254 |
AddRef(); |
|
danderson@0
|
255 |
return *this; |
|
danderson@0
|
256 |
} |
|
danderson@0
|
257 |
|
|
danderson@0
|
258 |
private: |
|
danderson@0
|
259 |
void AddRef() { |
|
danderson@0
|
260 |
if (thing_) |
|
danderson@0
|
261 |
thing_->AddRef(); |
|
danderson@0
|
262 |
} |
|
danderson@0
|
263 |
void Release() { |
|
danderson@0
|
264 |
if (thing_) |
|
danderson@0
|
265 |
thing_->Release(); |
|
danderson@0
|
266 |
} |
|
danderson@0
|
267 |
|
|
danderson@0
|
268 |
protected: |
|
danderson@0
|
269 |
T *thing_; |
|
danderson@0
|
270 |
}; |
|
danderson@0
|
271 |
|
|
danderson@0
|
272 |
template <typename T> template <typename S> |
|
danderson@0
|
273 |
PassRef<T>::PassRef(const Ref<S> &other) |
|
danderson@0
|
274 |
: thing_(*other) |
|
danderson@0
|
275 |
{ |
|
danderson@0
|
276 |
AddRef(); |
|
danderson@0
|
277 |
} |
|
danderson@0
|
278 |
|
|
danderson@0
|
279 |
} // namespace ke |
|
danderson@0
|
280 |
|
|
danderson@0
|
281 |
#endif // _include_amtl_refcounting_h_ |
|
danderson@0
|
282 |
|