source: src/Actions/Action_impl_pre.hpp@ 2a6a2c

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 2a6a2c was 2a6a2c, checked in by Frederik Heber <heber@…>, 14 years ago

Removed MapOfActions::populateActions().

  • Action prototypes are now instantiated within the object file, as they register automatically with the ActionRegistry and can henceforth be used.
    • new define INSTANCE with a sort of unique name.
    • instance is const and hence not to be used directly.
    • MapOfActions::populateActions() removed in CommandLineWindow, QtMainWindow and TextWindow classes.
    • NOTE: this hopefully remedies the problem of forgetting to add new Actions.
  • Registry does not cleanup() in its destructor, but function may be called from derived class if desired.
    • All Action prototypes are destroyed at end of program and hence cleanup() would cause memory corruption.
  • Property mode set to 100644
File size: 7.4 KB
Line 
1/*
2 * Action_impl.hpp
3 *
4 * Created on: Aug 25, 2010
5 * Author: heber
6 */
7
8/** These macros define the following functions, necessary but repetitive for
9 * every Action:
10 * -# Dialog* fillDialog()
11 * -# action command (e.g. AnalysisMolecularVolume() )
12 * -# void getParametersfromValuStorage()
13 * -# struct Action...Parameters
14 *
15 * For this, the user has the define the following values, each with
16 * parenthesis, for the values/parameters the action needs
17 * -# paramtypes, e.g. (int)(double)
18 * -# paramtokens, e.g. ("Z")("length")
19 * -# paramreferences, e.g. (Z)(length)
20 * and for additional values/parameters to save in the state
21 * -# statetypes, e.g. (int)(double)
22 * -# statereferences, e.g. (Z)(length)
23 * and the name and category of the action
24 * -# CATEGORY, e.g. Analysis
25 * -# ACTIONNAME, e.g. MolecularVolume
26 */
27
28
29#include <boost/preprocessor/cat.hpp>
30#include <boost/preprocessor/expand.hpp>
31#include <boost/preprocessor/comparison/equal.hpp>
32#include <boost/preprocessor/comparison/not_equal.hpp>
33#include <boost/preprocessor/control/if.hpp>
34#include <boost/preprocessor/debug/assert.hpp>
35#include <boost/preprocessor/iteration/local.hpp>
36#include <boost/preprocessor/punctuation/comma_if.hpp>
37#include <boost/preprocessor/repetition/repeat.hpp>
38#include <boost/preprocessor/seq/elem.hpp>
39#include <boost/preprocessor/seq/push_back.hpp>
40#include <boost/preprocessor/seq/seq.hpp>
41#include <boost/preprocessor/seq/size.hpp>
42#include <boost/preprocessor/seq/transform.hpp>
43
44// some derived names
45#define ACTION BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Action))
46#define COMMAND BOOST_PP_CAT(CATEGORY, ACTIONNAME)
47#define STATE BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, State))
48#define PARAMS BOOST_PP_CAT(CATEGORY, BOOST_PP_CAT(ACTIONNAME, Parameters))
49#define INSTANCE BOOST_PP_CAT(this_, BOOST_PP_CAT(ACTIONNAME, _instance))
50
51// check if no lists given
52#ifndef paramtypes
53#define MAXPARAMTYPES 0
54#else
55#define MAXPARAMTYPES BOOST_PP_SEQ_SIZE(paramtypes)
56#endif
57#ifndef statetypes
58#define MAXSTATETYPES 0
59#else
60#define MAXSTATETYPES BOOST_PP_SEQ_SIZE(statetypes)
61#endif
62
63// check user has given name and category
64#ifndef CATEGORY
65ERROR: No "CATEGORY" defined in: __FILE__
66#endif
67
68#ifndef ACTIONNAME
69ERROR: No "ACTIONNAME" defined in: __FILE__
70#endif
71
72// calculate numbers and check whether all have same size
73#ifdef paramtokens
74BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramtokens)),\
75 ERROR: There are not the same number of "paramtokens" and "paramtypes" in: __FILE__ \
76)
77#endif
78#ifdef paramreferences
79BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramreferences)),\
80 ERROR: There are not the same number of "paramtokens" and "paramreferences" in: __FILE__ \
81)
82#endif
83
84#ifdef statetypes
85BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXSTATETYPES, BOOST_PP_SEQ_SIZE(statereferences)),\
86 ERROR: There are not the same number of "statetypes" and "statereferences" in: __FILE__ \
87)
88#endif
89
90// print a list of type ref followed by a separator, i.e. "int i;"
91#define initialiser_print(z,n,initialiserlist) \
92 BOOST_PP_SEQ_ELEM(n, initialiserlist) \
93 (BOOST_PP_CAT(_, BOOST_PP_SEQ_ELEM(n, initialiserlist))),
94
95// print a list of ref(_ref) followed by a separator, i.e. "id(_id),"
96#define type_print(z,n,TYPELIST, VARLIST, separator) \
97 BOOST_PP_SEQ_ELEM(n, TYPELIST) \
98 BOOST_PP_SEQ_ELEM(n, VARLIST)\
99 separator
100
101// print a list of type ref followed, i.e. "int i, double position"
102#define type_list(z,n,TYPELIST,VARLIST) \
103 BOOST_PP_COMMA_IF(n)\
104 BOOST_PP_SEQ_ELEM(n, TYPELIST) \
105 BOOST_PP_SEQ_ELEM(n, VARLIST)
106
107// prints dialog->query calls for paramtypes with tokens
108#define dialog_print(z,n,unused) \
109 dialog->query<\
110 BOOST_PP_SEQ_ELEM(n, paramtypes)\
111 >(\
112 BOOST_PP_SEQ_ELEM(n, paramtokens)\
113 , ValueStorage::getInstance().getDescription(\
114 BOOST_PP_SEQ_ELEM(n, paramtokens)\
115 ));
116
117// prints set/queryCurrentValue (command) for paramreferences and paramtokens
118#define value_print(z,n,command, prefix) \
119 ValueStorage::getInstance(). command (\
120 BOOST_PP_SEQ_ELEM(n, paramtokens)\
121 , \
122 prefix\
123 BOOST_PP_SEQ_ELEM(n, paramreferences)\
124 );
125
126#include "Actions/ActionRegistry.hpp"
127#include "UIElements/Dialog.hpp"
128#include "Actions/ValueStorage.hpp"
129
130
131// =========== memento to remember the state when undoing ===========
132class STATE : public ActionState {
133public:
134 STATE(
135#if defined statetypes && defined statereferences // if we have parameters, we have to add "_" before each reference and add the params as the last one
136#define OP(s,data,elem) BOOST_PP_CAT(data, elem) // OP to add "_"
137#define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, BOOST_PP_SEQ_PUSH_BACK(statetypes, const ACTION::PARAMS &), BOOST_PP_SEQ_TRANSFORM(OP, _, BOOST_PP_SEQ_PUSH_BACK(statereferences, params)))
138#else /// if not, params is only list
139#define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, (const ACTION::PARAMS &), (_params))
140#endif
141#define BOOST_PP_LOCAL_LIMITS (0, MAXSTATETYPES)
142#include BOOST_PP_LOCAL_ITERATE()
143) :
144#if defined statetypes && defined statereferences // do we have parameters at all?
145BOOST_PP_REPEAT(MAXSTATETYPES, initialiser_print, statereferences)
146#endif
147params(_params)
148 {}
149
150#if defined statetypes && defined statereferences // do we have parameters at all?
151#define BOOST_PP_LOCAL_MACRO(n) type_print(~, n, statetypes, statereferences, ;)
152#define BOOST_PP_LOCAL_LIMITS (0, MAXSTATETYPES-1)
153#include BOOST_PP_LOCAL_ITERATE()
154#endif
155 ACTION::PARAMS params;
156};
157
158// =========== name of action ===========
159const char ACTION::NAME[] = TOKEN;
160
161// (const) prototype to be placed into the ActionRegistry (must be deleted by registry itself)
162const ACTION INSTANCE;
163
164// =========== constructor ===========
165ACTION::ACTION () :
166 Action(NAME)
167{}
168
169// =========== destructor ===========
170ACTION::~ACTION ()
171{}
172
173// =========== fill a dialog ===========
174Dialog* ACTION::fillDialog(Dialog *dialog) {
175 ASSERT(dialog,"No Dialog given when filling actionname's dialog");
176#if BOOST_PP_EQUAL(MAXPARAMTYPES,0)
177 dialog->queryEmpty(NAME, Traits.getDescription());
178#else
179#define BOOST_PP_LOCAL_MACRO(n) dialog_print(~, n, ~)
180#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
181#include BOOST_PP_LOCAL_ITERATE()
182#endif
183 return dialog;
184};
185
186// =========== command for calling action directly ===========
187#if defined paramtypes && defined paramreferences
188void COMMAND(
189#define BOOST_PP_LOCAL_MACRO(n) type_list(~, n, paramtypes, paramreferences)
190#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
191#include BOOST_PP_LOCAL_ITERATE()
192)
193#else
194void COMMAND()
195#endif
196{
197 ACTION::PARAMS params;
198 Action *ToCall = ActionRegistry::getInstance().getActionByName( ACTION::NAME ); //->clone(params);
199#if BOOST_PP_NOT_EQUAL(MAXPARAMTYPES,0)
200#define BOOST_PP_LOCAL_MACRO(n) value_print(~, n, setCurrentValue, )
201#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
202#include BOOST_PP_LOCAL_ITERATE()
203#endif
204 ToCall->call(Action::NonInteractive);
205};
206
207// =========== obtain parameters from Storage, used by performCall() ===========
208void ACTION::getParametersfromValueStorage() {
209#if BOOST_PP_NOT_EQUAL(MAXPARAMTYPES,0)
210#define BOOST_PP_LOCAL_MACRO(n) value_print(~, n, queryCurrentValue, params.)
211#define BOOST_PP_LOCAL_LIMITS (0, MAXPARAMTYPES-1)
212#include BOOST_PP_LOCAL_ITERATE()
213#endif
214};
215
216// free up defines
217#undef paramtypes
218#undef paramtokens
219#undef paramreferences
220#undef MAXPARAMTYPES
221#undef statetypes
222#undef statereferences
223#undef MAXSTATETYPES
224
225#undef ACTION
226#undef COMMAND
227#undef PARAMS
228#undef STATE
229#undef INSTANCE
230
231#undef ACTIONNAME
232#undef CATEGORY
233#undef TOKEN
Note: See TracBrowser for help on using the repository browser.