savegame.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 ASYLUM_SYSTEM_SAVEGAME_H
#define ASYLUM_SYSTEM_SAVEGAME_H

#include "common/savefile.h"
#include "common/serializer.h"
#include "common/util.h"

#include "asylum/shared.h"

namespace Asylum {

#define SAVEGAME_COUNT 25

class AsylumEngine;

class Savegame {
public:
    Savegame(AsylumEngine *engine);
    ~Savegame() {};

    bool hasSavegames() const;

    void loadList();

    void load();

    bool quickLoad();

    void save();

    bool quickSave();

    void remove();

    bool isCompatible();

    // Static methods

    static void seek(Common::InSaveFile *file, uint32 offset, const Common::String &description);

    static uint32 read(Common::InSaveFile *file, const Common::String &description);

    static Common::String read(Common::InSaveFile *file, uint32 strLength, const Common::String &description);

    static void read(Common::InSaveFile *file, Common::Serializable *data, uint32 size, uint32 count, const Common::String &description);

    static void write(Common::OutSaveFile *file, uint32 val, const Common::String &description);

    static void write(Common::OutSaveFile *file, const Common::String &val, uint32 strLength, const Common::String &description);

    static void write(Common::OutSaveFile *file, Common::Serializable *data, uint32 size, uint32 count, const Common::String &description);

    // Movies
    void setMovieViewed(uint32 index);
    uint32 getMoviesViewed(int32 *movieList) const;
    void loadMoviesViewed();

    // Accessors
    void setName(uint32 index, const Common::String &name);
    Common::String getName(uint32 index) const;

    Common::String *getName() { return &_names[_index]; }
    void setIndex(uint32 index) { _index = index; }
    uint32 getIndex() { return _index; }

    bool hasSavegame(uint32 index) const;
    ResourcePackId getScenePack() { return (ResourcePackId)(_savegameToScene[_index] + 4); }

    void resetVersion();
    const char *getVersion() { return _version.c_str(); }
    uint32 getBuild() { return _build; }

private:
    AsylumEngine *_vm;

    uint32 _index;
    byte _moviesViewed[196];
    uint32 _savegameToScene[SAVEGAME_COUNT];
    bool _savegames[SAVEGAME_COUNT];
    Common::String _names[SAVEGAME_COUNT];
    Common::String _version;
    uint32 _build;

    // Helpers


    Common::String getFilename(uint32 index) const;

    bool isSavegamePresent(const Common::String &filename) const;

    // Reading & writing

    bool readHeader(Common::InSaveFile *file);

    void writeHeader(Common::OutSaveFile *file) const;

    void loadData(const Common::String &filename);

    void saveData(const Common::String &filename, const Common::String &name, ChapterIndex chapter);
};

} // End of namespace Asylum

#endif // ASYLUM_SYSTEM_SAVEGAME_H