| 1 | /*
 | 
|---|
| 2 |  * Project: MoleCuilder
 | 
|---|
| 3 |  * Description: creates and alters molecular systems
 | 
|---|
| 4 |  * Copyright (C)  2010-2012 University of Bonn. All rights reserved.
 | 
|---|
| 5 |  * Copyright (C)  2013 Frederik Heber. All rights reserved.
 | 
|---|
| 6 |  * 
 | 
|---|
| 7 |  *
 | 
|---|
| 8 |  *   This file is part of MoleCuilder.
 | 
|---|
| 9 |  *
 | 
|---|
| 10 |  *    MoleCuilder is free software: you can redistribute it and/or modify
 | 
|---|
| 11 |  *    it under the terms of the GNU General Public License as published by
 | 
|---|
| 12 |  *    the Free Software Foundation, either version 2 of the License, or
 | 
|---|
| 13 |  *    (at your option) any later version.
 | 
|---|
| 14 |  *
 | 
|---|
| 15 |  *    MoleCuilder is distributed in the hope that it will be useful,
 | 
|---|
| 16 |  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
|---|
| 17 |  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
|---|
| 18 |  *    GNU General Public License for more details.
 | 
|---|
| 19 |  *
 | 
|---|
| 20 |  *    You should have received a copy of the GNU General Public License
 | 
|---|
| 21 |  *    along with MoleCuilder.  If not, see <http://www.gnu.org/licenses/>.
 | 
|---|
| 22 |  */
 | 
|---|
| 23 | 
 | 
|---|
| 24 | /*
 | 
|---|
| 25 |  * MakroAction.cpp
 | 
|---|
| 26 |  *
 | 
|---|
| 27 |  *  Created on: Dec 17, 2009
 | 
|---|
| 28 |  *      Author: crueger
 | 
|---|
| 29 |  */
 | 
|---|
| 30 | 
 | 
|---|
| 31 | // include config.h
 | 
|---|
| 32 | #ifdef HAVE_CONFIG_H
 | 
|---|
| 33 | #include <config.h>
 | 
|---|
| 34 | #endif
 | 
|---|
| 35 | 
 | 
|---|
| 36 | #include "CodePatterns/MemDebug.hpp"
 | 
|---|
| 37 | 
 | 
|---|
| 38 | #include <string>
 | 
|---|
| 39 | 
 | 
|---|
| 40 | #include "Actions/MakroAction.hpp"
 | 
|---|
| 41 | #include "Actions/Action.hpp"
 | 
|---|
| 42 | #include "Actions/ActionExceptions.hpp"
 | 
|---|
| 43 | #include "Actions/ActionRegistry.hpp"
 | 
|---|
| 44 | #include "Actions/ActionSequence.hpp"
 | 
|---|
| 45 | #include "CodePatterns/Assert.hpp"
 | 
|---|
| 46 | #include "UIElements/Dialog.hpp"
 | 
|---|
| 47 | #include "UIElements/UIFactory.hpp"
 | 
|---|
| 48 | 
 | 
|---|
| 49 | using namespace MoleCuilder;
 | 
|---|
| 50 | 
 | 
|---|
| 51 | class MakroActionState : public ActionState{
 | 
|---|
| 52 | public:
 | 
|---|
| 53 |   MakroActionState(ActionSequence::stateSet _states) :
 | 
|---|
| 54 |     states(_states)
 | 
|---|
| 55 |   {}
 | 
|---|
| 56 |   virtual ~MakroActionState(){
 | 
|---|
| 57 |     // All contained states are destroyed by the shared ptrs
 | 
|---|
| 58 |   }
 | 
|---|
| 59 | 
 | 
|---|
| 60 |   ActionSequence::stateSet states;
 | 
|---|
| 61 | };
 | 
|---|
| 62 | 
 | 
|---|
| 63 | MakroAction::MakroAction(const MakroAction &_instance) :
 | 
|---|
| 64 |     Action(_instance.Traits),
 | 
|---|
| 65 |     actions(_instance.actions)
 | 
|---|
| 66 | {}
 | 
|---|
| 67 | 
 | 
|---|
| 68 | MakroAction::MakroAction(const ActionTrait &_trait,ActionSequence& _actions) :
 | 
|---|
| 69 |     Action(_trait),
 | 
|---|
| 70 |     actions(_actions)
 | 
|---|
| 71 | {
 | 
|---|
| 72 | }
 | 
|---|
| 73 | 
 | 
|---|
| 74 | MakroAction::~MakroAction()
 | 
|---|
| 75 | {
 | 
|---|
| 76 |   // emptying the sequence is done in ActionSequence
 | 
|---|
| 77 | }
 | 
|---|
| 78 | 
 | 
|---|
| 79 | void MakroAction::prepare(ActionRegistry &AR)
 | 
|---|
| 80 | {}
 | 
|---|
| 81 | 
 | 
|---|
| 82 | void MakroAction::unprepare(ActionRegistry &AR)
 | 
|---|
| 83 | {}
 | 
|---|
| 84 | 
 | 
|---|
| 85 | void MakroAction::setLoop(unsigned int _loop)
 | 
|---|
| 86 | {
 | 
|---|
| 87 |   actions.setLoop(_loop);
 | 
|---|
| 88 | }
 | 
|---|
| 89 | 
 | 
|---|
| 90 | bool MakroAction::removeAction(const std::string &name)
 | 
|---|
| 91 | {
 | 
|---|
| 92 |   return actions.removeAction(name);
 | 
|---|
| 93 | }
 | 
|---|
| 94 | 
 | 
|---|
| 95 | Dialog* MakroAction::fillOwnDialog(Dialog *dialog) {
 | 
|---|
| 96 |   return dialog;
 | 
|---|
| 97 | }
 | 
|---|
| 98 | 
 | 
|---|
| 99 | Dialog* MakroAction::fillDialog(Dialog *dialog) {
 | 
|---|
| 100 |   dialog = fillOwnDialog(dialog);
 | 
|---|
| 101 |   return actions.fillAllDialogs(dialog);
 | 
|---|
| 102 | }
 | 
|---|
| 103 | 
 | 
|---|
| 104 | ActionState::ptr MakroAction::performCall(){
 | 
|---|
| 105 |   ActionSequence::stateSet states = actions.callAll(true);
 | 
|---|
| 106 |   return ActionState::ptr(new MakroActionState(states));
 | 
|---|
| 107 | }
 | 
|---|
| 108 | 
 | 
|---|
| 109 | ActionState::ptr MakroAction::performUndo(ActionState::ptr _state) {
 | 
|---|
| 110 |   MakroActionState *state = dynamic_cast<MakroActionState*>(_state.get());
 | 
|---|
| 111 |   ASSERT(state,"Type mismatch for the state of the MakroAction");
 | 
|---|
| 112 |   ActionSequence::stateSet states = actions.undoAll(state->states);
 | 
|---|
| 113 |   return ActionState::ptr(new MakroActionState(states));
 | 
|---|
| 114 | }
 | 
|---|
| 115 | 
 | 
|---|
| 116 | ActionState::ptr MakroAction::performRedo(ActionState::ptr _state){
 | 
|---|
| 117 |   MakroActionState *state = dynamic_cast<MakroActionState*>(_state.get());
 | 
|---|
| 118 |   ASSERT(state,"Type mismatch for the state of the MakroAction");
 | 
|---|
| 119 |   ActionSequence::stateSet states = actions.redoAll(state->states);
 | 
|---|
| 120 |   return ActionState::ptr(new MakroActionState(states));
 | 
|---|
| 121 | }
 | 
|---|
| 122 | 
 | 
|---|
| 123 | bool MakroAction::canUndo() {
 | 
|---|
| 124 |   return actions.canUndo();
 | 
|---|
| 125 | }
 | 
|---|
| 126 | 
 | 
|---|
| 127 | bool MakroAction::shouldUndo() {
 | 
|---|
| 128 |   return actions.shouldUndo();
 | 
|---|
| 129 | }
 | 
|---|
| 130 | 
 | 
|---|
| 131 | Action* MakroAction::clone(enum QueryOptions flag) const
 | 
|---|
| 132 | {
 | 
|---|
| 133 |   if (flag == Interactive)
 | 
|---|
| 134 |     return new MakroAction(Traits, actions);
 | 
|---|
| 135 |   else
 | 
|---|
| 136 |     return new MakroAction(*this);
 | 
|---|
| 137 | }
 | 
|---|
| 138 | 
 | 
|---|
| 139 | void MakroAction::prepare(enum QueryOptions flag)
 | 
|---|
| 140 | {
 | 
|---|
| 141 |   if (flag == Interactive) {
 | 
|---|
| 142 |     // create and run our dialog and also of all members of the sequence
 | 
|---|
| 143 |     Dialog* dialog = createDialog();
 | 
|---|
| 144 |     if (dialog->hasQueries()) {
 | 
|---|
| 145 |       if (!dialog->display())
 | 
|---|
| 146 |         // dialog error or aborted -> throw exception
 | 
|---|
| 147 |         throw ActionFailureException() << ActionNameString(getName());
 | 
|---|
| 148 |     }
 | 
|---|
| 149 |     delete(dialog);
 | 
|---|
| 150 |   }
 | 
|---|
| 151 | }
 | 
|---|
| 152 | 
 | 
|---|
| 153 | void MakroAction::outputAsCLI(std::ostream &ost) const
 | 
|---|
| 154 | {
 | 
|---|
| 155 |   actions.outputAsCLI(ost);
 | 
|---|
| 156 | }
 | 
|---|
| 157 | 
 | 
|---|
| 158 | void MakroAction::outputAsPython(std::ostream &ost, const std::string &prefix) const
 | 
|---|
| 159 | {
 | 
|---|
| 160 |   actions.outputAsPython(ost, prefix);
 | 
|---|
| 161 | }
 | 
|---|
| 162 | 
 | 
|---|
| 163 | void MakroAction::setOptionValue(const std::string &_token, const std::string &_value)
 | 
|---|
| 164 | {
 | 
|---|
| 165 |   actions.setOptionValue(_token, _value);
 | 
|---|
| 166 | }
 | 
|---|