YiSharedPtr.h

Go to the documentation of this file.

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

#include "utility/YiRtti.h"
#include "utility/YiError.h"

#include "smartptr/YiDefaultPtrDeleter.h"
#include "smartptr/YiCallbackDeleter.h"
#include "smartptr/YiFunctorDeleter.h"

#include <memory>

template<typename YI_PTR_TYPE>
class CYIWeakPtr;

template<typename YI_PTR_TYPE>
class CYISharedPtr
{
    template<typename YI_OTHER_PTR_TYPE> friend class CYIWeakPtr;
    template<typename YI_OTHER_PTR_TYPE> friend class CYISharedPtr;
    template<typename YI_OTHER_PTR_TYPE>
    friend class CYIEnableSharedFromThis;

public:
    CYISharedPtr();

    explicit CYISharedPtr(YI_PTR_TYPE *pData);

    explicit CYISharedPtr(YI_PTR_TYPE *pData, typename CYICallbackDeleter<YI_PTR_TYPE>::YI_CALLBACK pCallback);

    template<typename YI_FUNCTION_OBJECT>
    explicit CYISharedPtr(YI_PTR_TYPE *pData, YI_FUNCTION_OBJECT functor);

    template<typename YI_OTHER_TYPE>
    CYISharedPtr(const std::shared_ptr<YI_OTHER_TYPE> &pShared);

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr(const CYISharedPtr<YI_OTHER_PTR_TYPE> &rOther);

    CYISharedPtr(const CYIWeakPtr<YI_PTR_TYPE> &rOther) = delete; // Removed because the std::shared_ptr version throws when the weak pointer is empty

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr(const CYIWeakPtr<YI_OTHER_PTR_TYPE> &rOther) = delete; // Removed because the std::shared_ptr version throws when the weak pointer is empty

    ~CYISharedPtr();

    void Reset();

    YI_PTR_TYPE &operator*() const;

    YI_PTR_TYPE *operator->() const;

    bool operator!() const;

    operator bool() const;

    template<typename YI_OTHER_PTR_TYPE>
    operator std::shared_ptr<YI_OTHER_PTR_TYPE>() const;

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr<YI_PTR_TYPE> &operator=(const std::shared_ptr<YI_OTHER_PTR_TYPE> &rOther);

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr<YI_PTR_TYPE> &operator=(const CYISharedPtr<YI_OTHER_PTR_TYPE> &rOther);

    CYISharedPtr<YI_PTR_TYPE> &operator=(const CYIWeakPtr<YI_PTR_TYPE> &rOther) = delete; // Removed because this is not present on std::shared_ptr

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr<YI_PTR_TYPE> &operator=(const CYIWeakPtr<YI_OTHER_PTR_TYPE> &rOther) = delete; // Removed because this is not present on std::shared_ptr

    YI_PTR_TYPE *Get() const;

    bool IsNull() const;

    bool IsUnique() const;

    uint32_t GetUseCount() const;

    void Swap(CYISharedPtr<YI_PTR_TYPE> &rPtr);

    CYIWeakPtr<YI_PTR_TYPE> ToWeakPtr() const;

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr<YI_OTHER_PTR_TYPE> StaticCast() const;

    template<typename YI_OTHER_PTR_TYPE>
    CYISharedPtr<YI_OTHER_PTR_TYPE> DynamicCast() const;

    const CYIRuntimeTypeInfo *GetRuntimeTypeInfo() const;
    
    static const CYIRuntimeTypeInfo &GetClassTypeInfo();

#if YI_LOG_SHARED_PTR_COUNTS

    void EnableCountsLogging();
#endif

private:
    std::shared_ptr<YI_PTR_TYPE> m_pShared;
};

#include "smartptr/YiSharedPtr.inl"

#endif /* _YI_SHARED_PTR_H_ */