1 // shared_ptr and weak_ptr implementation -*- C++ -*-
3 // Copyright (C) 2007-2014 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 // GCC Note: Based on files from version 1.32.0 of the Boost library.
28 // Copyright (c) 2001, 2002, 2003 Peter Dimov and Multi Media Ltd.
31 // Copyright (C) 1998, 1999 Greg Colvin and Beman Dawes.
32 // Copyright (C) 2001, 2002, 2003 Peter Dimov
35 // Copyright (C) 2001, 2002, 2003 Peter Dimov
37 // enable_shared_from_this.hpp
38 // Copyright (C) 2002 Peter Dimov
40 // Distributed under the Boost Software License, Version 1.0. (See
41 // accompanying file LICENSE_1_0.txt or copy at
42 // http://www.boost.org/LICENSE_1_0.txt)
44 /** @file bits/shared_ptr.h
45 * This is an internal header file, included by other library headers.
46 * Do not attempt to use it directly. @headername{memory}
50 #define _SHARED_PTR_H 1
52 #include <bits/shared_ptr_base.h>
54 namespace std
_GLIBCXX_VISIBILITY(default)
56 _GLIBCXX_BEGIN_NAMESPACE_VERSION
59 * @addtogroup pointer_abstractions
63 /// 20.7.2.2.11 shared_ptr I/O
64 template<typename _Ch
, typename _Tr
, typename _Tp
, _Lock_policy _Lp
>
65 inline std::basic_ostream
<_Ch
, _Tr
>&
66 operator<<(std::basic_ostream
<_Ch
, _Tr
>& __os
,
67 const __shared_ptr
<_Tp
, _Lp
>& __p
)
73 /// 20.7.2.2.10 shared_ptr get_deleter
74 template<typename _Del
, typename _Tp
, _Lock_policy _Lp
>
76 get_deleter(const __shared_ptr
<_Tp
, _Lp
>& __p
) noexcept
79 return static_cast<_Del
*>(__p
._M_get_deleter(typeid(_Del
)));
87 * @brief A smart pointer with reference-counted copy semantics.
89 * The object pointed to is deleted when the last shared_ptr pointing to
90 * it is destroyed or reset.
92 template<typename _Tp
>
93 class shared_ptr
: public __shared_ptr
<_Tp
>
97 * @brief Construct an empty %shared_ptr.
98 * @post use_count()==0 && get()==0
100 constexpr shared_ptr() noexcept
101 : __shared_ptr
<_Tp
>() { }
103 shared_ptr(const shared_ptr
&) noexcept
= default;
106 * @brief Construct a %shared_ptr that owns the pointer @a __p.
107 * @param __p A pointer that is convertible to element_type*.
108 * @post use_count() == 1 && get() == __p
109 * @throw std::bad_alloc, in which case @c delete @a __p is called.
111 template<typename _Tp1
>
112 explicit shared_ptr(_Tp1
* __p
)
113 : __shared_ptr
<_Tp
>(__p
) { }
116 * @brief Construct a %shared_ptr that owns the pointer @a __p
117 * and the deleter @a __d.
118 * @param __p A pointer.
119 * @param __d A deleter.
120 * @post use_count() == 1 && get() == __p
121 * @throw std::bad_alloc, in which case @a __d(__p) is called.
123 * Requirements: _Deleter's copy constructor and destructor must
126 * __shared_ptr will release __p by calling __d(__p)
128 template<typename _Tp1
, typename _Deleter
>
129 shared_ptr(_Tp1
* __p
, _Deleter __d
)
130 : __shared_ptr
<_Tp
>(__p
, __d
) { }
133 * @brief Construct a %shared_ptr that owns a null pointer
134 * and the deleter @a __d.
135 * @param __p A null pointer constant.
136 * @param __d A deleter.
137 * @post use_count() == 1 && get() == __p
138 * @throw std::bad_alloc, in which case @a __d(__p) is called.
140 * Requirements: _Deleter's copy constructor and destructor must
143 * The last owner will call __d(__p)
145 template<typename _Deleter
>
146 shared_ptr(nullptr_t __p
, _Deleter __d
)
147 : __shared_ptr
<_Tp
>(__p
, __d
) { }
150 * @brief Construct a %shared_ptr that owns the pointer @a __p
151 * and the deleter @a __d.
152 * @param __p A pointer.
153 * @param __d A deleter.
154 * @param __a An allocator.
155 * @post use_count() == 1 && get() == __p
156 * @throw std::bad_alloc, in which case @a __d(__p) is called.
158 * Requirements: _Deleter's copy constructor and destructor must
159 * not throw _Alloc's copy constructor and destructor must not
162 * __shared_ptr will release __p by calling __d(__p)
164 template<typename _Tp1
, typename _Deleter
, typename _Alloc
>
165 shared_ptr(_Tp1
* __p
, _Deleter __d
, _Alloc __a
)
166 : __shared_ptr
<_Tp
>(__p
, __d
, std::move(__a
)) { }
169 * @brief Construct a %shared_ptr that owns a null pointer
170 * and the deleter @a __d.
171 * @param __p A null pointer constant.
172 * @param __d A deleter.
173 * @param __a An allocator.
174 * @post use_count() == 1 && get() == __p
175 * @throw std::bad_alloc, in which case @a __d(__p) is called.
177 * Requirements: _Deleter's copy constructor and destructor must
178 * not throw _Alloc's copy constructor and destructor must not
181 * The last owner will call __d(__p)
183 template<typename _Deleter
, typename _Alloc
>
184 shared_ptr(nullptr_t __p
, _Deleter __d
, _Alloc __a
)
185 : __shared_ptr
<_Tp
>(__p
, __d
, std::move(__a
)) { }
187 // Aliasing constructor
190 * @brief Constructs a %shared_ptr instance that stores @a __p
191 * and shares ownership with @a __r.
192 * @param __r A %shared_ptr.
193 * @param __p A pointer that will remain valid while @a *__r is valid.
194 * @post get() == __p && use_count() == __r.use_count()
196 * This can be used to construct a @c shared_ptr to a sub-object
197 * of an object managed by an existing @c shared_ptr.
200 * shared_ptr< pair<int,int> > pii(new pair<int,int>());
201 * shared_ptr<int> pi(pii, &pii->first);
202 * assert(pii.use_count() == 2);
205 template<typename _Tp1
>
206 shared_ptr(const shared_ptr
<_Tp1
>& __r
, _Tp
* __p
) noexcept
207 : __shared_ptr
<_Tp
>(__r
, __p
) { }
210 * @brief If @a __r is empty, constructs an empty %shared_ptr;
211 * otherwise construct a %shared_ptr that shares ownership
213 * @param __r A %shared_ptr.
214 * @post get() == __r.get() && use_count() == __r.use_count()
216 template<typename _Tp1
, typename
= typename
217 std::enable_if
<std::is_convertible
<_Tp1
*, _Tp
*>::value
>::type
>
218 shared_ptr(const shared_ptr
<_Tp1
>& __r
) noexcept
219 : __shared_ptr
<_Tp
>(__r
) { }
222 * @brief Move-constructs a %shared_ptr instance from @a __r.
223 * @param __r A %shared_ptr rvalue.
224 * @post *this contains the old value of @a __r, @a __r is empty.
226 shared_ptr(shared_ptr
&& __r
) noexcept
227 : __shared_ptr
<_Tp
>(std::move(__r
)) { }
230 * @brief Move-constructs a %shared_ptr instance from @a __r.
231 * @param __r A %shared_ptr rvalue.
232 * @post *this contains the old value of @a __r, @a __r is empty.
234 template<typename _Tp1
, typename
= typename
235 std::enable_if
<std::is_convertible
<_Tp1
*, _Tp
*>::value
>::type
>
236 shared_ptr(shared_ptr
<_Tp1
>&& __r
) noexcept
237 : __shared_ptr
<_Tp
>(std::move(__r
)) { }
240 * @brief Constructs a %shared_ptr that shares ownership with @a __r
241 * and stores a copy of the pointer stored in @a __r.
242 * @param __r A weak_ptr.
243 * @post use_count() == __r.use_count()
244 * @throw bad_weak_ptr when __r.expired(),
245 * in which case the constructor has no effect.
247 template<typename _Tp1
>
248 explicit shared_ptr(const weak_ptr
<_Tp1
>& __r
)
249 : __shared_ptr
<_Tp
>(__r
) { }
251 #if _GLIBCXX_USE_DEPRECATED
252 template<typename _Tp1
>
253 shared_ptr(std::auto_ptr
<_Tp1
>&& __r
);
256 template<typename _Tp1
, typename _Del
>
257 shared_ptr(std::unique_ptr
<_Tp1
, _Del
>&& __r
)
258 : __shared_ptr
<_Tp
>(std::move(__r
)) { }
261 * @brief Construct an empty %shared_ptr.
262 * @param __p A null pointer constant.
263 * @post use_count() == 0 && get() == nullptr
265 constexpr shared_ptr(nullptr_t
) noexcept
: shared_ptr() { }
267 shared_ptr
& operator=(const shared_ptr
&) noexcept
= default;
269 template<typename _Tp1
>
271 operator=(const shared_ptr
<_Tp1
>& __r
) noexcept
273 this->__shared_ptr
<_Tp
>::operator=(__r
);
277 #if _GLIBCXX_USE_DEPRECATED
278 template<typename _Tp1
>
280 operator=(std::auto_ptr
<_Tp1
>&& __r
)
282 this->__shared_ptr
<_Tp
>::operator=(std::move(__r
));
288 operator=(shared_ptr
&& __r
) noexcept
290 this->__shared_ptr
<_Tp
>::operator=(std::move(__r
));
296 operator=(shared_ptr
<_Tp1
>&& __r
) noexcept
298 this->__shared_ptr
<_Tp
>::operator=(std::move(__r
));
302 template<typename _Tp1
, typename _Del
>
304 operator=(std::unique_ptr
<_Tp1
, _Del
>&& __r
)
306 this->__shared_ptr
<_Tp
>::operator=(std::move(__r
));
311 // This constructor is non-standard, it is used by allocate_shared.
312 template<typename _Alloc
, typename
... _Args
>
313 shared_ptr(_Sp_make_shared_tag __tag
, const _Alloc
& __a
,
315 : __shared_ptr
<_Tp
>(__tag
, __a
, std::forward
<_Args
>(__args
)...)
318 template<typename _Tp1
, typename _Alloc
, typename
... _Args
>
319 friend shared_ptr
<_Tp1
>
320 allocate_shared(const _Alloc
& __a
, _Args
&&... __args
);
322 // This constructor is non-standard, it is used by weak_ptr::lock().
323 shared_ptr(const weak_ptr
<_Tp
>& __r
, std::nothrow_t
)
324 : __shared_ptr
<_Tp
>(__r
, std::nothrow
) { }
326 friend class weak_ptr
<_Tp
>;
329 // 20.7.2.2.7 shared_ptr comparisons
330 template<typename _Tp1
, typename _Tp2
>
332 operator==(const shared_ptr
<_Tp1
>& __a
,
333 const shared_ptr
<_Tp2
>& __b
) noexcept
334 { return __a
.get() == __b
.get(); }
336 template<typename _Tp
>
338 operator==(const shared_ptr
<_Tp
>& __a
, nullptr_t
) noexcept
341 template<typename _Tp
>
343 operator==(nullptr_t
, const shared_ptr
<_Tp
>& __a
) noexcept
346 template<typename _Tp1
, typename _Tp2
>
348 operator!=(const shared_ptr
<_Tp1
>& __a
,
349 const shared_ptr
<_Tp2
>& __b
) noexcept
350 { return __a
.get() != __b
.get(); }
352 template<typename _Tp
>
354 operator!=(const shared_ptr
<_Tp
>& __a
, nullptr_t
) noexcept
355 { return (bool)__a
; }
357 template<typename _Tp
>
359 operator!=(nullptr_t
, const shared_ptr
<_Tp
>& __a
) noexcept
360 { return (bool)__a
; }
362 template<typename _Tp1
, typename _Tp2
>
364 operator<(const shared_ptr
<_Tp1
>& __a
,
365 const shared_ptr
<_Tp2
>& __b
) noexcept
367 typedef typename
std::common_type
<_Tp1
*, _Tp2
*>::type _CT
;
368 return std::less
<_CT
>()(__a
.get(), __b
.get());
371 template<typename _Tp
>
373 operator<(const shared_ptr
<_Tp
>& __a
, nullptr_t
) noexcept
374 { return std::less
<_Tp
*>()(__a
.get(), nullptr); }
376 template<typename _Tp
>
378 operator<(nullptr_t
, const shared_ptr
<_Tp
>& __a
) noexcept
379 { return std::less
<_Tp
*>()(nullptr, __a
.get()); }
381 template<typename _Tp1
, typename _Tp2
>
383 operator<=(const shared_ptr
<_Tp1
>& __a
,
384 const shared_ptr
<_Tp2
>& __b
) noexcept
385 { return !(__b
< __a
); }
387 template<typename _Tp
>
389 operator<=(const shared_ptr
<_Tp
>& __a
, nullptr_t
) noexcept
390 { return !(nullptr < __a
); }
392 template<typename _Tp
>
394 operator<=(nullptr_t
, const shared_ptr
<_Tp
>& __a
) noexcept
395 { return !(__a
< nullptr); }
397 template<typename _Tp1
, typename _Tp2
>
399 operator>(const shared_ptr
<_Tp1
>& __a
,
400 const shared_ptr
<_Tp2
>& __b
) noexcept
401 { return (__b
< __a
); }
403 template<typename _Tp
>
405 operator>(const shared_ptr
<_Tp
>& __a
, nullptr_t
) noexcept
406 { return std::less
<_Tp
*>()(nullptr, __a
.get()); }
408 template<typename _Tp
>
410 operator>(nullptr_t
, const shared_ptr
<_Tp
>& __a
) noexcept
411 { return std::less
<_Tp
*>()(__a
.get(), nullptr); }
413 template<typename _Tp1
, typename _Tp2
>
415 operator>=(const shared_ptr
<_Tp1
>& __a
,
416 const shared_ptr
<_Tp2
>& __b
) noexcept
417 { return !(__a
< __b
); }
419 template<typename _Tp
>
421 operator>=(const shared_ptr
<_Tp
>& __a
, nullptr_t
) noexcept
422 { return !(__a
< nullptr); }
424 template<typename _Tp
>
426 operator>=(nullptr_t
, const shared_ptr
<_Tp
>& __a
) noexcept
427 { return !(nullptr < __a
); }
429 template<typename _Tp
>
430 struct less
<shared_ptr
<_Tp
>> : public _Sp_less
<shared_ptr
<_Tp
>>
433 // 20.7.2.2.8 shared_ptr specialized algorithms.
434 template<typename _Tp
>
436 swap(shared_ptr
<_Tp
>& __a
, shared_ptr
<_Tp
>& __b
) noexcept
439 // 20.7.2.2.9 shared_ptr casts.
440 template<typename _Tp
, typename _Tp1
>
441 inline shared_ptr
<_Tp
>
442 static_pointer_cast(const shared_ptr
<_Tp1
>& __r
) noexcept
443 { return shared_ptr
<_Tp
>(__r
, static_cast<_Tp
*>(__r
.get())); }
445 template<typename _Tp
, typename _Tp1
>
446 inline shared_ptr
<_Tp
>
447 const_pointer_cast(const shared_ptr
<_Tp1
>& __r
) noexcept
448 { return shared_ptr
<_Tp
>(__r
, const_cast<_Tp
*>(__r
.get())); }
450 template<typename _Tp
, typename _Tp1
>
451 inline shared_ptr
<_Tp
>
452 dynamic_pointer_cast(const shared_ptr
<_Tp1
>& __r
) noexcept
454 if (_Tp
* __p
= dynamic_cast<_Tp
*>(__r
.get()))
455 return shared_ptr
<_Tp
>(__r
, __p
);
456 return shared_ptr
<_Tp
>();
461 * @brief A smart pointer with weak semantics.
463 * With forwarding constructors and assignment operators.
465 template<typename _Tp
>
466 class weak_ptr
: public __weak_ptr
<_Tp
>
469 constexpr weak_ptr() noexcept
470 : __weak_ptr
<_Tp
>() { }
472 template<typename _Tp1
, typename
= typename
473 std::enable_if
<std::is_convertible
<_Tp1
*, _Tp
*>::value
>::type
>
474 weak_ptr(const weak_ptr
<_Tp1
>& __r
) noexcept
475 : __weak_ptr
<_Tp
>(__r
) { }
477 template<typename _Tp1
, typename
= typename
478 std::enable_if
<std::is_convertible
<_Tp1
*, _Tp
*>::value
>::type
>
479 weak_ptr(const shared_ptr
<_Tp1
>& __r
) noexcept
480 : __weak_ptr
<_Tp
>(__r
) { }
482 template<typename _Tp1
>
484 operator=(const weak_ptr
<_Tp1
>& __r
) noexcept
486 this->__weak_ptr
<_Tp
>::operator=(__r
);
490 template<typename _Tp1
>
492 operator=(const shared_ptr
<_Tp1
>& __r
) noexcept
494 this->__weak_ptr
<_Tp
>::operator=(__r
);
499 lock() const noexcept
500 { return shared_ptr
<_Tp
>(*this, std::nothrow
); }
503 // 20.7.2.3.6 weak_ptr specialized algorithms.
504 template<typename _Tp
>
506 swap(weak_ptr
<_Tp
>& __a
, weak_ptr
<_Tp
>& __b
) noexcept
510 /// Primary template owner_less
511 template<typename _Tp
>
514 /// Partial specialization of owner_less for shared_ptr.
515 template<typename _Tp
>
516 struct owner_less
<shared_ptr
<_Tp
>>
517 : public _Sp_owner_less
<shared_ptr
<_Tp
>, weak_ptr
<_Tp
>>
520 /// Partial specialization of owner_less for weak_ptr.
521 template<typename _Tp
>
522 struct owner_less
<weak_ptr
<_Tp
>>
523 : public _Sp_owner_less
<weak_ptr
<_Tp
>, shared_ptr
<_Tp
>>
527 * @brief Base class allowing use of member function shared_from_this.
529 template<typename _Tp
>
530 class enable_shared_from_this
533 constexpr enable_shared_from_this() noexcept
{ }
535 enable_shared_from_this(const enable_shared_from_this
&) noexcept
{ }
537 enable_shared_from_this
&
538 operator=(const enable_shared_from_this
&) noexcept
541 ~enable_shared_from_this() { }
546 { return shared_ptr
<_Tp
>(this->_M_weak_this
); }
548 shared_ptr
<const _Tp
>
549 shared_from_this() const
550 { return shared_ptr
<const _Tp
>(this->_M_weak_this
); }
553 template<typename _Tp1
>
555 _M_weak_assign(_Tp1
* __p
, const __shared_count
<>& __n
) const noexcept
556 { _M_weak_this
._M_assign(__p
, __n
); }
558 template<typename _Tp1
>
560 __enable_shared_from_this_helper(const __shared_count
<>& __pn
,
561 const enable_shared_from_this
* __pe
,
562 const _Tp1
* __px
) noexcept
565 __pe
->_M_weak_assign(const_cast<_Tp1
*>(__px
), __pn
);
568 mutable weak_ptr
<_Tp
> _M_weak_this
;
572 * @brief Create an object that is owned by a shared_ptr.
573 * @param __a An allocator.
574 * @param __args Arguments for the @a _Tp object's constructor.
575 * @return A shared_ptr that owns the newly created object.
576 * @throw An exception thrown from @a _Alloc::allocate or from the
577 * constructor of @a _Tp.
579 * A copy of @a __a will be used to allocate memory for the shared_ptr
580 * and the new object.
582 template<typename _Tp
, typename _Alloc
, typename
... _Args
>
583 inline shared_ptr
<_Tp
>
584 allocate_shared(const _Alloc
& __a
, _Args
&&... __args
)
586 return shared_ptr
<_Tp
>(_Sp_make_shared_tag(), __a
,
587 std::forward
<_Args
>(__args
)...);
591 * @brief Create an object that is owned by a shared_ptr.
592 * @param __args Arguments for the @a _Tp object's constructor.
593 * @return A shared_ptr that owns the newly created object.
594 * @throw std::bad_alloc, or an exception thrown from the
595 * constructor of @a _Tp.
597 template<typename _Tp
, typename
... _Args
>
598 inline shared_ptr
<_Tp
>
599 make_shared(_Args
&&... __args
)
601 typedef typename
std::remove_const
<_Tp
>::type _Tp_nc
;
602 return std::allocate_shared
<_Tp
>(std::allocator
<_Tp_nc
>(),
603 std::forward
<_Args
>(__args
)...);
606 /// std::hash specialization for shared_ptr.
607 template<typename _Tp
>
608 struct hash
<shared_ptr
<_Tp
>>
609 : public __hash_base
<size_t, shared_ptr
<_Tp
>>
612 operator()(const shared_ptr
<_Tp
>& __s
) const noexcept
613 { return std::hash
<_Tp
*>()(__s
.get()); }
616 // @} group pointer_abstractions
618 _GLIBCXX_END_NAMESPACE_VERSION
621 #endif // _SHARED_PTR_H