| 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 |  * Registry<Action>.cpp
 | 
|---|
| 26 |  *
 | 
|---|
| 27 |  *  Created on: Jan 7, 2010
 | 
|---|
| 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 "CodePatterns/Assert.hpp"
 | 
|---|
| 39 | 
 | 
|---|
| 40 | #include "Actions/ActionRegistry.hpp"
 | 
|---|
| 41 | #include "CodePatterns/Singleton_impl.hpp"
 | 
|---|
| 42 | #include "CodePatterns/Registry_impl.hpp"
 | 
|---|
| 43 | 
 | 
|---|
| 44 | #include "GlobalListOfActions.hpp"
 | 
|---|
| 45 | 
 | 
|---|
| 46 | #include "AllActionHeaders.hpp"
 | 
|---|
| 47 | 
 | 
|---|
| 48 | #include <boost/preprocessor/iteration/local.hpp>
 | 
|---|
| 49 | #include <boost/preprocessor/seq/elem.hpp>
 | 
|---|
| 50 | #include <boost/preprocessor/seq/size.hpp>
 | 
|---|
| 51 | 
 | 
|---|
| 52 | using namespace MoleCuilder;
 | 
|---|
| 53 | 
 | 
|---|
| 54 | // static entities
 | 
|---|
| 55 | bool ActionRegistry::completely_instatiated = false;
 | 
|---|
| 56 | 
 | 
|---|
| 57 | /** Constructor for class ActionRegistry.
 | 
|---|
| 58 |  */
 | 
|---|
| 59 | ActionRegistry::ActionRegistry()
 | 
|---|
| 60 | {
 | 
|---|
| 61 |   //std::cout << "ActionRegistry::ActionRegistry() called, instance is " << this << "." << std::endl;
 | 
|---|
| 62 |   fillRegistry();
 | 
|---|
| 63 |   completely_instatiated = true;
 | 
|---|
| 64 | }
 | 
|---|
| 65 | 
 | 
|---|
| 66 | /** Destructor for class ActionRegistry.
 | 
|---|
| 67 |  */
 | 
|---|
| 68 | ActionRegistry::~ActionRegistry()
 | 
|---|
| 69 | {
 | 
|---|
| 70 |   // first clear each macro action that require presence of all primitive ones
 | 
|---|
| 71 |   MakroAction * presentAction =
 | 
|---|
| 72 |       dynamic_cast<MakroAction *>(getActionByName("subgraph-dissection"));
 | 
|---|
| 73 |   ASSERT( presentAction != NULL,
 | 
|---|
| 74 |       "ActionRegistry::fillRegistry() - makro action has not been registered.");
 | 
|---|
| 75 |   presentAction->unprepare(*this);
 | 
|---|
| 76 | 
 | 
|---|
| 77 |   //std::cout << "ActionRegistry::~ActionRegistry() called, instance is " << this << "." << std::endl;
 | 
|---|
| 78 |   cleanup();
 | 
|---|
| 79 | }
 | 
|---|
| 80 | 
 | 
|---|
| 81 | 
 | 
|---|
| 82 | /** Instantiates each existing Action.
 | 
|---|
| 83 |  *
 | 
|---|
| 84 |  */
 | 
|---|
| 85 | void ActionRegistry::fillRegistry()
 | 
|---|
| 86 | {
 | 
|---|
| 87 | #define instance_print(z,n,list) \
 | 
|---|
| 88 |         { \
 | 
|---|
| 89 |         Action * presentAction = new \
 | 
|---|
| 90 |         BOOST_PP_CAT(BOOST_PP_SEQ_ELEM(n, list), Action) \
 | 
|---|
| 91 |         (); \
 | 
|---|
| 92 |         registerInstance(presentAction); \
 | 
|---|
| 93 |         }
 | 
|---|
| 94 | #define BOOST_PP_LOCAL_MACRO(n) instance_print(~, n, GLOBALLISTOFACTIONS)
 | 
|---|
| 95 | #define BOOST_PP_LOCAL_LIMITS  (0, BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(GLOBALLISTOFACTIONS)))
 | 
|---|
| 96 | #include BOOST_PP_LOCAL_ITERATE()
 | 
|---|
| 97 | #undef instance_print  
 | 
|---|
| 98 | 
 | 
|---|
| 99 |   // now prepare each macro action that require presence of all primitive ones
 | 
|---|
| 100 |   MakroAction * presentAction =
 | 
|---|
| 101 |       dynamic_cast<MakroAction *>(getActionByName("subgraph-dissection"));
 | 
|---|
| 102 |   ASSERT( presentAction != NULL,
 | 
|---|
| 103 |       "ActionRegistry::fillRegistry() - makro action has not been registered.");
 | 
|---|
| 104 |   presentAction->prepare(*this);
 | 
|---|
| 105 | }
 | 
|---|
| 106 | 
 | 
|---|
| 107 | /** Just passes on call to Registry<Action>::getByName().
 | 
|---|
| 108 |  * \param name name of Action
 | 
|---|
| 109 |  * \return pointer to Action
 | 
|---|
| 110 |  */
 | 
|---|
| 111 | Action* ActionRegistry::getActionByName(const std::string name)
 | 
|---|
| 112 | {
 | 
|---|
| 113 |   return getByName(name);
 | 
|---|
| 114 | }
 | 
|---|
| 115 | 
 | 
|---|
| 116 | /** Just passes on call to Registry<Action>::isPresentByName().
 | 
|---|
| 117 |  * \param name name of Action
 | 
|---|
| 118 |  * \return true - Action instance present, false - not
 | 
|---|
| 119 |  */
 | 
|---|
| 120 | bool ActionRegistry::isActionPresentByName(const std::string name) const
 | 
|---|
| 121 | {
 | 
|---|
| 122 |   return isPresentByName(name);
 | 
|---|
| 123 | }
 | 
|---|
| 124 | 
 | 
|---|
| 125 | /** Returns the last present action position in the requested menu.
 | 
|---|
| 126 |  * \param &token token of the menu
 | 
|---|
| 127 |  * \return last used position
 | 
|---|
| 128 |  */
 | 
|---|
| 129 | int ActionRegistry::getLastPosition(const std::string &token) const
 | 
|---|
| 130 | {
 | 
|---|
| 131 |   int position = 0;
 | 
|---|
| 132 |   for (const_iterator iter = getBeginIter();
 | 
|---|
| 133 |       iter != getEndIter();
 | 
|---|
| 134 |       ++iter) {
 | 
|---|
| 135 |     const std::string &MenuName = (iter->second)->Traits.getMenuName();
 | 
|---|
| 136 |     const int &MenuPosition = (iter->second)->Traits.getMenuPosition();
 | 
|---|
| 137 |     if ((MenuName == token) && (position < MenuPosition))
 | 
|---|
| 138 |       position = MenuPosition;
 | 
|---|
| 139 |   }
 | 
|---|
| 140 |   return position;
 | 
|---|
| 141 | }
 | 
|---|
| 142 | 
 | 
|---|
| 143 | 
 | 
|---|
| 144 | CONSTRUCT_SINGLETON(ActionRegistry)
 | 
|---|
| 145 | CONSTRUCT_REGISTRY(Action)
 | 
|---|