resource_manager.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  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.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../api_core.h"
#include "../Resources/resource.h"
#include "../System/weakptr.h"
#include "../IOData/virtual_directory.h"
#include <vector>

class CL_IODevice;
class CL_Resource;
class CL_VirtualDirectory;
class CL_ResourceManager_Impl;

class CL_API_CORE CL_ResourceManager
{
public:
        CL_ResourceManager();

        CL_ResourceManager(const CL_String &filename);

        CL_ResourceManager(const CL_String &filename, CL_VirtualDirectory directory);

        CL_ResourceManager(CL_IODevice file, CL_VirtualDirectory directory = CL_VirtualDirectory());

        CL_ResourceManager(const CL_ResourceManager &other);

        ~CL_ResourceManager();

public:
        bool resource_exists(const CL_String &resource_id) const;

        std::vector<CL_String> get_section_names() const;


        std::vector<CL_String> get_resource_names() const;

        std::vector<CL_String> get_resource_names(const CL_String &section) const;


        std::vector<CL_String> get_resource_names_of_type(const CL_String &type) const;

        std::vector<CL_String> get_resource_names_of_type(
                const CL_String &type,
                const CL_String &section) const;

        CL_Resource get_resource(
                const CL_String &resource_id,
                bool resolve_alias = true,
                int reserved = 0);

        CL_VirtualDirectory get_directory(const CL_Resource &resource) const;

        bool get_boolean_resource(
                const CL_String &resource_id,
                bool default_value);

        int get_integer_resource(
                const CL_String &resource_id,
                int default_value);

public:
        CL_ResourceManager &operator =(const CL_ResourceManager &copy);

        bool operator ==(const CL_ResourceManager &manager) const;

        void set_directory(const CL_VirtualDirectory &directory);


        void add_resources(const CL_ResourceManager& additional_resources);

        void remove_resources(const CL_ResourceManager& additional_resources);

        CL_Resource create_resource(const CL_String &resource_id, const CL_String &type);

        void destroy_resource(const CL_String &resource_id);

        void save(const CL_String &filename);

        void save(const CL_String &filename, CL_VirtualDirectory directory);

        void save(CL_IODevice file);

        void load(const CL_String &filename);

        void load(const CL_String &filename, CL_VirtualDirectory directory);

        void load(CL_IODevice file, CL_VirtualDirectory directory = CL_VirtualDirectory());

private:

        CL_ResourceManager(CL_WeakPtr<CL_ResourceManager_Impl> &impl);

        CL_SharedPtr<CL_ResourceManager_Impl> impl;

        friend class CL_Resource;
};

---