[bcf653] | 1 | /*
|
---|
| 2 | * Project: MoleCuilder
|
---|
| 3 | * Description: creates and alters molecular systems
|
---|
[0aa122] | 4 | * Copyright (C) 2010-2012 University of Bonn. All rights reserved.
|
---|
[94d5ac6] | 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/>.
|
---|
[bcf653] | 21 | */
|
---|
| 22 |
|
---|
[65b6e0] | 23 | /*
|
---|
| 24 | * Action.cpp
|
---|
| 25 | *
|
---|
| 26 | * Created on: Dec 8, 2009
|
---|
| 27 | * Author: crueger
|
---|
| 28 | */
|
---|
| 29 |
|
---|
[bf3817] | 30 | // include config.h
|
---|
| 31 | #ifdef HAVE_CONFIG_H
|
---|
| 32 | #include <config.h>
|
---|
| 33 | #endif
|
---|
| 34 |
|
---|
[ad011c] | 35 | #include "CodePatterns/MemDebug.hpp"
|
---|
[112b09] | 36 |
|
---|
[df32ee] | 37 | #include <iostream>
|
---|
[e4b2f6] | 38 | #include <sstream>
|
---|
[cc04b7] | 39 | #include <string>
|
---|
[65b6e0] | 40 |
|
---|
[cc04b7] | 41 | #include "Actions/Action.hpp"
|
---|
[e69c87] | 42 | #include "Actions/ActionExceptions.hpp"
|
---|
[6367dd] | 43 | #include "Actions/ActionQueue.hpp"
|
---|
[0c8056] | 44 | #include "Actions/ActionRegistry.hpp"
|
---|
[4e145c] | 45 | #include "UIElements/Dialog.hpp"
|
---|
[ad011c] | 46 | #include "CodePatterns/Assert.hpp"
|
---|
| 47 | #include "CodePatterns/MemDebug.hpp"
|
---|
[047878] | 48 | #include "UIElements/UIFactory.hpp"
|
---|
[cc04b7] | 49 |
|
---|
[ad011c] | 50 | #include "CodePatterns/Log.hpp"
|
---|
| 51 | #include "CodePatterns/Verbose.hpp"
|
---|
[4e145c] | 52 |
|
---|
[ce7fdc] | 53 | using namespace MoleCuilder;
|
---|
[cc04b7] | 54 |
|
---|
[b5b01e] | 55 | ActionState::ptr getEmptyState() {
|
---|
| 56 | return ActionState::ptr(Memory::ignore(new ActionState()));
|
---|
[6d6b54] | 57 | }
|
---|
| 58 |
|
---|
[dfef3f] | 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
|
---|
[b5b01e] | 72 | ActionState::ptr Action::success;
|
---|
| 73 | ActionState::ptr Action::failure;
|
---|
[67e2b3] | 74 |
|
---|
[126867] | 75 | Action::Action(const ActionTrait &_Traits) :
|
---|
| 76 | Traits(_Traits)
|
---|
[36053c] | 77 | {}
|
---|
[65b6e0] | 78 |
|
---|
| 79 | Action::~Action()
|
---|
[36053c] | 80 | {}
|
---|
[cc04b7] | 81 |
|
---|
[13799e] | 82 | const string Action::getName() const
|
---|
| 83 | {
|
---|
[e4afb4] | 84 | return Traits.getName();
|
---|
[cc04b7] | 85 | }
|
---|
[67e2b3] | 86 |
|
---|
[e4b2f6] | 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;
|
---|
[3139b2] | 96 | for (ActionTrait::options_const_iterator iter = Traits.getBeginIter();
|
---|
[e4b2f6] | 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 |
|
---|
[047878] | 114 | Dialog * Action::createDialog(){
|
---|
| 115 | Dialog *dialog = UIFactory::getInstance().makeDialog();
|
---|
| 116 | return fillDialog(dialog);
|
---|
| 117 | }
|
---|
| 118 |
|
---|
[4e145c] | 119 | void Action::call(enum QueryOptions flag){
|
---|
[2efa90] | 120 | if(!isActive()){
|
---|
| 121 | return;
|
---|
| 122 | }
|
---|
[67e2b3] | 123 | // forward to private virtual
|
---|
[4e145c] | 124 | if (flag == Interactive) {
|
---|
| 125 | Dialog* dialog = createDialog();
|
---|
[031f62] | 126 | if (dialog->hasQueries()) {
|
---|
[95f965] | 127 | if (!dialog->display())
|
---|
| 128 | // dialog error or aborted -> throw exception
|
---|
| 129 | throw ActionFailureException() << ActionNameString(getName());
|
---|
[4e145c] | 130 | }
|
---|
[031f62] | 131 | delete(dialog);
|
---|
[4e145c] | 132 | }
|
---|
[b5b01e] | 133 | ActionState::ptr state = Action::failure;
|
---|
[e2f3114] | 134 | // try {
|
---|
[862b6a] | 135 | startTimer();
|
---|
[4e145c] | 136 | state = performCall();
|
---|
[862b6a] | 137 | endTimer();
|
---|
[e2f3114] | 138 | // } catch(MissingValueException&) {
|
---|
[47d041] | 139 | // ELOG(0, "There is a value missing for action " << getName());
|
---|
[e2f3114] | 140 | // };
|
---|
[4e145c] | 141 |
|
---|
[d56640] | 142 | if(shouldUndo() && state != failure){
|
---|
| 143 | if(canUndo()){
|
---|
[6367dd] | 144 | ActionQueue::getInstance().addElement(this,state);
|
---|
[d56640] | 145 | }
|
---|
| 146 | else{
|
---|
[6367dd] | 147 | ActionQueue::getInstance().clear();
|
---|
[d56640] | 148 | }
|
---|
| 149 | }
|
---|
[e69c87] | 150 |
|
---|
| 151 | // throw an exception that can be caught in case of failure
|
---|
| 152 | if (state == Action::failure)
|
---|
| 153 | throw ActionFailureException() << ActionNameString(getName());
|
---|
[67e2b3] | 154 | }
|
---|
[b5b01e] | 155 | ActionState::ptr Action::undo(ActionState::ptr _state) {
|
---|
[67e2b3] | 156 | // forward to private virtual
|
---|
| 157 | return performUndo(_state);
|
---|
| 158 | }
|
---|
[b5b01e] | 159 | ActionState::ptr Action::redo(ActionState::ptr _state) {
|
---|
[67e2b3] | 160 | // forward to private virtual
|
---|
| 161 | return performRedo(_state);
|
---|
| 162 | }
|
---|
[f9352d] | 163 |
|
---|
| 164 |
|
---|
| 165 | bool Action::isActive(){
|
---|
| 166 | return true;
|
---|
| 167 | }
|
---|
[df32ee] | 168 |
|
---|