files.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 XEEN_FILES_H
#define XEEN_FILES_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/file.h"
#include "common/memstream.h"
#include "common/savefile.h"
#include "common/serializer.h"
#include "common/str-array.h"
#include "graphics/surface.h"

namespace Xeen {

class XeenEngine;
class CCArchive;
class BaseCCArchive;
class File;
class SaveArchive;
class Party;
class OutFile;
class SavesManager;

#define SYNC_AS(SUFFIX,STREAM,TYPE,SIZE) \
    template<typename T> \
    void syncAs ## SUFFIX(T &val, Version minVersion = 0, Version maxVersion = kLastVersion) { \
        if (_version < minVersion || _version > maxVersion) \
            return; \
        if (_loadStream) \
            val = static_cast<TYPE>(_loadStream->read ## STREAM()); \
        else { \
            TYPE tmp = (TYPE)val; \
            _saveStream->write ## STREAM(tmp); \
        } \
        _bytesSynced += SIZE; \
    }

struct CCEntry {
    uint16 _id;
    int _offset;
    uint16 _size;
    int _writeOffset;

    CCEntry() : _id(0), _offset(0), _size(0), _writeOffset(0) {}
    CCEntry(uint16 id, uint32 offset, uint32 size)
        : _id(id), _offset(offset), _size(size) {
    }
};

/*
 * Main resource manager
 */
class FileManager {
public:
    int _ccNum;
public:
    FileManager(XeenEngine *vm);

    ~FileManager();

    bool setup();

    void setGameCc(int ccMode);

    void load(Common::SeekableReadStream &stream);

    void save(Common::WriteStream &s);
};

class File : public Common::File {
    friend class FileManager;
    friend class OutFile;
    friend class SavesManager;
    friend class Debugger;
private:
    static CCArchive *_xeenCc, *_darkCc, *_introCc;
    static SaveArchive *_xeenSave, *_darkSave;
    static BaseCCArchive *_currentArchive;
    static SaveArchive *_currentSave;
public:
    static void setCurrentArchive(int ccMode);

    static void syncBitFlags(Common::Serializer &s, bool *startP, bool *endP);
public:
    File() : Common::File() {}
    File(const Common::String &filename);
    File(const Common::String &filename, int ccMode);
    File(const Common::String &filename, Common::Archive &archive);
    ~File() override {}

    bool open(const Common::Path &filename) override;

    bool open(const Common::Path &filename, Common::Archive &archive) override;

    virtual bool open(const Common::String &filename, int ccMode);

    bool open(const Common::FSNode &node) override {
        return Common::File::open(node);
    }

    bool open(SeekableReadStream *stream, const Common::String &name) override {
        return Common::File::open(stream, name);
    }

    Common::String readString();

    static bool exists(const Common::String &filename);

    static bool exists(const Common::String &filename, int ccMode);

    static bool exists(const Common::String &filename, Common::Archive &archive);
};

class SubWriteStream : virtual public Common::WriteStream {
protected:
    Common::WriteStream *_parentStream;
    uint32 _begin;
public:
    SubWriteStream(Common::WriteStream *parentStream) :
        _parentStream(parentStream),  _begin(parentStream->pos()) {
    }

    uint32 write(const void *dataPtr, uint32 dataSize) override {
        return _parentStream->write(dataPtr, dataSize);
    }
    bool flush() override { return _parentStream->flush(); }
    void finalize() override {}
    int64 pos() const override { return _parentStream->pos() - _begin; }
};

class StringArray : public Common::StringArray {
public:
    StringArray() {}
    StringArray(const Common::String &name) { load(name); }

    void load(const Common::String &name);

    void load(const Common::String &name, int ccMode);
};

class XeenSerializer : public Common::Serializer {
private:
    Common::SeekableReadStream *_in;
    int _filesize;
public:
    XeenSerializer(Common::SeekableReadStream *in, Common::WriteStream *out) :
        Common::Serializer(in, out), _in(in), _filesize(-1) {}

    SYNC_AS(Sint8, Byte, int8, 1)

    bool finished() {
        if (_in && _filesize == -1)
            _filesize = _in->size();
        return _in != nullptr && _in->pos() >= _filesize;
    }
};

class BaseCCArchive : public Common::Archive {
protected:
    Common::Array<CCEntry> _index;

    void loadIndex(Common::SeekableReadStream &stream);

    void saveIndex(Common::WriteStream &stream);

    virtual bool getHeaderEntry(const Common::String &resourceName, CCEntry &ccEntry) const;

    virtual bool getHeaderEntry(uint16 id, CCEntry &ccEntry) const;
public:
    static uint16 convertNameToId(const Common::String &resourceName);
public:
    BaseCCArchive() {}

    // Archive implementation
    bool hasFile(const Common::Path &path) const override;
    int listMembers(Common::ArchiveMemberList &list) const override;
    const Common::ArchiveMemberPtr getMember(const Common::Path &path) const override;
};

class CCArchive : public BaseCCArchive {
private:
    Common::String _filename;
    Common::String _prefix;
    bool _encoded;
protected:
    bool getHeaderEntry(const Common::String &resourceName, CCEntry &ccEntry) const override;
public:
    CCArchive(const Common::String &filename, bool encoded);
    CCArchive(const Common::String &filename, const Common::String &prefix, bool encoded);
    ~CCArchive() override;

    // Archive implementation
    Common::SeekableReadStream *createReadStreamForMember(const Common::Path &path) const override;
};

class SaveArchive : public BaseCCArchive {
    friend class OutFile;
private:
    Party *_party;
    byte *_data;
    uint32 _dataSize;
    Common::HashMap<uint16, Common::MemoryWriteStreamDynamic *> _newData;
public:
    SaveArchive(Party *party);
    ~SaveArchive() override;

    void reset(CCArchive *src);

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

    virtual Common::SeekableReadStream *createReadStreamForMember(uint16 id) const;

    void load(Common::SeekableReadStream &stream);

    void save(Common::WriteStream &s);

    void loadParty();

    void replaceEntry(uint16 id, const byte *data, size_t size);
};

class OutFile : public Common::WriteStream {
private:
    SaveArchive *_archive;
    Common::String _filename;
    Common::MemoryWriteStreamDynamic _backingStream;
public:
    OutFile(const Common::String &filename);
    OutFile(const Common::String &filename, SaveArchive *archive);
    OutFile(const Common::String &filename, int ccMode);

    void finalize() override;

    uint32 write(const void *dataPtr, uint32 dataSize) override;

    int64 pos() const override;
};

} // End of namespace Xeen

#endif /* XEEN_FILES_H */