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