ResourceHolder.hpp

Go to the documentation of this file.

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

#include <Thor/Resources/KnownIdStrategy.hpp>
#include <Thor/Resources/OwnershipModels.hpp>
#include <Thor/Resources/ResourceExceptions.hpp>
#include <Thor/Resources/ResourceLoader.hpp>

#include <Aurora/Tools/NonCopyable.hpp>

#include <memory>
#include <map>


namespace thor
{


template <typename R, typename I, class O = Resources::CentralOwner>
class ResourceHolder : private aurora::NonCopyable
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private types
    private:
        // Abbreviate class containing ownership policy types and functions
        typedef typename detail::OwnershipModel<O, R>   Om;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:
        typedef typename Om::Returned           Resource;

        typedef typename Om::ConstReturned      ConstResource;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    ResourceHolder();

                                    ResourceHolder(ResourceHolder&& source);

        ResourceHolder&             operator= (ResourceHolder&& source);

        Resource                    acquire(const I& id, const ResourceLoader<R>& how, Resources::KnownIdStrategy known = Resources::AssumeNew);

        void                        release(const I& id);

        Resource                    operator[] (const I& id);

        ConstResource               operator[] (const I& id) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions
    private:
        // Load resource (must be new)
        Resource                    load(const I& id, const ResourceLoader<R>& how);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        std::map<I, typename Om::Stored>    mMap;
};


} // namespace thor

#include <Thor/Resources/Detail/ResourceHolder.inl>
#endif // THOR_RESOURCEHOLDER_HPP