| 1 | /*
 | 
|---|
| 2 |  * Project: MoleCuilder
 | 
|---|
| 3 |  * Description: creates and alters molecular systems
 | 
|---|
| 4 |  * Copyright (C)  2013 Frederik Heber. 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 |  * ActionQueue.cpp
 | 
|---|
| 25 |  *
 | 
|---|
| 26 |  *  Created on: Aug 16, 2013
 | 
|---|
| 27 |  *      Author: heber
 | 
|---|
| 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 "Actions/ActionQueue.hpp"
 | 
|---|
| 38 | 
 | 
|---|
| 39 | #include "CodePatterns/Assert.hpp"
 | 
|---|
| 40 | #include "CodePatterns/IteratorAdaptors.hpp"
 | 
|---|
| 41 | #include "CodePatterns/Log.hpp"
 | 
|---|
| 42 | #include "CodePatterns/Singleton_impl.hpp"
 | 
|---|
| 43 | 
 | 
|---|
| 44 | #include <string>
 | 
|---|
| 45 | #include <sstream>
 | 
|---|
| 46 | #include <vector>
 | 
|---|
| 47 | 
 | 
|---|
| 48 | #include "Actions/ActionHistory.hpp"
 | 
|---|
| 49 | #include "Actions/ActionRegistry.hpp"
 | 
|---|
| 50 | 
 | 
|---|
| 51 | using namespace MoleCuilder;
 | 
|---|
| 52 | 
 | 
|---|
| 53 | ActionQueue::ActionQueue() :
 | 
|---|
| 54 |     AR(new ActionRegistry()),
 | 
|---|
| 55 |     history(new ActionHistory)
 | 
|---|
| 56 | {}
 | 
|---|
| 57 | 
 | 
|---|
| 58 | ActionQueue::~ActionQueue()
 | 
|---|
| 59 | {
 | 
|---|
| 60 |   queue.clear();
 | 
|---|
| 61 |   delete history;
 | 
|---|
| 62 |   delete AR;
 | 
|---|
| 63 | }
 | 
|---|
| 64 | 
 | 
|---|
| 65 | void ActionQueue::queueAction(const std::string &name, enum Action::QueryOptions state)
 | 
|---|
| 66 | {
 | 
|---|
| 67 |   Action* _action = AR->getActionByName(name);
 | 
|---|
| 68 |   queue.push_back(_action);
 | 
|---|
| 69 |   _action->call(state);
 | 
|---|
| 70 | }
 | 
|---|
| 71 | 
 | 
|---|
| 72 | void ActionQueue::queueAction(Action *_action, enum Action::QueryOptions state)
 | 
|---|
| 73 | {
 | 
|---|
| 74 |   queue.push_back(_action);
 | 
|---|
| 75 |   _action->call(state);
 | 
|---|
| 76 | }
 | 
|---|
| 77 | 
 | 
|---|
| 78 | Action* ActionQueue::getActionByName(const std::string &name)
 | 
|---|
| 79 | {
 | 
|---|
| 80 |   return AR->getActionByName(name);
 | 
|---|
| 81 | }
 | 
|---|
| 82 | 
 | 
|---|
| 83 | bool ActionQueue::isActionKnownByName(const std::string &name) const
 | 
|---|
| 84 | {
 | 
|---|
| 85 |   return AR->isActionPresentByName(name);
 | 
|---|
| 86 | }
 | 
|---|
| 87 | 
 | 
|---|
| 88 | void ActionQueue::registerAction(Action *_action)
 | 
|---|
| 89 | {
 | 
|---|
| 90 |   AR->registerInstance(_action);
 | 
|---|
| 91 | }
 | 
|---|
| 92 | 
 | 
|---|
| 93 | void ActionQueue::outputAsCLI(std::ostream &output) const
 | 
|---|
| 94 | {
 | 
|---|
| 95 |   for (ActionQueue_t::const_iterator iter = queue.begin();
 | 
|---|
| 96 |       iter != queue.end();
 | 
|---|
| 97 |       ++iter) {
 | 
|---|
| 98 |     // skip store-session in printed list
 | 
|---|
| 99 |     if ( ((*iter)->getName() != std::string("store-session"))
 | 
|---|
| 100 |         && ((*iter)->getName() != std::string("load-session"))) {
 | 
|---|
| 101 |       if (iter != queue.begin())
 | 
|---|
| 102 |         output << " ";
 | 
|---|
| 103 |       (*iter)->outputAsCLI(output);
 | 
|---|
| 104 |     }
 | 
|---|
| 105 |   }
 | 
|---|
| 106 |   output << std::endl;
 | 
|---|
| 107 | }
 | 
|---|
| 108 | 
 | 
|---|
| 109 | void ActionQueue::outputAsPython(std::ostream &output) const
 | 
|---|
| 110 | {
 | 
|---|
| 111 |   const std::string prefix("pyMoleCuilder");
 | 
|---|
| 112 |   output << "import " << prefix << std::endl;
 | 
|---|
| 113 |   output << "# ========================== Stored Session BEGIN ==========================" << std::endl;
 | 
|---|
| 114 |   for (ActionQueue_t::const_iterator iter = queue.begin();
 | 
|---|
| 115 |       iter != queue.end();
 | 
|---|
| 116 |       ++iter) {
 | 
|---|
| 117 |     // skip store-session in printed list
 | 
|---|
| 118 |     if ( ((*iter)->getName() != std::string("store-session"))
 | 
|---|
| 119 |         && ((*iter)->getName() != std::string("load-session")))
 | 
|---|
| 120 |       (*iter)->outputAsPython(output, prefix);
 | 
|---|
| 121 |   }
 | 
|---|
| 122 |   output << "# =========================== Stored Session END ===========================" << std::endl;
 | 
|---|
| 123 | }
 | 
|---|
| 124 | 
 | 
|---|
| 125 | const ActionTrait& ActionQueue::getActionsTrait(const std::string &name) const
 | 
|---|
| 126 | {
 | 
|---|
| 127 |   // this const_cast is just required as long as we have a non-const getActionByName
 | 
|---|
| 128 |   const Action * const action = const_cast<ActionQueue *>(this)->getActionByName(name);
 | 
|---|
| 129 |   return action->Traits;
 | 
|---|
| 130 | }
 | 
|---|
| 131 | 
 | 
|---|
| 132 | void ActionQueue::addElement(Action* _Action,ActionState::ptr _state)
 | 
|---|
| 133 | {
 | 
|---|
| 134 |   history->addElement(_Action, _state);
 | 
|---|
| 135 | }
 | 
|---|
| 136 | 
 | 
|---|
| 137 | void ActionQueue::clear()
 | 
|---|
| 138 | {
 | 
|---|
| 139 |   history->clear();
 | 
|---|
| 140 | }
 | 
|---|
| 141 | 
 | 
|---|
| 142 | 
 | 
|---|
| 143 | const ActionQueue::ActionTokens_t ActionQueue::getListOfActions() const
 | 
|---|
| 144 | {
 | 
|---|
| 145 |   ActionTokens_t returnlist;
 | 
|---|
| 146 | 
 | 
|---|
| 147 |   returnlist.insert(
 | 
|---|
| 148 |       returnlist.end(),
 | 
|---|
| 149 |       MapKeyConstIterator<ActionRegistry::const_iterator>(AR->getBeginIter()),
 | 
|---|
| 150 |       MapKeyConstIterator<ActionRegistry::const_iterator>(AR->getEndIter()));
 | 
|---|
| 151 | 
 | 
|---|
| 152 |   return returnlist;
 | 
|---|
| 153 | }
 | 
|---|
| 154 | 
 | 
|---|
| 155 | void ActionQueue::undoLast()
 | 
|---|
| 156 | {
 | 
|---|
| 157 |         history->undoLast();
 | 
|---|
| 158 | }
 | 
|---|
| 159 | 
 | 
|---|
| 160 | void ActionQueue::redoLast()
 | 
|---|
| 161 | {
 | 
|---|
| 162 |         history->redoLast();
 | 
|---|
| 163 | }
 | 
|---|
| 164 | 
 | 
|---|
| 165 | 
 | 
|---|
| 166 | CONSTRUCT_SINGLETON(ActionQueue)
 | 
|---|