savefile.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 COMMON_SAVEFILE_H
#define COMMON_SAVEFILE_H

#include "common/noncopyable.h"
#include "common/scummsys.h"
#include "common/stream.h"
#include "common/str-array.h"
#include "common/error.h"

namespace Common {

typedef SeekableReadStream InSaveFile;

class OutSaveFile: public SeekableWriteStream {
protected:
    WriteStream *_wrapped; 
public:
    OutSaveFile(WriteStream *w); 
    virtual ~OutSaveFile();

    bool err() const override;

    void clearErr() override;

    void finalize() override;

    bool flush() override;

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

    int64 pos() const override;

    bool seek(int64 offset, int whence) override;

    int64 size() const override;
};

class SaveFileManager : NonCopyable {

protected:
    Error _error;      
    String _errorDesc; 
    virtual void setError(Error error, const String &errorDesc) { _error = error; _errorDesc = errorDesc; }

public:
    virtual ~SaveFileManager() {}

    virtual void clearError() { _error = kNoError; _errorDesc.clear(); }

    virtual Error getError() { return _error; }

    virtual String getErrorDesc() { return _errorDesc; }

    virtual String popErrorDesc();

    virtual OutSaveFile *openForSaving(const String &name, bool compress = true) = 0;

    virtual InSaveFile *openForLoading(const String &name) = 0;

    virtual InSaveFile *openRawFile(const String &name) = 0;

    virtual bool removeSavefile(const String &name) = 0;

    virtual bool renameSavefile(const String &oldName, const String &newName, bool compress = true);

    virtual bool copySavefile(const String &oldName, const String &newName, bool compress = true);

    virtual StringArray listSavefiles(const String &pattern) = 0;

    virtual void updateSavefilesList(StringArray &lockedFiles) = 0;

    virtual bool exists(const String &name) = 0;
};

} // End of namespace Common

#endif