From c8170d9430e9a5572cba5bb0520ebe0b49c91239 Mon Sep 17 00:00:00 2001
From: Jeff Young <jeff@rokeby.ie>
Date: Sat, 1 Aug 2020 18:19:31 +0100
Subject: [PATCH] Restore selection after rebuilding DRC/ERC tree.

Fixes https://gitlab.com/kicad/code/kicad/issues/5042
---
 common/rc_item.cpp | 27 ++++++++++++++++++++++++---
 common/rc_item.h   |  2 ++
 2 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/common/rc_item.cpp b/common/rc_item.cpp
index fe77bbc6ae..a9c484702a 100644
--- a/common/rc_item.cpp
+++ b/common/rc_item.cpp
@@ -142,11 +142,17 @@ void RC_TREE_MODEL::rebuildModel( RC_ITEMS_PROVIDER* aProvider, int aSeverities
 {
     wxWindowUpdateLocker updateLock( m_view );
 
-    // Even with the updateLock, wxWidgets sometimes ties its knickers in
-    // a knot when trying to run a wxdataview_selection_changed_callback()
-    // on a row that has been deleted.
+    RC_ITEM* selectedRcItem = nullptr;
+
     if( m_view )
+    {
+        RC_TREE_NODE* selectedNode = ToNode( m_view->GetSelection() );
+        selectedRcItem = selectedNode ? selectedNode->m_RcItem : nullptr;
+
+        // Even with the updateLock, wxWidgets sometimes ties its knickers in a knot trying
+        // to run a wxdataview_selection_changed_callback() on a row that has been deleted.
         m_view->UnselectAll();
+    }
 
     if( aProvider != m_rcItemsProvider )
     {
@@ -200,6 +206,21 @@ void RC_TREE_MODEL::rebuildModel( RC_ITEMS_PROVIDER* aProvider, int aSeverities
     m_view->AppendTextColumn( wxEmptyString, 0, wxDATAVIEW_CELL_INERT, width );
 
     ExpandAll();
+
+    // Most annoyingly wxWidgets won't tell us the scroll position (and no, all the usual
+    // routines don't work), so we can only restore the scroll position based on a selection.
+    if( selectedRcItem )
+    {
+        for( RC_TREE_NODE* candidate : m_tree )
+        {
+            if( candidate->m_RcItem == selectedRcItem )
+            {
+                m_view->Select( ToItem( candidate ) );
+                m_view->EnsureVisible( ToItem( candidate ) );
+                break;
+            }
+        }
+    }
 }
 
 
diff --git a/common/rc_item.h b/common/rc_item.h
index b8ef6d27d3..dc3562b113 100644
--- a/common/rc_item.h
+++ b/common/rc_item.h
@@ -291,6 +291,8 @@ private:
     RC_ITEMS_PROVIDER*         m_rcItemsProvider;   // I own this, but not its contents
 
     std::vector<RC_TREE_NODE*> m_tree;              // I own this
+    mutable const RC_ITEM*     m_lastQueried;       // Used as a massive hack to restore the
+                                                    // widget's scroll position.
 };