1 | /*
|
---|
2 | * Project: MoleCuilder
|
---|
3 | * Description: creates and alters molecular systems
|
---|
4 | * Copyright (C) 2010-2012 University of Bonn. All rights reserved.
|
---|
5 | *
|
---|
6 | *
|
---|
7 | * This file is part of MoleCuilder.
|
---|
8 | *
|
---|
9 | * MoleCuilder is free software: you can redistribute it and/or modify
|
---|
10 | * it under the terms of the GNU General Public License as published by
|
---|
11 | * the Free Software Foundation, either version 2 of the License, or
|
---|
12 | * (at your option) any later version.
|
---|
13 | *
|
---|
14 | * MoleCuilder is distributed in the hope that it will be useful,
|
---|
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
17 | * GNU General Public License for more details.
|
---|
18 | *
|
---|
19 | * You should have received a copy of the GNU General Public License
|
---|
20 | * along with MoleCuilder. If not, see <http://www.gnu.org/licenses/>.
|
---|
21 | */
|
---|
22 |
|
---|
23 | /*
|
---|
24 | * Action.cpp
|
---|
25 | *
|
---|
26 | * Created on: Dec 8, 2009
|
---|
27 | * Author: crueger
|
---|
28 | */
|
---|
29 |
|
---|
30 | // include config.h
|
---|
31 | #ifdef HAVE_CONFIG_H
|
---|
32 | #include <config.h>
|
---|
33 | #endif
|
---|
34 |
|
---|
35 | #include "CodePatterns/MemDebug.hpp"
|
---|
36 |
|
---|
37 | #include <iostream>
|
---|
38 | #include <sstream>
|
---|
39 | #include <string>
|
---|
40 |
|
---|
41 | #include "Actions/Action.hpp"
|
---|
42 | #include "Actions/ActionExceptions.hpp"
|
---|
43 | #include "Actions/ActionQueue.hpp"
|
---|
44 | #include "Actions/ActionRegistry.hpp"
|
---|
45 | #include "UIElements/Dialog.hpp"
|
---|
46 | #include "CodePatterns/Assert.hpp"
|
---|
47 | #include "CodePatterns/MemDebug.hpp"
|
---|
48 | #include "UIElements/UIFactory.hpp"
|
---|
49 |
|
---|
50 | #include "CodePatterns/Log.hpp"
|
---|
51 | #include "CodePatterns/Verbose.hpp"
|
---|
52 |
|
---|
53 | using namespace MoleCuilder;
|
---|
54 |
|
---|
55 | ActionState::ptr getEmptyState() {
|
---|
56 | return ActionState::ptr(Memory::ignore(new ActionState()));
|
---|
57 | }
|
---|
58 |
|
---|
59 | void Action::removeStaticStateEntities()
|
---|
60 | {
|
---|
61 | Action::success.reset();
|
---|
62 | Action::failure.reset();
|
---|
63 | }
|
---|
64 |
|
---|
65 | void Action::createStaticStateEntities()
|
---|
66 | {
|
---|
67 | Action::success = getEmptyState();
|
---|
68 | Action::failure = getEmptyState();
|
---|
69 | }
|
---|
70 |
|
---|
71 | // An empty state to indicate success, these are (de)initialized by ActionHistory
|
---|
72 | ActionState::ptr Action::success;
|
---|
73 | ActionState::ptr Action::failure;
|
---|
74 |
|
---|
75 | Action::Action(const ActionTrait &_Traits) :
|
---|
76 | Traits(_Traits)
|
---|
77 | {}
|
---|
78 |
|
---|
79 | Action::~Action()
|
---|
80 | {}
|
---|
81 |
|
---|
82 | const string Action::getName() const
|
---|
83 | {
|
---|
84 | return Traits.getName();
|
---|
85 | }
|
---|
86 |
|
---|
87 | const std::string Action::help() const
|
---|
88 | {
|
---|
89 | std::stringstream outputstream;
|
---|
90 | outputstream << "Description for Action '" << getName() << "': " << Traits.getDescription()
|
---|
91 | << std::endl;
|
---|
92 | if (!Traits.hasOption(getName())) {
|
---|
93 | outputstream << "\tNote that this Action does not take an argument." << std::endl;
|
---|
94 | }
|
---|
95 | outputstream << "Options available for action '" << getName() << "':" << std::endl;
|
---|
96 | for (ActionTrait::options_const_iterator iter = Traits.getBeginIter();
|
---|
97 | iter != Traits.getEndIter();
|
---|
98 | ++iter) {
|
---|
99 | outputstream << "Option '" << iter->first << "':" << std::endl;
|
---|
100 | outputstream << "\tDescription: " << iter->second->getDescription() << "." << std::endl;
|
---|
101 | outputstream << "\tArgument's type: " << iter->second->getTypeName() << "." << std::endl;
|
---|
102 | outputstream << "\tDefault value: ";
|
---|
103 | if (iter->second->hasDefaultValue()) {
|
---|
104 | outputstream << "Yes, is '" << iter->second->getDefaultValue() << "'";
|
---|
105 | } else {
|
---|
106 | outputstream << "None";
|
---|
107 | }
|
---|
108 | outputstream << "." << std::endl;
|
---|
109 | }
|
---|
110 |
|
---|
111 | return outputstream.str();
|
---|
112 | }
|
---|
113 |
|
---|
114 | void Action::prepare(enum QueryOptions flag)
|
---|
115 | {
|
---|
116 | // fill with
|
---|
117 | if (flag == Interactive) {
|
---|
118 | Dialog* dialog = createDialog();
|
---|
119 | if (dialog->hasQueries()) {
|
---|
120 | if (!dialog->display())
|
---|
121 | // dialog error or aborted -> throw exception
|
---|
122 | throw ActionFailureException() << ActionNameString(getName());
|
---|
123 | }
|
---|
124 | delete(dialog);
|
---|
125 | }
|
---|
126 | }
|
---|
127 |
|
---|
128 | Dialog * Action::createDialog(){
|
---|
129 | Dialog *dialog = UIFactory::getInstance().makeDialog(Traits.getName());
|
---|
130 | return fillDialog(dialog);
|
---|
131 | }
|
---|
132 |
|
---|
133 | void Action::call(){
|
---|
134 | if(!isActive()){
|
---|
135 | return;
|
---|
136 | }
|
---|
137 | ActionState::ptr state = Action::failure;
|
---|
138 | startTimer();
|
---|
139 | try {
|
---|
140 | state = performCall();
|
---|
141 | } catch (ParameterException &e) {
|
---|
142 | if( const std::string *name=boost::get_error_info<ParameterName>(e) )
|
---|
143 | ELOG(1, "The following parameter value is not valid: " << *name << ".");
|
---|
144 | state = Action::failure;
|
---|
145 | }
|
---|
146 | endTimer();
|
---|
147 |
|
---|
148 | if (shouldUndo() && state != Action::failure) {
|
---|
149 | if (canUndo()) {
|
---|
150 | ActionQueue::getInstance().addElement(this,state);
|
---|
151 | }
|
---|
152 | // else{
|
---|
153 | // ActionQueue::getInstance().clear();
|
---|
154 | // }
|
---|
155 | }
|
---|
156 |
|
---|
157 | // throw an exception that can be caught in case of failure
|
---|
158 | if (state == Action::failure)
|
---|
159 | throw ActionFailureException() << ActionNameString(getName());
|
---|
160 | }
|
---|
161 | ActionState::ptr Action::undo(ActionState::ptr _state) {
|
---|
162 | // forward to private virtual
|
---|
163 | return performUndo(_state);
|
---|
164 | }
|
---|
165 | ActionState::ptr Action::redo(ActionState::ptr _state) {
|
---|
166 | // forward to private virtual
|
---|
167 | return performRedo(_state);
|
---|
168 | }
|
---|
169 |
|
---|
170 | void Action::insertAction(Action *_action, enum Action::QueryOptions state)
|
---|
171 | {
|
---|
172 | ActionQueue::getInstance().insertAction(_action, state);
|
---|
173 | }
|
---|
174 |
|
---|
175 | bool Action::isActive(){
|
---|
176 | return true;
|
---|
177 | }
|
---|
178 |
|
---|
179 | void Action::pushStatus(const std::string& _msg)
|
---|
180 | {
|
---|
181 | ActionQueue::getInstance().pushStatus(_msg);
|
---|
182 | }
|
---|
183 |
|
---|