savestate.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 ENGINES_SAVESTATE_H
#define ENGINES_SAVESTATE_H

#include "common/array.h"
#include "common/str.h"
#include "common/ustr.h"
#include "common/ptr.h"

class MetaEngine;

namespace Graphics {
struct Surface;
}

class SaveStateDescriptor final {
private:
    enum SaveType {
        kSaveTypeUndetermined,
        kSaveTypeRegular,
        kSaveTypeAutosave
    };

    void initSaveSlot(const MetaEngine *metaEngine);
public:
    SaveStateDescriptor();
    SaveStateDescriptor(const MetaEngine *metaEngine, int slot);
    SaveStateDescriptor(const MetaEngine *metaEngine, int slot, const Common::String &d);
    SaveStateDescriptor(const MetaEngine *metaEngine, int slot, const Common::U32String &d);

    void setSaveSlot(int slot) { _slot = slot; }

    int getSaveSlot() const { return _slot; }

    void setDescription(const Common::String &desc) { _description = desc; }
    void setDescription(const Common::U32String &desc) { _description = desc.encode(); }

    const Common::String &getDescription() const { return _description; }

    void setDeletableFlag(bool state) { _isDeletable = state; }

    bool getDeletableFlag() const { return _isDeletable; }

    void setWriteProtectedFlag(bool state) { _isWriteProtected = state; }

    bool getWriteProtectedFlag() const { return _isWriteProtected; }

    void setLocked(bool state) {
        _isLocked = state;

        //just in case:
        if (state) {
            setDeletableFlag(false);
            setWriteProtectedFlag(true);
        }
    }

    bool getLocked() const { return _isLocked; }

    const Graphics::Surface *getThumbnail() const { return _thumbnail.get(); }

    void setThumbnail(Graphics::Surface *t);
    void setThumbnail(Common::SharedPtr<Graphics::Surface> t) { _thumbnail = t; }

    void setSaveDate(int year, int month, int day);

    const Common::String &getSaveDate() const { return _saveDate; }

    void setSaveTime(int hour, int min);

    const Common::String &getSaveTime() const { return _saveTime; }

    void setPlayTime(int hours, int minutes);

    void setPlayTime(uint32 msecs);

    const Common::String &getPlayTime() const { return _playTime; }

    uint32 getPlayTimeMSecs() const { return _playTimeMSecs; }

    void setAutosave(bool autosave);

    bool isAutosave() const;

    bool hasAutosaveName() const;

    bool isValid() const;
private:
    int _slot;

    Common::String _description;

    bool _isDeletable;

    bool _isWriteProtected;

    bool _isLocked;

    Common::String _saveDate;

    Common::String _saveTime;

    Common::String _playTime;

    uint32 _playTimeMSecs;

    Common::SharedPtr<Graphics::Surface> _thumbnail;

    SaveType _saveType;
};

typedef Common::Array<SaveStateDescriptor> SaveStateList;

struct SaveStateDescriptorSlotComparator {
    bool operator()(const SaveStateDescriptor &x, const SaveStateDescriptor &y) const {
        return x.getSaveSlot() < y.getSaveSlot();
    }
};
#endif