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 | * Action.cpp
|
---|
10 | *
|
---|
11 | * Created on: Dec 8, 2009
|
---|
12 | * Author: crueger
|
---|
13 | */
|
---|
14 |
|
---|
15 | // include config.h
|
---|
16 | #ifdef HAVE_CONFIG_H
|
---|
17 | #include <config.h>
|
---|
18 | #endif
|
---|
19 |
|
---|
20 | #include "CodePatterns/MemDebug.hpp"
|
---|
21 |
|
---|
22 | #include <iostream>
|
---|
23 | #include <string>
|
---|
24 |
|
---|
25 | #include "Actions/Action.hpp"
|
---|
26 | #include "Actions/ActionRegistry.hpp"
|
---|
27 | #include "Actions/ActionHistory.hpp"
|
---|
28 | #include "Actions/OptionRegistry.hpp"
|
---|
29 | #include "Actions/OptionTrait.hpp"
|
---|
30 | #include "Exceptions/MissingValueException.hpp"
|
---|
31 | #include "UIElements/Dialog.hpp"
|
---|
32 | #include "CodePatterns/Assert.hpp"
|
---|
33 | #include "CodePatterns/MemDebug.hpp"
|
---|
34 | #include "UIElements/UIFactory.hpp"
|
---|
35 |
|
---|
36 | #include "CodePatterns/Log.hpp"
|
---|
37 | #include "CodePatterns/Verbose.hpp"
|
---|
38 |
|
---|
39 | using namespace std;
|
---|
40 |
|
---|
41 | Action::state_ptr getEmptyState() {
|
---|
42 | return Action::state_ptr(Memory::ignore(new ActionState()));
|
---|
43 | }
|
---|
44 |
|
---|
45 | // An empty state to indicate success
|
---|
46 | Action::state_ptr Action::success = getEmptyState();
|
---|
47 | Action::state_ptr Action::failure = getEmptyState();
|
---|
48 |
|
---|
49 | Action::Action(const ActionTraits &_Traits, bool _doRegister) :
|
---|
50 | Traits(_Traits)
|
---|
51 | {
|
---|
52 | // register with ActionRegistry
|
---|
53 | if(_doRegister){
|
---|
54 | ActionRegistry::getInstance().registerInstance(this);
|
---|
55 | }
|
---|
56 |
|
---|
57 | // register with OptionRegistry
|
---|
58 | for (ActionTraits::options_const_iterator optioniter = Traits.getBeginIter();
|
---|
59 | optioniter != Traits.getEndIter();
|
---|
60 | ++optioniter) {
|
---|
61 | // options may have been re-used by other Actions, so check beforehand whether adding is needed
|
---|
62 | if (!OptionRegistry::getInstance().isOptionPresentByName((optioniter->first))) {
|
---|
63 | OptionRegistry::getInstance().registerInstance(optioniter->second);
|
---|
64 | } else { // if present, ASSERT that types coincide
|
---|
65 | #ifndef NDEBUG
|
---|
66 | OptionTrait const * const PresentOption = OptionRegistry::getInstance().getOptionByName(optioniter->first);
|
---|
67 | #endif
|
---|
68 | ASSERT(PresentOption->getType() == optioniter->second->getType(),
|
---|
69 | ("Action::Action() - option to add "+
|
---|
70 | std::string(optioniter->first)+
|
---|
71 | " of Action "+
|
---|
72 | std::string(getName())+
|
---|
73 | " is already present with different type!"
|
---|
74 | )
|
---|
75 | );
|
---|
76 | }
|
---|
77 | }
|
---|
78 | }
|
---|
79 |
|
---|
80 | Action::~Action()
|
---|
81 | {}
|
---|
82 |
|
---|
83 | const string Action::getName(){
|
---|
84 | return Traits.getName();
|
---|
85 | }
|
---|
86 |
|
---|
87 | void Action::removeStaticStateEntities()
|
---|
88 | {
|
---|
89 | success.reset();
|
---|
90 | failure.reset();
|
---|
91 | }
|
---|
92 |
|
---|
93 | Dialog * Action::createDialog(){
|
---|
94 | Dialog *dialog = UIFactory::getInstance().makeDialog();
|
---|
95 | return fillDialog(dialog);
|
---|
96 | }
|
---|
97 |
|
---|
98 | void Action::call(enum QueryOptions flag){
|
---|
99 | if(!isActive()){
|
---|
100 | return;
|
---|
101 | }
|
---|
102 | // forward to private virtual
|
---|
103 | if (flag == Interactive) {
|
---|
104 | Dialog* dialog = createDialog();
|
---|
105 | if (dialog->hasQueries()) {
|
---|
106 | dialog->display();
|
---|
107 | }
|
---|
108 | delete(dialog);
|
---|
109 | }
|
---|
110 | state_ptr state = Action::failure;
|
---|
111 | // try {
|
---|
112 | state = performCall();
|
---|
113 | // } catch(MissingValueException&) {
|
---|
114 | // DoeLog(0) && (eLog() << Verbose(0) << "There is a value missing for action " << getName() << endl);
|
---|
115 | // };
|
---|
116 |
|
---|
117 | if(shouldUndo() && state != failure){
|
---|
118 | if(canUndo()){
|
---|
119 | ActionHistory::getInstance().addElement(this,state);
|
---|
120 | }
|
---|
121 | else{
|
---|
122 | ActionHistory::getInstance().clear();
|
---|
123 | }
|
---|
124 | }
|
---|
125 | }
|
---|
126 | Action::state_ptr Action::undo(state_ptr _state) {
|
---|
127 | // forward to private virtual
|
---|
128 | return performUndo(_state);
|
---|
129 | }
|
---|
130 | Action::state_ptr Action::redo(state_ptr _state) {
|
---|
131 | // forward to private virtual
|
---|
132 | return performRedo(_state);
|
---|
133 | }
|
---|
134 |
|
---|
135 |
|
---|
136 | bool Action::isActive(){
|
---|
137 | return true;
|
---|
138 | }
|
---|
139 |
|
---|