ILocalStoragePatch.h

/*
 * Copyright 2018-2020 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIB_QUENTIER_LOCAL_STORAGE_I_LOCAL_STORAGE_PATCH_H
#define LIB_QUENTIER_LOCAL_STORAGE_I_LOCAL_STORAGE_PATCH_H
 
#include <quentier/utility/Linkage.h>
 
#include <QObject>
 
namespace quentier {
 
QT_FORWARD_DECLARE_CLASS(ErrorString)
QT_FORWARD_DECLARE_CLASS(LocalStorageDatabaseUpgrader)
 

class QUENTIER_EXPORT ILocalStoragePatch : public QObject
{
    Q_OBJECT
protected:
    explicit ILocalStoragePatch(QObject * parent = nullptr);
 
public:
    virtual ~ILocalStoragePatch();

    virtual int fromVersion() const = 0;

    virtual int toVersion() const = 0;

    virtual QString patchShortDescription() const = 0;

    virtual QString patchLongDescription() const = 0;

    virtual bool backupLocalStorage(ErrorString & errorDescription) = 0;

    virtual bool restoreLocalStorageFromBackup(
        ErrorString & errorDescription) = 0;

    virtual bool removeLocalStorageBackup(ErrorString & errorDescription) = 0;

    virtual bool apply(ErrorString & errorDescription) = 0;
 
    friend class LocalStorageDatabaseUpgrader;
 
Q_SIGNALS:
    void progress(double progress);

    void backupProgress(double progress);

    void restoreBackupProgress(double progress);
};
 
} // namespace quentier
 
#endif // LIB_QUENTIER_LOCAL_STORAGE_I_LOCAL_STORAGE_PATCH_H