SmartPtr/CopiedPtr.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2012 Jan Haller
// 
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
// 
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
// 
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
// 
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
// 
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef THOR_COPIEDPTR_HPP
#define THOR_COPIEDPTR_HPP

#include <Thor/Detail/SmartPtrImpl.hpp>
#include <Thor/Config.hpp>

#include <algorithm>
#include <cassert>


namespace thor
{

template <typename T, template <typename> class OwnershipPolicy>
class MovedPtr;


template <typename T, template <typename> class OwnershipPolicy = DynamicCopy>
class CopiedPtr
{
    // --------------------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    CopiedPtr();

        template <typename U>
        explicit                    CopiedPtr(U* pointer);
                            
                                    CopiedPtr(const CopiedPtr& origin);

                                    CopiedPtr(MovedPtr<T, OwnershipPolicy> source);

                                    ~CopiedPtr();
        
        CopiedPtr&                  operator= (const CopiedPtr& origin);

        CopiedPtr&                  operator= (MovedPtr<T, OwnershipPolicy> source);

        void                        Swap(CopiedPtr& other);
        
        void                        Reset();
            
        template <typename U>
        void                        Reset(U* pointer);
        
        T*                          Release();
            
                                    operator THOR_DETAIL SafeBool() const;

        T&                          operator* () const;
        
        T*                          operator-> () const;
        
        T*                          Get() const;
        

    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        detail::SmartPtrImpl<T, OwnershipPolicy>    mImpl;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    friend struct detail::SmartPtrAccessor;
};

template <typename T, template <typename> class OwnershipPolicy>
MovedPtr<T, OwnershipPolicy> Move(CopiedPtr<T, OwnershipPolicy>& source);

template <typename T, template <typename> class OwnershipPolicy>
MovedPtr<T, OwnershipPolicy> Copy(const CopiedPtr<T, OwnershipPolicy>& origin);

template <typename T, template <typename> class OwnershipPolicy>
void swap(CopiedPtr<T, OwnershipPolicy>& lhs, CopiedPtr<T, OwnershipPolicy>& rhs);


} // namespace thor

#include <Thor/Detail/CopiedPtr.inl>
#endif // THOR_COPIEDPTR_HPP