Changeset 126867

Timestamp:

Sep 19, 2013, 8:23:52 PM (11 years ago)

Author:

Frederik Heber <heber@…>

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:

05c989

Parents:

d649b7

git-author:

Frederik Heber <heber@…> (08/20/13 15:45:30)

git-committer:

Frederik Heber <heber@…> (09/19/13 20:23:52)

Message:

Actions no longer register themselves, ActionQueue::addAction() introduced.

• eventually, Actions should be constrained to the ActionQueue alone. They may be created externally but their control has to be delivered to the ActionQueue.
• Hence, we reversed the registering process: Actions do not register themselves with the ActionRegistry but as almost all are created in ActionRegistry::fillRegistry() they are registered there as well.
• Actions cstor and dstor are now protected, ActionRegistry is friend.
• Action needs to befriend Registry<T> and ActionSequenceTest to grant access to dstor.

Location:

src

Files:

• Actions/Action.cpp (modified) (2 diffs)
• Actions/Action.hpp (modified) (4 diffs)
• Actions/ActionQueue.cpp (modified) (1 diff)
• Actions/ActionQueue.hpp (modified) (2 diffs)
• Actions/Action_impl_pre.hpp (modified) (1 diff)
• Actions/AtomsCalculation_impl.hpp (modified) (1 diff)
• Actions/Calculation.hpp (modified) (1 diff)
• Actions/Calculation_impl.hpp (modified) (1 diff)
• Actions/ErrorAction.cpp (modified) (1 diff)
• Actions/ErrorAction.hpp (modified) (1 diff)
• Actions/GraphAction/SubgraphDissectionAction.cpp (modified) (1 diff)
• Actions/MakroAction.cpp (modified) (1 diff)
• Actions/MakroAction.hpp (modified) (1 diff)
• Actions/MakroAction_impl_pre.hpp (modified) (1 diff)
• Actions/ManipulateAtomsProcess.cpp (modified) (1 diff)
• Actions/ManipulateAtomsProcess.hpp (modified) (1 diff)
• Actions/MethodAction.cpp (modified) (1 diff)
• Actions/MethodAction.hpp (modified) (1 diff)
• Actions/OptionRegistry.hpp (modified) (1 diff)
• Actions/Process.cpp (modified) (1 diff)
• Actions/Process.hpp (modified) (1 diff)
• Actions/Reaction.hpp (modified) (1 diff)
• Actions/Reaction_impl.hpp (modified) (1 diff)
• Actions/Reaction_impl_pre.hpp (modified) (1 diff)
• Actions/unittests/ActionSequenceUnitTest.cpp (modified) (4 diffs)
• UIElements/Menu/TextMenu/TextMenu.hpp (modified) (1 diff)
• UIElements/Menu/TextMenu/TxMenuLeaveAction.cpp (modified) (1 diff)
• UIElements/TextUI/TextWindow.cpp (modified) (2 diffs)
• UIElements/TextUI/TextWindow.hpp (modified) (1 diff)
• World.cpp (modified) (1 diff)

src/Actions/Action.cpp

@@ -75 +75 @@
 ActionState::ptr Action::failure;
 
-Action::Action(const ActionTrait &_Traits, ActionRegistry * const _AR) :
-    Traits(_Traits),
-    AR(_AR)
-{
-  // register with ActionRegistry
-  if(AR != NULL) {
-    AR->registerInstance(this);
-  }
-
+Action::Action(const ActionTrait &_Traits) :
+    Traits(_Traits)
+{
   // register with OptionRegistry
   for (ActionTrait::options_const_iterator optioniter = Traits.getBeginIter();
@@ -128 +122 @@
 Action::~Action()
 {
-  // unregister us if still registered
-  if (AR != NULL)
-    AR->unregisterInstance(this);
-
   for (ActionTrait::options_const_iterator optioniter = Traits.getBeginIter();
       optioniter != Traits.getEndIter();

src/Actions/Action.hpp

@@ -25 +25 @@
 
 // forward declaration
+template <typename T> class Registry;
 
 namespace MoleCuilder {
+  class ActionHistory;
   class ActionRegistry;
   class ActionSequence;
 }
+class ActionSequenceTest;
 class Dialog;
 
@@ -80 +83 @@
 class Action
 {
-friend class ActionSequence;
-friend class ActionHistory;
+  friend class ActionHistory;
+  friend class ActionRegistry;
+  friend class ActionSequence;
+  template <typename T> friend class ::Registry;
+  //!> TextMenu needs to instantiate some specific Actions, grant access to cstor
+  friend class TextMenu;
+
+  // some unit tests on Actions
+  friend class ::ActionSequenceTest;
 public:
 
   enum QueryOptions {Interactive, NonInteractive};
 
+protected:
   /**
    * Standard constructor of Action Base class
@@ -97 +108 @@
    *
    * \param Traits information class to this action
-   * \param _AR pointer to ActionRegistry to register, NULL - do not register
-   */
-  Action(const ActionTrait &_Traits, ActionRegistry * const _AR = NULL);
+   */
+  Action(const ActionTrait &_Traits);
   virtual ~Action();
 
+public:
   /**
    * This method is used to call an action. The basic operations for the Action
@@ -163 +174 @@
   const ActionTrait Traits;
 
-  /** Action is registered with an ActionRegistry and stores its pointer internally.
-   *
-   */
-  ActionRegistry* const AR;
-
 protected:
   /** Removes the static entities Action::success and Action::failure.

src/Actions/ActionQueue.cpp

@@ -69 +69 @@
 }
 
+void ActionQueue::registerAction(Action *_action)
+{
+  AR->registerInstance(_action);
+}
+
 const ActionTrait& ActionQueue::getActionsTrait(const std::string &name) const
 {

src/Actions/ActionQueue.hpp

@@ -55 +55 @@
   bool isActionKnownByName(const std::string &name) const;
 
+  /** Register an Action with the ActionRegistry.
+   *
+   * \param _action action to add
+   */
+  void registerAction(Action *_action);
+
   /** Returns the vector with the tokens of all currently known Actions.
    *
@@ -67 +73 @@
    */
   const ActionTrait& getActionsTrait(const std::string &name) const;
-
-  /** Getter function for the ActionRegistry for transitional purpose.
-   *
-   * \return ref to internal ActionRegistry
-   */
-  ActionRegistry& getActionRegistry() {
-    return *AR;
-  }
 
   /** Undoes last called Action.

src/Actions/Action_impl_pre.hpp

@@ -234 +234 @@
 // =========== constructor ===========
 ACTION::ACTION () :
-  Action(ActionTraits< ACTION >(), NULL)
+  Action(ActionTraits< ACTION >())
 {}
 

src/Actions/AtomsCalculation_impl.hpp

@@ -22 +22 @@
 template<typename T>
 AtomsCalculation<T>::AtomsCalculation(boost::function<T(atom*)> _op,const ActionTrait &_trait,AtomDescriptor _descr) :
-  Calculation<std::vector<T> >(0,_trait,NULL),
+  Calculation<std::vector<T> >(0,_trait),
   descr(_descr),
   op(_op)

src/Actions/Calculation.hpp

@@ -30 +30 @@
 {
 public:
-  Calculation(int _maxSteps, const ActionTrait &_trait, ActionRegistry * const _AR);
+  Calculation(int _maxSteps, const ActionTrait &_trait);
   virtual ~Calculation();
 

src/Actions/Calculation_impl.hpp

@@ -22 +22 @@
 
 template<typename T>
-Calculation<T>::Calculation(int _maxSteps, const ActionTrait &_trait, ActionRegistry * const _AR) :
-  Process(_maxSteps,_trait,_AR),
+Calculation<T>::Calculation(int _maxSteps, const ActionTrait &_trait) :
+  Process(_maxSteps,_trait),
   result(0),
   done(false)

src/Actions/ErrorAction.cpp

@@ -44 +44 @@
 using namespace MoleCuilder;
 
-ErrorAction::ErrorAction(const ActionTrait &_trait,const char * _errorMsg, ActionRegistry * const _AR) :
-Action(_trait,_AR),
+ErrorAction::ErrorAction(const ActionTrait &_trait,const char * _errorMsg) :
+Action(_trait),
 errorMsg(_errorMsg)
 {

src/Actions/ErrorAction.hpp

@@ -23 +23 @@
 {
 public:
-  ErrorAction(const ActionTrait &_trait,const char * _errorMsg, ActionRegistry * const _AR);
+  ErrorAction(const ActionTrait &_trait,const char * _errorMsg);
   virtual ~ErrorAction();
 

src/Actions/GraphAction/SubgraphDissectionAction.cpp

@@ -78 +78 @@
 
 GraphSubgraphDissectionAction::GraphSubgraphDissectionAction() :
-  MakroAction(ActionTraits< GraphSubgraphDissectionAction >(), actions, false)
+  MakroAction(ActionTraits< GraphSubgraphDissectionAction >(), actions)
 {}
 

src/Actions/MakroAction.cpp

@@ -61 +61 @@
 };
 
-MakroAction::MakroAction(const ActionTrait &_trait,ActionSequence& _actions, ActionRegistry * const _AR) :
-Action(_trait,_AR),
-actions(_actions)
+MakroAction::MakroAction(const ActionTrait &_trait,ActionSequence& _actions) :
+    Action(_trait),
+    actions(_actions)
 {
 }

src/Actions/MakroAction.hpp

@@ -31 +31 @@
 {
 public:
-  MakroAction(const ActionTrait &_trait,ActionSequence& _actions, ActionRegistry * const _AR=NULL);
+  MakroAction(const ActionTrait &_trait,ActionSequence& _actions);
   virtual ~MakroAction();
 

src/Actions/MakroAction_impl_pre.hpp

@@ -235 +235 @@
 // =========== constructor ===========
 ACTION::ACTION () :
-  MakroAction(ActionTraits< ACTION >(), actions, NULL)
+  MakroAction(ActionTraits< ACTION >(), actions)
 {}
 

src/Actions/ManipulateAtomsProcess.cpp

@@ -47 +47 @@
     boost::function<void(atom*)> _operation,
     AtomDescriptor _descr,
-    const ActionTrait &_trait,
-    ActionRegistry * const _AR) :
-  Process(0,_trait,_AR),
+    const ActionTrait &_trait) :
+  Process(0,_trait),
   descr(_descr),
   operation(_operation)

src/Actions/ManipulateAtomsProcess.hpp

@@ -30 +30 @@
 {
 public:
-  ManipulateAtomsProcess(boost::function<void(atom*)> _operation, AtomDescriptor descr,const ActionTrait &_trait,ActionRegistry * const _AR);
+  ManipulateAtomsProcess(boost::function<void(atom*)> _operation, AtomDescriptor descr,const ActionTrait &_trait);
   virtual ~ManipulateAtomsProcess();
 

src/Actions/MethodAction.cpp

@@ -44 +44 @@
 using namespace MoleCuilder;
 
-MethodAction::MethodAction(const ActionTrait &_trait,boost::function<void()> _executeMethod,ActionRegistry * const _AR) :
-   Action(_trait,_AR),
+MethodAction::MethodAction(const ActionTrait &_trait,boost::function<void()> _executeMethod) :
+   Action(_trait),
 executeMethod(_executeMethod)
 {

src/Actions/MethodAction.hpp

@@ -29 +29 @@
 {
 public:
-  MethodAction(const ActionTrait &_trait,boost::function<void()> _executeMethod,ActionRegistry * const _AR);
+  MethodAction(const ActionTrait &_trait,boost::function<void()> _executeMethod);
   virtual ~MethodAction();
   virtual bool canUndo();

src/Actions/OptionRegistry.hpp

@@ -28 +28 @@
  *
  */
-class OptionRegistry : public Singleton<OptionRegistry>, public Registry<OptionTrait>
+class OptionRegistry : public Singleton<OptionRegistry>, public ::Registry<OptionTrait>
 {
   friend class Singleton<OptionRegistry>;

src/Actions/Process.cpp

@@ -41 +41 @@
 using namespace MoleCuilder;
 
-Process::Process(int _maxSteps, const ActionTrait &_trait, ActionRegistry * const _AR) :
-  Action(_trait,_AR),
+Process::Process(int _maxSteps, const ActionTrait &_trait) :
+  Action(_trait),
   Observable("Process"),
   maxSteps(_maxSteps),

src/Actions/Process.hpp

@@ -51 +51 @@
 {
 public:
-  Process(int _maxSteps, const ActionTrait &_trait, ActionRegistry * const _AR);
+  Process(int _maxSteps, const ActionTrait &_trait);
   virtual ~Process();
 

src/Actions/Reaction.hpp

@@ -30 +30 @@
 {
 public:
-  Reaction(const ActionTrait &_trait, ActionRegistry * const _AR=NULL);
+  Reaction(const ActionTrait &_trait);
   virtual ~Reaction();
 

src/Actions/Reaction_impl.hpp

@@ -23 +23 @@
 
 template<typename T>
-Reaction<T>::Reaction(const ActionTrait &_trait, ActionRegistry * const _AR) :
-  Action(_trait,_AR),
+Reaction<T>::Reaction(const ActionTrait &_trait) :
+  Action(_trait),
   result(0),
   done(false)

src/Actions/Reaction_impl_pre.hpp

@@ -163 +163 @@
 // =========== constructor ===========
 REACTION::REACTION () :
-  Reaction< RETURNTYPE >(ActionTraits< REACTION >(), NULL)
+  Reaction< RETURNTYPE >(ActionTraits< REACTION >())
 {}
 

src/Actions/unittests/ActionSequenceUnitTest.cpp

@@ -62 +62 @@
 public:
   canUndoActionStub(const ActionTrait &_trait):
-    Action(_trait,NULL){}
+    Action(_trait){}
   virtual ~canUndoActionStub(){}
 
@@ -91 +91 @@
 public:
   cannotUndoActionStub(const ActionTrait &_trait) :
-    Action(_trait,NULL){}
+    Action(_trait){}
   virtual ~cannotUndoActionStub(){}
 
@@ -120 +120 @@
 public:
   wasCalledActionStub(const ActionTrait &_trait) :
-      Action(_trait,NULL),
+      Action(_trait),
       called(false)
   {}
@@ -277 +277 @@
 
   ActionTrait MakroTrait("Test MakroAction");
-  MakroAction act(MakroTrait,*sequence,NULL);
+  MakroAction act(MakroTrait,*sequence);
 
   act.call();

src/UIElements/Menu/TextMenu/TextMenu.hpp

@@ -155 +155 @@
         token,
         lastposition(token)+2); // have a separator in between
-    new TxMenu::LeaveAction(NewMenu->getMenuInstance(), leaveTrait);
+    MoleCuilder::Action *_action = new TxMenu::LeaveAction(NewMenu->getMenuInstance(), leaveTrait);
+    MoleCuilder::ActionQueue::getInstance().registerAction(_action);
     NewMenu->init();
     new ActionMenuItem('q',"leave"+token,NewMenu->getMenuInstance(),"leave"+token);

src/UIElements/Menu/TextMenu/TxMenuLeaveAction.cpp

@@ -48 +48 @@
  */
 TxMenu::LeaveAction::LeaveAction(TxMenu* const _menu, const ActionTrait & LeaveActionTrait) :
-  Action(LeaveActionTrait, &ActionQueue::getInstance().getActionRegistry()),
+  Action(LeaveActionTrait),
   menu(_menu)
 {}

src/UIElements/TextUI/TextWindow.cpp

@@ -91 +91 @@
   // create a specific quit action for this UI and store in registry
   ActionTrait quitTrait(OptionTrait("quit", &typeid(void), "quits the program"));
-  quitAction = new MethodAction(quitTrait,boost::bind(&TxMenu::doQuit,main_menu->getMenuInstance()),&ActionQueue::getInstance().getActionRegistry());
+  quitAction = new MethodAction(quitTrait,boost::bind(&TxMenu::doQuit,main_menu->getMenuInstance()));
+  MoleCuilder::ActionQueue::getInstance().registerAction(quitAction);
   new ActionMenuItem('q',"quit",main_menu->getMenuInstance(),"quit");
 
@@ -100 +101 @@
 TextWindow::~TextWindow()
 {
-  for (std::list<Action *>::iterator iter = returnFromActions.begin();
-      !returnFromActions.empty();
-      iter = returnFromActions.begin()) {
-    delete (*iter);
-    returnFromActions.erase(iter);
-  }
   delete moleculeView;
   delete statusIndicator;

src/UIElements/TextUI/TextWindow.hpp

@@ -41 +41 @@
   TextMenu<TxMenu> *main_menu;
 
-  // some actions only needed in textMenus
-  std::list<MoleCuilder::Action *> returnFromActions;
   MoleCuilder::Action *quitAction;
   // all views that are contained in the main Menu

src/World.cpp

@@ -373 +373 @@
 ManipulateAtomsProcess* World::manipulateAtoms(boost::function<void(atom*)> op,std::string name,AtomDescriptor descr){
   ActionTrait manipulateTrait(name);
-  return new ManipulateAtomsProcess(op, descr,manipulateTrait,NULL);
+  return new ManipulateAtomsProcess(op, descr,manipulateTrait);
 }