fml::ScopedTypeRef< T, Traits > Class Template Reference

#include <scoped_typeref.h>

Inheritance diagram for fml::ScopedTypeRef< T, Traits >:

Public Types
typedef T	element_type

Public Member Functions
	ScopedTypeRef (__unsafe_unretained T object=Traits::InvalidValue(), fml::scoped_policy::OwnershipPolicy policy=fml::scoped_policy::kAssume)
	ScopedTypeRef (const ScopedTypeRef< T, Traits > &that)
template<typename R , typename RTraits >
	ScopedTypeRef (const ScopedTypeRef< R, RTraits > &that_as_subclass)
	ScopedTypeRef (ScopedTypeRef< T, Traits > &&that)
	~ScopedTypeRef ()
ScopedTypeRef &	operator= (const ScopedTypeRef< T, Traits > &that)
T *	InitializeInto ()
void	reset (__unsafe_unretained T object=Traits::InvalidValue(), fml::scoped_policy::OwnershipPolicy policy=fml::scoped_policy::kAssume)
bool	operator== (__unsafe_unretained T that) const
bool	operator!= (__unsafe_unretained T that) const
	operator T () const __attribute((ns_returns_not_retained))
T	get () const __attribute((ns_returns_not_retained))
void	swap (ScopedTypeRef &that)

Protected Member Functions
T	release () __attribute((ns_returns_not_retained))

Detailed Description

template<typename T, typename Traits = ScopedTypeRefTraits<T>>
class fml::ScopedTypeRef< T, Traits >

Definition at line 51 of file scoped_typeref.h.

Member Typedef Documentation

element_type

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

typedef T fml::ScopedTypeRef< T, Traits >::element_type

Definition at line 53 of file scoped_typeref.h.

Constructor & Destructor Documentation

ScopedTypeRef() [1/4]

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

fml::ScopedTypeRef< T, Traits >::ScopedTypeRef ( __unsafe_unretained T  object = Traits::InvalidValue(), fml::scoped_policy::OwnershipPolicy  policy = fml::scoped_policy::kAssume  )

inlineexplicit

Definition at line 55 of file scoped_typeref.h.

      : object_(object) {
    if (object_ && policy == fml::scoped_policy::kRetain) {
      object_ = Traits::Retain(object_);
    }
  }

ScopedTypeRef() [2/4]

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

fml::ScopedTypeRef< T, Traits >::ScopedTypeRef ( const ScopedTypeRef< T, Traits > &  that )

inline

Definition at line 65 of file scoped_typeref.h.

                                                      : object_(that.object_) {
    if (object_) {
      object_ = Traits::Retain(object_);
    }
  }

ScopedTypeRef() [3/4]

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

template<typename R , typename RTraits >

fml::ScopedTypeRef< T, Traits >::ScopedTypeRef ( const ScopedTypeRef< R, RTraits > &  that_as_subclass )

inlineexplicit

Definition at line 73 of file scoped_typeref.h.

      : object_(that_as_subclass.get()) {
    if (object_) {
      object_ = Traits::Retain(object_);
    }
  }

ScopedTypeRef() [4/4]

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

fml::ScopedTypeRef< T, Traits >::ScopedTypeRef ( ScopedTypeRef< T, Traits > &&  that )

inline

Definition at line 81 of file scoped_typeref.h.

                                                 : object_(that.object_) {
    that.object_ = Traits::InvalidValue();
  }

~ScopedTypeRef()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

fml::ScopedTypeRef< T, Traits >::~ScopedTypeRef ( )

inline

Definition at line 85 of file scoped_typeref.h.

                   {
    if (object_) {
      Traits::Release(object_);
    }
  }

Member Function Documentation

get()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

T fml::ScopedTypeRef< T, Traits >::get ( ) const

inline

Definition at line 123 of file scoped_typeref.h.

{ return object_; }

InitializeInto()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

T * fml::ScopedTypeRef< T, Traits >::InitializeInto ( )

inline

Definition at line 99 of file scoped_typeref.h.

                                    {
    FML_DCHECK(!object_);
    return &object_;
  }

operator T()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

fml::ScopedTypeRef< T, Traits >::operator T ( ) const

inline

Definition at line 121 of file scoped_typeref.h.

{ return object_; }

operator!=()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

bool fml::ScopedTypeRef< T, Traits >::operator!= ( __unsafe_unretained T  that ) const

inline

Definition at line 118 of file scoped_typeref.h.

{ return object_ != that; }

operator=()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

ScopedTypeRef & fml::ScopedTypeRef< T, Traits >::operator= ( const ScopedTypeRef< T, Traits > &  that )

inline

Definition at line 91 of file scoped_typeref.h.

                                                                 {
    reset(that.get(), fml::scoped_policy::kRetain);
    return *this;
  }

operator==()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

bool fml::ScopedTypeRef< T, Traits >::operator== ( __unsafe_unretained T  that ) const

inline

Definition at line 116 of file scoped_typeref.h.

{ return object_ == that; }

release()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

T fml::ScopedTypeRef< T, Traits >::release ( )

inlineprotected

Definition at line 135 of file scoped_typeref.h.

                                                                   {
    __unsafe_unretained T temp = object_;
    object_ = Traits::InvalidValue();
    return temp;
  }

reset()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

void fml::ScopedTypeRef< T, Traits >::reset ( __unsafe_unretained T  object = Traits::InvalidValue(), fml::scoped_policy::OwnershipPolicy  policy = fml::scoped_policy::kAssume  )

inline

Definition at line 104 of file scoped_typeref.h.

                                          {
    if (object && policy == fml::scoped_policy::kRetain) {
      object = Traits::Retain(object);
    }
    if (object_) {
      Traits::Release(object_);
    }
    object_ = object;
  }

swap()

template<typename T , typename Traits = ScopedTypeRefTraits<T>>

void fml::ScopedTypeRef< T, Traits >::swap ( ScopedTypeRef< T, Traits > &  that )

inline

Definition at line 125 of file scoped_typeref.h.

                                 {
    __unsafe_unretained T temp = that.object_;
    that.object_ = object_;
    object_ = temp;
  }

---

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

• fml/platform/darwin/scoped_typeref.h