Resources/ResourcePtr.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_RESOURCEPTR_HPP
#define THOR_RESOURCEPTR_HPP

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

#include THOR_TR1_HEADER(memory)
#include <cassert>


namespace thor
{


template <class Resource>
class ResourcePtr
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                ResourcePtr();

        explicit                ResourcePtr(Resource* rawPointer);

        template <typename D>
                                ResourcePtr(Resource* rawPointer, D deleter);

                                ResourcePtr(const ResourcePtr& origin);
                                
        template <class Resource2>
                                ResourcePtr(const ResourcePtr<Resource2>& origin);

        ResourcePtr&            operator= (const ResourcePtr& origin);

        template <class Resource2>
        ResourcePtr&            operator= (const ResourcePtr<Resource2>& origin);

                                ~ResourcePtr();

        void                    Swap(ResourcePtr& other);

        void                    Reset();

        void                    Reset(Resource* rawPointer);

        template <typename D>
        void                    Reset(Resource* rawPointer, D deleter);

                                operator THOR_DETAIL SafeBool() const;

        Resource&               operator* () const;
        
        Resource*               operator-> () const;
    

    // ---------------------------------------------------------------------------------------------------------------------------
    // Implementation details
    public:
        // Construct from shared_ptr
        explicit                ResourcePtr(std::tr1::shared_ptr<Resource> sharedPtr);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        std::tr1::shared_ptr<Resource>  mPointer;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    template <class Resource1, class Resource2>
    friend bool operator== (const ResourcePtr<Resource1>& lhs, const ResourcePtr<Resource2>& rhs);
    
    template <class Resource2>
    friend class ResourcePtr;
};

template <class Resource>
void swap(ResourcePtr<Resource>& lhs, ResourcePtr<Resource>& rhs);

template <class Resource1, class Resource2>
bool operator== (const ResourcePtr<Resource1>& lhs, const ResourcePtr<Resource2>& rhs);

template <class Resource1, class Resource2>
bool operator!= (const ResourcePtr<Resource1>& lhs, const ResourcePtr<Resource2>& rhs);

template <class Resource>
ResourcePtr<Resource> NoDeletePtr(Resource* pointer);


} // namespace thor

#include <Thor/Detail/ResourcePtr.inl>
#endif // THOR_RESOURCEPTR_HPP