archive.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_ARCHIVE_H
#define AURORA_ARCHIVE_H

#include <list>

#include <boost/noncopyable.hpp>

#include "src/common/types.h"
#include "src/common/ustring.h"
#include "src/common/hash.h"

#include "src/aurora/types.h"

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {

class Archive : boost::noncopyable {
public:
    struct Resource {
        Common::UString name;  
        uint64          hash;  
        FileType        type;  
        uint32          index; 

        Resource();
    };

    typedef std::list<Resource> ResourceList;

    Archive();
    virtual ~Archive();

    virtual const ResourceList &getResources() const = 0;

    virtual uint32 getResourceSize(uint32 index) const;

    virtual Common::SeekableReadStream *getResource(uint32 index, bool tryNoCopy = false) const = 0;

    virtual Common::HashAlgo getNameHashAlgo() const;

    uint32 findResource(uint64 hash) const;
    uint32 findResource(const Common::UString &name, FileType type) const;
};

} // End of namespace Aurora

#endif // AURORA_ARCHIVE_H