Settings upgrade logic, classic for old installs
[quassel.git] / src / qtui / qtuiapplication.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2016 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) version 3.                                           *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #ifndef QTUIAPPLICATION_H_
22 #define QTUIAPPLICATION_H_
23
24 #ifdef HAVE_KDE4
25 #  include <KApplication>
26 #else
27 #  include <QApplication>
28 #endif
29
30 #include <QSessionManager>
31
32 #include "quassel.h"
33 #include "uisettings.h"
34 #include "qtuisettings.h"
35
36 class QtUi;
37
38 #ifdef HAVE_KDE4
39 class QtUiApplication : public KApplication, public Quassel
40 {
41 #else
42 class QtUiApplication : public QApplication, public Quassel
43 {
44 #endif
45
46     Q_OBJECT
47
48 public:
49     QtUiApplication(int &, char **);
50     ~QtUiApplication();
51     virtual bool init();
52
53     void resumeSessionIfPossible();
54     inline bool isAboutToQuit() const { return _aboutToQuit; }
55
56 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
57     void commitData(QSessionManager &manager) override;
58     void saveState(QSessionManager &manager) override;
59 #else
60     void commitData(QSessionManager &manager);
61     void saveState(QSessionManager &manager);
62 #endif
63
64 protected:
65     virtual void quit();
66
67 private:
68     /**
69      * Migrate settings if neccessary and possible
70      *
71      * If unsuccessful (major version changed, minor version upgrade failed), returning false, the
72      * settings are in an unknown state and the client should quit.
73      *
74      * @return True if settings successfully migrated, otherwise false
75      */
76     bool migrateSettings();
77
78     /**
79      * Migrate from one minor settings version to the next
80      *
81      * Settings can only be migrated one version at a time.  Start from the current version, calling
82      * this function for each intermediate version up until the latest version.
83      *
84      * @param[in] settings    Current settings instance
85      * @param[in] newVersion  Next target version for migration, at most 1 from the current version
86      * @return True if minor revision of settings successfully migrated, otherwise false
87      */
88     bool applySettingsMigration(QtUiSettings settings, const uint newVersion);
89
90     bool _aboutToQuit;
91 };
92
93
94 #endif