[5640] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
| 29 | #ifndef __Util_Scope_H__ |
---|
| 30 | #define __Util_Scope_H__ |
---|
| 31 | |
---|
| 32 | #include "UtilPrereqs.h" |
---|
[5850] | 33 | |
---|
[5640] | 34 | #include <cassert> |
---|
[5850] | 35 | #include <map> |
---|
[5640] | 36 | #include <set> |
---|
| 37 | #include "Debug.h" |
---|
| 38 | |
---|
| 39 | namespace orxonox |
---|
| 40 | { |
---|
| 41 | /** |
---|
| 42 | @brief The ScopeManager stores the variables of the scope templates in a statically linked context. |
---|
| 43 | */ |
---|
| 44 | class _UtilExport ScopeManager |
---|
| 45 | { |
---|
| 46 | template <ScopeID::Value scope> |
---|
| 47 | friend class Scope; |
---|
| 48 | friend class ScopeListener; |
---|
| 49 | |
---|
| 50 | private: |
---|
| 51 | static std::map<ScopeID::Value, int> instanceCounts_s; //!< Counts the number of active instances (>0 means active) for a scope |
---|
| 52 | static std::map<ScopeID::Value, std::set<ScopeListener*> > listeners_s; //!< Stores all listeners for a scope |
---|
| 53 | }; |
---|
| 54 | |
---|
| 55 | /** |
---|
| 56 | @brief ScopeListeners register themselves in the corresponding scope and wait for notifications. |
---|
| 57 | */ |
---|
| 58 | class _UtilExport ScopeListener |
---|
| 59 | { |
---|
| 60 | template <ScopeID::Value scope> |
---|
| 61 | friend class Scope; |
---|
| 62 | |
---|
| 63 | protected: |
---|
| 64 | //! Constructor: Registers the instance. |
---|
| 65 | ScopeListener(ScopeID::Value scope) : scope_(scope) |
---|
| 66 | { ScopeManager::listeners_s[this->scope_].insert(this); } |
---|
| 67 | //! Destructor: Unregisters the instance. |
---|
| 68 | virtual ~ScopeListener() |
---|
| 69 | { ScopeManager::listeners_s[this->scope_].erase(this); } |
---|
| 70 | |
---|
| 71 | //! Gets called if the scope is activated |
---|
| 72 | virtual void activated() = 0; |
---|
| 73 | //! Gets called if the scope is deactivated |
---|
| 74 | virtual void deactivated() = 0; |
---|
[5850] | 75 | //! Gets called if the scope is updated |
---|
| 76 | virtual void updated(const Clock& time) = 0; |
---|
[5640] | 77 | |
---|
| 78 | private: |
---|
| 79 | ScopeID::Value scope_; //!< Store the scope to unregister on destruction |
---|
| 80 | }; |
---|
| 81 | |
---|
| 82 | /** |
---|
| 83 | @brief A scope for a given template argument is either active or not. |
---|
| 84 | |
---|
| 85 | Objects inheriting from a ScopeListener are registered in a list (different for each scope). |
---|
| 86 | If the scope gets activated or deactivated, all objects in this list are notified. |
---|
| 87 | */ |
---|
| 88 | template <ScopeID::Value scope> |
---|
| 89 | class Scope |
---|
| 90 | { |
---|
| 91 | public: |
---|
| 92 | //! Constructor: Increases the instance counter and activates the scope if the count went from 0 to 1. Counts >1 don't change anything. |
---|
| 93 | Scope() |
---|
| 94 | { |
---|
| 95 | ScopeManager::instanceCounts_s[scope]++; |
---|
| 96 | assert(ScopeManager::instanceCounts_s[scope] > 0); |
---|
| 97 | if (ScopeManager::instanceCounts_s[scope] == 1) |
---|
| 98 | { |
---|
| 99 | for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); ) |
---|
| 100 | (*(it++))->activated(); |
---|
| 101 | } |
---|
| 102 | } |
---|
| 103 | |
---|
| 104 | //! Destructor: Decreases the instance counter and deactivates the scope if the count went from 1 to 0. Counts >0 don't change anything. |
---|
| 105 | ~Scope() |
---|
| 106 | { |
---|
| 107 | ScopeManager::instanceCounts_s[scope]--; |
---|
| 108 | |
---|
| 109 | // This shouldn't happen but just to be sure: check if the count is positive |
---|
| 110 | assert(ScopeManager::instanceCounts_s[scope] >= 0); |
---|
| 111 | if (ScopeManager::instanceCounts_s[scope] < 0) |
---|
| 112 | ScopeManager::instanceCounts_s[scope] = 0; |
---|
| 113 | |
---|
| 114 | if (ScopeManager::instanceCounts_s[scope] == 0) |
---|
| 115 | { |
---|
| 116 | for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); ) |
---|
| 117 | (*(it++))->deactivated(); |
---|
| 118 | } |
---|
| 119 | } |
---|
| 120 | |
---|
| 121 | //! Returns true if the scope is active. |
---|
| 122 | static bool isActive() |
---|
| 123 | { |
---|
| 124 | return (ScopeManager::instanceCounts_s[scope] > 0); |
---|
| 125 | } |
---|
[5850] | 126 | |
---|
| 127 | //! Update method for the ScopeListeners (to implement singleton updates) |
---|
| 128 | static void update(const Clock& time) |
---|
| 129 | { |
---|
| 130 | if (isActive()) |
---|
| 131 | { |
---|
| 132 | for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); ) |
---|
| 133 | (*(it++))->updated(time); |
---|
| 134 | } |
---|
| 135 | } |
---|
[5640] | 136 | }; |
---|
| 137 | } |
---|
| 138 | |
---|
| 139 | #endif /* __Util_Scope_H__ */ |
---|