source: src/Actions/Action_impl_header.hpp@ 3139b2

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
Last change on this file since 3139b2 was 3139b2, checked in by Frederik Heber <heber@…>, 13 years ago

Renamed ActionTrait and ActionTraits.

  • the specialized Trait contains multiple OptionTraits, hence is now called ActionTrait_s_, where its base class (that just has the OptionTrait for itself) is called ActionTrait.
  • This caused many changes in other Action related files.
  • Property mode set to 100644
File size: 7.5 KB
Line 
1/*
2 * Action_impl_header.hpp
3 *
4 * Created on: Aug 25, 2010
5 * Author: heber
6 */
7
8// include config.h
9#ifdef HAVE_CONFIG_H
10#include <config.h>
11#endif
12
13#include <boost/preprocessor/cat.hpp>
14#include <boost/preprocessor/comparison/equal.hpp>
15#include <boost/preprocessor/comparison/not_equal.hpp>
16#include <boost/preprocessor/control/if.hpp>
17#include <boost/preprocessor/debug/assert.hpp>
18#include <boost/preprocessor/iteration/local.hpp>
19#include <boost/preprocessor/punctuation/comma_if.hpp>
20#include <boost/preprocessor/repetition/repeat.hpp>
21#include <boost/preprocessor/seq/elem.hpp>
22#include <boost/preprocessor/seq/push_back.hpp>
23#include <boost/preprocessor/seq/seq.hpp>
24#include <boost/preprocessor/seq/size.hpp>
25#include <boost/preprocessor/seq/transform.hpp>
26
27#include <iostream>
28#include <typeinfo>
29
30#include "Actions/ActionTraits.hpp"
31#include "Actions/ValueStorage.hpp"
32
33// some derived names: if CATEGORY is not given, we don't prefix with it
34#ifdef CATEGORY
35#define ACTION BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Action))
36#define COMMAND BOOST_PP_CAT(CATEGORY, ACTIONNAME)
37#define PARAMS BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Parameters))
38#else
39#define ACTION BOOST_PP_CAT(ACTIONNAME, Action)
40#define COMMAND ACTIONNAME
41#define PARAMS BOOST_PP_CAT(ACTIONNAME, Parameters)
42#endif
43// check if no lists given
44#ifndef paramtypes
45#define MAXPARAMTYPES 0
46#else
47#define MAXPARAMTYPES BOOST_PP_SEQ_SIZE(paramtypes)
48#endif
49
50// check user has given name and category
51#ifndef ACTIONNAME
52ERROR: No "ACTIONNAME" defined in: __FILE__
53#endif
54
55// calculate numbers and check whether all have same size
56#ifdef paramtokens
57BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramtokens)),\
58 ERROR: There are not the same number of "paramtokens" and "paramtypes" in: __FILE__ \
59)
60#endif
61#ifdef paramreferences
62BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramreferences)),\
63 ERROR: There are not the same number of "paramtokens" and "paramreferences" in: __FILE__ \
64)
65#endif
66#ifdef paramdescriptions
67BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramdescriptions)),\
68 ERROR: There are not the same number of "paramtokens" and "paramdescriptions" in: __FILE__ \
69)
70#endif
71
72// check for mandatory defines
73#ifndef DESCRIPTION
74BOOST_PP_ASSERT_MSG(0, \
75 "ERROR: Description is mandatory for Actions, here for ACTION " \
76)
77#endif
78
79// check if paramdefaults is given, otherwise fill list with NODEFAULT
80// this does not work: paramdefaults has to be completely defined before
81// being used within option_print (used as an array there and not as
82// some function call still to be expanded)
83//#define paramdefaults (NODEFAULT)
84//#define tempvalue(z,n,value)
85// BOOST_PP_CAT(value,(NODEFAULT))
86//BOOST_PP_REPEAT(tempvalue, MAXPARAMTYPES, paramdefaults)
87//#undef tempvalue
88//#else
89
90// if present, check if correct number of arguments
91#ifdef paramdefaults
92BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramdefaults)),\
93 ERROR: There are not the same number of "paramtokens" and "paramdefaults" in: __FILE__ \
94)
95#endif
96
97// print a list of type ref followed by a separator, i.e. "int i;"
98#define type_print(z,n,TYPELIST, VARLIST, separator) \
99 BOOST_PP_SEQ_ELEM(n, TYPELIST) \
100 BOOST_PP_SEQ_ELEM(n, VARLIST)\
101 separator
102
103// print a list of type ref followed, i.e. "int i, double position"
104#define type_list(z,n,TYPELIST, VARLIST) \
105 BOOST_PP_COMMA_IF(n)\
106 BOOST_PP_SEQ_ELEM(n, TYPELIST) \
107 BOOST_PP_SEQ_ELEM(n, VARLIST)
108
109// prints Options.insert
110#ifdef paramdefaults
111#define option_print(z,n,unused, unused2) \
112 tester = Options. insert (\
113 std::pair< std::string, OptionTrait *> ( \
114 BOOST_PP_SEQ_ELEM(n, paramtokens), \
115 new OptionTrait(\
116 BOOST_PP_SEQ_ELEM(n, paramtokens), \
117 &typeid( BOOST_PP_SEQ_ELEM(n, paramtypes) ), \
118 BOOST_PP_SEQ_ELEM(n, paramdescriptions), \
119 std::string( BOOST_PP_SEQ_ELEM(n, paramdefaults) ) )\
120 )\
121 ); \
122 ASSERT(tester.second, "ActionTrait<ACTION>::ActionTrait<ACTION>() option token present twice!");
123#else
124#define option_print(z,n,unused, unused2) \
125 tester = Options. insert (\
126 std::pair< std::string, OptionTrait *> ( \
127 BOOST_PP_SEQ_ELEM(n, paramtokens), \
128 new OptionTrait(\
129 BOOST_PP_SEQ_ELEM(n, paramtokens), \
130 &typeid( BOOST_PP_SEQ_ELEM(n, paramtypes) ), \
131 BOOST_PP_SEQ_ELEM(n, paramdescriptions), \
132 NODEFAULT )\
133 )\
134 ); \
135 ASSERT(tester.second, "ActionTrait<ACTION>::ActionTrait<ACTION>() option token present twice!");
136#endif
137
138namespace MoleCuilder {
139
140void COMMAND(
141#if defined paramtypes && defined paramreferences
142#define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, paramtypes, paramreferences)
143#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
144#include BOOST_PP_LOCAL_ITERATE()
145#endif
146 );
147
148class ACTION;
149
150template <>
151class ActionTraits<ACTION> : public ActionTrait {
152public:
153 ActionTraits() :
154#ifndef SHORTFORM
155 ActionTrait(OptionTrait(TOKEN, &typeid(void), DESCRIPTION, std::string()))
156#else
157 ActionTrait(OptionTrait(TOKEN, &typeid(void), DESCRIPTION, std::string(), SHORTFORM))
158#endif /* SHORTFORM */
159 {
160 // initialize remainder of action info
161#ifdef MENUNAME
162 MenuTitle = MENUNAME;
163#endif
164#ifdef MENUPOSITION
165 MenuPosition = MENUPOSITION;
166#endif
167
168 // initialize action's options
169 std::pair< ActionTrait::options_iterator, bool > tester;
170#ifdef paramtokens
171#define BOOST_PP_LOCAL_MACRO(n) option_print(~, n, ~, )
172#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
173#include BOOST_PP_LOCAL_ITERATE()
174#endif
175 // associate action's short form also with option
176#ifdef SHORTFORM
177 if (Options.find(TOKEN) != Options.end())
178 Options[TOKEN]->setShortForm(std::string(SHORTFORM));
179#endif /* SHORTFORM */
180 //std::cout << "ActionTraits<" << BOOST_PP_STRINGIZE(ACTION) << ">::ActionTraits() on instance " << this << " with " << getName() << ", type " << getTypeName() << " and description " << getDescription() << std::endl;
181 }
182
183 virtual ~ActionTraits() {
184 //std::cout << "ActionTraits<" << BOOST_PP_STRINGIZE(ACTION) << ">::~ActionTraits() on instance " << this << " with name " << getName() << " called." << std::endl;
185 }
186};
187
188class ACTION : public Action {
189 #if defined paramtypes && defined paramreferences
190 friend void COMMAND(
191 #define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, paramtypes, paramreferences)
192 #define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
193 #include BOOST_PP_LOCAL_ITERATE()
194 );
195 # else
196 void COMMAND();
197 #endif
198
199public:
200 ACTION();
201 virtual ~ACTION();
202
203 bool canUndo();
204 bool shouldUndo();
205
206 struct PARAMS : ActionParameters {
207 #if defined paramtypes && defined paramreferences
208 #define BOOST_PP_LOCAL_MACRO(n) type_print(~, n, paramtypes, paramreferences, ;)
209 #define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
210 #include BOOST_PP_LOCAL_ITERATE()
211 #endif
212 } params;
213
214protected:
215 virtual Dialog * fillDialog(Dialog*);
216
217 void startTimer() const;
218 void endTimer() const;
219
220private:
221 virtual void getParametersfromValueStorage();
222 virtual Action::state_ptr performCall();
223 virtual Action::state_ptr performUndo(Action::state_ptr);
224 virtual Action::state_ptr performRedo(Action::state_ptr);
225};
226
227}
228
229#undef paramtypes
230#undef paramtokens
231#undef paramreferences
232#undef paramdescriptions
233#undef paramdefaults
234#undef MAXPARAMTYPES
235#undef statetypes
236#undef statereferences
237#undef MAXSTATETYPES
238
239#undef option_print
240#undef type_print
241#undef type_list
242
243#undef ACTION
244#undef COMMAND
245#undef COMMANDFULL
246#undef PARAMS
247
248#undef ACTIONNAME
249#undef CATEGORY
250#undef MENUNAME
251#undef MENUPOSITION
252#undef TOKEN
253
254#undef DESCRIPTION
255#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.