Another Copy Pointer

/*
 
 Copyright (c) 2013 Gergely Mancz
 
 Permission is hereby granted, free of charge, to any person obtaining a 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.
 
 http://www.opensource.org/licenses/mit-license.html
 
 */

#ifndef __COPYPTR_H__
#define __COPYPTR_H__

#include <algorithm>
#include <cassert>

#include <loki/static_check.h>

#include "selector.h"
#include "pointercomparison.h"

namespace Base
{

	template <class _Ty, template <typename> class _TComparisonPolicy = CopyHelper::PointerComparison, class _TCopyPolicy = CopyHelper::Selector<_Ty> >
	class CopyPtr
	{
	public:
		
		CopyPtr(_Ty* pAdoptObject = 0);
		CopyPtr(const CopyPtr& other);
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		CopyPtr(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other);
		virtual ~CopyPtr();
		
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		CopyPtr& operator=(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other);
		CopyPtr& operator=(const CopyPtr& other);
		CopyPtr& operator=(_Ty* pAdoptObject);
		
		_Ty* operator->();
		const _Ty* operator->() const;
		
		// comparison operators
		bool operator==(const CopyPtr& other) const;
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		bool operator==(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other) const;

		bool operator!=(const CopyPtr& other) const;
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		bool operator!=(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other) const;

		bool operator<(const CopyPtr& other) const;
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		bool operator<(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other) const;
		
		bool operator<=(const CopyPtr& other) const;
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		bool operator<=(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other) const;
		
		bool operator>(const CopyPtr& other) const;
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		bool operator>(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other) const;
		
		bool operator>=(const CopyPtr& other) const;
		template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
		bool operator>=(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other) const;
		
		_Ty* get();
		const _Ty* get() const;
		
		_Ty* release();

		void reset(_Ty* pAdoptObject = 0);
		
		bool isNull() const;
		
		void swap(CopyPtr& other, void (*pSwapFn)(_Ty&, _Ty&) = std::swap);
		
	protected:
		
		_Ty* m_pObject;
	};

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy >::CopyPtr(_Ty* pAdoptObject)
		: m_pObject(pAdoptObject)
	{
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::CopyPtr(const CopyPtr& other)
		: m_pObject(0)
	{
		*this = other;
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::CopyPtr(const CopyPtr< _TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy >& other)
		: m_pObject(0)
	{
		*this = other;
	}
		
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::~CopyPtr()
	{
		reset();
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>& CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator=(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other)
	{
		LOKI_STATIC_CHECK((Loki::SuperSubclass< _Ty, _TOther >::value), _TOther_Must_Inherit_From_Ty);

		reset();
		
		if (other.isNull())
			return *this;
		
		// using copy policy of other object
		m_pObject = _TOtherCopyPolicy::copy(other.get());
		
		return *this;
	}
		
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>& CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator=(const CopyPtr& other)
	{
		if (&other == this)
			return *this;
		
		reset();
		
		if (other.isNull())
			return *this;
		
		m_pObject = _TCopyPolicy::copy(other.m_pObject);
		
		return *this;
	}
    
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>& CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator=(_Ty* pAdoptObject)
    {
		if (pAdoptObject == m_pObject)
			return *this;
		
		reset();
		
		m_pObject = pAdoptObject;
		
		return *this;
    }

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	_Ty* CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator->()
	{
		assert(m_pObject);
		
		return m_pObject;
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	const _Ty* CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator->() const
	{
		assert(m_pObject);
		
		return m_pObject;
	}
		
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator==(const CopyPtr& other) const
	{
		return _TComparisonPolicy<_Ty>::isEqual(this->m_pObject, other.m_pObject);
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator==(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other) const
	{
		LOKI_STATIC_CHECK((Loki::IsSameType< _Ty, _TOther >::value), _TOther_And_Ty_Must_Be_The_Same_Type);
		// use comparison policy of this class
		return _TComparisonPolicy<_Ty>::isEqual(this->m_pObject, other.get());
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator!=(const CopyPtr& other) const
	{
		return !_TComparisonPolicy<_Ty>::isEqual(this->m_pObject, other.m_pObject);
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator!=(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other) const
	{
		LOKI_STATIC_CHECK((Loki::IsSameType< _Ty, _TOther >::value), _TOther_And_Ty_Must_Be_The_Same_Type);
		// use comparison policy of this class
		return !_TComparisonPolicy<_Ty>::isEqual(this->m_pObject, other.get());
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator<(const CopyPtr& other) const
	{
		return _TComparisonPolicy<_Ty>::isLessThan(this->m_pObject, other.m_pObject);
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator<(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other) const
	{
		LOKI_STATIC_CHECK((Loki::IsSameType< _Ty, _TOther >::value), _TOther_And_Ty_Must_Be_The_Same_Type);
		// use comparison policy of this class
		return !_TComparisonPolicy<_Ty>::isLessThan(this->m_pObject, other.get());
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator<=(const CopyPtr& other) const
	{
		return _TComparisonPolicy<_Ty>::isLessEqualThan(this->m_pObject, other.m_pObject);
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator<=(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other) const
	{
		LOKI_STATIC_CHECK((Loki::IsSameType< _Ty, _TOther >::value), _TOther_And_Ty_Must_Be_The_Same_Type);
		// use comparison policy of this class
		return !_TComparisonPolicy<_Ty>::isLessEqualThan(this->m_pObject, other.get());
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator>(const CopyPtr& other) const
	{
		return _TComparisonPolicy<_Ty>::isAboveThan(this->m_pObject, other.m_pObject);
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator>(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other) const
	{
		LOKI_STATIC_CHECK((Loki::IsSameType< _Ty, _TOther >::value), _TOther_And_Ty_Must_Be_The_Same_Type);
		// use comparison policy of this class
		return !_TComparisonPolicy<_Ty>::isAboveThan(this->m_pObject, other.get());
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator>=(const CopyPtr& other) const
	{
		return _TComparisonPolicy<_Ty>::isAboveEqualThan(this->m_pObject, other.m_pObject);
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	template <class _TOther, template <typename> class _TOtherComparisonPolicy, class _TOtherCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::operator>=(const CopyPtr<_TOther, _TOtherComparisonPolicy, _TOtherCopyPolicy>& other) const
	{
		LOKI_STATIC_CHECK((Loki::IsSameType< _Ty, _TOther >::value), _TOther_And_Ty_Must_Be_The_Same_Type);
		// use comparison policy of this class
		return !_TComparisonPolicy<_Ty>::isAboveEqualThan(this->m_pObject, other.get());
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	_Ty* CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::get()
	{
		return m_pObject;
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	const _Ty* CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::get() const
	{
		return m_pObject;
	}

	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	_Ty* CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::release()
	{
		_Ty* pObject = m_pObject;
		m_pObject = 0;
		return pObject;
	}
		
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	void CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::reset(_Ty* pAdoptObject)
	{
		_TCopyPolicy::destroy(m_pObject);
		m_pObject = pAdoptObject;
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	bool CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::isNull() const
	{
		return !m_pObject;
	}
	
	template <class _Ty, template <typename> class _TComparisonPolicy, class _TCopyPolicy>
	void CopyPtr<_Ty, _TComparisonPolicy, _TCopyPolicy>::swap(CopyPtr& other, void (*pSwapFn)(_Ty&, _Ty&))
	{
		(*pSwapFn)(m_pObject, other.m_pObject);
	}
	
} // Base ns

#endif // __COPYPTR_H__