Changeset 67e2b3 for src/Actions

Timestamp:

Mar 24, 2010, 4:26:21 PM (15 years ago)

Author:

Tillmann Crueger <crueger@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

5b0b98

Parents:

ce1d8c

Message:

Added methods that allow bookkeeping of actions for undo/redo methods

Location:

src/Actions

Files:

• Action.cpp (modified) (2 diffs)
• Action.hpp (modified) (2 diffs)
• ActionSequence.cpp (modified) (2 diffs)
• ActionSequence.hpp (modified) (3 diffs)
• Calculation.hpp (modified) (2 diffs)
• Calculation_impl.hpp (modified) (1 diff)
• ErrorAction.cpp (modified) (3 diffs)
• ErrorAction.hpp (modified) (1 diff)
• MakroAction.cpp (modified) (3 diffs)
• MakroAction.hpp (modified) (1 diff)
• ManipulateAtomsProcess.cpp (modified) (2 diffs)
• ManipulateAtomsProcess.hpp (modified) (1 diff)
• MethodAction.cpp (modified) (3 diffs)
• MethodAction.hpp (modified) (1 diff)
• small_actions.cpp (modified) (3 diffs)
• small_actions.hpp (modified) (2 diffs)

src/Actions/Action.cpp

@@ -12 +12 @@
 
 using namespace std;
+
+// this object is only ever used as indicator.
+ActionState success_val;
+
+ActionState *Action::success = &success_val;
 
 Action::Action(std::string _name,bool _doRegister) :
@@ -27 +32 @@
   return name;
 }
+
+void Action::call(){
+  // forward to private virtual
+  performCall();
+}
+ActionState* Action::undo(ActionState* _state) {
+  // forward to private virtual
+  return performUndo(_state);
+}
+ActionState* Action::redo(ActionState* _state) {
+  // forward to private virtual
+  return performRedo(_state);
+}

src/Actions/Action.hpp

@@ -11 +11 @@
 #include <string>
 
+// forward declaration
+
+class ActionState;
+class ActionSequence;
+
 /**
  * Base class for all actions.
@@ -21 +26 @@
 class Action
 {
-protected:
+friend class ActionSequence;
 public:
   Action(std::string _name,bool _doRegister=true);
   virtual ~Action();
 
-  virtual void call()=0;
-  virtual void undo()=0;
+  // this method only handles the infrastructure
+  // actuall action is passed on to a private virtual
+  void call();
+  ActionState* undo(ActionState*);
+  ActionState* redo(ActionState*);
+
   virtual bool canUndo()=0;
-  //virtual bool shouldUndo()=0;
+  virtual bool shouldUndo()=0;
 
   virtual const std::string getName();
 
+protected:
+  static ActionState* success;
+
 private:
+  virtual ActionState* performCall()=0;
+  virtual ActionState* performUndo(ActionState*)=0;
+  virtual ActionState* performRedo(ActionState*)=0;
+
   std::string name;
 };
 
+/**
+ * This class can be used by actions to save the state.
+ *
+ * It is implementing a memento pattern. The base class is completely empty,
+ * since no general state internals can be given. The Action performing
+ * the Undo should downcast to the apropriate type.
+ */
+class ActionState{
+public:
+  ActionState(){}
+  virtual ~ActionState(){}
+};
+
 #endif /* ACTION_H_ */

src/Actions/ActionSequence.cpp

@@ -8 +8 @@
 #include "Actions/ActionSequence.hpp"
 #include "Actions/Action.hpp"
+
+#include "Helpers/Assert.hpp"
 
 using namespace std;
@@ -34 +36 @@
 }
 
-void ActionSequence::callAll(){
-  deque<Action*>::iterator it;
-  for(it=actions.begin(); it!=actions.end(); it++)
-    (*it)->call();
+ActionSequence::stateSet ActionSequence::callAll(){
+  stateSet states;
+  for(actionSet::iterator it=actions.begin(); it!=actions.end(); it++){
+    // we want to have a global bookkeeping for all actions in the sequence, so
+    // we bypass the normal call
+    ActionState *state = (*it)->performCall();
+    states.push_back(state);
+  }
+  return states;
 }
 
-void ActionSequence::undoAll(){
-  deque<Action*>::reverse_iterator rit;
-  for(rit=actions.rbegin(); rit!=actions.rend(); rit++)
-    (*rit)->undo();
+ActionSequence::stateSet ActionSequence::undoAll(deque<ActionState*> states){
+  ASSERT(canUndo(),"Trying to undo a sequence that contains methods that can't be undone");
+  stateSet res;
+  actionSet::reverse_iterator actionRit = actions.rbegin();
+  stateSet::reverse_iterator stateRit = states.rbegin();
+  for(;actionRit!=actions.rend();++actionRit,++stateRit){
+    ASSERT(stateRit!=states.rend(),"End of states prematurely reached.");
+    if((*actionRit)->shouldUndo()){
+      ActionState *newState = (*actionRit)->performUndo(*stateRit);
+      // The order of the states has to correspond to the order of the actions
+      // this is why we have to add at the beginning
+      res.push_front(newState);
+    }
+    else{
+      res.push_front(Action::success);
+    }
+  }
+  return res;
+}
+
+ActionSequence::stateSet ActionSequence::redoAll(deque<ActionState*> states){
+  stateSet res;
+  actionSet::iterator actionIt = actions.begin();
+  stateSet::iterator stateIt = states.begin();
+  for(;actionIt!=actions.end();++actionIt,++stateIt){
+    ASSERT(stateIt!=states.end(),"End of states prematurely reached.");
+    if((*actionIt)->shouldUndo()){
+      ActionState *newState =(*actionIt)->performRedo(*stateIt);
+      res.push_back(newState);
+    }
+    else{
+      res.push_back(Action::success);
+    }
+  }
+  return res;
 }
 
 bool ActionSequence::canUndo(){
   bool canUndo=true;
-  deque<Action*>::iterator it;
-  for(it=actions.begin(); it!=actions.end(); it++)
-    canUndo &= (*it)->canUndo();
+  for(deque<Action*>::iterator it=actions.begin(); it!=actions.end(); ++it){
+    if((*it)->shouldUndo()){
+      canUndo &= (*it)->canUndo();
+    }
+  }
   return canUndo;
 }
+
+bool ActionSequence::shouldUndo(){
+  bool shouldUndo = false;
+  for(deque<Action*>::iterator it=actions.begin();it!=actions.end();++it){
+    shouldUndo |= (*it)->shouldUndo();
+  }
+  return shouldUndo;
+}

src/Actions/ActionSequence.hpp

@@ -12 +12 @@
 
 class Action;
+class ActionState;
 
 /**
@@ -19 +20 @@
 {
 public:
+  typedef std::deque<Action*> actionSet;
+  typedef std::deque<ActionState*> stateSet;
+
   ActionSequence();
   virtual ~ActionSequence();
@@ -25 +29 @@
   Action* removeLastAction();
 
-  void callAll();
-  void undoAll();
+  stateSet callAll();
+  stateSet undoAll(stateSet);
+  stateSet redoAll(stateSet);
 
   bool canUndo();
+  bool shouldUndo();
 
 private:
-  std::deque<Action*> actions;
+  actionSet actions;
 };
 

src/Actions/Calculation.hpp

@@ -29 +29 @@
    * from menu Items or other places.
    */
-  virtual void call();
-  virtual void undo();
   virtual bool canUndo();
+
+  virtual bool shouldUndo();
 
   /**
@@ -64 +64 @@
   virtual T* doCalc()=0;
 private:
+  virtual ActionState* performCall();
+  virtual ActionState* performUndo(ActionState*);
+  virtual ActionState* performRedo(ActionState*);
+
   bool done;
 };

src/Actions/Calculation_impl.hpp

@@ -29 +29 @@
 
 template<typename T>
-void Calculation<T>::call(){
+ActionState* Calculation<T>::performCall(){
   reset();
   (*this)();
+  return Action::success;
 }
 
 template<typename T>
-void Calculation<T>::undo(){}
+ActionState* Calculation<T>::performUndo(ActionState*){
+  ASSERT(0,"Cannot undo a calculation");
+  return Action::success;
+}
+template<typename T>
+ActionState* Calculation<T>::performRedo(ActionState*){
+  ASSERT(0,"Cannot redo a calculation");
+  return Action::success;
+}
 
 template<typename T>
 bool Calculation<T>::canUndo()
+{
+  return false;
+}
+
+template<typename T>
+bool Calculation<T>::shouldUndo()
 {
   return false;

src/Actions/ErrorAction.cpp

@@ -11 +11 @@
 #include "log.hpp"
 #include "verbose.hpp"
+#include "Helpers/Assert.hpp"
 
 using namespace std;
@@ -24 +25 @@
 }
 
-void ErrorAction::call() {
+ActionState* ErrorAction::performCall() {
   Log() << Verbose(0) << errorMsg << endl;
+  return Action::success;
 }
-void ErrorAction::undo() {
+ActionState* ErrorAction::performUndo(ActionState*) {
+  ASSERT(0,"Undo called for an ErrorAction");
+  return Action::success;
+}
+
+ActionState* ErrorAction::performRedo(ActionState*) {
+  ASSERT(0,"Redo called for an ErrorAction");
+  return Action::success;
 }
 
@@ -33 +42 @@
   return false;
 }
+
+bool ErrorAction::shouldUndo(){
+  return false;
+}

src/Actions/ErrorAction.hpp

@@ -18 +18 @@
   virtual ~ErrorAction();
 
-  virtual void call();
-  virtual void undo();
   virtual bool canUndo();
+  virtual bool shouldUndo();
 
 private:
+
+  virtual ActionState* performCall();
+  virtual ActionState* performUndo(ActionState*);
+  virtual ActionState* performRedo(ActionState*);
+
   std::string errorMsg;
 };

src/Actions/MakroAction.cpp

@@ -11 +11 @@
 #include "Actions/Action.hpp"
 #include "Actions/ActionSequence.hpp"
+#include "Helpers/Assert.hpp"
 
 using namespace std;
+
+class MakroActionState : public ActionState{
+public:
+  MakroActionState(ActionSequence::stateSet _states) :
+    states(_states)
+  {}
+  virtual ~MakroActionState(){
+    for(ActionSequence::stateSet::iterator iter=states.begin();
+        iter!=states.end();++iter){
+      delete *iter;
+    }
+  }
+
+  ActionSequence::stateSet states;
+};
 
 MakroAction::MakroAction(string _name,ActionSequence* _actions,bool _doRegister) :
@@ -30 +46 @@
 
 
-void MakroAction::call(){
-  actions->callAll();
+ActionState* MakroAction::performCall(){
+  ActionSequence::stateSet states = actions->callAll();
+  return new MakroActionState(states);
 }
 
-void MakroAction::undo() {
-  actions->undoAll();
+ActionState* MakroAction::performUndo(ActionState* _state) {
+  MakroActionState *state = dynamic_cast<MakroActionState*>(_state);
+  ASSERT(state,"Type mismatch for the state of the MakroAction");
+  ActionSequence::stateSet states = actions->undoAll(state->states);
+  return new MakroActionState(states);
 }
 
@@ -41 +61 @@
   return actions->canUndo();
 }
+
+bool MakroAction::shouldUndo() {
+  return actions->shouldUndo();
+}

src/Actions/MakroAction.hpp

@@ -26 +26 @@
   virtual ~MakroAction();
 
-  virtual void call();
-  virtual void undo();
-  virtual bool canUndo();
+  bool canUndo();
+  bool shouldUndo();
 
 private:
+  virtual ActionState* performCall();
+  virtual ActionState* performUndo(ActionState*);
+  virtual ActionState* performRedo(ActionState*);
+
   ActionSequence *actions;
 };

src/Actions/ManipulateAtomsProcess.cpp

@@ -11 +11 @@
 
 #include "World.hpp"
+#include "Helpers/Assert.hpp"
 
 using namespace std;
@@ -24 +25 @@
 {}
 
-void ManipulateAtomsProcess::call(){
+ActionState* ManipulateAtomsProcess::performCall(){
   World::getInstance().doManipulate(this);
+  return Action::success;
 }
 
-void ManipulateAtomsProcess::undo(){
+ActionState* ManipulateAtomsProcess::performUndo(ActionState*){
+  ASSERT(0,"Undo called for a ManipulateAtomsProcess");
+  return Action::success;
+}
 
+ActionState* ManipulateAtomsProcess::performRedo(ActionState*){
+  ASSERT(0,"Redo called for a ManipulateAtomsProcess");
+  return Action::success;
 }
 
 bool ManipulateAtomsProcess::canUndo(){
   return false;
+}
+
+bool ManipulateAtomsProcess::shouldUndo(){
+  return true;
 }
 

src/Actions/ManipulateAtomsProcess.hpp

@@ -23 +23 @@
   virtual ~ManipulateAtomsProcess();
 
-  virtual void call();
-  virtual void undo();
   virtual bool canUndo();
+  virtual bool shouldUndo();
 
   virtual void doManipulate(World *);
 private:
+
+  virtual ActionState* performCall();
+  virtual ActionState* performUndo(ActionState*);
+  virtual ActionState* performRedo(ActionState*);
+
   AtomDescriptor descr;
   boost::function<void(atom*)> operation;

src/Actions/MethodAction.cpp

@@ -10 +10 @@
 #include <string>
 
-#include "MethodAction.hpp"
+#include "Actions/MethodAction.hpp"
+#include "Helpers/Assert.hpp"
 
 using namespace std;
@@ -21 +22 @@
 
 MethodAction::~MethodAction()
-{
-  // TODO Auto-generated destructor stub
+{}
+
+
+ActionState* MethodAction::performCall() {
+  executeMethod();
+  // we don't have a state to save so we return Action::success
+  return Action::success;
 }
 
+ActionState* MethodAction::performUndo(ActionState*) {
+  ASSERT(0,"Cannot undo a MethodAction");
+  return Action::success;
+}
 
-void MethodAction::call() {
-  executeMethod();
-}
-void MethodAction::undo() {
-
+ActionState* MethodAction::performRedo(ActionState*){
+  ASSERT(0,"Cannot redo a MethodAction");
+  return Action::success;
 }
 
@@ -36 +44 @@
   return false;
 }
+
+bool MethodAction::shouldUndo(){
+  return true;
+}

src/Actions/MethodAction.hpp

@@ -22 +22 @@
   MethodAction(std::string _name,boost::function<void()> _executeMethod,bool _doRegister=true);
   virtual ~MethodAction();
+  virtual bool canUndo();
+  virtual bool shouldUndo();
 
-  virtual void call();
-  virtual void undo();
-  virtual bool canUndo();
+private:
+  virtual ActionState* performCall();
+  virtual ActionState* performUndo(ActionState*);
+  virtual ActionState* performRedo(ActionState*);
+
 
   boost::function<void()> executeMethod; //!< this stores the method to be called
-
-
 };
 

src/Actions/small_actions.cpp

@@ -14 +14 @@
 /****** ChangeMoleculeNameAction *****/
 
+// memento to remember the state when undoing
+
+class ChangeMoleculeNameState : public ActionState {
+public:
+  ChangeMoleculeNameState(molecule* _mol,std::string _lastName) :
+    mol(_mol),
+    lastName(_lastName)
+  {}
+  molecule* mol;
+  std::string lastName;
+};
+
 char ChangeMoleculeNameAction::NAME[] = "Change filename of Molecule";
 
@@ -24 +36 @@
 {}
 
-void ChangeMoleculeNameAction::call() {
+ActionState* ChangeMoleculeNameAction::performCall() {
   string filename;
   molecule *mol = NULL;
@@ -31 +43 @@
   dialog->queryMolecule("Enter index of molecule: ",&mol,molecules);
   dialog->queryString("Enter name: ",&filename);
+
   if(dialog->display()) {
+    string oldName = mol->getName();
     mol->setName(filename);
+    delete dialog;
+    return new ChangeMoleculeNameState(mol,oldName);
   }
-
-  delete dialog;
+  return 0;
 }
 
-void ChangeMoleculeNameAction::undo() {
+ActionState* ChangeMoleculeNameAction::performUndo(ActionState* _state) {
+  ChangeMoleculeNameState *state = dynamic_cast<ChangeMoleculeNameState*>(_state);
+  ASSERT(state,"State passed to ChangeMoleculeNameAction::performUndo did not have correct type");
 
+  string newName = state->mol->getName();
+  state->mol->setName(state->lastName);
+
+  return new ChangeMoleculeNameState(state->mol,newName);
+}
+
+ActionState* ChangeMoleculeNameAction::performRedo(ActionState *_state){
+  // Undo and redo have to do the same for this action
+  return performUndo(_state);
 }
 
 bool ChangeMoleculeNameAction::canUndo() {
-  return false;
+  return true;
 }
 

src/Actions/small_actions.hpp

@@ -14 +14 @@
   virtual ~ChangeMoleculeNameAction();
 
-  void call();
-  void undo();
   bool canUndo();
   bool shouldUndo();
@@ -21 +19 @@
   virtual const std::string getName();
 private:
+  virtual ActionState* performCall();
+  virtual ActionState* performUndo(ActionState*);
+  virtual ActionState* performRedo(ActionState*);
+
   MoleculeListClass *molecules;
   static char NAME[];