SmartPtr/MovedPtr.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_MOVEDPTR_HPP
#define THOR_MOVEDPTR_HPP

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

#include <algorithm>
#include <cassert>


namespace thor
{

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


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

        template <typename U>
        explicit                    MovedPtr(U* pointer);
        
                                    MovedPtr(MovedPtr& origin);
                                            
                                    ~MovedPtr();
        
        MovedPtr&                   operator= (MovedPtr& origin);
        
        void                        Swap(MovedPtr& 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;
        
        
    // ---------------------------------------------------------------------------------------------------------------------------
    // Implementation details
    public:
        // Constructor to allow interaction with function arguments and return values
                                    MovedPtr(detail::MovedPtrRef<T, OwnershipPolicy> ref);
    
        // Assignment operator to allow interaction with function arguments and return values
        MovedPtr&                   operator= (detail::MovedPtrRef<T, OwnershipPolicy> ref);
                                
        // Conversion operator to allow interaction with function arguments and return values
                                    operator detail::MovedPtrRef<T, OwnershipPolicy> ();


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


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

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

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


} // namespace thor

#include <Thor/Detail/MovedPtr.inl>
#endif // THOR_MOVEDPTR_HPP