llvm::IntrusiveRefCntPtr< T > Class Template Reference

#include <IntrusiveRefCntPtr.h>

Inheritance diagram for llvm::IntrusiveRefCntPtr< T >:

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= (IntrusiveRefCntPtr S)
	~IntrusiveRefCntPtr ()
T &	operator* () const
T *	operator-> () const
T *	getPtr () const
	operator unspecified_bool_type () const
void	swap (IntrusiveRefCntPtr &other)
void	reset ()
void	resetWithoutRelease ()

Detailed Description

template<class 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 31 of file IntrusiveRefCntPtr.h.

Member Typedef Documentation

template<class T>

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

Definition at line 114 of file IntrusiveRefCntPtr.h.

template<class T>

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

Definition at line 156 of file IntrusiveRefCntPtr.h.

Constructor & Destructor Documentation

template<class T>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr ( )

inlineexplicit

Definition at line 116 of file IntrusiveRefCntPtr.h.

template<class T>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr ( T *  obj )

inline

Definition at line 118 of file IntrusiveRefCntPtr.h.

template<class T>

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr ( const IntrusiveRefCntPtr< T > &  S )

inline

Definition at line 122 of file IntrusiveRefCntPtr.h.

template<class T>

template<class X >

llvm::IntrusiveRefCntPtr< T >::IntrusiveRefCntPtr ( const IntrusiveRefCntPtr< X > &  S )

inline

Definition at line 138 of file IntrusiveRefCntPtr.h.

template<class T>

llvm::IntrusiveRefCntPtr< T >::~IntrusiveRefCntPtr ( )

inline

Definition at line 148 of file IntrusiveRefCntPtr.h.

Member Function Documentation

template<class T>

T* llvm::IntrusiveRefCntPtr< T >::getPtr ( ) const

inline

Definition at line 154 of file IntrusiveRefCntPtr.h.

Referenced by llvm::IntrusiveRefCntPtr< detail::DirIterState >::operator unspecified_bool_type().

template<class T>

llvm::IntrusiveRefCntPtr< T >::operator unspecified_bool_type ( ) const

inline

Definition at line 157 of file IntrusiveRefCntPtr.h.

template<class T>

T& llvm::IntrusiveRefCntPtr< T >::operator* ( ) const

inline

Definition at line 150 of file IntrusiveRefCntPtr.h.

template<class T>

T* llvm::IntrusiveRefCntPtr< T >::operator-> ( ) const

inline

Definition at line 152 of file IntrusiveRefCntPtr.h.

template<class T>

IntrusiveRefCntPtr& llvm::IntrusiveRefCntPtr< T >::operator= ( IntrusiveRefCntPtr< T >  S )

inline

Definition at line 143 of file IntrusiveRefCntPtr.h.

template<class T>

void llvm::IntrusiveRefCntPtr< T >::reset ( )

inline

Definition at line 167 of file IntrusiveRefCntPtr.h.

Referenced by llvm::sys::fs::recursive_directory_iterator::increment(), llvm::sys::fs::recursive_directory_iterator::pop(), and llvm::sys::fs::recursive_directory_iterator::recursive_directory_iterator().

template<class T>

void llvm::IntrusiveRefCntPtr< T >::resetWithoutRelease ( )

inline

Definition at line 172 of file IntrusiveRefCntPtr.h.

template<class T>

void llvm::IntrusiveRefCntPtr< T >::swap ( IntrusiveRefCntPtr< T > &  other )

inline

Definition at line 161 of file IntrusiveRefCntPtr.h.

Referenced by llvm::IntrusiveRefCntPtr< detail::DirIterState >::operator=().

---

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

• IntrusiveRefCntPtr.h