YiScopedPtr.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_SCOPED_PTR_H_
#define _YI_SCOPED_PTR_H_

#include "smartptr/YiDeleteFunctors.h"
#include "utility/YiError.h"

#include <memory>

template<typename YI_PTR_TYPE, typename YI_DELETE_FUNCTOR = typename std::unique_ptr<YI_PTR_TYPE>::deleter_type>
class CYIScopedPtr
{
    template<typename YI_OTHER_PTR_TYPE, typename YI_OTHER_DELETER>
    friend class CYIScopedPtr;

public:
    inline explicit CYIScopedPtr(YI_PTR_TYPE *pPtr = nullptr) :
        m_pUnique(pPtr, YI_DELETE_FUNCTOR())
    {
    }

    inline CYIScopedPtr(YI_PTR_TYPE *pPtr, const YI_DELETE_FUNCTOR &deleter) :
        m_pUnique(pPtr, deleter)
    {
    }

    inline CYIScopedPtr(CYIScopedPtr &&other) :
        m_pUnique(std::move(other.m_pUnique))
    {
    }

    inline CYIScopedPtr(std::unique_ptr<YI_PTR_TYPE, YI_DELETE_FUNCTOR> &&other) :
        m_pUnique(std::move(other))
    {
    }

    inline CYIScopedPtr(YI_PTR_TYPE *pPtr, YI_DELETE_FUNCTOR &&deleter) :
        m_pUnique(pPtr, std::move(deleter))
    {
    }

    template<typename YI_PTR_OTHER_TYPE, typename YI_OTHER_DELETER>
    inline CYIScopedPtr(CYIScopedPtr<YI_PTR_OTHER_TYPE, YI_OTHER_DELETER> &&other) :
        m_pUnique(std::move(other.m_pUnique))
    {
    }

    inline ~CYIScopedPtr()
    {
    }

    inline void operator=(YI_PTR_TYPE *pPtr)
    {
        m_pUnique.reset(pPtr);
    }

    inline CYIScopedPtr &operator=(CYIScopedPtr &&other)
    {
        m_pUnique = std::move(other.m_pUnique);
        return *this;
    }

    inline CYIScopedPtr &operator=(std::unique_ptr<YI_PTR_TYPE, YI_DELETE_FUNCTOR> &&other)
    {
        m_pUnique = std::move(other);
        return *this;
    }

    template<typename YI_PTR_OTHER_TYPE, typename YI_OTHER_DELETER>
    inline CYIScopedPtr &operator=(CYIScopedPtr<YI_PTR_OTHER_TYPE, YI_OTHER_DELETER> &&other)
    {
        m_pUnique = std::move(other.m_pUnique);
        return *this;
    }

    inline YI_PTR_TYPE &operator*() const
    {
        return m_pUnique.operator*();
    }

    inline YI_PTR_TYPE *operator->() const
    {
        YI_ASSERT(GetPointer(), "CYIScopedPtr", "Attempted to dereference a null scoped pointer.");
        return m_pUnique.operator->();
    }

    inline bool operator!() const
    {
        return GetPointer() == nullptr;
    }

    inline operator bool() const
    {
        return GetPointer() != nullptr;
    }

    template<typename YI_PTR_OTHER_TYPE, typename YI_OTHER_DELETER>
    inline operator std::unique_ptr<YI_PTR_OTHER_TYPE, YI_OTHER_DELETER>()
    {
        return std::move(m_pUnique);
    }

    inline void Reset(YI_PTR_TYPE *pPtr = nullptr)
    {
        operator=(pPtr);
    }

    inline YI_PTR_TYPE *Get() const
    {
        return GetPointer();
    }

    inline YI_PTR_TYPE *Take()
    {
        return m_pUnique.release();
    }

    inline bool IsNull() const
    {
        return GetPointer() == nullptr;
    }

    inline void Swap(CYIScopedPtr<YI_PTR_TYPE, YI_DELETE_FUNCTOR> &rPtr)
    {
        m_pUnique.swap(rPtr.m_pUnique);
    }

private:
    inline YI_PTR_TYPE *GetPointer() const
    {
        return m_pUnique.get();
    }

    std::unique_ptr<YI_PTR_TYPE, YI_DELETE_FUNCTOR> m_pUnique;

    YI_DISALLOW_COPY_AND_ASSIGN(CYIScopedPtr)
};


template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator==(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return rLhs.Get() == rRhs.Get();
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator!=(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return rLhs.Get() != rRhs.Get();
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE>
inline bool
operator==(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const YI_R_PTR_TYPE *pRhs)
{
    return rLhs.Get() == pRhs;
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE>
inline bool
operator!=(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const YI_R_PTR_TYPE *pRhs)
{
    return rLhs.Get() != pRhs;
}

template<typename YI_L_PTR_TYPE, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator==(const YI_L_PTR_TYPE *pLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return pLhs == rRhs.Get();
}

template<typename YI_L_PTR_TYPE, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator!=(const YI_L_PTR_TYPE *pLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return pLhs != rRhs.Get();
}

#if __cplusplus >= 201103L || defined(YI_UWP) || defined(YI_WIN32)

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR>
inline bool
operator==(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const std::nullptr_t &pRhs)
{
    return rLhs.Get() == pRhs;
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR>
inline bool
operator!=(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const std::nullptr_t &pRhs)
{
    return rLhs.Get() != pRhs;
}

template<typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator==(const std::nullptr_t &pLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return pLhs == rRhs.Get();
}

template<typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator!=(const std::nullptr_t &pLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return pLhs != rRhs.Get();
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator==(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const std::unique_ptr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return rLhs.Get() == rRhs.get();
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator!=(const CYIScopedPtr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const std::unique_ptr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return rLhs.Get() != rRhs.get();
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator==(const std::unique_ptr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return rLhs.get() == rRhs.Get();
}

template<typename YI_L_PTR_TYPE, typename YI_L_DELETE_FUNCTOR, typename YI_R_PTR_TYPE, typename YI_R_DELETE_FUNCTOR>
inline bool
operator!=(const std::unique_ptr<YI_L_PTR_TYPE, YI_L_DELETE_FUNCTOR> &rLhs, const CYIScopedPtr<YI_R_PTR_TYPE, YI_R_DELETE_FUNCTOR> &rRhs)
{
    return rLhs.get() != rRhs.Get();
}

#endif // C++11 checks

#endif /* _YI_SCOPED_PTR_H_ */