service_ptr_t< T >

#include <service.h>

Inheritance diagram for service_ptr_t< T >:

Public Member Functions
	service_ptr_t () throw ()
	service_ptr_t (T *p_ptr) throw ()
	service_ptr_t (const t_self &p_source) throw ()
	service_ptr_t (t_self &&p_source) throw ()
template<typename t_source >
	service_ptr_t (t_source *p_ptr) throw ()
template<typename t_source >
	service_ptr_t (const service_ptr_base_t< t_source > &p_source) throw ()
template<typename t_source >
	service_ptr_t (const service_nnptr_t< t_source > &p_source) throw ()
template<typename t_source >
	service_ptr_t (service_ptr_t< t_source > &&p_source) throw ()
	~service_ptr_t () throw ()
service_ptr_t< service_base > &	_as_base_ptr ()
T *	_duplicate_ptr () const throw ()
template<typename t_source >
void	attach (t_source *p_ptr) throw ()
template<typename t_source >
void	copy (t_source *p_ptr) throw ()
template<typename t_source >
void	copy (const service_ptr_base_t< t_source > &p_source) throw ()
template<typename t_source >
void	copy (service_ptr_t< t_source > &&p_source) throw ()
T *	detach () throw ()
T *	get_ptr () const throw ()
bool	is_empty () const throw ()
bool	is_valid () const throw ()
bool	operator!= (const service_ptr_base_t< T > &p_item) const throw ()
bool	operator!= (T *p_item) const throw ()
template<typename otherPtr_t >
bool	operator&= (otherPtr_t other)
T &	operator* () const throw ()
service_obscure_refcounting< T > *	operator-> () const throw ()
bool	operator< (const service_ptr_base_t< T > &p_item) const throw ()
bool	operator< (T *p_item) const throw ()
template<typename t_other >
t_self &	operator<< (service_ptr_t< t_other > &p_source) throw ()
const t_self &	operator= (const t_self &p_source) throw ()
const t_self &	operator= (t_self &&p_source) throw ()
const t_self &	operator= (T *p_ptr) throw ()
template<typename t_source >
t_self &	operator= (const service_ptr_base_t< t_source > &p_source) throw ()
template<typename t_source >
t_self &	operator= (service_ptr_t< t_source > &&p_source) throw ()
template<typename t_source >
t_self &	operator= (t_source *p_ptr) throw ()
template<typename t_source >
t_self &	operator= (const service_nnptr_t< t_source > &p_ptr) throw ()
bool	operator== (const service_ptr_base_t< T > &p_item) const throw ()
bool	operator== (T *p_item) const throw ()
bool	operator> (const service_ptr_base_t< T > &p_item) const throw ()
bool	operator> (T *p_item) const throw ()
template<typename t_other >
t_self &	operator>> (service_ptr_t< t_other > &p_dest) throw ()
template<typename otherPtr_t >
void	operator^= (otherPtr_t other)
void	release () throw ()
Public Member Functions inherited from service_ptr_base_t< T >
T *	get_ptr () const throw ()

Static Public Member Functions
static bool	_as_base_ptr_check ()

Private Types
typedef service_ptr_t< T >	t_self

Private Member Functions
template<typename t_source >
void	_init (t_source *in) throw ()
template<typename t_source >
void	_init (t_source &&in) throw ()

Additional Inherited Members
Protected Attributes inherited from service_ptr_base_t< T >
T *	m_ptr

Detailed Description

template<typename T>
class service_ptr_t< T >

Autopointer class to be used with all services. Manages reference counter calls behind-the-scenes.

Definition at line 55 of file service.h.

Member Typedef Documentation

template<typename T>

typedef service_ptr_t<T> service_ptr_t< T >::t_self

private

Definition at line 57 of file service.h.

Constructor & Destructor Documentation

template<typename T>

service_ptr_t< T >::service_ptr_t ( ) throw ( )

inline

Definition at line 67 of file service.h.

{this->m_ptr = NULL;}

template<typename T>

service_ptr_t< T >::service_ptr_t ( T *  p_ptr ) throw ( )

inline

Definition at line 68 of file service.h.

{_init(p_ptr);}

template<typename T>

service_ptr_t< T >::service_ptr_t ( const t_self &  p_source ) throw ( )

inline

Definition at line 69 of file service.h.

{_init(p_source.get_ptr());}

template<typename T>

service_ptr_t< T >::service_ptr_t ( t_self &&  p_source ) throw ( )

inline

Definition at line 70 of file service.h.

{_init(std::move(p_source));}

template<typename T>

template<typename t_source >

service_ptr_t< T >::service_ptr_t ( t_source *  p_ptr ) throw ( )

inline

Definition at line 71 of file service.h.

{_init(p_ptr);}

template<typename T>

template<typename t_source >

service_ptr_t< T >::service_ptr_t ( const service_ptr_base_t< t_source > &  p_source ) throw ( )

inline

Definition at line 72 of file service.h.

{_init(p_source.get_ptr());}

template<typename T>

template<typename t_source >

service_ptr_t< T >::service_ptr_t ( const service_nnptr_t< t_source > &  p_source ) throw ( )

inline

Definition at line 73 of file service.h.

{ this->m_ptr = p_source.get_ptr(); this->m_ptr->service_add_ref(); }

template<typename T>

template<typename t_source >

service_ptr_t< T >::service_ptr_t ( service_ptr_t< t_source > &&  p_source ) throw ( )

inline

Definition at line 74 of file service.h.

{ _init(std::move(p_source)); }

template<typename T>

service_ptr_t< T >::~service_ptr_t ( ) throw ( )

inline

Definition at line 76 of file service.h.

{service_release_safe(this->m_ptr);}

Member Function Documentation

template<typename T>

service_ptr_t<service_base>& service_ptr_t< T >::_as_base_ptr ( )

inline

Definition at line 157 of file service.h.

                                                 {
        PFC_ASSERT( _as_base_ptr_check() );
        return *reinterpret_cast<service_ptr_t<service_base>*>(this);
    }

template<typename T>

static bool service_ptr_t< T >::_as_base_ptr_check ( )

inlinestatic

Definition at line 161 of file service.h.

                                     {
        return static_cast<service_base*>((T*)NULL) == reinterpret_cast<service_base*>((T*)NULL);
    }

template<typename T>

T* service_ptr_t< T >::_duplicate_ptr ( ) const throw ( )

inline

Definition at line 140 of file service.h.

                                             {//should not be used ! temporary !
        service_add_ref_safe(this->m_ptr);
        return this->m_ptr;
    }

template<typename T>

template<typename t_source >

void service_ptr_t< T >::_init ( t_source *  in ) throw ( )

inlineprivate

Definition at line 59 of file service.h.

                                                                  {
        this->m_ptr = in;
        if (this->m_ptr) this->m_ptr->service_add_ref();
    }

template<typename T>

template<typename t_source >

void service_ptr_t< T >::_init ( t_source &&  in ) throw ( )

inlineprivate

Definition at line 63 of file service.h.

                                                                   {
        this->m_ptr = in.detach();
    }

template<typename T>

template<typename t_source >

void service_ptr_t< T >::attach ( t_source *  p_ptr ) throw ( )

inline

Definition at line 150 of file service.h.

                                                 {
        service_release_safe(this->m_ptr);
        this->m_ptr = pfc::safe_ptr_cast<T>(p_ptr);
    }

template<typename T>

template<typename t_source >

void service_ptr_t< T >::copy ( t_source *  p_ptr ) throw ( )

inline

Definition at line 79 of file service.h.

                                        {
        service_add_ref_safe(p_ptr);
        service_release_safe(this->m_ptr);
        this->m_ptr = pfc::safe_ptr_cast<T>(p_ptr);
    }

template<typename T>

template<typename t_source >

void service_ptr_t< T >::copy ( const service_ptr_base_t< t_source > &  p_source ) throw ( )

inline

Definition at line 86 of file service.h.

{copy(p_source.get_ptr());}

template<typename T>

template<typename t_source >

void service_ptr_t< T >::copy ( service_ptr_t< t_source > &&  p_source ) throw ( )

inline

Definition at line 89 of file service.h.

{attach(p_source.detach());}

template<typename T>

T* service_ptr_t< T >::detach ( ) throw ( )

inline

Definition at line 145 of file service.h.

                               {
        return pfc::replace_null_t(this->m_ptr);
    }

template<typename T>

T* service_ptr_t< T >::get_ptr ( ) const throw ( )

inline

Definition at line 117 of file service.h.

{return this->m_ptr;}

template<typename T>

bool service_ptr_t< T >::is_empty ( ) const throw ( )

inline

Definition at line 120 of file service.h.

{return this->m_ptr == NULL;}

template<typename T>

bool service_ptr_t< T >::is_valid ( ) const throw ( )

inline

Definition at line 119 of file service.h.

{return this->m_ptr != NULL;}

template<typename T>

bool service_ptr_t< T >::operator!= ( const service_ptr_base_t< T > &  p_item ) const throw ( )

inline

Definition at line 123 of file service.h.

{return this->m_ptr != p_item.get_ptr();}

template<typename T>

bool service_ptr_t< T >::operator!= ( T *  p_item ) const throw ( )

inline

Definition at line 129 of file service.h.

{return this->m_ptr != p_item;}

template<typename T>

template<typename otherPtr_t >

bool service_ptr_t< T >::operator&= ( otherPtr_t  other )

inline

Conditional cast operator - attempts to obtain a vaild service pointer to the expected class; returns true on success, false on failure.

Definition at line 174 of file service.h.

                                          {
        PFC_ASSERT( other.is_valid() );
        return other->cast(*this);
    }

template<typename T>

T& service_ptr_t< T >::operator* ( ) const throw ( )

inline

Definition at line 155 of file service.h.

{return *this->m_ptr;}

template<typename T>

service_obscure_refcounting<T>* service_ptr_t< T >::operator-> ( ) const throw ( )

inline

Definition at line 115 of file service.h.

{PFC_ASSERT(this->m_ptr != NULL);return service_obscure_refcounting_cast(this->m_ptr);}

template<typename T>

bool service_ptr_t< T >::operator< ( const service_ptr_base_t< T > &  p_item ) const throw ( )

inline

Definition at line 126 of file service.h.

{return this->m_ptr < p_item.get_ptr();}

template<typename T>

bool service_ptr_t< T >::operator< ( T *  p_item ) const throw ( )

inline

Definition at line 132 of file service.h.

{return this->m_ptr < p_item;}

template<typename T>

template<typename t_other >

t_self& service_ptr_t< T >::operator<< ( service_ptr_t< t_other > &  p_source ) throw ( )

inline

Definition at line 135 of file service.h.

{attach(p_source.detach());return *this;}

template<typename T>

const t_self& service_ptr_t< T >::operator= ( const t_self &  p_source ) throw ( )

inline

Definition at line 92 of file service.h.

{copy(p_source); return *this;}

template<typename T>

const t_self& service_ptr_t< T >::operator= ( t_self &&  p_source ) throw ( )

inline

Definition at line 93 of file service.h.

{copy(std::move(p_source)); return *this;}

template<typename T>

const t_self& service_ptr_t< T >::operator= ( T *  p_ptr ) throw ( )

inline

Definition at line 94 of file service.h.

{copy(p_ptr); return *this;}

template<typename T>

template<typename t_source >

t_self& service_ptr_t< T >::operator= ( const service_ptr_base_t< t_source > &  p_source ) throw ( )

inline

Definition at line 96 of file service.h.

{copy(p_source); return *this;}

template<typename T>

template<typename t_source >

t_self& service_ptr_t< T >::operator= ( service_ptr_t< t_source > &&  p_source ) throw ( )

inline

Definition at line 97 of file service.h.

{copy(std::move(p_source)); return *this;}

template<typename T>

template<typename t_source >

t_self& service_ptr_t< T >::operator= ( t_source *  p_ptr ) throw ( )

inline

Definition at line 98 of file service.h.

{copy(p_ptr); return *this;}

template<typename T>

template<typename t_source >

t_self& service_ptr_t< T >::operator= ( const service_nnptr_t< t_source > &  p_ptr ) throw ( )

inline

Definition at line 100 of file service.h.

                                                                                                           {
        service_release_safe(this->m_ptr);
        t_source * ptr = p_ptr.get_ptr();
        ptr->service_add_ref();
        this->m_ptr = ptr;
        return *this;
    }

template<typename T>

bool service_ptr_t< T >::operator== ( const service_ptr_base_t< T > &  p_item ) const throw ( )

inline

Definition at line 122 of file service.h.

{return this->m_ptr == p_item.get_ptr();}

template<typename T>

bool service_ptr_t< T >::operator== ( T *  p_item ) const throw ( )

inline

Definition at line 128 of file service.h.

{return this->m_ptr == p_item;}

template<typename T>

bool service_ptr_t< T >::operator> ( const service_ptr_base_t< T > &  p_item ) const throw ( )

inline

Definition at line 125 of file service.h.

{return this->m_ptr > p_item.get_ptr();}

template<typename T>

bool service_ptr_t< T >::operator> ( T *  p_item ) const throw ( )

inline

Definition at line 131 of file service.h.

{return this->m_ptr > p_item;}

template<typename T>

template<typename t_other >

t_self& service_ptr_t< T >::operator>> ( service_ptr_t< t_other > &  p_dest ) throw ( )

inline

Definition at line 137 of file service.h.

{p_dest.attach(detach());return *this;}

template<typename T>

template<typename otherPtr_t >

void service_ptr_t< T >::operator^= ( otherPtr_t  other )

inline

Forced cast operator - obtains a valid service pointer to the expected class or crashes the app if such pointer cannot be obtained.

Definition at line 167 of file service.h.

                                          {
        PFC_ASSERT( other.is_valid() );
        if (!other->cast(*this)) uBugCheck();
    }

template<typename T>

void service_ptr_t< T >::release ( ) throw ( )

inline

Definition at line 109 of file service.h.

                                  {
        service_release_safe(this->m_ptr);
        this->m_ptr = NULL;
    }

---

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

• foobar2000/SDK/service.h