42 #ifndef TEUCHOS_RCP_HPP
43 #define TEUCHOS_RCP_HPP
59 #include "Teuchos_Ptr.hpp"
60 #include "Teuchos_Assert.hpp"
61 #include "Teuchos_Exceptions.hpp"
62 #include "Teuchos_dyn_cast.hpp"
75 RCPNode* RCP_createNewRCPNodeRawPtrNonowned( T* p )
77 return new RCPNodeTmpl<T,DeallocNull<T> >(p, DeallocNull<T>(),
false);
83 RCPNode* RCP_createNewRCPNodeRawPtrNonownedUndefined( T* p )
85 return new RCPNodeTmpl<T,DeallocNull<T> >(p, DeallocNull<T>(),
false, null);
91 RCPNode* RCP_createNewRCPNodeRawPtr( T* p,
bool has_ownership_in )
93 return new RCPNodeTmpl<T,DeallocDelete<T> >(p, DeallocDelete<T>(), has_ownership_in);
97 template<
class T,
class Dealloc_T>
99 RCPNode* RCP_createNewDeallocRCPNodeRawPtr(
100 T* p, Dealloc_T dealloc,
bool has_ownership_in
103 return new RCPNodeTmpl<T,Dealloc_T>(p, dealloc, has_ownership_in);
107 template<
class T,
class Dealloc_T>
109 RCPNode* RCP_createNewDeallocRCPNodeRawPtrUndefined(
110 T* p, Dealloc_T dealloc,
bool has_ownership_in
113 return new RCPNodeTmpl<T,Dealloc_T>(p, dealloc, has_ownership_in, null);
120 : ptr_(p), node_(node)
126 T* RCP<T>::access_private_ptr()
const
132 RCPNodeHandle& RCP<T>::nonconst_access_private_node()
138 const RCPNodeHandle& RCP<T>::access_private_node()
const
158 #ifndef TEUCHOS_DEBUG
159 , node_(RCP_createNewRCPNodeRawPtrNonowned(p))
165 if (existing_RCPNode) {
172 RCP_createNewRCPNodeRawPtrNonowned(p),
178 #endif // TEUCHOS_DEBUG
186 node_(RCP_createNewRCPNodeRawPtrNonownedUndefined(p))
194 #ifndef TEUCHOS_DEBUG
195 , node_(RCP_createNewRCPNodeRawPtr(p, has_ownership_in))
201 if (!has_ownership_in) {
204 if (existing_RCPNode) {
219 #endif // TEUCHOS_DEBUG
224 template<
class Dealloc_T>
228 #ifndef TEUCHOS_DEBUG
229 , node_(RCP_createNewDeallocRCPNodeRawPtr(p, dealloc, has_ownership_in))
237 RCPNodeThrowDeleter nodeDeleter(RCP_createNewDeallocRCPNodeRawPtr(p, dealloc, has_ownership_in));
245 #endif // TEUCHOS_DEBUG
250 template<
class Dealloc_T>
252 RCP<T>::RCP( T* p, Dealloc_T dealloc, ERCPUndefinedWithDealloc,
bool has_ownership_in )
254 #ifndef TEUCHOS_DEBUG
255 , node_(RCP_createNewDeallocRCPNodeRawPtrUndefined(p, dealloc, has_ownership_in))
265 p, dealloc, has_ownership_in));
273 #endif // TEUCHOS_DEBUG
280 : ptr_(r_ptr.ptr_), node_(r_ptr.node_)
287 : ptr_(r_ptr.ptr_), node_(std::move(r_ptr.node_))
298 node_(r_ptr.access_private_node())
307 node_(r_ptr.access_private_node())
326 RCP<T>(r_ptr).swap(*
this);
341 node_ = std::move(r_ptr.node_);
360 std::swap(r_ptr.ptr_, ptr_);
361 node_.swap(r_ptr.node_);
380 debug_assert_not_null();
381 debug_assert_valid_ptr();
390 debug_assert_not_null();
391 debug_assert_valid_ptr();
399 debug_assert_valid_ptr();
417 return Ptr<T>(this->create_weak());
419 return Ptr<T>(getRawPtr());
436 return rcp_implicit_cast<
const T>(*this);
455 return node_.strength();
464 return node_.is_valid_ptr();
473 return node_.strong_count();
481 return node_.weak_count();
489 return node_.total_count();
497 node_.has_ownership(
true);
505 return node_.has_ownership();
513 debug_assert_valid_ptr();
514 node_.has_ownership(
false);
523 debug_assert_valid_ptr();
524 return RCP<T>(ptr_, node_.create_weak());
532 debug_assert_valid_ptr();
533 return RCP<T>(ptr_, node_.create_strong());
536 #if defined(HAVE_TEUCHOSCORE_CXX11) && defined(HAVE_TEUCHOS_THREAD_SAFE)
541 if (strength() == RCP_STRONG) {
542 return create_strong();
547 RCPNodeHandle attemptStrong = node_.create_strong_lock();
548 return RCP<T>( attemptStrong.is_node_null() ? 0 : ptr_, attemptStrong);
558 return node_.same_node(r_ptr.access_private_node());
573 throw_null_ptr_error(
typeName(*
this));
583 node_.assert_valid_ptr(*
this);
609 *
this =
rcp(p, has_ownership_in);
624 return RCP<T>(p, owns_mem);
628 template<
class T,
class Dealloc_T>
631 Teuchos::rcpWithDealloc( T* p, Dealloc_T dealloc,
bool owns_mem )
633 return RCP<T>(p, dealloc, owns_mem);
637 template<
class T,
class Dealloc_T>
640 Teuchos::rcpWithDeallocUndef( T* p, Dealloc_T dealloc,
bool owns_mem )
642 return RCP<T>(p, dealloc, RCP_UNDEFINED_WITH_DEALLOC, owns_mem);
648 Teuchos::rcpFromRef( T& r )
650 return RCP<T>(&r, RCP_WEAK_NO_DEALLOC);
656 Teuchos::rcpFromUndefRef( T& r )
658 return RCP<T>(&r, RCP_UNDEFINED_WEAK_NO_DEALLOC);
662 template<
class T,
class Embedded>
664 Teuchos::rcpWithEmbeddedObjPreDestroy(
665 T* p,
const Embedded &embedded,
bool owns_mem
669 p, embeddedObjDeallocDelete<T>(embedded,PRE_DESTROY), owns_mem
674 template<
class T,
class Embedded>
676 Teuchos::rcpWithEmbeddedObjPostDestroy(
677 T* p,
const Embedded &embedded,
bool owns_mem
680 return rcpWithDealloc( p, embeddedObjDeallocDelete<T>(embedded,POST_DESTROY), owns_mem );
684 template<
class T,
class Embedded>
686 Teuchos::rcpWithEmbeddedObj( T* p,
const Embedded &embedded,
bool owns_mem )
688 return rcpWithEmbeddedObjPostDestroy<T,Embedded>(p,embedded,owns_mem);
692 template<
class T,
class ParentT>
694 Teuchos::rcpWithInvertedObjOwnership(
const RCP<T> &child,
695 const RCP<ParentT> &parent)
697 using std::make_pair;
704 Teuchos::rcpCloneNode(
const RCP<T> &p)
731 bool Teuchos::operator==(
const RCP<T> &p,
ENull )
733 return p.get() == NULL;
739 bool Teuchos::operator!=(
const RCP<T> &p,
ENull )
741 return p.get() != NULL;
745 template<
class T1,
class T2>
747 bool Teuchos::operator==(
const RCP<T1> &p1,
const RCP<T2> &p2 )
749 return p1.access_private_node().same_node(p2.access_private_node());
753 template<
class T1,
class T2>
755 bool Teuchos::operator!=(
const RCP<T1> &p1,
const RCP<T2> &p2 )
757 return !p1.access_private_node().same_node(p2.access_private_node());
761 template<
class T2,
class T1>
764 Teuchos::rcp_implicit_cast(
const RCP<T1>& p1)
767 T2 *check = p1.
get();
768 return RCP<T2>(check, p1.access_private_node());
772 template<
class T2,
class T1>
775 Teuchos::rcp_static_cast(
const RCP<T1>& p1)
778 T2 *check =
static_cast<T2*
>(p1.get());
779 return RCP<T2>(check, p1.access_private_node());
783 template<
class T2,
class T1>
786 Teuchos::rcp_const_cast(
const RCP<T1>& p1)
789 T2 *check =
const_cast<T2*
>(p1.get());
790 return RCP<T2>(check, p1.access_private_node());
794 template<
class T2,
class T1>
797 Teuchos::rcp_dynamic_cast(
const RCP<T1>& p1,
bool throw_on_fail)
806 p =
dynamic_cast<T2*
>(p1.get());
809 return RCP<T2>(p, p1.access_private_node());
816 template<
class T1,
class T2>
818 void Teuchos::set_extra_data(
const T1 &extra_data,
const std::string& name,
821 p->assert_not_null();
822 p->nonconst_access_private_node().set_extra_data(
823 any(extra_data), name, destroy_when,
828 template<
class T1,
class T2>
830 const T1& Teuchos::get_extra_data(
const RCP<T2>& p,
const std::string& name )
834 p.access_private_node().get_extra_data(
835 TypeNameTraits<T1>::name(), name
841 template<
class T1,
class T2>
843 T1& Teuchos::get_nonconst_extra_data( RCP<T2>& p,
const std::string& name )
847 p.nonconst_access_private_node().get_extra_data(
848 TypeNameTraits<T1>::name(), name
854 template<
class T1,
class T2>
857 Teuchos::get_optional_extra_data(
const RCP<T2>& p,
const std::string& name )
860 const any *extra_data = p.access_private_node().get_optional_extra_data(
861 TypeNameTraits<T1>::name(), name);
863 return Ptr<const T1>(&
any_cast<T1>(*extra_data));
868 template<
class T1,
class T2>
871 Teuchos::get_optional_nonconst_extra_data( RCP<T2>& p,
const std::string& name )
874 any *extra_data = p.nonconst_access_private_node().get_optional_extra_data(
875 TypeNameTraits<T1>::name(), name);
877 return Ptr<T1>(&
any_cast<T1>(*extra_data));
882 template<
class Dealloc_T,
class T>
884 const Dealloc_T& Teuchos::get_dealloc(
const RCP<T>& p )
886 return get_nonconst_dealloc<Dealloc_T>(
const_cast<RCP<T>&
>(p));
890 template<
class Dealloc_T,
class T>
892 Dealloc_T& Teuchos::get_nonconst_dealloc(
const RCP<T>& p )
894 typedef RCPNodeTmpl<typename Dealloc_T::ptr_t,Dealloc_T> requested_type;
896 RCPNodeTmpl<typename Dealloc_T::ptr_t,Dealloc_T>
897 *dnode =
dynamic_cast<RCPNodeTmpl<typename Dealloc_T::ptr_t,Dealloc_T>*
>(
898 p.access_private_node().node_ptr());
900 dnode==NULL, NullReferenceError
901 ,
"get_dealloc<" << TypeNameTraits<Dealloc_T>::name()
902 <<
"," << TypeNameTraits<T>::name() <<
">(p): "
903 <<
"Error, requested type \'" << TypeNameTraits<requested_type>::name()
904 <<
"\' does not match actual type of the node \'"
905 <<
typeName(*p.access_private_node().node_ptr()) <<
"!"
907 return dnode->get_nonconst_dealloc();
911 template<
class Dealloc_T,
class T>
914 Teuchos::get_optional_nonconst_dealloc(
const RCP<T>& p )
917 typedef RCPNodeTmpl<typename Dealloc_T::ptr_t,Dealloc_T> RCPNT;
918 RCPNT *dnode =
dynamic_cast<RCPNT*
>(p.access_private_node().node_ptr());
920 return ptr(&dnode->get_nonconst_dealloc());
925 template<
class Dealloc_T,
class T>
928 Teuchos::get_optional_dealloc(
const RCP<T>& p )
930 return get_optional_nonconst_dealloc<Dealloc_T>(
const_cast<RCP<T>&
>(p));
934 template<
class TOrig,
class Embedded,
class T>
935 const Embedded& Teuchos::getEmbeddedObj(
const RCP<T>& p )
937 typedef EmbeddedObjDealloc<TOrig,Embedded,DeallocDelete<TOrig> > Dealloc_t;
938 return get_dealloc<Dealloc_t>(p).getObj();
942 template<
class TOrig,
class Embedded,
class T>
943 Embedded& Teuchos::getNonconstEmbeddedObj(
const RCP<T>& p )
945 typedef EmbeddedObjDealloc<TOrig,Embedded,DeallocDelete<TOrig> > Dealloc_t;
946 return get_nonconst_dealloc<Dealloc_t>(p).getNonconstObj();
950 template<
class TOrig,
class Embedded,
class T>
952 Teuchos::getOptionalEmbeddedObj(
const RCP<T>& p )
954 typedef EmbeddedObjDealloc<TOrig,Embedded,DeallocDelete<TOrig> > Dealloc_t;
955 const Ptr<const Dealloc_t> dealloc = get_optional_dealloc<Dealloc_t>(p);
957 return ptr(&dealloc->getObj());
963 template<
class TOrig,
class Embedded,
class T>
965 Teuchos::getOptionalNonconstEmbeddedObj(
const RCP<T>& p )
967 typedef EmbeddedObjDealloc<TOrig,Embedded,DeallocDelete<TOrig> > Dealloc_t;
968 const Ptr<Dealloc_t> dealloc = get_optional_nonconst_dealloc<Dealloc_t>(p);
970 return ptr(&dealloc->getNonconstObj());
976 template<
class ParentT,
class T>
980 typedef std::pair<RCP<T>, RCP<ParentT> > Pair_t;
981 Pair_t pair = getEmbeddedObj<T, Pair_t>(invertedChild);
987 std::ostream& Teuchos::operator<<( std::ostream& out, const RCP<T>& p )
991 <<
"ptr="<<(
const void*)(p.get())
992 <<
",node="<<p.access_private_node()
993 <<
",strong_count="<<p.strong_count()
994 <<
",weak_count="<<p.weak_count()
1000 #endif // TEUCHOS_RCP_HPP
~RCP()
Removes a reference to a dynamically allocated object and possibly deletes the object if owned...
RCP< const T > getConst() const
Return an RCP<const T> version of *this.
RCP(ENull null_arg=null)
Initialize RCP<T> to NULL.
RCP< T > create_weak() const
Create a new weak RCP object from another (strong) RCP object.
bool has_ownership() const
Returns true if this has ownership of object pointed to by this->get() in order to delete it...
bool nonnull(const std::shared_ptr< T > &p)
Returns true if p.get()!=NULL.
bool is_null(const std::shared_ptr< T > &p)
Returns true if p.get()==NULL.
ValueType & any_cast(any &operand)
Used to extract the templated value held in Teuchos::any to a given value type.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
T_To & dyn_cast(T_From &from)
Dynamic casting utility function meant to replace dynamic_cast<T&> by throwing a better documented er...
void swap(RCP< T > &r_ptr)
Swap the contents with some other RCP object.
RCP< T > create_strong() const
Create a new strong RCP object from another (weak) RCP object.
T * get() const
Get the raw C++ pointer to the underlying object.
void release()
Releaes the RCPNode pointer before the destructor is called.
ENull
Used to initialize a RCP object to NULL using an implicit conversion!
ERCPStrength strength() const
Strength of the pointer.
std::string concreteTypeName(const T &t)
Template function for returning the type name of the actual concrete name of a passed-in object...
bool is_null(const ArrayRCP< T > &p)
Returns true if p.get()==NULL.
T * operator->() const
Pointer (->) access to members of underlying object.
RCP< T > rcpWithEmbeddedObj(T *p, const Embedded &embedded, bool owns_mem=true)
Create an RCP with and also put in an embedded object.
Node class to keep track of address and the reference count for a reference-counted utility class and...
T * getRawPtr() const
Get the raw C++ pointer to the underlying object.
const RCP< T > & assert_valid_ptr() const
If the object pointer is non-null, assert that it is still valid.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
void set_has_ownership()
Give this and other RCP<> objects ownership of the referenced object this->get(). ...
void reset()
Reset to null.
Ptr< T > ptr() const
Get a safer wrapper raw C++ pointer to the underlying object.
Ptr< T > operator()() const
Shorthand for ptr().
bool shares_resource(const RCP< T2 > &r_ptr) const
Returns true if the smart pointers share the same underlying reference-counted object.
T & operator*() const
Dereference the underlying object.
ERCPStrength
Used to specify if the pointer is weak or strong.
RCP< T > & operator=(const RCP< T > &r_ptr)
Copy the pointer to the referenced object and increment the reference count.
const Ptr< T > & assert_not_null() const
Throws std::logic_error if this->get()==NULL, otherwise returns reference to *this.
const RCP< T > & assert_not_null() const
Throws NullReferenceError if this->get()==NULL, otherwise returns reference to *this.
static RCPNode * getExistingRCPNode(T *p)
Return a raw pointer to an existing owning RCPNode given the address to the underlying object if it e...
Ptr< T > release()
Release the ownership of the underlying dynamically allocated object.
Ptr< T > ptr(T *p)
Create a pointer to an object from a raw pointer.
Provides std::map class for deficient platforms.
bool is_valid_ptr() const
Return if the underlying object pointer is still valid or not.
Handle class that manages the RCPNode's reference counting.
RCP< ParentT > getInvertedObjOwnershipParent(const RCP< T > &invertedChild)
Get the parent back from an inverted ownership RCP.
EPrePostDestruction
Used to specify a pre or post destruction of extra data.
Reference-counted pointer class and non-member templated function implementations.
Smart reference counting pointer class for automatic garbage collection.
Deletes a (non-owning) RCPNode but not it's underlying object in case of a throw. ...
RCP< T > rcpWithDealloc(T *p, Dealloc_T dealloc, bool owns_mem=true)
Initialize from a raw pointer with a deallocation policy.
Defines basic traits returning the name of a type in a portable and readable way. ...
int strong_count() const
Return the number of active RCP<> objects that have a "strong" reference to the underlying reference-...
void swap(RCPNodeHandle &node_ref)
Swap the contents of node_ref with *this.
int weak_count() const
Return the number of active RCP<> objects that have a "weak" reference to the underlying reference-co...
int total_count() const
Total count (strong_count() + weak_count()).
Simple wrapper class for raw pointers to single objects where no persisting relationship exists...
std::string typeName(const T &t)
Template function for returning the concrete type name of a passed-in object.
bool is_null() const
Returns true if the underlying pointer is null.