SmartPtr/ScopedPtr.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011 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_SCOPEDPTR_HPP
#define THOR_SCOPEDPTR_HPP

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

#include <algorithm>
#include <cassert>


namespace thor
{


template <typename T>
class ScopedPtr : private NonCopyable
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    ScopedPtr();

        explicit                    ScopedPtr(T* pointer);
                            
                                    ~ScopedPtr();

        void                        Swap(ScopedPtr& other);
        
        void                        Reset();
            
        void                        Reset(T* pointer);
        
        T*                          Release();
        
                                    operator THOR_DETAIL SafeBool() const;

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

    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        detail::SmartPtrImpl<T>     mImpl;
        
    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    friend detail::SmartPtrImpl<T>& detail::GetImpl<T, ScopedPtr>(ScopedPtr& smartPointer);
};

template <typename T>
void swap(ScopedPtr<T>& lhs, ScopedPtr<T>& rhs);


} // namespace thor

#include <Thor/Detail/ScopedPtr.inl>
#endif // THOR_SCOPEDPTR_HPP