Add undo/redo support to RelActAutoGui.

Seems to work okay, but will probably need more fine-tuning or fixing.

Author: wcjohns

InterSpec/RelActAutoGui.h

@@ -309,6 +309,10 @@ class RelActAutoGui : public Wt::WContainerWidget
 
   void addDownloadAndUploadLinks( Wt::WContainerWidget *parent );
   void handleRequestToUploadXmlConfig();
+
+  /** Registers an undo/redo step if the current state differs from the previous state. */
+  void addUndoRedoStep();
+
 protected:
 
   enum RenderActions
@@ -322,10 +326,14 @@ class RelActAutoGui : public Wt::WContainerWidget
     UpdateFitEnergyCal    = 0x0040,
     UpdateRefGammaLines   = 0x0080,
     UpdateShowHideBack    = 0x0100,
-    UpdateXRaysInRois     = 0x0200
+    UpdateXRaysInRois     = 0x0200,
+    AddUndoRedoStep       = 0x0400
   };//enum D3RenderActions
-  
+
   Wt::WFlags<RenderActions> m_render_flags;
+
+  /** The GUI state from the last render; used for undo/redo deduplication. */
+  std::shared_ptr<const RelActCalcAuto::RelActAutoGuiState> m_currentGuiState;
 
   std::string m_default_par_sets_dir;
   std::string m_user_par_sets_dir;

InterSpec/RelActCalc.h

@@ -337,6 +337,9 @@ struct PhysicalModelShieldInput
 
   static const double sm_upper_allowed_areal_density_in_g_per_cm2; //Set to 500
 
+  bool operator==( const PhysicalModelShieldInput &rhs ) const;
+  bool operator!=( const PhysicalModelShieldInput &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const PhysicalModelShieldInput &lhs, const PhysicalModelShieldInput &rhs );
 #endif

InterSpec/RelActCalcAuto.h

@@ -184,6 +184,9 @@ struct RoiRange
   void toXml( ::rapidxml::xml_node<char> *parent ) const;
   void fromXml( const ::rapidxml::xml_node<char> *parent );
 
+  bool operator==( const RoiRange &rhs ) const;
+  bool operator!=( const RoiRange &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const RoiRange &lhs, const RoiRange &rhs );
 #endif
@@ -311,6 +314,9 @@ struct FloatingPeak
   void toXml( ::rapidxml::xml_node<char> *parent ) const;
   void fromXml( const ::rapidxml::xml_node<char> *parent );
 
+  bool operator==( const FloatingPeak &rhs ) const;
+  bool operator!=( const FloatingPeak &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const FloatingPeak &lhs, const FloatingPeak &rhs );
 #endif
@@ -585,6 +591,9 @@ struct RelEffCurveInput
   void toXml( ::rapidxml::xml_node<char> *parent ) const;
   void fromXml( const ::rapidxml::xml_node<char> *constraint_node );
 
+  bool operator==( const ActRatioConstraint &rhs ) const;
+  bool operator!=( const ActRatioConstraint &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const ActRatioConstraint &lhs, const ActRatioConstraint &rhs );
 #endif
@@ -619,6 +628,9 @@ struct RelEffCurveInput
     void toXml( ::rapidxml::xml_node<char> *parent ) const;
     void fromXml( const ::rapidxml::xml_node<char> *parent );
 
+  bool operator==( const MassFractionConstraint &rhs ) const;
+  bool operator!=( const MassFractionConstraint &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const MassFractionConstraint &lhs, const MassFractionConstraint &rhs );
 #endif
@@ -663,6 +675,9 @@ struct RelEffCurveInput
   rapidxml::xml_node<char> *toXml( ::rapidxml::xml_node<char> *parent ) const;
   void fromXml( const ::rapidxml::xml_node<char> *parent );
 
+  bool operator==( const RelEffCurveInput &rhs ) const;
+  bool operator!=( const RelEffCurveInput &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const RelEffCurveInput &lhs, const RelEffCurveInput &rhs );
 #endif
@@ -780,6 +795,9 @@ struct Options
    */
   void fromXml( const ::rapidxml::xml_node<char> *parent );
 
+  bool operator==( const Options &rhs ) const;
+  bool operator!=( const Options &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const Options &lhs, const Options &rhs );
 #endif
@@ -841,6 +859,9 @@ struct RelActAutoGuiState
   ::rapidxml::xml_node<char> *serialize( ::rapidxml::xml_node<char> *parent ) const;
   void deSerialize( const rapidxml::xml_node<char> *base_node );
 
+  bool operator==( const RelActAutoGuiState &rhs ) const;
+  bool operator!=( const RelActAutoGuiState &rhs ) const;
+
 #if( PERFORM_DEVELOPER_CHECKS )
   static void equalEnough( const RelActAutoGuiState &lhs, const RelActAutoGuiState &rhs );
 #endif

src/InterSpec.cpp

@@ -9716,61 +9716,51 @@ void InterSpec::programaticallyCloseAutoRemoteRidResultDialog()
 #if( USE_REL_ACT_TOOL )
 RelActAutoGui *InterSpec::relActAutoWindow( const bool createIfNotOpen )
 {
+  assert( (!m_relActAutoGui) == (!m_relActAutoWindow) );
+  
   if( !createIfNotOpen )
     return m_relActAutoGui;
 
-  if( !m_relActAutoGui )
+  if( m_relActAutoGui )
+    return m_relActAutoGui;
+  
+  const std::pair<RelActAutoGui *,AuxWindow *> widgets = RelActAutoGui::createWindow( this );
+  if( !widgets.first || !widgets.second )
+    return m_relActAutoGui;
+  
+  m_relActAutoGui = widgets.first;
+  m_relActAutoWindow = widgets.second;
+  
+  m_relActAutoWindow->finished().connect( boost::bind( &InterSpec::handleRelActAutoClose, this ) );
+  
+  try
   {
-    const std::pair<RelActAutoGui *,AuxWindow *> widgets = RelActAutoGui::createWindow( this );
-    if( !widgets.first || !widgets.second )
-      return m_relActAutoGui;
-      
-    m_relActAutoGui = widgets.first;
-    m_relActAutoWindow = widgets.second;
-    
-    m_relActAutoWindow->finished().connect( boost::bind( &InterSpec::handleRelActAutoClose, this ) );
-    
-    try
+    std::unique_ptr<RelActCalcAuto::RelActAutoGuiState> relActState = m_dataMeasurement
+    ? m_dataMeasurement->getRelActAutoGuiState()
+    : nullptr;
+    if( relActState )
     {
-      std::unique_ptr<RelActCalcAuto::RelActAutoGuiState> relActState = m_dataMeasurement
-                                                  ? m_dataMeasurement->getRelActAutoGuiState()
-                                                  : nullptr;
-      if( relActState )
-      {
-        m_relActAutoGui->deSerialize( *relActState );
-        m_relActAutoGui->checkIfInUserConfigOrCreateOne( true );
-      }
-    }catch( std::exception &e )
-    {
-      passMessage( "Error setting &quot;Isotopics from nuclides&quot; state to previously used state: "
-                  + std::string(e.what()), WarningWidget::WarningMsgHigh );
-      
+      m_relActAutoGui->deSerialize( *relActState );
+      m_relActAutoGui->checkIfInUserConfigOrCreateOne( true );
+    }
+  }catch( std::exception &e )
+  {
+    passMessage( "Error setting &quot;Isotopics from nuclides&quot; state to previously used state: "
+                + std::string(e.what()), WarningWidget::WarningMsgHigh );
+    
 #if( PERFORM_DEVELOPER_CHECKS )
-      log_developer_error( __func__, ("Error deserializing Rel. Act. GUI state: " + string(e.what())).c_str() );
+    log_developer_error( __func__, ("Error deserializing Rel. Act. GUI state: " + string(e.what())).c_str() );
 #endif
-      
-      //assert( 0 );
-    }//try / catch
-
-    if( m_undo && m_undo->canAddUndoRedoNow() )
-    {
-      auto undo = [this](){ handleRelActAutoClose(); };
-      auto redo = [this](){ relActAutoWindow(true); };
-      m_undo->addUndoRedoStep( std::move(undo), std::move(redo), "Show 'Isotopics from nuclides' tool" );
-    }//if( m_undo && !m_undo->canAddUndoRedoNow() )
-
-    // Since we dont have undo/redo implemented for RelActAuto - we will block it entirely
-    new UndoRedoManager::BlockGuiUndoRedo( m_relActAutoGui );
-  }else
-  {
-    const double windowWidth = 0.95 * renderedWidth();
-    const double windowHeight = 0.95 * renderedHeight();
-    m_relActAutoWindow->resizeWindow( windowWidth, windowHeight );
 
-    m_relActAutoWindow->resizeToFitOnScreen();
-    m_relActAutoWindow->show();
-    m_relActAutoWindow->centerWindow();
-  }//if( !m_shieldingSourceFit )
+    //assert( 0 );
+  }//try / catch
+  
+  if( m_undo && m_undo->canAddUndoRedoNow() )
+  {
+    auto undo = [this](){ handleRelActAutoClose(); };
+    auto redo = [this](){ relActAutoWindow(true); };
+    m_undo->addUndoRedoStep( std::move(undo), std::move(redo), "Show 'Isotopics from nuclides' tool" );
+  }//if( m_undo && !m_undo->canAddUndoRedoNow() )
 
   assert( m_relActAutoMenuItem );
   m_relActAutoMenuItem->disable();

src/InterSpecApp.cpp

@@ -68,6 +68,7 @@
 #include "InterSpec/InterSpecUser.h"
 #include "InterSpec/DataBaseUtils.h"
 #include "InterSpec/WarningWidget.h"
+#include "InterSpec/UndoRedoManager.h"
 #include "InterSpec/UserPreferences.h"
 
 #if( BUILD_AS_ELECTRON_APP )
@@ -612,6 +613,9 @@ void InterSpecApp::setupWidgets( const bool attemptStateLoad  )
     return;
   }//try / catch to create a InterSpec object
 
+  // Keep from adding any undo/redo while we finish initial rendering
+  UndoRedoManager::BlockUndoRedoInserts undo_blocker;
+  
   root()->addStyleClass( "specviewer" );
 
   // TODO: we could add an explicit CSS class