Changeset e4afb4 for src/Actions/Action_impl_header.hpp

Timestamp:

Oct 30, 2010, 8:42:44 PM (15 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:

76cec6, c38826

Parents:

23359f

git-author:

Frederik Heber <heber@…> (10/30/10 19:55:54)

git-committer:

Frederik Heber <heber@…> (10/30/10 20:42:44)

Message:

Huge refactoring: Introduction of Traits to Actions.

This change is really big but the introduction of the Trait concept (at least
in its current light form) is so fundamental that lots of pieces had to be
changed in order to get everything working.

The main point why it was necessary to add these traits in the first place was
to comfortably allow for adding extension of Actions information-wise, i.e.
with stuff that is only important for the QtUI, such as icons, or tooltips, ...
This extra information should not be stored with Action itself, as it has
nothing to do with the workings of the Action. And neither should it get
stored with some blown-out-of-proportions MapOfActions class ...

The gist of the change is as follows:

• OptionTrait contains the token, description, shortform and type of an option, such as ("position", "position in space, none, typeid(Vector)).
• ActionTrait is the derived form for actions where additionally MenuPosition and MenuName are stored (and probably more to come for the GUI), also we have a set of OptionTrait instances, one for each option of the Action.
• Action then contains this ActionTrait, specialized for each Action.
• the preprocessor macros have been enhanced to gather all this information from the .def files.
• MapOfActions is gone. Completely. Most of its use was to store this extra information and the ValueStorage part now is just in class ValueStorage.
• ValueStorage is no more an interface to MapOfActions but as the name says a (type-safe) ValueStorage.

Listing the (remaining) changes in alphabetical order of the class:

• Action
  • member value ::name dropped, ::getName() uses ActionTraits::getName()
  • new define NODEFAULT which is used in paramdefaults in .def files
  • all derived actions classes such as Process, Calculations, MakroAction,... have been adapated to use the ActionTrait concept as well.

• ActionHistory
  • extraced RedoAction and UndoAction, shifted implementation into their own object files and they use .def files as well (i.e. streamlined with method used for other actions)

• CommandLineParser
  • CommandLineParser goes through ActionRegistry to get arguments and types to add
  • we use TypeEnumContainer which before was present in MapOfActions, as CommandLineParser::AddOptionsToParser() needs enums in its switch statement, we can't switch on types and types are not known until run-time. Hence, templates won't do either.
  • ShortFormMap is created here now (and used here only)
  • File was moved over to UIElements/CommandLineUI.

• MenuDescription
  • contain information on Menus such as name, ...
  • new unit test checks for consistency

• molecule
  • const member functions: Copy(), Output() and OutputBonds()

• OptionRegistry
  • new registry class for options only
  • we want the same type throughout the code for each token, e.g. "position"
  • the registry containts checks for consistency

• OptionTrait
  • default values are specified in paramdefaults, none are given by NODEFAULT
  • introduced default for translate-atoms, point-correlation, pair-correlation

• Registry pattern
  • new unit test, but only sceleton code so far

• ...Query, also ...Pipe
  • atoms, molecule and elements are now all const
  • also ValueStorage's signatures all have const therein

• ValueStorage
  • set/queryCurrentValue from MapOfActions
  • at times VectorValue has been in .def files where Vector was in the signature. This is cleared. Such stuff is only present for e.g. BoxVector being queried as a Vector. But this is a feature and intended.

• World
  • most of the (un)selection functions now work on const atoms and molecules
  • in one case we need a const_cast to remove this, but this is intentional, as the vector of selected atoms stores non-const pointers and this is ok.

There is only one test which had to be changed slightly because a specific
option token as "position" must now have the same type everywhere, e.g. always
Vector.

• TESTFIX: Simple_configuration/2: --position -> --domain-position (and associated to BoxVector)

File:

• src/Actions/Action_impl_header.hpp (modified) (11 diffs)

src/Actions/Action_impl_header.hpp

@@ -20 +20 @@
 #include <boost/preprocessor/seq/transform.hpp>
 
+#include <iostream>
+#include <typeinfo>
+
+#include "Actions/ActionTraits.hpp"
+#include "Actions/OptionTrait.hpp"
 #include "Actions/ValueStorage.hpp"
 
-// some derived names
+// some derived names: if CATEGORY is not given, we don't prefix with it
+#ifdef CATEGORY
 #define ACTION BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Action))
 #define COMMAND BOOST_PP_CAT(CATEGORY, ACTIONNAME)
 #define PARAMS BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Parameters))
-
+#else
+#define ACTION BOOST_PP_CAT(ACTIONNAME, Action)
+#define COMMAND ACTIONNAME
+#define PARAMS BOOST_PP_CAT(ACTIONNAME, Parameters)
+#endif
 // check if no lists given
 #ifndef paramtypes
@@ -35 +45 @@
 
 // check user has given name and category
-#ifndef CATEGORY
-ERROR: No "CATEGORY" defined in: __FILE__
-#endif
-
 #ifndef ACTIONNAME
 ERROR: No "ACTIONNAME" defined in: __FILE__
@@ -66 +72 @@
 )
 #endif
-#ifndef TYPEINFO
-BOOST_PP_ASSERT_MSG(0, \
-    "ERROR: Type is mandatory for Actions, here for ACTION " \
+
+// check if paramdefaults is given, otherwise fill list with NODEFAULT
+// this does not work: paramdefaults has to be completely defined before
+// being used within option_print (used as an array there and not as
+// some function call still to be expanded)
+//#define paramdefaults (NODEFAULT)
+//#define tempvalue(z,n,value)
+//  BOOST_PP_CAT(value,(NODEFAULT))
+//BOOST_PP_REPEAT(tempvalue, MAXPARAMTYPES, paramdefaults)
+//#undef tempvalue
+//#else
+
+// if present, check if correct number of arguments
+#ifdef paramdefaults
+BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramdefaults)),\
+  ERROR: There are not the same number of "paramtokens" and "paramdefaults" in: __FILE__ \
 )
 #endif
@@ -84 +103 @@
   BOOST_PP_SEQ_ELEM(n, VARLIST)
 
-// prints OptionDescription.insert
-#define optiondescription_print(z,n,unused, unused2) \
-  OptionDescription. insert (\
-      pair<std::string, std::string> (\
-  BOOST_PP_SEQ_ELEM(n, paramtokens), \
-  BOOST_PP_SEQ_ELEM(n, paramdescriptions) )\
-  );
-
+// prints Options.insert
+#ifdef paramdefaults
+#define option_print(z,n,unused, unused2) \
+  tester = Options. insert (\
+      std::pair< std::string, OptionTrait *> ( \
+      BOOST_PP_SEQ_ELEM(n, paramtokens), \
+      new OptionTrait(\
+          BOOST_PP_SEQ_ELEM(n, paramtokens), \
+          &typeid( BOOST_PP_SEQ_ELEM(n, paramtypes) ), \
+          BOOST_PP_SEQ_ELEM(n, paramdescriptions), \
+          BOOST_PP_SEQ_ELEM(n, paramdefaults) )\
+      )\
+  ); \
+  ASSERT(tester.second, "ActionTrait<ACTION>::ActionTrait<ACTION>() option token present twice!");
+#else
+#define option_print(z,n,unused, unused2) \
+  tester = Options. insert (\
+      std::pair< std::string, OptionTrait *> ( \
+      BOOST_PP_SEQ_ELEM(n, paramtokens), \
+      new OptionTrait(\
+          BOOST_PP_SEQ_ELEM(n, paramtokens), \
+          &typeid( BOOST_PP_SEQ_ELEM(n, paramtypes) ), \
+          BOOST_PP_SEQ_ELEM(n, paramdescriptions), \
+          NODEFAULT )\
+      )\
+  ); \
+  ASSERT(tester.second, "ActionTrait<ACTION>::ActionTrait<ACTION>() option token present twice!");
+#endif
 
 #if defined paramtypes && defined paramreferences
@@ -108 +147 @@
 class ActionTrait<ACTION> : public ActionTraits {
 public:
-  ActionTrait()
+  ActionTrait() :
+#ifndef SHORTFORM
+    ActionTraits(OptionTrait(TOKEN, &typeid(void), DESCRIPTION, std::string()))
+#else
+    ActionTraits(OptionTrait(TOKEN, &typeid(void), DESCRIPTION, std::string(), SHORTFORM))
+#endif /* SHORTFORM */
   {
-#ifdef DEFAULTVALUE
-    CurrentValue = DEFAULTVALUE;
-#endif
-#ifdef DESCRIPTION
-    Description = DESCRIPTION;
-#endif
-#ifdef paramdescriptions
-#define BOOST_PP_LOCAL_MACRO(n) optiondescription_print(~, n, ~, )
+  // initialize remainder of action info
+#ifdef MENUNAME
+    MenuTitle = MENUNAME;
+#endif
+#ifdef MENUPOSITION
+    MenuPosition = MENUPOSITION;
+#endif
+
+  // initialize action's options
+  std::pair< ActionTraits::options_iterator, bool > tester;
+#ifdef paramtokens
+#define BOOST_PP_LOCAL_MACRO(n) option_print(~, n, ~, )
 #define BOOST_PP_LOCAL_LIMITS  (0, MAXPARAMTYPES-1)
 #include BOOST_PP_LOCAL_ITERATE()
 #endif
-#ifdef MENUNAME
-    MenuTitle = MENUNAME;
-#endif
-#ifdef MENUPOSITION
-    MenuPosition = MENUPOSITION;
-#endif
+  // associate action's short form also with option
 #ifdef SHORTFORM
-    ShortForm = SHORTFORM;
-#endif
-#ifdef TYPEINFO
-    InternalType = TYPEINFO;
-#endif
+  if (Options.find(TOKEN) != Options.end())
+    Options[TOKEN]->setShortForm(std::string(SHORTFORM));
+#endif /* SHORTFORM */
+  std::cout << "ActionTrait<ACTION>::ActionTrait() with " << getName() << ", type " << getTypeName() << " and description " << getDescription() << std::endl;
   }
 
@@ -139 +181 @@
 
 class ACTION : public Action {
-  friend
   #if defined paramtypes && defined paramreferences
-  void COMMAND(
+  friend void COMMAND(
   #define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, paramtypes, paramreferences)
   #define BOOST_PP_LOCAL_LIMITS  (0, MAXPARAMTYPES-1)
@@ -157 +198 @@
   bool shouldUndo();
 
-  virtual const std::string getName();
-
   struct PARAMS : ActionParameters {
   #if defined paramtypes && defined paramreferences
@@ -167 +206 @@
   } params;
 
-  ActionTrait<ACTION> Traits;
-
 protected:
   virtual Dialog * fillDialog(Dialog*);
@@ -176 +213 @@
   virtual Action::state_ptr performUndo(Action::state_ptr);
   virtual Action::state_ptr performRedo(Action::state_ptr);
-
-  static const char NAME[];
 };
 
@@ -183 +218 @@
 #undef paramtokens
 #undef paramreferences
+#undef paramdescriptions
+#undef paramdefaults
 #undef MAXPARAMTYPES
 #undef statetypes
@@ -195 +232 @@
 #undef ACTIONNAME
 #undef CATEGORY
+#undef MENUNAME
+#undef MENUPOSITION
 #undef TOKEN
+
+#undef DESCRIPTION
+#undef SHORTFORM