data_archive.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 ULTIMA_SHARED_ENGINE_DATA_ARCHIVE_H
#define ULTIMA_SHARED_ENGINE_DATA_ARCHIVE_H

#include "common/archive.h"
#include "common/fs.h"
#include "common/path.h"

namespace Ultima {
namespace Shared {

class UltimaDataArchive : public Common::Archive {
private:
    Common::Archive *_zip;
    Common::Path _publicFolder;
    Common::Path _innerfolder;


    UltimaDataArchive(Common::Archive *zip, const Common::Path &subfolder) :
        _zip(zip), _publicFolder("data/"), _innerfolder(subfolder) {}

    Common::Path innerToPublic(const Common::Path &filename) const {
        assert(filename.isRelativeTo(_publicFolder));
        return _innerfolder.join(filename.relativeTo(_publicFolder));
    }
public:
    static bool load(const Common::Path &subfolder,
        int reqMajorVersion, int reqMinorVersion, Common::U32String &errorMsg);
public:
    ~UltimaDataArchive() override {
        delete _zip;
    }

    bool hasFile(const Common::Path &path) const override;

    int listMatchingMembers(Common::ArchiveMemberList &list,
        const Common::Path &pattern, bool matchPathComponents = false) const override;

    int listMembers(Common::ArchiveMemberList &list) const override;

    const Common::ArchiveMemberPtr getMember(const Common::Path &path)
        const override;

    Common::SeekableReadStream *createReadStreamForMember(
        const Common::Path &path) const override;

    bool isPathDirectory(const Common::Path &path) const override;
};

#ifndef RELEASE_BUILD

class UltimaDataArchiveProxy : public Common::Archive {
    friend class UltimaDataArchive;
private:
    Common::FSNode _folder;
    const Common::Path _publicFolder;

    UltimaDataArchiveProxy(const Common::FSNode &folder) : _folder(folder), _publicFolder("data/") {}

    Common::FSNode getNode(const Common::Path &name) const;
public:
    ~UltimaDataArchiveProxy() override {
    }

    bool hasFile(const Common::Path &path) const override {
        return path.isRelativeTo(_publicFolder) && getNode(path).exists();
    }

    int listMatchingMembers(Common::ArchiveMemberList &list,
            const Common::Path &pattern, bool matchPathComponents = false) const override;

    int listMembers(Common::ArchiveMemberList &list) const override;

    const Common::ArchiveMemberPtr getMember(const Common::Path &path)
        const override;

    Common::SeekableReadStream *createReadStreamForMember(
        const Common::Path &path) const override;

    bool isPathDirectory(const Common::Path &path) const override;
};

#endif

} // End of namespace Shared
} // End of namespace Ultima

#endif