Changeset 5877

Timestamp:

Oct 5, 2009, 1:34:10 AM (15 years ago)

Author:

rgrieder

Message:

Added new an option for the ScopedSingletonManager that can allow the Singleton to fail (throw an exception).
Also improved exception-safety in Scope so that when for a Singleton fails, the Scope will deactivate all activated listeners and properly destroy itself.

Location:

code/branches/core5/src

Files:

• libraries/core/Core.cc (modified) (2 diffs)
• libraries/core/ScopedSingletonManager.h (modified) (6 diffs)
• libraries/core/input/KeyBinderManager.cc (modified) (1 diff)
• libraries/core/input/KeyDetector.cc (modified) (1 diff)
• libraries/util/Scope.h (modified) (5 diffs)
• modules/questsystem/QuestManager.cc (modified) (1 diff)
• modules/questsystem/notifications/NotificationManager.cc (modified) (1 diff)
• orxonox/CameraManager.cc (modified) (1 diff)
• orxonox/LevelManager.cc (modified) (1 diff)
• orxonox/PlayerManager.cc (modified) (1 diff)
• orxonox/overlays/InGameConsole.cc (modified) (1 diff)
• orxonox/sound/SoundManager.cc (modified) (1 diff)

code/branches/core5/src/libraries/core/Core.cc

@@ -434 +434 @@
     {
         // singletons from other libraries
-        ScopedSingletonManager::update(time, ScopeID::Root);
+        ScopedSingletonManager::update<ScopeID::Root>(time);
         if (this->bGraphicsLoaded_)
         {
@@ -442 +442 @@
             this->guiManager_->update(time);
             // graphics singletons from other libraries
-            ScopedSingletonManager::update(time, ScopeID::Graphics);
+            ScopedSingletonManager::update<ScopeID::Graphics>(time);
         }
         // process thread commands

code/branches/core5/src/libraries/core/ScopedSingletonManager.h

@@ -34 +34 @@
 #include <cassert>
 #include <map>
+#include "util/Exception.h"
 #include "util/Scope.h"
 #include "util/Singleton.h"
 
-#define ManageScopedSingleton(className, scope) \
-    static ClassScopedSingletonManager<className, scope> className##ScopedSingletonManager(#className)
+#define ManageScopedSingleton(className, scope, allowedToFail) \
+    static ClassScopedSingletonManager<className, scope, allowedToFail> className##ScopedSingletonManager(#className)
 
 namespace orxonox
@@ -53 +54 @@
             static void removeManager(ScopedSingletonManager* manager);
 
-            static void update(const Clock& time, ScopeID::Value scope)
+            template<ScopeID::Value scope>
+            static void update(const Clock& time)
             {
+                assert(Scope<scope>::isActive());
                 for (ManagerMultiMap::iterator it = getManagersByScope().lower_bound(scope); it != getManagersByScope().upper_bound(scope); ++it)
                     it->second->update(time);
@@ -69 +72 @@
     };
 
-    template <class T, ScopeID::Value scope>
+    template <class T, ScopeID::Value scope, bool allowedToFail>
     class ClassScopedSingletonManager : public ScopedSingletonManager, public ScopeListener
     {
@@ -83 +86 @@
         ~ClassScopedSingletonManager()
         {
+            assert(singletonPtr_ == NULL);
             ScopedSingletonManager::removeManager(this);
         }
@@ -101 +105 @@
         }
 
+        void destroy(OrxonoxClass*)
+        {
+            singletonPtr_->destroy();
+        }
+        void destroy(void*)
+        {
+            delete singletonPtr_;
+        }
+
+        //! Called every frame by the ScopedSingletonManager
+        void update(const Clock& time)
+        {
+            assert(Scope<scope>::isActive());
+            // assuming T inherits Singleton<T>
+            singletonPtr_->updateSingleton(time);
+        }
+
+    private:
+        T* singletonPtr_;
+    };
+
+    template <class T, ScopeID::Value scope>
+    class ClassScopedSingletonManager<T, scope, true> : public ScopedSingletonManager, public ScopeListener
+    {
+    public:
+        ClassScopedSingletonManager(const std::string& className)
+            : ScopedSingletonManager(className, scope)
+            , ScopeListener(scope)
+            , singletonPtr_(NULL)
+        {
+            ScopedSingletonManager::addManager(this);
+        }
+
+        ~ClassScopedSingletonManager()
+        {
+            assert(singletonPtr_ == NULL);
+            ScopedSingletonManager::removeManager(this);
+        }
+
+        //! Called if the Scope of the Singleton gets active (creates the instance)
+        void activated()
+        {
+            assert(singletonPtr_ == NULL);
+            try
+                { singletonPtr_ = new T(); }
+            catch (...)
+                { COUT(1) << "Singleton creation failed: " << Exception::handleMessage() << std::endl; }
+        }
+
+        //! Called if the Scope of this Singleton gets deactivated (destroys the instance)
+        void deactivated()
+        {
+            if (singletonPtr_ != NULL)
+            {
+                this->destroy(singletonPtr_);
+                singletonPtr_ = NULL;
+            }
+        }
+
         void destroy(OrxonoxClass* ptr)
         {
@@ -113 +176 @@
         void update(const Clock& time)
         {
+            assert(Scope<scope>::isActive());
             // assuming T inherits Singleton<T>
-            singletonPtr_->updateSingleton(time);
+            if (singletonPtr_ != NULL)
+                singletonPtr_->updateSingleton(time);
         }
 

code/branches/core5/src/libraries/core/input/KeyBinderManager.cc

@@ -41 +41 @@
 {
     KeyBinderManager* KeyBinderManager::singletonPtr_s = 0;
-    ManageScopedSingleton(KeyBinderManager, ScopeID::Graphics);
+    ManageScopedSingleton(KeyBinderManager, ScopeID::Graphics, false);
 
     KeyBinderManager::KeyBinderManager()

code/branches/core5/src/libraries/core/input/KeyDetector.cc

@@ -40 +40 @@
     std::string KeyDetector::callbackCommand_s = "KeyDetectorKeyPressed";
     KeyDetector* KeyDetector::singletonPtr_s = 0;
-    ManageScopedSingleton(KeyDetector, ScopeID::Graphics);
+    ManageScopedSingleton(KeyDetector, ScopeID::Graphics, false);
 
     KeyDetector::KeyDetector()

code/branches/core5/src/libraries/util/Scope.h

@@ -35 +35 @@
 #include <map>
 #include <set>
+
 #include "Debug.h"
+#include "ScopeGuard.h"
 
 namespace orxonox
@@ -63 +65 @@
         protected:
             //! Constructor: Registers the instance.
-            ScopeListener(ScopeID::Value scope) : scope_(scope)
+            ScopeListener(ScopeID::Value scope) : scope_(scope), bActivated_(false)
                 { ScopeManager::listeners_s[this->scope_].insert(this); }
             //! Destructor: Unregisters the instance.
@@ -76 +78 @@
         private:
             ScopeID::Value scope_; //!< Store the scope to unregister on destruction
+            bool bActivated_;
     };
 
@@ -91 +94 @@
             Scope()
             {
-                ScopeManager::instanceCounts_s[scope]++;
-                assert(ScopeManager::instanceCounts_s[scope] > 0);
-                if (ScopeManager::instanceCounts_s[scope] == 1)
+                try
                 {
-                    for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); )
-                        (*(it++))->activated();
+                    ScopeManager::instanceCounts_s[scope]++;
+                    assert(ScopeManager::instanceCounts_s[scope] > 0);
+                    if (ScopeManager::instanceCounts_s[scope] == 1)
+                    {
+                        Loki::ScopeGuard deactivator = Loki::MakeObjGuard(*this, &Scope::deactivateListeners);
+                        for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); )
+                        {
+                            (*it)->activated();
+                            (*(it++))->bActivated_ = true;
+                        }
+                        deactivator.Dismiss();
+                    }
+                }
+                catch (...)
+                {
+                    ScopeManager::instanceCounts_s[scope]--;
+                    throw;
                 }
             }
@@ -111 +127 @@
 
                 if (ScopeManager::instanceCounts_s[scope] == 0)
+                    this->deactivateListeners();
+            }
+
+            void deactivateListeners()
+            {
+                for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); )
                 {
-                    for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); )
-                        (*(it++))->deactivated();
+                    if ((*it)->bActivated_)
+                    {
+                        try
+                            { (*it)->deactivated(); }
+                        catch (...)
+                            { COUT(0) << "ScopeListener::deactivated() failed! This MUST NOT happen, fix it!" << std::endl; }
+                        (*(it++))->bActivated_ = false;
+                    }
+                    else
+                        ++it;
                 }
             }

code/branches/core5/src/modules/questsystem/QuestManager.cc

@@ -57 +57 @@
     //! Pointer to the current (and single) instance of this class.
     /*static*/ QuestManager* QuestManager::singletonPtr_s = NULL;
-    ManageScopedSingleton(QuestManager, ScopeID::Root);
+    ManageScopedSingleton(QuestManager, ScopeID::Root, false);
 
     /**

code/branches/core5/src/modules/questsystem/notifications/NotificationManager.cc

@@ -48 +48 @@
 
     NotificationManager* NotificationManager::singletonPtr_s = NULL;
-    ManageScopedSingleton(NotificationManager, ScopeID::Root);
+    ManageScopedSingleton(NotificationManager, ScopeID::Root, false);
 
     /**

code/branches/core5/src/orxonox/CameraManager.cc

@@ -45 +45 @@
 namespace orxonox
 {
-    ManageScopedSingleton(CameraManager, ScopeID::Graphics);
     CameraManager* CameraManager::singletonPtr_s = 0;
+    ManageScopedSingleton(CameraManager, ScopeID::Graphics, false);
 
     CameraManager::CameraManager()

code/branches/core5/src/orxonox/LevelManager.cc

@@ -44 +44 @@
     SetCommandLineArgument(level, "").shortcut("l").information("Default level file (overrides LevelManager::defaultLevelName_ configValue)");
 
-    ManageScopedSingleton(LevelManager, ScopeID::Root);
     LevelManager* LevelManager::singletonPtr_s = 0;
+    ManageScopedSingleton(LevelManager, ScopeID::Root, false);
 
     LevelManager::LevelManager()

code/branches/core5/src/orxonox/PlayerManager.cc

@@ -39 +39 @@
 {
     PlayerManager* PlayerManager::singletonPtr_s = 0;
-    ManageScopedSingleton(PlayerManager, ScopeID::Root);
+    ManageScopedSingleton(PlayerManager, ScopeID::Root, false);
 
     PlayerManager::PlayerManager()

code/branches/core5/src/orxonox/overlays/InGameConsole.cc

@@ -62 +62 @@
 
     InGameConsole* InGameConsole::singletonPtr_s = 0;
-    ManageScopedSingleton(InGameConsole, ScopeID::Graphics);
+    ManageScopedSingleton(InGameConsole, ScopeID::Graphics, false);
 
     /**

code/branches/core5/src/orxonox/sound/SoundManager.cc

@@ -40 +40 @@
 {
     SoundManager* SoundManager::singletonPtr_s = NULL;
-    ManageScopedSingleton(SoundManager, ScopeID::Graphics);
+    ManageScopedSingleton(SoundManager, ScopeID::Graphics, true);
 
     /**