archive_file.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/>.
 *
 */

#ifndef ULTIMA8_FILESYS_ARCHIVEFILE_H
#define ULTIMA8_FILESYS_ARCHIVEFILE_H

#include "ultima/shared/std/string.h"

namespace Ultima {
namespace Ultima8 {

class ArchiveFile {
public:
    virtual ~ArchiveFile() { }

    virtual bool isValid() const {
        return _valid;
    }

    virtual bool exists(uint32 index) = 0;

    virtual bool exists(const Std::string &name) = 0;


    virtual uint8 *getObject(uint32 index, uint32 *size = 0) = 0;

    virtual uint8 *getObject(const Std::string &name, uint32 *size = 0) = 0;


    virtual uint32 getSize(uint32 index) const = 0;

    virtual uint32 getSize(const Std::string &name) const = 0;

    Common::SeekableReadStream *getDataSource(uint32 index, bool is_text = false);

    Common::SeekableReadStream *getDataSource(const Std::string &name, bool is_text = false);

    virtual uint32 getCount() const = 0;

    virtual uint32 getIndexCount() const = 0;

    virtual bool isIndexed() const = 0;

    virtual bool isNamed() const = 0;

protected:
    static bool extractIndexFromName(const Std::string &name, uint32 &index);

    bool _valid;
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif