resmanager.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_RESOURCEMANAGER_H
#define SWORD25_RESOURCEMANAGER_H

#include "common/list.h"
#include "common/hashmap.h"
#include "common/hash-str.h"

#include "sword25/kernel/common.h"

namespace Sword25 {

//#define PRECACHE_RESOURCES

class ResourceService;
class Resource;
class Kernel;

class ResourceManager {
    friend class Kernel;

public:
    Resource *requestResource(const Common::String &fileName);

#ifdef PRECACHE_RESOURCES

    bool precacheResource(const Common::String &fileName, bool forceReload = false);
#endif

    bool registerResourceService(ResourceService *pService);

    void emptyCache();

    void emptyThumbnailCache();

    void dumpLockedResources();

private:
    ResourceManager(Kernel *pKernel) :
        _kernelPtr(pKernel)
    {}
    virtual ~ResourceManager();

    void moveToFront(Resource *pResource);

    Resource *loadResource(const Common::String &fileName);

    Common::String getUniqueFileName(const Common::String &fileName) const;

    Common::List<Resource *>::iterator deleteResource(Resource *pResource);

    Resource *getResource(const Common::String &uniqueFileName) const;

    void deleteResourcesIfNecessary();

    Kernel *_kernelPtr;
    Common::Array<ResourceService *> _resourceServices;
    Common::List<Resource *> _resources;
    typedef Common::HashMap<Common::String, Resource *> ResMap;
    ResMap _resourceHashMap;
};

} // End of namespace Sword25

#endif