Library: allow views to save/restore the current state

library views store states in a QCache in WTrackTableView incl. * track selection * current index (focused track) * scroll positions, horizontal + vertical with a unique key composed of * feature (playlist/crate/browse ...) * child item (playlistId/crateId/directory ...) * current search term Credits for this and the required commits go to https://github.com/poelzi <[email protected]> I just boiled down some picks from stalled #3063
mixxxdj · Aug 9, 2021 · 4966ec3 · 4966ec3
1 parent 7297b1d
commit 4966ec3
Show file tree

Hide file tree

Showing 15 changed files with 188 additions and 134 deletions.
diff --git a/src/library/autodj/dlgautodj.h b/src/library/autodj/dlgautodj.h
@@ -12,10 +12,10 @@
 #include "library/trackcollection.h"
 #include "preferences/usersettings.h"
 #include "track/track_decl.h"
+#include "widget/wtracktableview.h"
 
 class PlaylistTableModel;
 class WLibrary;
-class WTrackTableView;
 
 class DlgAutoDJ : public QWidget, public Ui::DlgAutoDJ, public LibraryView {
     Q_OBJECT
@@ -33,6 +33,12 @@ class DlgAutoDJ : public QWidget, public Ui::DlgAutoDJ, public LibraryView {
     void loadSelectedTrack() override;
     void loadSelectedTrackToGroup(const QString& group, bool play) override;
     void moveSelection(int delta) override;
+    void saveCurrentViewState() override {
+        m_pTrackTableView->saveCurrentViewState();
+    };
+    void restoreCurrentViewState() override {
+        m_pTrackTableView->restoreCurrentViewState();
+    };
 
   public slots:
     void shufflePlaylistButton(bool buttonChecked);

diff --git a/src/library/dlganalysis.h b/src/library/dlganalysis.h
@@ -3,14 +3,14 @@
 #include <QButtonGroup>
 #include <QItemSelection>
 
-#include "preferences/usersettings.h"
+#include "analyzer/analyzerprogress.h"
 #include "library/analysislibrarytablemodel.h"
 #include "library/libraryview.h"
 #include "library/ui_dlganalysis.h"
-#include "analyzer/analyzerprogress.h"
+#include "preferences/usersettings.h"
+#include "widget/wanalysislibrarytableview.h"
 
 class AnalysisLibraryTableModel;
-class WAnalysisLibraryTableView;
 class Library;
 class WLibrary;
 
@@ -34,6 +34,12 @@ class DlgAnalysis : public QWidget, public Ui::DlgAnalysis, public virtual Libra
     inline const QString currentSearch() {
         return m_pAnalysisLibraryTableModel->currentSearch();
     }
+    void saveCurrentViewState() override {
+        m_pAnalysisLibraryTableView->saveCurrentViewState();
+    };
+    void restoreCurrentViewState() override {
+        m_pAnalysisLibraryTableView->restoreCurrentViewState();
+    };
 
   public slots:
     void tableSelectionChanged(const QItemSelection& selected,

diff --git a/src/library/dlghidden.h b/src/library/dlghidden.h
@@ -2,14 +2,14 @@
 
 #include <QItemSelection>
 
-#include "library/ui_dlghidden.h"
-#include "preferences/usersettings.h"
+#include "controllers/keyboard/keyboardeventfilter.h"
 #include "library/library.h"
 #include "library/libraryview.h"
-#include "controllers/keyboard/keyboardeventfilter.h"
+#include "library/ui_dlghidden.h"
+#include "preferences/usersettings.h"
+#include "widget/wtracktableview.h"
 
 class WLibrary;
-class WTrackTableView;
 class HiddenTableModel;
 
 class DlgHidden : public QWidget, public Ui::DlgHidden, public LibraryView {
@@ -25,6 +25,12 @@ class DlgHidden : public QWidget, public Ui::DlgHidden, public LibraryView {
     bool hasFocus() const override;
     void onSearch(const QString& text) override;
     QString currentSearch();
+    void saveCurrentViewState() override {
+        m_pTrackTableView->saveCurrentViewState();
+    };
+    void restoreCurrentViewState() override {
+        m_pTrackTableView->restoreCurrentViewState();
+    };
 
   public slots:
     void clicked();

diff --git a/src/library/dlgmissing.h b/src/library/dlgmissing.h
@@ -2,14 +2,14 @@
 
 #include <QItemSelection>
 
-#include "library/ui_dlgmissing.h"
-#include "preferences/usersettings.h"
+#include "controllers/keyboard/keyboardeventfilter.h"
 #include "library/library.h"
 #include "library/libraryview.h"
-#include "controllers/keyboard/keyboardeventfilter.h"
+#include "library/ui_dlgmissing.h"
+#include "preferences/usersettings.h"
+#include "widget/wtracktableview.h"
 
 class WLibrary;
-class WTrackTableView;
 class MissingTableModel;
 
 class DlgMissing : public QWidget, public Ui::DlgMissing, public LibraryView {
@@ -25,6 +25,12 @@ class DlgMissing : public QWidget, public Ui::DlgMissing, public LibraryView {
     bool hasFocus() const override;
     void onSearch(const QString& text) override;
     QString currentSearch();
+    void saveCurrentViewState() override {
+        m_pTrackTableView->saveCurrentViewState();
+    };
+    void restoreCurrentViewState() override {
+        m_pTrackTableView->restoreCurrentViewState();
+    };
 
   public slots:
     void clicked();

diff --git a/src/library/library.cpp b/src/library/library.cpp
@@ -355,7 +355,14 @@ void Library::bindLibraryWidget(
             &Library::switchToView,
             pLibraryWidget,
             &WLibrary::switchToView);
-
+    connect(this,
+            &Library::saveModelState,
+            pTrackTableView,
+            &WTrackTableView::slotSaveCurrentViewState);
+    connect(this,
+            &Library::restoreModelState,
+            pTrackTableView,
+            &WTrackTableView::slotRestoreCurrentViewState);
     connect(pTrackTableView,
             &WTrackTableView::trackSelected,
             this,

diff --git a/src/library/library.h b/src/library/library.h
@@ -126,7 +126,7 @@ class Library: public QObject {
     void onSkinLoadFinished();
 
   signals:
-    void showTrackModel(QAbstractItemModel* model);
+    void showTrackModel(QAbstractItemModel* model, bool restoreState = true);
     void switchToView(const QString& view);
     void loadTrack(TrackPointer pTrack);
     void loadTrackToPlayer(TrackPointer pTrack, const QString& group, bool play = false);

diff --git a/src/library/libraryfeature.h b/src/library/libraryfeature.h
@@ -121,7 +121,7 @@ class LibraryFeature : public QObject {
         Q_UNUSED(index);
     }
   signals:
-    void showTrackModel(QAbstractItemModel* model);
+    void showTrackModel(QAbstractItemModel* model, bool restoreState = true);
     void switchToView(const QString& view);
     void loadTrack(TrackPointer pTrack);
     void loadTrackToPlayer(TrackPointer pTrack, const QString& group, bool play = false);

diff --git a/src/library/libraryview.h b/src/library/libraryview.h
@@ -26,6 +26,8 @@ class LibraryView {
     virtual void slotAddToAutoDJBottom() {};
     virtual void slotAddToAutoDJTop() {};
     virtual void slotAddToAutoDJReplace() {};
+    virtual void saveCurrentViewState(){};
+    virtual void restoreCurrentViewState(){};
 
     /// If applicable, requests that the LibraryView load the selected track to
     /// the specified group. Does nothing otherwise.

diff --git a/src/library/recording/dlgrecording.cpp b/src/library/recording/dlgrecording.cpp
@@ -69,6 +69,10 @@ DlgRecording::DlgRecording(
             &RecordingManager::durationRecorded,
             this,
             &DlgRecording::slotDurationRecorded);
+    connect(&m_browseModel,
+            &BrowseTableModel::restoreModelState,
+            m_pTrackTableView,
+            &WTrackTableView::restoreCurrentViewState);
 
     QBoxLayout* box = qobject_cast<QBoxLayout*>(layout());
     VERIFY_OR_DEBUG_ASSERT(box) { //Assumes the form layout is a QVBox/QHBoxLayout!

diff --git a/src/library/recording/dlgrecording.h b/src/library/recording/dlgrecording.h
@@ -10,10 +10,10 @@
 #include "preferences/usersettings.h"
 #include "recording/recordingmanager.h"
 #include "track/track_decl.h"
+#include "widget/wtracktableview.h"
 
 class PlaylistTableModel;
 class WLibrary;
-class WTrackTableView;
 
 class DlgRecording : public QWidget, public Ui::DlgRecording, public virtual LibraryView {
     Q_OBJECT
@@ -33,6 +33,12 @@ class DlgRecording : public QWidget, public Ui::DlgRecording, public virtual Lib
     void loadSelectedTrackToGroup(const QString& group, bool play) override;
     void moveSelection(int delta) override;
     inline const QString currentSearch() { return m_proxyModel.currentSearch(); }
+    void saveCurrentViewState() override {
+        m_pTrackTableView->saveCurrentViewState();
+    };
+    void restoreCurrentViewState() override {
+        m_pTrackTableView->restoreCurrentViewState();
+    };
 
   public slots:
     void slotRecordingStateChanged(bool);

diff --git a/src/widget/wlibrary.cpp b/src/widget/wlibrary.cpp
@@ -54,14 +54,9 @@ void WLibrary::switchToView(const QString& name) {
     QMutexLocker lock(&m_mutex);
     //qDebug() << "WLibrary::switchToView" << name;
 
-    WTrackTableView* ttView = qobject_cast<WTrackTableView*>(
+    LibraryView* oldLibraryView = dynamic_cast<LibraryView*>(
             currentWidget());
 
-    if (ttView != nullptr){
-        //qDebug("trying to save position");
-        ttView->saveCurrentVScrollBarPos();
-    }
-
     QWidget* widget = m_viewMap.value(name, nullptr);
     if (widget != nullptr) {
         LibraryView * lview = dynamic_cast<LibraryView*>(widget);
@@ -72,17 +67,13 @@ void WLibrary::switchToView(const QString& name) {
             return;
         }
         if (currentWidget() != widget) {
+            if (oldLibraryView) {
+                oldLibraryView->saveCurrentViewState();
+            }
             //qDebug() << "WLibrary::setCurrentWidget" << name;
             setCurrentWidget(widget);
             lview->onShow();
-        }
-
-        WTrackTableView* ttWidgetView = qobject_cast<WTrackTableView*>(
-                widget);
-
-        if (ttWidgetView != nullptr){
-            qDebug("trying to restore position");
-            ttWidgetView->restoreCurrentVScrollBarPos();
+            lview->restoreCurrentViewState();
         }
     }
 }

diff --git a/src/widget/wlibrarytableview.cpp b/src/widget/wlibrarytableview.cpp
@@ -12,14 +12,16 @@
 #include "widget/wskincolor.h"
 #include "widget/wwidget.h"
 
+namespace {
+// number of entries in the model cache
+constexpr int kModelCacheSize = 1000;
+} // namespace
+
 WLibraryTableView::WLibraryTableView(QWidget* parent,
-        UserSettingsPointer pConfig,
-        const ConfigKey& vScrollBarPosKey)
+        UserSettingsPointer pConfig)
         : QTableView(parent),
           m_pConfig(pConfig),
-          m_vScrollBarPosKey(vScrollBarPosKey) {
-    loadVScrollBarPosState();
-
+          m_modelStateCache(kModelCacheSize) {
     // Setup properties for table
 
     // Editing starts when clicking on an already selected item.
@@ -53,37 +55,9 @@ WLibraryTableView::WLibraryTableView(QWidget* parent,
 }
 
 WLibraryTableView::~WLibraryTableView() {
+    m_modelStateCache.clear();
 }
 
-void WLibraryTableView::loadVScrollBarPosState() {
-    // TODO(rryan) I'm not sure I understand the value in saving the v-scrollbar
-    // position across restarts of Mixxx. Now that we have different views for
-    // each mode, the views should just maintain their scrollbar position when
-    // you switch views. We should discuss this.
-    m_noSearchVScrollBarPos = m_pConfig->getValueString(m_vScrollBarPosKey).toInt();
-}
-
-void WLibraryTableView::restoreNoSearchVScrollBarPos() {
-    // Restore the scrollbar's position (scroll to that spot)
-    // when the search has been cleared
-    //qDebug() << "restoreNoSearchVScrollBarPos()" << m_noSearchVScrollBarPos;
-    updateGeometries();
-    verticalScrollBar()->setValue(m_noSearchVScrollBarPos);
-}
-
-void WLibraryTableView::saveNoSearchVScrollBarPos() {
-    // Save the scrollbar's position so we can return here after
-    // a search is cleared.
-    //qDebug() << "saveNoSearchVScrollBarPos()" << m_noSearchVScrollBarPos;
-    m_noSearchVScrollBarPos = verticalScrollBar()->value();
-}
-
-
-void WLibraryTableView::saveVScrollBarPosState() {
-    //Save the vertical scrollbar position.
-    int scrollbarPosition = verticalScrollBar()->value();
-    m_pConfig->set(m_vScrollBarPosKey, ConfigValue(scrollbarPosition));
-}
 
 void WLibraryTableView::moveSelection(int delta) {
     QAbstractItemModel* pModel = model();
@@ -131,19 +105,63 @@ void WLibraryTableView::moveSelection(int delta) {
     }
 }
 
-void WLibraryTableView::saveVScrollBarPos(TrackModel* key){
-    m_vScrollBarPosValues[key] = verticalScrollBar()->value();
+void WLibraryTableView::saveTrackModelState(
+        const QAbstractItemModel* model, const QString& key) {
+    //qDebug() << "saveTrackModelState:" << model << key;
+    VERIFY_OR_DEBUG_ASSERT(model) {
+        return;
+    }
+    VERIFY_OR_DEBUG_ASSERT(!key.isEmpty()) {
+        return;
+    }
+    ModelState* state = m_modelStateCache.take(key);
+    if (!state) {
+        state = new ModelState();
+    }
+    state->verticalScrollPosition = verticalScrollBar()->value();
+    state->horizontalScrollPosition = horizontalScrollBar()->value();
+    if (!selectionModel()->selectedIndexes().isEmpty()) {
+        state->selectionIndex = selectionModel()->selectedIndexes();
+    } else {
+        state->selectionIndex = QModelIndexList();
+    }
+    const QModelIndex currIndex = selectionModel()->currentIndex();
+    if (currIndex.isValid()) {
+        state->currentIndex = currIndex;
+    } else {
+        state->currentIndex = QModelIndex();
+    }
+    m_modelStateCache.insert(key, state, 1);
 }
 
-void WLibraryTableView::restoreVScrollBarPos(TrackModel* key){
-    updateGeometries();
+void WLibraryTableView::restoreTrackModelState(
+        const QAbstractItemModel* model, const QString& key) {
+    //qDebug() << "restoreTrackModelState:" << model << key;
+    //<< m_vModelState.keys();
+    if (model == nullptr) {
+        return;
+    }
 
-    if (m_vScrollBarPosValues.contains(key)){
-        verticalScrollBar()->setValue(m_vScrollBarPosValues[key]);
-    }else{
-        m_vScrollBarPosValues[key] = 0;
-        verticalScrollBar()->setValue(0);
+    ModelState* state = m_modelStateCache.take(key);
+    if (!state) {
+        return;
+    }
+
+    verticalScrollBar()->setValue(state->verticalScrollPosition);
+    horizontalScrollBar()->setValue(state->horizontalScrollPosition);
+
+    auto selection = selectionModel();
+    selection->clearSelection();
+    if (!state->selectionIndex.isEmpty()) {
+        for (auto index : qAsConst(state->selectionIndex)) {
+            selection->select(index, QItemSelectionModel::Select);
+        }
+    }
+    if (state->currentIndex.isValid()) {
+        selection->setCurrentIndex(state->currentIndex, QItemSelectionModel::NoUpdate);
     }
+    // reinsert the state into the cache
+    m_modelStateCache.insert(key, state, 1);
 }
 
 void WLibraryTableView::setTrackTableFont(const QFont& font) {
@@ -176,6 +194,24 @@ void WLibraryTableView::setSelectedClick(bool enable) {
     }
 }
 
+void WLibraryTableView::saveCurrentViewState() {
+    const QAbstractItemModel* currentModel = model();
+    QString key = getStateKey();
+    if (!currentModel || key.isEmpty()) {
+        return;
+    }
+    saveTrackModelState(currentModel, key);
+}
+
+void WLibraryTableView::restoreCurrentViewState() {
+    const QAbstractItemModel* currentModel = model();
+    QString key = getStateKey();
+    if (!currentModel || key.isEmpty()) {
+        return;
+    }
+    restoreTrackModelState(currentModel, key);
+}
+
 void WLibraryTableView::focusInEvent(QFocusEvent* event) {
     QTableView::focusInEvent(event);