resman.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef AURORA_RESMAN_H
#define AURORA_RESMAN_H

#include <list>
#include <vector>
#include <map>
#include <set>

#include "src/common/types.h"
#include "src/common/ustring.h"
#include "src/common/singleton.h"
#include "src/common/filelist.h"
#include "src/common/hash.h"
#include "src/common/changeid.h"

#include "src/aurora/types.h"

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {

class Archive;
class KEYFile;
class KEYDataFile;

class ResourceManager : public Common::Singleton<ResourceManager> {
public:
    struct ResourceID {
        Common::UString name;
        FileType type;
        uint64 hash;
    };

    ResourceManager();
    ~ResourceManager();

    void clear();

    // .--- Global resource properties
    void setRIMsAreERFs(bool rimsAreERFs);

    void setHasSmall(bool hasSmall);

    void setHashAlgo(Common::HashAlgo algo);

    void setCursorRemap(const std::vector<Common::UString> &remap);

    void addTypeAlias(FileType alias, FileType realType);
    // '---

    // .--- Data base
    void registerDataBase(const Common::UString &path);

    const Common::UString &getDataBase() const;
    // '---

    // .--- Archives
    bool hasArchive(const Common::UString &file);

    void indexArchive(const Common::UString &file, uint32 priority, Common::ChangeID *changeID = 0);
    // '---

    void indexArchive(const Common::UString &file, uint32 priority, const std::vector<byte> &password,
                      Common::ChangeID *changeID = 0);
    // '---

    // .--- Directories and files
    bool hasResourceDir(const Common::UString &dir);

    void indexResourceFile(const Common::UString &file, uint32 priority, Common::ChangeID *changeID = 0);

    void indexResourceDir(const Common::UString &dir, const char *glob, int depth,
                          uint32 priority, Common::ChangeID *changeID = 0);
    // '---

    // .--- Utility methods
    void undo(Common::ChangeID &changeID);

    void blacklist(const Common::UString &name, FileType type);

    void declareResource(const Common::UString &name, FileType type);

    void declareResource(const Common::UString &name);
    // '---

    // .--- Resources
    bool hasResource(uint64 hash) const;

    bool hasResource(const Common::UString &name, FileType type) const;

    bool hasResource(const Common::UString &name, ResourceType type) const;

    bool hasResource(const Common::UString &name) const;

    bool hasResource(const Common::UString &name, const std::vector<FileType> &types) const;

    Common::UString findResourceFile(const Common::UString &name, FileType type) const;

    Common::UString findResourceFile(const Common::UString &name, ResourceType type) const;

    Common::UString findResourceFile(const Common::UString &name) const;

    Common::UString findResourceFile(const Common::UString &name, const std::vector<FileType> &types) const;

    Common::SeekableReadStream *getResource(uint64 hash, FileType *type = 0) const;

    Common::SeekableReadStream *getResource(const Common::UString &name, FileType type) const;

    Common::SeekableReadStream *getResource(const Common::UString &name) const;

    Common::SeekableReadStream *getResource(const Common::UString &name,
            const std::vector<FileType> &types, FileType *foundType = 0) const;

    Common::SeekableReadStream *getResource(ResourceType resType,
            const Common::UString &name, FileType *foundType = 0) const;

    void getAvailableResources(FileType type, std::list<ResourceID> &list) const;
    void getAvailableResources(const std::vector<FileType> &types, std::list<ResourceID> &list) const;
    void getAvailableResources(ResourceType type, std::list<ResourceID> &list) const;
    // '---

    void dumpResourcesList(const Common::UString &fileName) const;


private:
    typedef std::vector<FileType> FileTypeList;
    typedef std::set<FileType> FileTypeSet;

    struct Resource;
    struct OpenedArchive;

    // .--- Archives
    struct KnownArchive {
        Common::UString name; 
        ArchiveType     type; 

        Resource *resource;

        OpenedArchive *opened;

        KnownArchive();
        KnownArchive(ArchiveType t, const Common::UString &n, Resource &r);
    };

    struct OpenedArchive {
        Archive *archive;

        KnownArchive *known;

        OpenedArchive *parent;
        std::list<OpenedArchive *> children;

        OpenedArchive();

        void set(KnownArchive &kA, Archive &a);
    };

    typedef std::list<KnownArchive> KnownArchives;
    typedef std::list<OpenedArchive> OpenedArchives;
    // '---

    // .--- Resources
    enum Source {
        kSourceNone   , 
        kSourceFile   , 
        kSourceArchive  
    };

    struct Resource {
        Common::UString name; 
        FileType        type; 

        bool isSmall;

        uint32 priority;

        std::pair<KnownArchives *, KnownArchives::iterator> selfArchive;

        Source source;

        // For kSourceFile
        Common::UString path; 

        // For kSourceArchive
        OpenedArchive *archive;      
        uint32         archiveIndex; 

        Resource();

        bool operator<(const Resource &right) const;
    };

    typedef std::list<Resource> ResourceList;
    typedef std::map<uint64, ResourceList> ResourceMap;
    // '---

    // .--- Changes
    typedef std::pair<KnownArchives *, KnownArchives::iterator> KnownArchiveChange;
    typedef OpenedArchives::iterator OpenedArchiveChange;
    struct ResourceChange {
        ResourceMap::iterator  hashIt;
        ResourceList::iterator resIt;
    };

    typedef std::list<KnownArchiveChange>  KnownArchiveChanges;
    typedef std::list<OpenedArchiveChange> OpenedArchiveChanges;
    typedef std::list<ResourceChange>      ResourceChanges;

    struct ChangeSet {
        KnownArchiveChanges  knownArchives;
        OpenedArchiveChanges openedArchives;
        ResourceChanges      resources;
    };

    typedef std::list<ChangeSet> ChangeSetList;

    class Change : public Common::ChangeContent {
    private:
        Change(ChangeSetList::iterator change) : _change(change) { }

        ChangeSetList::iterator _change;

        friend class ResourceManager;

    public:
        ~Change() { }

        Common::ChangeContent *clone() const { return new Change(_change); }
    };
    // '---


    bool _hasSmall;

    Common::HashAlgo _hashAlgo;

    std::vector<Common::UString> _cursorRemap;

    Common::UString _baseDir;
    Common::UString _baseArchive;

    KnownArchives  _knownArchives[kArchiveMAX]; 
    OpenedArchives _openedArchives;             

    std::map<FileType, FileType> _typeAliases;

    ResourceMap   _resources; 
    ChangeSetList _changes;   

    FileTypeSet  _archiveTypeTypes [kArchiveMAX];  
    FileTypeList _resourceTypeTypes[kResourceMAX]; 


    void clearResources();

    // .--- Searching for archives
    KnownArchive *findArchive(const Common::UString &file);
    KnownArchive *findArchive(Common::UString file, KnownArchives &archives);
    // '---

    // .--- Indexing archives
    void indexKEY(Common::SeekableReadStream *stream, uint32 priority, Change *change);
    uint32 openKEYBIFs(Common::SeekableReadStream *keyStream,
                       std::vector<KnownArchive *> &archives, std::vector<KEYDataFile *> &keyData);

    void indexArchive(KnownArchive &knownArchive, Archive *archive,
                      uint32 priority, Change *change);

    Common::SeekableReadStream *openArchiveStream(const KnownArchive &archive) const;
    // '---

    // .--- Adding resources

    bool checkResourceIsArchive(Resource &resource, Change *change);

    void addResource(Resource &resource, uint64 hash, Change *change);
    void addResource(const Common::UString &path, Change *change, uint32 priority);

    void addResources(const Common::FileList &files, Change *change, uint32 priority);
    // '---

    // .--- Finding and getting resources
    const Resource *getRes(uint64 hash) const;
    const Resource *getRes(const Common::UString &name, const std::vector<FileType> &types) const;
    const Resource *getRes(const Common::UString &name, FileType type) const;

    Common::SeekableReadStream *getResource(const Resource &res, bool tryNoCopy = false) const;

    Common::SeekableReadStream *getArchiveResource(const Resource &res, bool tryNoCopy = false) const;

    uint32 getResourceSize(const Resource &res) const;
    // '---

    // .--- Resource utility methods
    bool normalizeType(Resource &resource);

    ArchiveType     getArchiveType(FileType type) const;
    ArchiveType     getArchiveType(const Common::UString &name) const;
    Common::UString getArchiveName(const Resource &resource) const;

    inline uint64 getHash(const Common::UString &name, FileType type) const;
    inline uint64 getHash(const Common::UString &name) const;

    void checkHashCollision(const Resource &resource, ResourceMap::const_iterator resList);

    Change *newChangeSet(Common::ChangeID &changeID);
    // '---

};

} // End of namespace Aurora

#define ResMan ::Aurora::ResourceManager::instance()

#endif // AURORA_RESMAN_H