Magic_Game/Kiwano/common/IntrusivePtr.hpp

// Copyright (c) 2016-2018 Kiwano - Nomango
// 
// Permission is hereby granted, free of charge, to any person obtaining lhs copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include "../macros.h"
#include <utility>
#include <type_traits>

namespace kiwano
{
	template <typename _Ty, typename _Manager, bool _Enable>
	class IntrusivePtr;

	template <typename _Ty, typename _Manager>
	class IntrusivePtr<_Ty, _Manager, false>;


	template <typename _Ty, typename _Manager>
	using RealIntrusivePtr = IntrusivePtr<_Ty, _Manager, true>;

	template <typename _Ty, typename _Manager>
	class IntrusivePtr<_Ty, _Manager, true>
	{
		_Ty* ptr_{ nullptr };

	public:
		using Type = _Ty;

		IntrusivePtr() KGE_NOEXCEPT {}

		IntrusivePtr(nullptr_t) KGE_NOEXCEPT {}

		IntrusivePtr(Type* p) KGE_NOEXCEPT : ptr_(p)
		{
			typename _Manager::AddRef(ptr_);
		}

		IntrusivePtr(const IntrusivePtr& other) KGE_NOEXCEPT
			: ptr_(other.ptr_)
		{
			typename _Manager::AddRef(ptr_);
		}

		template <typename _UTy>
		IntrusivePtr(const RealIntrusivePtr<_UTy, _Manager>& other) KGE_NOEXCEPT
			: ptr_(other.Get())
		{
			typename _Manager::AddRef(ptr_);
		}

		IntrusivePtr(IntrusivePtr&& other) KGE_NOEXCEPT
		{
			ptr_ = other.ptr_;
			other.ptr_ = nullptr;
		}

		~IntrusivePtr() KGE_NOEXCEPT
		{
			typename _Manager::Release(ptr_);
		}

		inline Type* Get() const KGE_NOEXCEPT { return ptr_; }

		inline void Reset() KGE_NOEXCEPT
		{
			IntrusivePtr{}.Swap(*this);
		}

		inline void Swap(IntrusivePtr& other) KGE_NOEXCEPT
		{
			std::swap(ptr_, other.ptr_);
		}

		inline Type* operator ->() const
		{
			KGE_ASSERT(ptr_ != nullptr && "Invalid pointer");
			return ptr_;
		}

		inline Type& operator *() const
		{
			KGE_ASSERT(ptr_ != nullptr && "Invalid pointer");
			return *ptr_;
		}

		inline Type** operator &()
		{
			KGE_ASSERT(ptr_ == nullptr && "Memory leak");
			return &ptr_;
		}

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

		inline bool operator !() const KGE_NOEXCEPT { return ptr_ == 0; }

		inline IntrusivePtr& operator =(const IntrusivePtr& other) KGE_NOEXCEPT
		{
			if (other.ptr_ != ptr_)
				IntrusivePtr(other).Swap(*this);
			return *this;
		}

		inline IntrusivePtr& operator =(IntrusivePtr&& other) KGE_NOEXCEPT
		{
			typename _Manager::Release(ptr_);
			ptr_ = other.ptr_;
			other.ptr_ = nullptr;
			return *this;
		}

		inline IntrusivePtr& operator =(Type* p) KGE_NOEXCEPT
		{
			if (p != ptr_)
				IntrusivePtr(p).Swap(*this);
			return *this;
		}

		inline IntrusivePtr& operator =(nullptr_t) KGE_NOEXCEPT
		{
			if (nullptr != ptr_)
				IntrusivePtr{}.Swap(*this);
			return *this;
		}
	};

	template <class _Ty, class _UTy, class _Manager>
	inline bool operator==(RealIntrusivePtr<_Ty, _Manager> const& lhs, RealIntrusivePtr<_UTy, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return lhs.Get() == rhs.Get();
	}

	template <class _Ty, class _UTy, class _Manager>
	inline bool operator!=(RealIntrusivePtr<_Ty, _Manager> const& lhs, RealIntrusivePtr<_UTy, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return lhs.Get() != rhs.Get();
	}

	template <class _Ty, class _UTy, class _Manager>
	inline bool operator<(RealIntrusivePtr<_Ty, _Manager> const& lhs, RealIntrusivePtr<_UTy, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return lhs.Get() < rhs.Get();
	}

	template <class _Ty, class _Manager>
	inline bool operator==(RealIntrusivePtr<_Ty, _Manager> const& lhs, _Ty* rhs) KGE_NOEXCEPT
	{
		return lhs.Get() == rhs;
	}

	template <class _Ty, class _Manager>
	inline bool operator!=(RealIntrusivePtr<_Ty, _Manager> const& lhs, _Ty* rhs) KGE_NOEXCEPT
	{
		return lhs.Get() != rhs;
	}

	template <class _Ty, class _Manager>
	inline bool operator==(_Ty* lhs, RealIntrusivePtr<_Ty, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return lhs == rhs.Get();
	}

	template <class _Ty, class _Manager>
	inline bool operator!=(_Ty* lhs, RealIntrusivePtr<_Ty, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return lhs != rhs.Get();
	}

	template <class _Ty, class _Manager>
	inline bool operator==(RealIntrusivePtr<_Ty, _Manager> const& lhs, nullptr_t) KGE_NOEXCEPT
	{
		return !static_cast<bool>(lhs);
	}

	template <class _Ty, class _Manager>
	inline bool operator!=(RealIntrusivePtr<_Ty, _Manager> const& lhs, nullptr_t) KGE_NOEXCEPT
	{
		return static_cast<bool>(lhs);
	}

	template <class _Ty, class _Manager>
	inline bool operator==(nullptr_t, RealIntrusivePtr<_Ty, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return !static_cast<bool>(rhs);
	}

	template <class _Ty, class _Manager>
	inline bool operator!=(nullptr_t, RealIntrusivePtr<_Ty, _Manager> const& rhs) KGE_NOEXCEPT
	{
		return static_cast<bool>(rhs);
	}

	// template class cannot specialize std::swap,
	// so implement a swap function in kiwano namespace
	template <class _Ty, class _Manager>
	inline void swap(RealIntrusivePtr<_Ty, _Manager>& lhs, RealIntrusivePtr<_Ty, _Manager>& rhs) KGE_NOEXCEPT
	{
		lhs.Swap(rhs);
	}

}