Correctly save and restore window size, docks position and toolbars (#90)

* Fix toolbars and docks save/restore between sessions

* Correctly restore window size

* Fix compilation on ubuntu 16.04

Author: GuLinux

.gitignore

@@ -9,3 +9,5 @@ __pycache__
 .kdev4*
 .directory
 CMakeLists.txt.user
+compile_commands.json
+

CMakeLists.txt

@@ -3,6 +3,7 @@ enable_testing()
 project(PlanetaryImager)
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 set(MAJOR_VERSION 0)
 set(MINOR_VERSION 7)

src/CMakeLists.txt

@@ -1,4 +1,4 @@
-set(PlanetaryImager_GUI_SRCS planetaryimager_mainwindow.cpp planetaryimager_mainwindow.ui resources/resources.qrc)
+set(PlanetaryImager_GUI_SRCS planetaryimager_mainwindow.cpp mainwindowwidgets.cpp planetaryimager_mainwindow.ui resources/resources.qrc)
 set(PlanetaryImager_SRCS planetaryimager_main.cpp ${PlanetaryImager_GUI_SRCS})
 
 

src/mainwindowwidgets.cpp

@@ -0,0 +1,114 @@
+/*
+ * Copyright (C) 2019  Marco Gulino <marco@gulinux.net>
+ *
+ * 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/>.
+ *
+ */
+
+
+#include "mainwindowwidgets.h"
+#include "commons/configuration.h"
+#include <QMainWindow>
+#include <QList>
+#include <QDockWidget>
+#include <QAction>
+#include <QMenu>
+#include <QDebug>
+#include <QVariantMap>
+#include <QVariantList>
+#include <QJsonDocument>
+#include <QToolBar>
+#include <algorithm>
+
+using namespace std;
+
+DPTR_IMPL(MainWindowWidgets) {
+    QMainWindow *main_window;
+    QMenu *window_menu;
+    Configuration &configuration;
+    bool is_first_run;
+
+    QAction *docks_separator;
+    QAction *toolbars_separator;
+    QList<QDockWidget*> docks;
+    QList<QToolBar*> toolbars;
+    void add_menu_action(const char *text, function<void()> lambda_function);
+};
+
+void MainWindowWidgets::Private::add_menu_action(const char *text, function<void()> lambda_function) {
+    auto action = window_menu->addAction(QObject::tr(text));
+    QObject::connect(action, &QAction::triggered, main_window, lambda_function);
+}
+
+MainWindowWidgets::MainWindowWidgets(QMainWindow *main_window, QMenu *windowMenu, Configuration &configuration) : dptr(main_window, windowMenu, configuration, !configuration.widgets_setup_first_run()) {
+    configuration.set_widgets_setup_first_run(true);
+    windowMenu->addSection(QObject::tr("Panels"));
+    d->docks_separator = windowMenu->addSeparator();
+    d->add_menu_action("Show All", [this]{
+        for(auto dock: d->docks) {
+            dock->show();
+        }
+    });
+    d->add_menu_action("Hide All", [this] {
+        for(auto dock: d->docks) {
+            dock->hide();
+        }
+    });
+
+    windowMenu->addSection(QObject::tr("Toolbars"));
+    d->toolbars_separator = windowMenu->addSeparator();
+    d->add_menu_action("Show All", [this]{
+        for(auto toolbar: d->toolbars) {
+            toolbar->show();
+        }
+    });
+    d->add_menu_action("Hide All", [this] {
+        for(auto toolbar: d->toolbars) {
+            toolbar->hide();
+        }
+    });
+
+}
+
+MainWindowWidgets::~MainWindowWidgets() {
+}
+
+
+void MainWindowWidgets::save() {
+    d->configuration.set_dock_status(d->main_window->saveState());
+}
+
+void MainWindowWidgets::load() {
+    d->main_window->restoreState(d->configuration.dock_status());
+    for(auto dock: d->docks) {
+        d->main_window->restoreDockWidget(dock);
+    }
+}
+
+void MainWindowWidgets::add_dock(QDockWidget *widget) {
+    if(d->is_first_run && !d->docks.isEmpty()) {
+        d->main_window->tabifyDockWidget(d->docks.first(), widget);
+    }
+
+    d->window_menu->insertAction(d->docks_separator, widget->toggleViewAction());
+    d->docks.push_back({widget});
+}
+
+void MainWindowWidgets::add_toolbar(QToolBar *toolbar, bool add_to_main_window) {
+    d->toolbars.push_back(toolbar);
+    if(add_to_main_window) {
+        d->main_window->addToolBar(toolbar);
+    }
+    d->window_menu->insertAction(d->toolbars_separator, toolbar->toggleViewAction());
+}

src/mainwindowwidgets.h

@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 2019  Marco Gulino <marco@gulinux.net>
+ *
+ * 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/>.
+ *
+ */
+
+#include "dptr.h"
+#include "commons/fwd.h"
+
+FWD_PTR(MainWindowWidgets)
+FWD(QMainWindow)
+FWD(QDockWidget)
+FWD(QToolBar)
+FWD(QMenu)
+FWD(Configuration)
+
+class MainWindowWidgets {
+public:
+    MainWindowWidgets(QMainWindow *main_window, QMenu *windowMenu, Configuration &configuration);
+    ~MainWindowWidgets();
+    void add_dock(QDockWidget *widget);
+    void add_toolbar(QToolBar *toolbar, bool add_to_main_window = false);
+    void save();
+    void load();
+private:
+    DPTR
+};

src/planetaryimager_mainwindow.cpp

@@ -47,6 +47,7 @@
 #include <QGraphicsScene>
 #include <QFileInfo>
 #include <QDesktopServices>
+#include <QDesktopWidget>
 
 #include "widgets/editroidialog.h"
 
@@ -64,6 +65,7 @@
 
 #include "planetaryimager.h"
 #include "drivers/driver.h"
+#include "mainwindowwidgets.h"
 
 using namespace GuLinux;
 using namespace std;
@@ -75,12 +77,13 @@ Q_DECLARE_METATYPE(cv::Mat)
 DPTR_IMPL(PlanetaryImagerMainWindow) {
   PlanetaryImagerPtr planetaryImager;
   FilesystemBrowserPtr filesystemBrowser;
+  MainWindowWidgetsPtr main_window_widgets;
 
   static PlanetaryImagerMainWindow *q;
   unique_ptr<Ui::PlanetaryImagerMainWindow> ui;
   Imager *imager = nullptr;
   void rescan_devices();
-  void saveState();
+  void saveWindowGeometry();
 
   StatusBarInfoWidget *statusbar_info_widget;
   shared_ptr<DisplayImage> displayImage;
@@ -113,17 +116,15 @@ PlanetaryImagerMainWindow *PlanetaryImagerMainWindow::Private::q = nullptr;
 PlanetaryImagerMainWindow::~PlanetaryImagerMainWindow()
 {
   LOG_F_SCOPE
-  d->saveState();
   if(d->imager) {
       d->imager->destroy();
   }
   d->displayImage->quit();
   d->planetaryImager->quit();
 }
 
-void PlanetaryImagerMainWindow::Private::saveState()
+void PlanetaryImagerMainWindow::Private::saveWindowGeometry()
 {
-  planetaryImager->configuration().set_dock_status(q->saveState());
   planetaryImager->configuration().set_main_window_geometry(q->saveGeometry());
 }
 
@@ -142,6 +143,9 @@ PlanetaryImagerMainWindow::PlanetaryImagerMainWindow(
     d->ui.reset(new Ui::PlanetaryImagerMainWindow);
 
     d->ui->setupUi(this);
+    d->main_window_widgets = make_shared<MainWindowWidgets>(this, d->ui->menuWindow, planetaryImager->configuration());
+
+    restoreGeometry(d->planetaryImager->configuration().main_window_geometry());
     setWindowIcon(QIcon::fromTheme("planetary_imager"));
     d->ui->recording->setWidget(d->recording_panel = new RecordingPanel{d->planetaryImager->configuration(), filesystemBrowser});
     d->configurationDialog = new ConfigurationDialog(d->planetaryImager->configuration(), this);
@@ -184,38 +188,28 @@ PlanetaryImagerMainWindow::PlanetaryImagerMainWindow(
     d->image_widget->actions()[ZoomableImage::Actions::ZoomRealSize]->setShortcut({Qt::CTRL + Qt::Key_Backspace});
     d->image_widget->actions()[ZoomableImage::Actions::ZoomRealSize]->setIcon(QIcon{":/resources/real_size.png"});
     d->image_widget->toolbar()->setWindowTitle("Image Control");
-    addToolBar(d->image_widget->toolbar());
-    QToolBar *helpToolBar = new QToolBar;
-    helpToolBar->setWindowTitle(tr("Help"));
+    d->image_widget->toolbar()->setObjectName("imageToolbar");
+
+    d->main_window_widgets->add_toolbar(d->ui->imageManipulation);
+    d->main_window_widgets->add_toolbar(d->ui->ROIToolbar);
+    d->main_window_widgets->add_toolbar(d->image_widget->toolbar(), true);
+    QToolBar *helpToolBar = new QToolBar(tr("Help"));
     auto whatsThis = QWhatsThis::createAction();
     whatsThis->setIcon(QIcon{":/resources/help.png"});
     helpToolBar->addAction(whatsThis);
-    addToolBar(helpToolBar);
+    helpToolBar->setObjectName("help");
+    d->main_window_widgets->add_toolbar(helpToolBar, true);
+
     d->image_widget->toolbar()->setFloatable(true);
     d->image_widget->toolbar()->setMovable(true);
 
-    restoreGeometry(d->planetaryImager->configuration().main_window_geometry());
-    restoreState(d->planetaryImager->configuration().dock_status());
     connect(d->ui->actionAbout, &QAction::triggered, bind(&QMessageBox::about, this, tr("About"),
 							  tr("%1 version %2.\nFast imaging capture software for planetary imaging").arg(qApp->applicationDisplayName())
 							 .arg(qApp->applicationVersion())));
     connect(d->ui->actionAbout_Qt, &QAction::triggered, &QApplication::aboutQt);
     connect(d->ui->action_devices_rescan, &QAction::triggered, bind(&Private::rescan_devices, d.get()));
     connect(d->ui->actionShow_settings, &QAction::triggered, bind(&QDialog::show, d->configurationDialog));
 
-    auto dockWidgetToggleVisibility = [=](QDockWidget *widget, bool visible){ widget->setVisible(visible); };
-    auto dockWidgetVisibleCheck = [=](QAction *action, QDockWidget *widget) { action->setChecked(widget->isVisible()); };
-    QList<QDockWidget*> dock_widgets;
-    auto setupDockWidget = [&](QAction *action, QDockWidget *widget){
-      dockWidgetVisibleCheck(action, widget);
-      connect(action, &QAction::triggered, bind(dockWidgetToggleVisibility, widget, _1));
-      connect(widget, &QDockWidget::visibilityChanged, bind(dockWidgetVisibleCheck, action, widget));
-      connect(widget, &QDockWidget::dockLocationChanged, bind(&Private::saveState, d.get()));
-      connect(widget, &QDockWidget::topLevelChanged, bind(&Private::saveState, d.get()));
-      connect(widget, &QDockWidget::visibilityChanged, bind(&Private::saveState, d.get()));
-      dock_widgets.push_back(widget);
-    };
-
     connect(d->configurationDialog, &QDialog::accepted, this, bind(&DisplayImage::read_settings, d->displayImage), Qt::DirectConnection);
     connect(d->configurationDialog, &QDialog::accepted, this, bind(&Histogram::read_settings, d->histogram), Qt::DirectConnection);
     connect(d->configurationDialog, &QDialog::accepted, this,
@@ -236,16 +230,14 @@ PlanetaryImagerMainWindow::PlanetaryImagerMainWindow(
         QTimer::singleShot(5000,  bind(&DisplayImage::setRecording, d->displayImage, false));
         QTimer::singleShot(5000,  bind(&Histogram::setRecording, d->histogram, false));
     }, Qt::QueuedConnection);
-    setupDockWidget(d->ui->actionChip_Info, d->ui->chipInfoWidget);
-    setupDockWidget(d->ui->actionCamera_Settings, d->ui->camera_settings);
-    setupDockWidget(d->ui->actionRecording, d->ui->recording);
-    setupDockWidget(d->ui->actionHistogram, d->ui->histogram);
-    if(! d->planetaryImager->configuration().widgets_setup_first_run() ) {
-      tabifyDockWidget(d->ui->chipInfoWidget, d->ui->camera_settings);
-      tabifyDockWidget(d->ui->chipInfoWidget, d->ui->histogram);
-      tabifyDockWidget(d->ui->chipInfoWidget, d->ui->recording);
-      d->planetaryImager->configuration().set_widgets_setup_first_run(true);
-    }
+
+    d->main_window_widgets->add_dock(d->ui->chipInfoWidget);
+    d->main_window_widgets->add_dock(d->ui->camera_settings);
+    d->main_window_widgets->add_dock(d->ui->recording);
+    d->main_window_widgets->add_dock(d->ui->histogram);
+
+    d->main_window_widgets->load();
+
     qDebug() << "file " << logFilePath << "exists: " << QFile::exists(logFilePath);
     d->ui->actionOpen_log_file_folder->setMenuRole(QAction::ApplicationSpecificRole);
     d->ui->actionOpen_log_file_folder->setVisible( ! logFilePath.isEmpty() && QFile::exists(logFilePath));
@@ -269,8 +261,6 @@ PlanetaryImagerMainWindow::PlanetaryImagerMainWindow(
 #endif
     });
 
-    connect(d->ui->actionHide_all, &QAction::triggered, [=]{ for_each(begin(dock_widgets), end(dock_widgets), bind(&QWidget::hide, _1) ); });
-    connect(d->ui->actionShow_all, &QAction::triggered, [=]{ for_each(begin(dock_widgets), end(dock_widgets), bind(&QWidget::show, _1) ); });
     connect(MessagesLogger::instance(), &MessagesLogger::message, this, bind(&PlanetaryImagerMainWindow::notify, this, _1, _2, _3, _4), Qt::QueuedConnection);
     connect(d->displayImage.get(), &DisplayImage::gotImage, this, bind(&ZoomableImage::setImage, d->image_widget, _1), Qt::QueuedConnection);
 
@@ -332,8 +322,15 @@ PlanetaryImagerMainWindow::PlanetaryImagerMainWindow(
     d->rescan_devices();
 }
 
+void PlanetaryImagerMainWindow::showEvent(QShowEvent *event)
+{
+  QMainWindow::showEvent(event);
+}
+
 void PlanetaryImagerMainWindow::closeEvent(QCloseEvent* event)
 {
+  d->main_window_widgets->save();
+  d->saveWindowGeometry();
   QMainWindow::closeEvent(event);
   emit quit();
 }

src/planetaryimager_mainwindow.h

@@ -57,6 +57,7 @@ public slots:
   void notify(const QDateTime &when, MessagesLogger::Type notification_type, const QString &title, const QString &message);
 protected:
   void closeEvent(QCloseEvent *event) override;
+  void showEvent(QShowEvent *event) override;
 signals:
   void quit();
   void imagerChanged();

src/planetaryimager_mainwindow.ui

@@ -26,7 +26,7 @@
      <x>0</x>
      <y>0</y>
      <width>997</width>
-     <height>30</height>
+     <height>27</height>
     </rect>
    </property>
    <widget class="QMenu" name="menuDevice">
@@ -46,18 +46,6 @@
     <addaction name="menu_device_load"/>
     <addaction name="actionDisconnect"/>
    </widget>
-   <widget class="QMenu" name="menuPanels">
-    <property name="title">
-     <string>Pa&amp;nels</string>
-    </property>
-    <addaction name="separator"/>
-    <addaction name="actionChip_Info"/>
-    <addaction name="actionCamera_Settings"/>
-    <addaction name="actionRecording"/>
-    <addaction name="actionHistogram"/>
-    <addaction name="actionHide_all"/>
-    <addaction name="actionShow_all"/>
-   </widget>
    <widget class="QMenu" name="menuView">
     <property name="title">
      <string>V&amp;iew</string>
@@ -84,11 +72,16 @@
     <addaction name="actionAbout_Qt"/>
     <addaction name="actionQuit"/>
    </widget>
+   <widget class="QMenu" name="menuWindow">
+    <property name="title">
+     <string>Window</string>
+    </property>
+   </widget>
+   <addaction name="menuPlanetary_Imager"/>
    <addaction name="menuDevice"/>
-   <addaction name="menuPanels"/>
    <addaction name="menuView"/>
    <addaction name="menuROI"/>
-   <addaction name="menuPlanetary_Imager"/>
+   <addaction name="menuWindow"/>
   </widget>
   <widget class="QStatusBar" name="statusbar"/>
   <widget class="QDockWidget" name="chipInfoWidget">
@@ -134,7 +127,7 @@
           <x>0</x>
           <y>0</y>
           <width>80</width>
-          <height>162</height>
+          <height>165</height>
          </rect>
         </property>
        </widget>