llvm::IntrusiveRefCntPtr< T > Class Template Reference

#include <IntrusiveRefCntPtr.h>

Inheritance diagram for llvm::IntrusiveRefCntPtr< T >:

[legend]

Collaboration diagram for llvm::IntrusiveRefCntPtr< T >:

[legend]

List of all members.

Public Types
typedef T	element_type
typedef T *(IntrusiveRefCntPtr::*	unspecified_bool_type )() const
Public Member Functions
	IntrusiveRefCntPtr ()
	IntrusiveRefCntPtr (T *obj)
	IntrusiveRefCntPtr (const IntrusiveRefCntPtr &S)
template<class X>
	IntrusiveRefCntPtr (const IntrusiveRefCntPtr< X > &S)
IntrusiveRefCntPtr &	operator= (const IntrusiveRefCntPtr &S)
template<class X>
IntrusiveRefCntPtr &	operator= (const IntrusiveRefCntPtr< X > &S)
IntrusiveRefCntPtr &	operator= (T *S)
	~IntrusiveRefCntPtr ()
T &	operator* () const
T *	operator-> () const
T *	getPtr () const
	operator unspecified_bool_type () const
void	swap (IntrusiveRefCntPtr &other)

---

Detailed Description

template<typename T>
class llvm::IntrusiveRefCntPtr< T >

IntrusiveRefCntPtr - A template class that implements a "smart pointer" that assumes the wrapped object has a reference count associated with it that can be managed via calls to IntrusivePtrAddRef/IntrusivePtrRelease. The smart pointers manage reference counts via the RAII idiom: upon creation of smart pointer the reference count of the wrapped object is incremented and upon destruction of the smart pointer the reference count is decremented. This class also safely handles wrapping NULL pointers.

Reference counting is implemented via calls to Obj->Retain()/Obj->Release(). Release() is required to destroy the object when the reference count reaches zero. Inheriting from RefCountedBase/RefCountedBaseVPTR takes care of this automatically.

Definition at line 102 of file IntrusiveRefCntPtr.h.

---

Member Typedef Documentation

template<typename T>

typedef T llvm::IntrusiveRefCntPtr< T >::element_type

Definition at line 106 of file IntrusiveRefCntPtr.h.

template<typename T>

typedef T*(IntrusiveRefCntPtr::* llvm::IntrusiveRefCntPtr< T >::unspecified_bool_type)() const

---

Constructor & Destructor Documentation

template<typename T>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr

(

)

[inline, explicit]

Definition at line 108 of file IntrusiveRefCntPtr.h.

template<typename T>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr

(

T *

obj

)

[inline, explicit]

Definition at line 110 of file IntrusiveRefCntPtr.h.

template<typename T>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr

(

const IntrusiveRefCntPtr< T > &

S

)

[inline]

Definition at line 114 of file IntrusiveRefCntPtr.h.

template<typename T>

template<class X>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr

(

const IntrusiveRefCntPtr< X > &

S

)

[inline]

Definition at line 119 of file IntrusiveRefCntPtr.h.

template<typename T>

llvm::IntrusiveRefCntPtr< T >::~IntrusiveRefCntPtr

(

)

[inline]

Definition at line 140 of file IntrusiveRefCntPtr.h.

---

Member Function Documentation

template<typename T>

IntrusiveRefCntPtr& llvm::IntrusiveRefCntPtr< T >::operator=

(

const IntrusiveRefCntPtr< T > &

S

)

[inline]

Definition at line 124 of file IntrusiveRefCntPtr.h.

template<typename T>

template<class X>

IntrusiveRefCntPtr& llvm::IntrusiveRefCntPtr< T >::operator=

(

const IntrusiveRefCntPtr< X > &

S

)

[inline]

Definition at line 130 of file IntrusiveRefCntPtr.h.

template<typename T>

IntrusiveRefCntPtr& llvm::IntrusiveRefCntPtr< T >::operator=

(

T *

S

)

[inline]

Definition at line 135 of file IntrusiveRefCntPtr.h.

template<typename T>

T& llvm::IntrusiveRefCntPtr< T >::operator*

(

)

const [inline]

Definition at line 142 of file IntrusiveRefCntPtr.h.

template<typename T>

T* llvm::IntrusiveRefCntPtr< T >::operator->

(

)

const [inline]

Definition at line 144 of file IntrusiveRefCntPtr.h.

template<typename T>

T* llvm::IntrusiveRefCntPtr< T >::getPtr

(

)

const [inline]

Definition at line 146 of file IntrusiveRefCntPtr.h.

Referenced by llvm::simplify_type< const IntrusiveRefCntPtr< T > >::getSimplifiedValue(), llvm::simplify_type< IntrusiveRefCntPtr< T > >::getSimplifiedValue(), llvm::IntrusiveRefCntPtr< llvmc::Edge >::operator unspecified_bool_type(), llvm::operator!=(), llvm::IntrusiveRefCntPtr< llvmc::Edge >::operator=(), and llvm::operator==().

template<typename T>

llvm::IntrusiveRefCntPtr< T >::operator unspecified_bool_type

(

)

const [inline]

Definition at line 149 of file IntrusiveRefCntPtr.h.

template<typename T>

void llvm::IntrusiveRefCntPtr< T >::swap

(

IntrusiveRefCntPtr< T > &

other

)

[inline]

Definition at line 153 of file IntrusiveRefCntPtr.h.

---

The documentation for this class was generated from the following file:

• IntrusiveRefCntPtr.h