qtui: Fix quit sequence and lifetime issues
[quassel.git] / src / qtui / qtuiapplication.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2018 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 #pragma once
22
23 #include <memory>
24
25 #ifdef HAVE_KDE4
26 #  include <KApplication>
27 #else
28 #  include <QApplication>
29 #endif
30
31 #include <QSessionManager>
32
33 #include "client.h"
34 #include "quassel.h"
35 #include "uisettings.h"
36 #include "qtuisettings.h"
37
38 class QtUi;
39
40 #ifdef HAVE_KDE4
41 class QtUiApplication : public KApplication
42 {
43 #else
44 class QtUiApplication : public QApplication
45 {
46 #endif
47
48     Q_OBJECT
49
50 public:
51     QtUiApplication(int &, char **);
52
53     virtual void init();
54
55     void resumeSessionIfPossible();
56     inline bool isAboutToQuit() const { return _aboutToQuit; }
57
58 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
59     void commitData(QSessionManager &manager) override;
60     void saveState(QSessionManager &manager) override;
61 #else
62     void commitData(QSessionManager &manager);
63     void saveState(QSessionManager &manager);
64 #endif
65
66 protected:
67     virtual Quassel::QuitHandler quitHandler();
68
69 private:
70     /**
71      * Migrate settings if neccessary and possible
72      *
73      * If unsuccessful (major version changed, minor version upgrade failed), returning false, the
74      * settings are in an unknown state and the client should quit.
75      *
76      * @return True if settings successfully migrated, otherwise false
77      */
78     bool migrateSettings();
79
80     /**
81      * Migrate from one minor settings version to the next
82      *
83      * Settings can only be migrated one version at a time.  Start from the current version, calling
84      * this function for each intermediate version up until the latest version.
85      *
86      * @param[in] settings    Current settings instance
87      * @param[in] newVersion  Next target version for migration, at most 1 from the current version
88      * @return True if minor revision of settings successfully migrated, otherwise false
89      */
90     bool applySettingsMigration(QtUiSettings settings, const uint newVersion);
91
92 private slots:
93     void initUi();
94
95 protected:
96     std::unique_ptr<Client> _client;
97
98 private:
99     bool _aboutToQuit{false};
100 };