1
#ifndef BOOST_SHARED_PTR_HPP_INCLUDED
2
#define BOOST_SHARED_PTR_HPP_INCLUDED
7
// (C) Copyright Greg Colvin and Beman Dawes 1998, 1999.
8
// Copyright (c) 2001, 2002, 2003 Peter Dimov
10
// Distributed under the Boost Software License, Version 1.0. (See
11
// accompanying file LICENSE_1_0.txt or copy at
12
// http://www.boost.org/LICENSE_1_0.txt)
14
// See http://www.boost.org/libs/smart_ptr/shared_ptr.htm for documentation.
18
#include "checked_delete.hpp"
19
#include "throw_exception.hpp"
20
#include "shared_count.hpp"
21
#include "workaround.hpp"
23
#include <memory> // for std::auto_ptr
24
#include <algorithm> // for std::swap
25
#include <functional> // for std::less
26
#include <typeinfo> // for std::bad_cast
27
#include <iosfwd> // for std::basic_ostream
29
#ifdef BOOST_MSVC // moved here to work around VC++ compiler crash
30
# pragma warning(push)
31
# pragma warning(disable:4284) // odd return type for operator->
37
template<class T> class weak_ptr;
38
template<class T> class enable_shared_from_this;
43
struct static_cast_tag {};
44
struct const_cast_tag {};
45
struct dynamic_cast_tag {};
46
struct polymorphic_cast_tag {};
48
template<class T> struct shared_ptr_traits
50
typedef T & reference;
53
template<> struct shared_ptr_traits<void>
55
typedef void reference;
58
#if !defined(BOOST_NO_CV_VOID_SPECIALIZATIONS)
60
template<> struct shared_ptr_traits<void const>
62
typedef void reference;
65
template<> struct shared_ptr_traits<void volatile>
67
typedef void reference;
70
template<> struct shared_ptr_traits<void const volatile>
72
typedef void reference;
75
// enable_shared_from_this support
77
template<class T, class Y> void sp_enable_shared_from_this( shared_count const & pn, boost::enable_shared_from_this<T> const * pe, Y const * px )
79
if(pe != 0) pe->_internal_weak_this._internal_assign(const_cast<Y*>(px), pn);
82
inline void sp_enable_shared_from_this( shared_count const & /*pn*/, ... )
92
// An enhanced relative of scoped_ptr with reference counted copy semantics.
93
// The object pointed to is deleted when the last shared_ptr pointing to it
94
// is destroyed or reset.
97
template<class T> class shared_ptr
101
// Borland 5.5.1 specific workaround
102
typedef shared_ptr<T> this_type;
106
typedef T element_type;
107
typedef T value_type;
109
typedef typename detail::shared_ptr_traits<T>::reference reference;
111
shared_ptr(): px(0), pn() // never throws in 1.30+
116
explicit shared_ptr(Y * p): px(p), pn(p, checked_deleter<Y>()) // Y must be complete
118
detail::sp_enable_shared_from_this( pn, p, p );
122
// Requirements: D's copy constructor must not throw
124
// shared_ptr will release p by calling d(p)
127
template<class Y, class D> shared_ptr(Y * p, D d): px(p), pn(p, d)
129
detail::sp_enable_shared_from_this( pn, p, p );
132
// generated copy constructor, assignment, destructor are fine...
134
// except that Borland C++ has a bug, and g++ with -Wsynth warns
135
#if defined(__BORLANDC__) || defined(__GNUC__)
137
shared_ptr & operator=(shared_ptr const & r) // never throws
140
pn = r.pn; // shared_count::op= doesn't throw
147
explicit shared_ptr(weak_ptr<Y> const & r): pn(r.pn) // may throw
149
// it is now safe to copy r.px, as pn(r.pn) did not throw
154
shared_ptr(shared_ptr<Y> const & r): px(r.px), pn(r.pn) // never throws
159
shared_ptr(shared_ptr<Y> const & r, detail::static_cast_tag): px(static_cast<element_type *>(r.px)), pn(r.pn)
164
shared_ptr(shared_ptr<Y> const & r, detail::const_cast_tag): px(const_cast<element_type *>(r.px)), pn(r.pn)
169
shared_ptr(shared_ptr<Y> const & r, detail::dynamic_cast_tag): px(dynamic_cast<element_type *>(r.px)), pn(r.pn)
171
if(px == 0) // need to allocate new counter -- the cast failed
173
pn = detail::shared_count();
178
shared_ptr(shared_ptr<Y> const & r, detail::polymorphic_cast_tag): px(dynamic_cast<element_type *>(r.px)), pn(r.pn)
182
boost::throw_exception(std::bad_cast());
186
#ifndef BOOST_NO_AUTO_PTR
189
explicit shared_ptr(std::auto_ptr<Y> & r): px(r.get()), pn()
192
pn = detail::shared_count(r);
193
detail::sp_enable_shared_from_this( pn, tmp, tmp );
198
#if !defined(BOOST_MSVC) || (BOOST_MSVC > 1200)
201
shared_ptr & operator=(shared_ptr<Y> const & r) // never throws
204
pn = r.pn; // shared_count::op= doesn't throw
210
#ifndef BOOST_NO_AUTO_PTR
213
shared_ptr & operator=(std::auto_ptr<Y> & r)
215
this_type(r).swap(*this);
221
void reset() // never throws in 1.30+
223
this_type().swap(*this);
226
template<class Y> void reset(Y * p) // Y must be complete
228
BOOST_ASSERT(p == 0 || p != px); // catch self-reset errors
229
this_type(p).swap(*this);
232
template<class Y, class D> void reset(Y * p, D d)
234
this_type(p, d).swap(*this);
237
reference operator* () const // never throws
239
BOOST_ASSERT(px != 0);
243
T * operator-> () const // never throws
245
BOOST_ASSERT(px != 0);
249
T * get() const // never throws
254
// implicit conversion to "bool"
256
#if defined(__SUNPRO_CC) && BOOST_WORKAROUND(__SUNPRO_CC, <= 0x530)
258
operator bool () const
263
#elif defined(__MWERKS__) && BOOST_WORKAROUND(__MWERKS__, BOOST_TESTED_AT(0x3003))
264
typedef T * (this_type::*unspecified_bool_type)() const;
266
operator unspecified_bool_type() const // never throws
268
return px == 0? 0: &this_type::get;
273
typedef T * this_type::*unspecified_bool_type;
275
operator unspecified_bool_type() const // never throws
277
return px == 0? 0: &this_type::px;
282
// operator! is redundant, but some compilers need it
284
bool operator! () const // never throws
289
bool unique() const // never throws
294
long use_count() const // never throws
296
return pn.use_count();
299
void swap(shared_ptr<T> & other) // never throws
301
std::swap(px, other.px);
305
template<class Y> bool _internal_less(shared_ptr<Y> const & rhs) const
310
void * _internal_get_deleter(std::type_info const & ti) const
312
return pn.get_deleter(ti);
315
// Tasteless as this may seem, making all members public allows member templates
316
// to work in the absence of member template friends. (Matthew Langston)
318
#ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
322
template<class Y> friend class shared_ptr;
323
template<class Y> friend class weak_ptr;
328
T * px; // contained pointer
329
detail::shared_count pn; // reference counter
333
template<class T, class U> inline bool operator==(shared_ptr<T> const & a, shared_ptr<U> const & b)
335
return a.get() == b.get();
338
template<class T, class U> inline bool operator!=(shared_ptr<T> const & a, shared_ptr<U> const & b)
340
return a.get() != b.get();
343
#if __GNUC__ == 2 && __GNUC_MINOR__ <= 96
345
// Resolve the ambiguity between our op!= and the one in rel_ops
347
template<class T> inline bool operator!=(shared_ptr<T> const & a, shared_ptr<T> const & b)
349
return a.get() != b.get();
354
template<class T, class U> inline bool operator<(shared_ptr<T> const & a, shared_ptr<U> const & b)
356
return a._internal_less(b);
359
template<class T> inline void swap(shared_ptr<T> & a, shared_ptr<T> & b)
364
template<class T, class U> shared_ptr<T> static_pointer_cast(shared_ptr<U> const & r)
366
return shared_ptr<T>(r, detail::static_cast_tag());
369
template<class T, class U> shared_ptr<T> const_pointer_cast(shared_ptr<U> const & r)
371
return shared_ptr<T>(r, detail::const_cast_tag());
374
template<class T, class U> shared_ptr<T> dynamic_pointer_cast(shared_ptr<U> const & r)
376
return shared_ptr<T>(r, detail::dynamic_cast_tag());
379
// shared_*_cast names are deprecated. Use *_pointer_cast instead.
381
template<class T, class U> shared_ptr<T> shared_static_cast(shared_ptr<U> const & r)
383
return shared_ptr<T>(r, detail::static_cast_tag());
386
template<class T, class U> shared_ptr<T> shared_dynamic_cast(shared_ptr<U> const & r)
388
return shared_ptr<T>(r, detail::dynamic_cast_tag());
391
template<class T, class U> shared_ptr<T> shared_polymorphic_cast(shared_ptr<U> const & r)
393
return shared_ptr<T>(r, detail::polymorphic_cast_tag());
396
template<class T, class U> shared_ptr<T> shared_polymorphic_downcast(shared_ptr<U> const & r)
398
BOOST_ASSERT(dynamic_cast<T *>(r.get()) == r.get());
399
return shared_static_cast<T>(r);
402
// get_pointer() enables boost::mem_fn to recognize shared_ptr
404
template<class T> inline T * get_pointer(shared_ptr<T> const & p)
411
#if defined(__GNUC__) && (__GNUC__ < 3)
413
template<class Y> std::ostream & operator<< (std::ostream & os, shared_ptr<Y> const & p)
421
# if defined(BOOST_MSVC) && BOOST_WORKAROUND(BOOST_MSVC, <= 1200 && __SGI_STL_PORT)
422
// MSVC6 has problems finding std::basic_ostream through the using declaration in namespace _STL
423
using std::basic_ostream;
424
template<class E, class T, class Y> basic_ostream<E, T> & operator<< (basic_ostream<E, T> & os, shared_ptr<Y> const & p)
426
template<class E, class T, class Y> std::basic_ostream<E, T> & operator<< (std::basic_ostream<E, T> & os, shared_ptr<Y> const & p)
435
// get_deleter (experimental)
437
#if (defined(__GNUC__) && (__GNUC__ < 3)) || (defined(__EDG_VERSION__) && (__EDG_VERSION__ <= 238))
439
// g++ 2.9x doesn't allow static_cast<X const *>(void *)
440
// apparently EDG 2.38 also doesn't accept it
442
template<class D, class T> D * get_deleter(shared_ptr<T> const & p)
444
void const * q = p._internal_get_deleter(typeid(D));
445
return const_cast<D *>(static_cast<D const *>(q));
450
template<class D, class T> D * get_deleter(shared_ptr<T> const & p)
452
return static_cast<D *>(p._internal_get_deleter(typeid(D)));
460
# pragma warning(pop)
463
#endif // #if defined(BOOST_NO_MEMBER_TEMPLATES) && !defined(BOOST_MSVC6_MEMBER_TEMPLATES)
465
#endif // #ifndef BOOST_SHARED_PTR_HPP_INCLUDED