source: src/UIElements/TextUI/TextWindow.cpp@ e4afb4

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 v1.0.6
Last change on this file since e4afb4 was e4afb4, checked in by Frederik Heber <heber@…>, 14 years ago

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)
  • 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)
  • Property mode set to 100644
File size: 5.8 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/*
9 * TextWindow.cpp
10 *
11 * Created on: Jan 7, 2010
12 * Author: crueger
13 */
14
15// include config.h
16#ifdef HAVE_CONFIG_H
17#include <config.h>
18#endif
19
20#include "Helpers/MemDebug.hpp"
21
22#include <boost/bind.hpp>
23#include <boost/shared_ptr.hpp>
24
25#include "Menu/Menu.hpp"
26#include "Menu/MenuDescription.hpp"
27#include "Menu/TextMenu.hpp"
28#include "Menu/ActionMenuItem.hpp"
29#include "Menu/SeperatorItem.hpp"
30#include "Menu/DisplayMenuItem.hpp"
31#include "Menu/SubMenuItem.hpp"
32#include "TextUI/TextStatusIndicator.hpp"
33#include "TextUI/TextWindow.hpp"
34#include "Actions/MethodAction.hpp"
35#include "Actions/ErrorAction.hpp"
36#include "Actions/ActionRegistry.hpp"
37#include "Actions/ActionTraits.hpp"
38#include "Parser/ChangeTracker.hpp"
39#include "Views/StreamStringView.hpp"
40#include "Views/MethodStringView.hpp"
41
42#include "defs.hpp"
43#include "Helpers/Log.hpp"
44#include "Helpers/Verbose.hpp"
45
46// all needed due to config::SaveAll()
47#include "config.hpp"
48#include "periodentafel.hpp"
49
50// config::SaveAll() and enumerate()
51#include "molecule.hpp"
52
53#include <iostream>
54#include <map>
55
56// TODO: see what code can be moved to a base class for Graphic and Text Windows
57TextWindow::TextWindow()
58{
59 map <std::string, TextMenu *> NametoTextMenuMap;
60 std::set <char> ShortcutList;
61 // reserve s for save and q for quite
62 ShortcutList.insert('s');
63 ShortcutList.insert('q');
64
65 // build the main menu
66 main_menu = new TextMenu(Log() << Verbose(0), "Main Menu");
67
68 moleculeView = new StreamStringView(boost::bind(&MoleculeListClass::Enumerate,World::getInstance().getMolecules(),_1));
69 new DisplayMenuItem(main_menu,moleculeView,"Molecule List");
70
71 new SeperatorItem(main_menu);
72
73 Action* undoAction = ActionRegistry::getInstance().getActionByName("undo");
74 new ActionMenuItem(getSuitableShortForm(ShortcutList,"Undo last operation"),"Undo last operation",main_menu,undoAction);
75
76 Action* redoAction = ActionRegistry::getInstance().getActionByName("redo");
77 new ActionMenuItem(getSuitableShortForm(ShortcutList,"Redo last operation"),"Redo last operation",main_menu,redoAction);
78
79 new SeperatorItem(main_menu);
80
81 MenuDescription menudescriptions;
82 for(MenuDescription::const_iterator iter = menudescriptions.getBeginIter(); iter != menudescriptions.getEndIter(); ++iter) {
83 TextMenu *Menu = new TextMenu((ostream &)std::cout, menudescriptions.getDescription(*iter));
84 NametoTextMenuMap.insert( pair <std::string, TextMenu *> (*iter, Menu) );
85 new SubMenuItem(getSuitableShortForm(ShortcutList,*iter),menudescriptions.getDescription(*iter).c_str(),main_menu,Menu);
86 }
87
88 new SeperatorItem(main_menu);
89
90 // save has reserved key 's'
91 Action *saveConfigAction = ActionRegistry::getInstance().getActionByName("output");
92 new ActionMenuItem('s',"save current setup to config files",main_menu,saveConfigAction);
93
94 ActionTraits quitTrait(OptionTrait("quitAction", &typeid(void), "quits the program"));
95 quitAction = new MethodAction(quitTrait,boost::bind(&TextMenu::doQuit,main_menu),false);
96 new ActionMenuItem('q',"quit",main_menu,quitAction);
97
98 // quit has reserved key 'q'
99 // go through all menus and create them
100 for (map <std::string, TextMenu *>::iterator MenuRunner = NametoTextMenuMap.begin(); MenuRunner != NametoTextMenuMap.end(); ++MenuRunner)
101 populateMenu(MenuRunner->second, MenuRunner->first);
102
103 // Add status indicators etc...
104
105 statusIndicator = new TextStatusIndicator();
106}
107
108TextWindow::~TextWindow()
109{
110 for (std::list<Action *>::iterator iter = returnFromActions.begin(); !returnFromActions.empty(); ++iter)
111 delete (*iter);
112 returnFromActions.clear();
113 delete quitAction;
114 delete moleculeView;
115 delete statusIndicator;
116 delete main_menu;
117}
118
119void TextWindow::display() {
120 main_menu->display();
121}
122
123char TextWindow::getSuitableShortForm(std::set <char> &ShortcutList, const std::string name) const
124{
125 for (std::string::const_iterator CharRunner = name.begin(); CharRunner != name.end(); ++CharRunner) {
126 if (ShortcutList.find(*CharRunner) == ShortcutList.end()) {
127 ShortcutList.insert(*CharRunner);
128 return *CharRunner;
129 }
130 }
131 // if no letter matches, take digits
132 int i=0;
133 for (;i<10;++i) {
134 if (ShortcutList.find((char)i + '0') == ShortcutList.end())
135 break;
136 }
137 if (i != 10) {
138 ShortcutList.insert((char)i + '0');
139 return ((char)i + '0');
140 } else {
141 DoeLog(1) && (eLog() << Verbose(1) << "Could not find a suitable shortform for " << name << "." << endl);
142 return '#';
143 }
144}
145
146void TextWindow::populateMenu(TextMenu* Menu, const std::string &MenuName)
147{
148 Action *ActionItem = NULL;
149 set <char> ShortcutList;
150 // reserve 'q' for quit
151 ShortcutList.insert('q');
152 // through all actions for this menu
153 MenuDescription md;
154 std::multimap <std::string, std::string> MenuItems = md.getMenuItemsMap();
155 std::pair < std::multimap <std::string, std::string>::iterator, std::multimap <std::string, std::string>::iterator > MenuActions = MenuItems.equal_range(MenuName);
156 for (std::multimap <std::string, std::string>::const_iterator MenuRunner = MenuActions.first; MenuRunner != MenuActions.second; ++MenuRunner) {
157 ActionItem = ActionRegistry::getInstance().getActionByName(MenuRunner->second);
158 new ActionMenuItem(getSuitableShortForm(ShortcutList, MenuRunner->second),ActionItem->Traits.getDescription().c_str(),Menu,ActionItem);
159 }
160 // finally add default quit item
161 ActionTraits LeaveActionTraits("Leave menu: "+Menu->getTitle());
162 Action *returnFromAction = new TextMenu::LeaveAction(Menu, LeaveActionTraits);
163 //returnFromActions.push_back(returnFromAction);
164 MenuItem *returnFromItem = new ActionMenuItem('q',"return to Main menu",Menu,returnFromAction);
165 Menu->addDefault(returnFromItem);
166}
Note: See TracBrowser for help on using the repository browser.