]> git.lyx.org Git - features.git/blob - boost/boost/smart_ptr/shared_ptr.hpp
9ead1ba1dd77e019db810201a83ae0f23f8c69bb
[features.git] / boost / boost / smart_ptr / shared_ptr.hpp
1 #ifndef BOOST_SMART_PTR_SHARED_PTR_HPP_INCLUDED
2 #define BOOST_SMART_PTR_SHARED_PTR_HPP_INCLUDED
3
4 //
5 //  shared_ptr.hpp
6 //
7 //  (C) Copyright Greg Colvin and Beman Dawes 1998, 1999.
8 //  Copyright (c) 2001-2008 Peter Dimov
9 //
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)
13 //
14 //  See http://www.boost.org/libs/smart_ptr/shared_ptr.htm for documentation.
15 //
16
17 #include <boost/config.hpp>   // for broken compiler workarounds
18
19 #if defined(BOOST_NO_MEMBER_TEMPLATES) && !defined(BOOST_MSVC6_MEMBER_TEMPLATES)
20 #include <boost/smart_ptr/detail/shared_ptr_nmt.hpp>
21 #else
22
23 // In order to avoid circular dependencies with Boost.TR1
24 // we make sure that our include of <memory> doesn't try to
25 // pull in the TR1 headers: that's why we use this header 
26 // rather than including <memory> directly:
27 #include <boost/config/no_tr1/memory.hpp>  // std::auto_ptr
28
29 #include <boost/assert.hpp>
30 #include <boost/checked_delete.hpp>
31 #include <boost/throw_exception.hpp>
32 #include <boost/smart_ptr/detail/shared_count.hpp>
33 #include <boost/detail/workaround.hpp>
34 #include <boost/smart_ptr/detail/sp_convertible.hpp>
35
36 #if !defined(BOOST_SP_NO_ATOMIC_ACCESS)
37 #include <boost/smart_ptr/detail/spinlock_pool.hpp>
38 #include <boost/memory_order.hpp>
39 #endif
40
41 #include <algorithm>            // for std::swap
42 #include <functional>           // for std::less
43 #include <typeinfo>             // for std::bad_cast
44 #include <cstddef>              // for std::size_t
45
46 #if !defined(BOOST_NO_IOSTREAM)
47 #if !defined(BOOST_NO_IOSFWD)
48 #include <iosfwd>               // for std::basic_ostream
49 #else
50 #include <ostream>
51 #endif
52 #endif
53
54 namespace boost
55 {
56
57 template<class T> class shared_ptr;
58 template<class T> class weak_ptr;
59 template<class T> class enable_shared_from_this;
60 template<class T> class enable_shared_from_this2;
61
62 namespace detail
63 {
64
65 struct static_cast_tag {};
66 struct const_cast_tag {};
67 struct dynamic_cast_tag {};
68 struct polymorphic_cast_tag {};
69
70 template<class T> struct shared_ptr_traits
71 {
72     typedef T & reference;
73 };
74
75 template<> struct shared_ptr_traits<void>
76 {
77     typedef void reference;
78 };
79
80 #if !defined(BOOST_NO_CV_VOID_SPECIALIZATIONS)
81
82 template<> struct shared_ptr_traits<void const>
83 {
84     typedef void reference;
85 };
86
87 template<> struct shared_ptr_traits<void volatile>
88 {
89     typedef void reference;
90 };
91
92 template<> struct shared_ptr_traits<void const volatile>
93 {
94     typedef void reference;
95 };
96
97 #endif
98
99 // enable_shared_from_this support
100
101 template< class X, class Y, class T > inline void sp_enable_shared_from_this( boost::shared_ptr<X> const * ppx, Y const * py, boost::enable_shared_from_this< T > const * pe )
102 {
103     if( pe != 0 )
104     {
105         pe->_internal_accept_owner( ppx, const_cast< Y* >( py ) );
106     }
107 }
108
109 template< class X, class Y, class T > inline void sp_enable_shared_from_this( boost::shared_ptr<X> * ppx, Y const * py, boost::enable_shared_from_this2< T > const * pe )
110 {
111     if( pe != 0 )
112     {
113         pe->_internal_accept_owner( ppx, const_cast< Y* >( py ) );
114     }
115 }
116
117 #ifdef _MANAGED
118
119 // Avoid C4793, ... causes native code generation
120
121 struct sp_any_pointer
122 {
123     template<class T> sp_any_pointer( T* ) {}
124 };
125
126 inline void sp_enable_shared_from_this( sp_any_pointer, sp_any_pointer, sp_any_pointer )
127 {
128 }
129
130 #else // _MANAGED
131
132 inline void sp_enable_shared_from_this( ... )
133 {
134 }
135
136 #endif // _MANAGED
137
138 #if !defined( BOOST_NO_SFINAE ) && !defined( BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION ) && !defined( BOOST_NO_AUTO_PTR )
139
140 // rvalue auto_ptr support based on a technique by Dave Abrahams
141
142 template< class T, class R > struct sp_enable_if_auto_ptr
143 {
144 };
145
146 template< class T, class R > struct sp_enable_if_auto_ptr< std::auto_ptr< T >, R >
147 {
148     typedef R type;
149 }; 
150
151 #endif
152
153 } // namespace detail
154
155
156 //
157 //  shared_ptr
158 //
159 //  An enhanced relative of scoped_ptr with reference counted copy semantics.
160 //  The object pointed to is deleted when the last shared_ptr pointing to it
161 //  is destroyed or reset.
162 //
163
164 template<class T> class shared_ptr
165 {
166 private:
167
168     // Borland 5.5.1 specific workaround
169     typedef shared_ptr<T> this_type;
170
171 public:
172
173     typedef T element_type;
174     typedef T value_type;
175     typedef T * pointer;
176     typedef typename boost::detail::shared_ptr_traits<T>::reference reference;
177
178     shared_ptr(): px(0), pn() // never throws in 1.30+
179     {
180     }
181
182     template<class Y>
183     explicit shared_ptr( Y * p ): px( p ), pn( p ) // Y must be complete
184     {
185         boost::detail::sp_enable_shared_from_this( this, p, p );
186     }
187
188     //
189     // Requirements: D's copy constructor must not throw
190     //
191     // shared_ptr will release p by calling d(p)
192     //
193
194     template<class Y, class D> shared_ptr(Y * p, D d): px(p), pn(p, d)
195     {
196         boost::detail::sp_enable_shared_from_this( this, p, p );
197     }
198
199     // As above, but with allocator. A's copy constructor shall not throw.
200
201     template<class Y, class D, class A> shared_ptr( Y * p, D d, A a ): px( p ), pn( p, d, a )
202     {
203         boost::detail::sp_enable_shared_from_this( this, p, p );
204     }
205
206 //  generated copy constructor, destructor are fine...
207
208 #if defined( BOOST_HAS_RVALUE_REFS )
209
210 // ... except in C++0x, move disables the implicit copy
211
212     shared_ptr( shared_ptr const & r ): px( r.px ), pn( r.pn ) // never throws
213     {
214     }
215
216 #endif
217
218     template<class Y>
219     explicit shared_ptr(weak_ptr<Y> const & r): pn(r.pn) // may throw
220     {
221         // it is now safe to copy r.px, as pn(r.pn) did not throw
222         px = r.px;
223     }
224
225     template<class Y>
226     shared_ptr( weak_ptr<Y> const & r, boost::detail::sp_nothrow_tag ): px( 0 ), pn( r.pn, boost::detail::sp_nothrow_tag() ) // never throws
227     {
228         if( !pn.empty() )
229         {
230             px = r.px;
231         }
232     }
233
234     template<class Y>
235 #if !defined( BOOST_SP_NO_SP_CONVERTIBLE )
236
237     shared_ptr( shared_ptr<Y> const & r, typename boost::detail::sp_enable_if_convertible<Y,T>::type = boost::detail::sp_empty() )
238
239 #else
240
241     shared_ptr( shared_ptr<Y> const & r )
242
243 #endif
244     : px( r.px ), pn( r.pn ) // never throws
245     {
246     }
247
248     // aliasing
249     template< class Y >
250     shared_ptr( shared_ptr<Y> const & r, T * p ): px( p ), pn( r.pn ) // never throws
251     {
252     }
253
254     template<class Y>
255     shared_ptr(shared_ptr<Y> const & r, boost::detail::static_cast_tag): px(static_cast<element_type *>(r.px)), pn(r.pn)
256     {
257     }
258
259     template<class Y>
260     shared_ptr(shared_ptr<Y> const & r, boost::detail::const_cast_tag): px(const_cast<element_type *>(r.px)), pn(r.pn)
261     {
262     }
263
264     template<class Y>
265     shared_ptr(shared_ptr<Y> const & r, boost::detail::dynamic_cast_tag): px(dynamic_cast<element_type *>(r.px)), pn(r.pn)
266     {
267         if(px == 0) // need to allocate new counter -- the cast failed
268         {
269             pn = boost::detail::shared_count();
270         }
271     }
272
273     template<class Y>
274     shared_ptr(shared_ptr<Y> const & r, boost::detail::polymorphic_cast_tag): px(dynamic_cast<element_type *>(r.px)), pn(r.pn)
275     {
276         if(px == 0)
277         {
278             boost::throw_exception(std::bad_cast());
279         }
280     }
281
282 #ifndef BOOST_NO_AUTO_PTR
283
284     template<class Y>
285     explicit shared_ptr(std::auto_ptr<Y> & r): px(r.get()), pn()
286     {
287         Y * tmp = r.get();
288         pn = boost::detail::shared_count(r);
289         boost::detail::sp_enable_shared_from_this( this, tmp, tmp );
290     }
291
292 #if !defined( BOOST_NO_SFINAE ) && !defined( BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION )
293
294     template<class Ap>
295     explicit shared_ptr( Ap r, typename boost::detail::sp_enable_if_auto_ptr<Ap, int>::type = 0 ): px( r.get() ), pn()
296     {
297         typename Ap::element_type * tmp = r.get();
298         pn = boost::detail::shared_count( r );
299         boost::detail::sp_enable_shared_from_this( this, tmp, tmp );
300     }
301
302
303 #endif // BOOST_NO_SFINAE, BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
304
305 #endif // BOOST_NO_AUTO_PTR
306
307     // assignment
308
309     shared_ptr & operator=( shared_ptr const & r ) // never throws
310     {
311         this_type(r).swap(*this);
312         return *this;
313     }
314
315 #if !defined(BOOST_MSVC) || (BOOST_MSVC >= 1400)
316
317     template<class Y>
318     shared_ptr & operator=(shared_ptr<Y> const & r) // never throws
319     {
320         this_type(r).swap(*this);
321         return *this;
322     }
323
324 #endif
325
326 #ifndef BOOST_NO_AUTO_PTR
327
328     template<class Y>
329     shared_ptr & operator=( std::auto_ptr<Y> & r )
330     {
331         this_type(r).swap(*this);
332         return *this;
333     }
334
335 #if !defined( BOOST_NO_SFINAE ) && !defined( BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION )
336
337     template<class Ap>
338     typename boost::detail::sp_enable_if_auto_ptr< Ap, shared_ptr & >::type operator=( Ap r )
339     {
340         this_type( r ).swap( *this );
341         return *this;
342     }
343
344
345 #endif // BOOST_NO_SFINAE, BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION
346
347 #endif // BOOST_NO_AUTO_PTR
348
349 // Move support
350
351 #if defined( BOOST_HAS_RVALUE_REFS )
352
353     shared_ptr( shared_ptr && r ): px( r.px ), pn() // never throws
354     {
355         pn.swap( r.pn );
356         r.px = 0;
357     }
358
359     template<class Y>
360 #if !defined( BOOST_SP_NO_SP_CONVERTIBLE )
361
362     shared_ptr( shared_ptr<Y> && r, typename boost::detail::sp_enable_if_convertible<Y,T>::type = boost::detail::sp_empty() )
363
364 #else
365
366     shared_ptr( shared_ptr<Y> && r )
367
368 #endif
369     : px( r.px ), pn() // never throws
370     {
371         pn.swap( r.pn );
372         r.px = 0;
373     }
374
375     shared_ptr & operator=( shared_ptr && r ) // never throws
376     {
377         this_type( static_cast< shared_ptr && >( r ) ).swap( *this );
378         return *this;
379     }
380
381     template<class Y>
382     shared_ptr & operator=( shared_ptr<Y> && r ) // never throws
383     {
384         this_type( static_cast< shared_ptr<Y> && >( r ) ).swap( *this );
385         return *this;
386     }
387
388 #endif
389
390     void reset() // never throws in 1.30+
391     {
392         this_type().swap(*this);
393     }
394
395     template<class Y> void reset(Y * p) // Y must be complete
396     {
397         BOOST_ASSERT(p == 0 || p != px); // catch self-reset errors
398         this_type(p).swap(*this);
399     }
400
401     template<class Y, class D> void reset( Y * p, D d )
402     {
403         this_type( p, d ).swap( *this );
404     }
405
406     template<class Y, class D, class A> void reset( Y * p, D d, A a )
407     {
408         this_type( p, d, a ).swap( *this );
409     }
410
411     template<class Y> void reset( shared_ptr<Y> const & r, T * p )
412     {
413         this_type( r, p ).swap( *this );
414     }
415
416     reference operator* () const // never throws
417     {
418         BOOST_ASSERT(px != 0);
419         return *px;
420     }
421
422     T * operator-> () const // never throws
423     {
424         BOOST_ASSERT(px != 0);
425         return px;
426     }
427
428     T * get() const // never throws
429     {
430         return px;
431     }
432
433 // implicit conversion to "bool"
434 #include <boost/smart_ptr/detail/operator_bool.hpp>
435
436     bool unique() const // never throws
437     {
438         return pn.unique();
439     }
440
441     long use_count() const // never throws
442     {
443         return pn.use_count();
444     }
445
446     void swap(shared_ptr<T> & other) // never throws
447     {
448         std::swap(px, other.px);
449         pn.swap(other.pn);
450     }
451
452     template<class Y> bool _internal_less(shared_ptr<Y> const & rhs) const
453     {
454         return pn < rhs.pn;
455     }
456
457     void * _internal_get_deleter( boost::detail::sp_typeinfo const & ti ) const
458     {
459         return pn.get_deleter( ti );
460     }
461
462     bool _internal_equiv( shared_ptr const & r ) const
463     {
464         return px == r.px && pn == r.pn;
465     }
466
467 // Tasteless as this may seem, making all members public allows member templates
468 // to work in the absence of member template friends. (Matthew Langston)
469
470 #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
471
472 private:
473
474     template<class Y> friend class shared_ptr;
475     template<class Y> friend class weak_ptr;
476
477
478 #endif
479
480     T * px;                     // contained pointer
481     boost::detail::shared_count pn;    // reference counter
482
483 };  // shared_ptr
484
485 template<class T, class U> inline bool operator==(shared_ptr<T> const & a, shared_ptr<U> const & b)
486 {
487     return a.get() == b.get();
488 }
489
490 template<class T, class U> inline bool operator!=(shared_ptr<T> const & a, shared_ptr<U> const & b)
491 {
492     return a.get() != b.get();
493 }
494
495 #if __GNUC__ == 2 && __GNUC_MINOR__ <= 96
496
497 // Resolve the ambiguity between our op!= and the one in rel_ops
498
499 template<class T> inline bool operator!=(shared_ptr<T> const & a, shared_ptr<T> const & b)
500 {
501     return a.get() != b.get();
502 }
503
504 #endif
505
506 template<class T, class U> inline bool operator<(shared_ptr<T> const & a, shared_ptr<U> const & b)
507 {
508     return a._internal_less(b);
509 }
510
511 template<class T> inline void swap(shared_ptr<T> & a, shared_ptr<T> & b)
512 {
513     a.swap(b);
514 }
515
516 template<class T, class U> shared_ptr<T> static_pointer_cast(shared_ptr<U> const & r)
517 {
518     return shared_ptr<T>(r, boost::detail::static_cast_tag());
519 }
520
521 template<class T, class U> shared_ptr<T> const_pointer_cast(shared_ptr<U> const & r)
522 {
523     return shared_ptr<T>(r, boost::detail::const_cast_tag());
524 }
525
526 template<class T, class U> shared_ptr<T> dynamic_pointer_cast(shared_ptr<U> const & r)
527 {
528     return shared_ptr<T>(r, boost::detail::dynamic_cast_tag());
529 }
530
531 // shared_*_cast names are deprecated. Use *_pointer_cast instead.
532
533 template<class T, class U> shared_ptr<T> shared_static_cast(shared_ptr<U> const & r)
534 {
535     return shared_ptr<T>(r, boost::detail::static_cast_tag());
536 }
537
538 template<class T, class U> shared_ptr<T> shared_dynamic_cast(shared_ptr<U> const & r)
539 {
540     return shared_ptr<T>(r, boost::detail::dynamic_cast_tag());
541 }
542
543 template<class T, class U> shared_ptr<T> shared_polymorphic_cast(shared_ptr<U> const & r)
544 {
545     return shared_ptr<T>(r, boost::detail::polymorphic_cast_tag());
546 }
547
548 template<class T, class U> shared_ptr<T> shared_polymorphic_downcast(shared_ptr<U> const & r)
549 {
550     BOOST_ASSERT(dynamic_cast<T *>(r.get()) == r.get());
551     return shared_static_cast<T>(r);
552 }
553
554 // get_pointer() enables boost::mem_fn to recognize shared_ptr
555
556 template<class T> inline T * get_pointer(shared_ptr<T> const & p)
557 {
558     return p.get();
559 }
560
561 // operator<<
562
563 #if !defined(BOOST_NO_IOSTREAM)
564
565 #if defined(BOOST_NO_TEMPLATED_IOSTREAMS) || ( defined(__GNUC__) &&  (__GNUC__ < 3) )
566
567 template<class Y> std::ostream & operator<< (std::ostream & os, shared_ptr<Y> const & p)
568 {
569     os << p.get();
570     return os;
571 }
572
573 #else
574
575 // in STLport's no-iostreams mode no iostream symbols can be used
576 #ifndef _STLP_NO_IOSTREAMS
577
578 # if defined(BOOST_MSVC) && BOOST_WORKAROUND(BOOST_MSVC, < 1300 && __SGI_STL_PORT)
579 // MSVC6 has problems finding std::basic_ostream through the using declaration in namespace _STL
580 using std::basic_ostream;
581 template<class E, class T, class Y> basic_ostream<E, T> & operator<< (basic_ostream<E, T> & os, shared_ptr<Y> const & p)
582 # else
583 template<class E, class T, class Y> std::basic_ostream<E, T> & operator<< (std::basic_ostream<E, T> & os, shared_ptr<Y> const & p)
584 # endif
585 {
586     os << p.get();
587     return os;
588 }
589
590 #endif // _STLP_NO_IOSTREAMS
591
592 #endif // __GNUC__ < 3
593
594 #endif // !defined(BOOST_NO_IOSTREAM)
595
596 // get_deleter
597
598 #if ( defined(__GNUC__) && BOOST_WORKAROUND(__GNUC__, < 3) ) || \
599     ( defined(__EDG_VERSION__) && BOOST_WORKAROUND(__EDG_VERSION__, <= 238) ) || \
600     ( defined(__HP_aCC) && BOOST_WORKAROUND(__HP_aCC, <= 33500) )
601
602 // g++ 2.9x doesn't allow static_cast<X const *>(void *)
603 // apparently EDG 2.38 and HP aCC A.03.35 also don't accept it
604
605 template<class D, class T> D * get_deleter(shared_ptr<T> const & p)
606 {
607     void const * q = p._internal_get_deleter(BOOST_SP_TYPEID(D));
608     return const_cast<D *>(static_cast<D const *>(q));
609 }
610
611 #else
612
613 template<class D, class T> D * get_deleter(shared_ptr<T> const & p)
614 {
615     return static_cast<D *>(p._internal_get_deleter(BOOST_SP_TYPEID(D)));
616 }
617
618 #endif
619
620 // atomic access
621
622 #if !defined(BOOST_SP_NO_ATOMIC_ACCESS)
623
624 template<class T> inline bool atomic_is_lock_free( shared_ptr<T> const * /*p*/ )
625 {
626     return false;
627 }
628
629 template<class T> shared_ptr<T> atomic_load( shared_ptr<T> const * p )
630 {
631     boost::detail::spinlock_pool<2>::scoped_lock lock( p );
632     return *p;
633 }
634
635 template<class T> inline shared_ptr<T> atomic_load_explicit( shared_ptr<T> const * p, memory_order /*mo*/ )
636 {
637     return atomic_load( p );
638 }
639
640 template<class T> void atomic_store( shared_ptr<T> * p, shared_ptr<T> r )
641 {
642     boost::detail::spinlock_pool<2>::scoped_lock lock( p );
643     p->swap( r );
644 }
645
646 template<class T> inline void atomic_store_explicit( shared_ptr<T> * p, shared_ptr<T> r, memory_order /*mo*/ )
647 {
648     atomic_store( p, r ); // std::move( r )
649 }
650
651 template<class T> shared_ptr<T> atomic_exchange( shared_ptr<T> * p, shared_ptr<T> r )
652 {
653     boost::detail::spinlock & sp = boost::detail::spinlock_pool<2>::spinlock_for( p );
654
655     sp.lock();
656     p->swap( r );
657     sp.unlock();
658
659     return r; // return std::move( r )
660 }
661
662 template<class T> shared_ptr<T> atomic_exchange_explicit( shared_ptr<T> * p, shared_ptr<T> r, memory_order /*mo*/ )
663 {
664     return atomic_exchange( p, r ); // std::move( r )
665 }
666
667 template<class T> bool atomic_compare_exchange( shared_ptr<T> * p, shared_ptr<T> * v, shared_ptr<T> w )
668 {
669     boost::detail::spinlock & sp = boost::detail::spinlock_pool<2>::spinlock_for( p );
670
671     sp.lock();
672
673     if( p->_internal_equiv( *v ) )
674     {
675         p->swap( w );
676
677         sp.unlock();
678
679         return true;
680     }
681     else
682     {
683         shared_ptr<T> tmp( *p );
684
685         sp.unlock();
686
687         tmp.swap( *v );
688         return false;
689     }
690 }
691
692 template<class T> inline bool atomic_compare_exchange_explicit( shared_ptr<T> * p, shared_ptr<T> * v, shared_ptr<T> w, memory_order /*success*/, memory_order /*failure*/ )
693 {
694     return atomic_compare_exchange( p, v, w ); // std::move( w )
695 }
696
697 #endif // !defined(BOOST_SP_NO_ATOMIC_ACCESS)
698
699 // hash_value
700
701 template< class T > struct hash;
702
703 template< class T > std::size_t hash_value( boost::shared_ptr<T> const & p )
704 {
705     return boost::hash< T* >()( p.get() );
706 }
707
708 } // namespace boost
709
710 #endif  // #if defined(BOOST_NO_MEMBER_TEMPLATES) && !defined(BOOST_MSVC6_MEMBER_TEMPLATES)
711
712 #endif  // #ifndef BOOST_SMART_PTR_SHARED_PTR_HPP_INCLUDED