Changeset 5867

Timestamp:

Oct 4, 2009, 12:02:28 AM (15 years ago)

Author:

rgrieder

Message:

Modified Scoped Singleton concept: Derive from Singleton normally, but place an important pre-main() instruction in the source file: ManageScopedSingleton(className, scope) (it's a macro).
This causes the Singleton to be created and destroyed with the Scope. Thus if a Singleton c'tor throws, it is much easier to react accordingly.

Location:

code/branches/core5/src

Files:

• libraries/core/CMakeLists.txt (modified) (1 diff)
• libraries/core/Core.cc (modified) (3 diffs)
• libraries/core/ScopedSingletonManager.cc (added)
• libraries/core/ScopedSingletonManager.h (added)
• libraries/util/Scope.h (modified) (2 diffs)
• libraries/util/ScopedSingleton.h (deleted)
• libraries/util/Singleton.h (modified) (1 diff)
• modules/questsystem/QuestManager.cc (modified) (2 diffs)
• modules/questsystem/QuestManager.h (modified) (3 diffs)
• modules/questsystem/QuestsystemPrecompiledHeaders.h (modified) (1 diff)
• modules/questsystem/notifications/NotificationManager.cc (modified) (2 diffs)
• modules/questsystem/notifications/NotificationManager.h (modified) (2 diffs)
• orxonox/CameraManager.cc (modified) (3 diffs)
• orxonox/CameraManager.h (modified) (2 diffs)
• orxonox/LevelManager.cc (modified) (2 diffs)
• orxonox/LevelManager.h (modified) (3 diffs)
• orxonox/PlayerManager.cc (modified) (2 diffs)
• orxonox/PlayerManager.h (modified) (1 diff)
• orxonox/overlays/InGameConsole.cc (modified) (2 diffs)
• orxonox/overlays/InGameConsole.h (modified) (2 diffs)
• orxonox/sound/SoundManager.cc (modified) (2 diffs)
• orxonox/sound/SoundManager.h (modified) (2 diffs)

code/branches/core5/src/libraries/core/CMakeLists.txt

@@ -37 +37 @@
   PathConfig.cc
   Resource.cc
+  ScopedSingletonManager.cc
   WindowEventListener.cc
 

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

@@ -65 +65 @@
 #include "Language.h"
 #include "LuaState.h"
+#include "ScopedSingletonManager.h"
 #include "Shell.h"
 #include "TclBind.h"
@@ -433 +434 @@
     {
         // singletons from other libraries
-        Scope<ScopeID::Root>::update(time);
+        ScopedSingletonManager::update(time, ScopeID::Root);
         if (this->bGraphicsLoaded_)
         {
@@ -441 +442 @@
             this->guiManager_->update(time);
             // graphics singletons from other libraries
-            Scope<ScopeID::Graphics>::update(time);
+            ScopedSingletonManager::update(time, ScopeID::Graphics);
         }
         // process thread commands

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

@@ -73 +73 @@
             //! Gets called if the scope is deactivated
             virtual void deactivated() = 0;
-            //! Gets called if the scope is updated
-            virtual void updated(const Clock& time) = 0;
 
         private:
@@ -124 +122 @@
                 return (ScopeManager::instanceCounts_s[scope] > 0);
             }
-
-            //! Update method for the ScopeListeners (to implement singleton updates)
-            static void update(const Clock& time)
-            {
-                if (isActive())
-                {
-                    for (typename std::set<ScopeListener*>::iterator it = ScopeManager::listeners_s[scope].begin(); it != ScopeManager::listeners_s[scope].end(); )
-                        (*(it++))->updated(time);
-                }
-            }
     };
 }

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

@@ -55 +55 @@
         }
 
+        //! Update method called by ClassSingletonManager (if used)
+        void updateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->update(time); }
+        //! Empty update method for the static polymorphism
+        void update(const Clock& time) { }
+
     protected:
         //! Constructor sets the singleton instance pointer

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

@@ -41 +41 @@
 #include "core/ConsoleCommand.h"
 #include "core/LuaState.h"
+#include "core/ScopedSingletonManager.h"
 #include "infos/PlayerInfo.h"
 #include "overlays/GUIOverlay.h"
@@ -56 +57 @@
     //! Pointer to the current (and single) instance of this class.
     /*static*/ QuestManager* QuestManager::singletonPtr_s = NULL;
+    ManageScopedSingleton(QuestManager, ScopeID::Root);
 
     /**

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

@@ -42 +42 @@
 #include <string>
 
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "core/OrxonoxClass.h"
 
@@ -59 +59 @@
     class _QuestsystemExport QuestManager
 // tolua_end
-        : public ScopedSingleton<QuestManager, ScopeID::Root>, public orxonox::OrxonoxClass
+        : public Singleton<QuestManager>, public orxonox::OrxonoxClass
     { // tolua_export
 
-            friend class ScopedSingleton<QuestManager, ScopeID::Root>;
+            friend class Singleton<QuestManager>;
             friend class QuestGUI;
 
@@ -70 +70 @@
 
             //! Returns a reference to the single instance of the Quest Manager.
-            static QuestManager& getInstance() { return ScopedSingleton<QuestManager, ScopeID::Root>::getInstance(); } // tolua_export
+            static QuestManager& getInstance() { return Singleton<QuestManager>::getInstance(); } // tolua_export
 
             //! Retreive the main window for the GUI. 

code/branches/core5/src/modules/questsystem/QuestsystemPrecompiledHeaders.h

@@ -51 +51 @@
 #include <OgreColourValue.h> // 16
 
-#include <tinyxml/ticpp.h>        // 14
-#include "util/ScopedSingleton.h" // 13
+#include <tinyxml/ticpp.h>   // 14
+#include "util/Singleton.h"  // 13
 
 ///////////////////////////////////////////

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

@@ -37 +37 @@
 
 #include "core/CoreIncludes.h"
+#include "core/ScopedSingletonManager.h"
 #include "Notification.h"
 #include "interfaces/NotificationListener.h"
@@ -47 +48 @@
 
     NotificationManager* NotificationManager::singletonPtr_s = NULL;
+    ManageScopedSingleton(NotificationManager, ScopeID::Root);
 
     /**

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

@@ -41 +41 @@
 #include <string>
 
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "core/OrxonoxClass.h"
 
@@ -53 +53 @@
         Damian 'Mozork' Frick
     */
-    class _QuestsystemExport NotificationManager : public ScopedSingleton<NotificationManager, ScopeID::Root>, public OrxonoxClass
+    class _QuestsystemExport NotificationManager : public Singleton<NotificationManager>, public OrxonoxClass
     {
-            friend class ScopedSingleton<NotificationManager, ScopeID::Root>;
+            friend class Singleton<NotificationManager>;
         public:
             NotificationManager();

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

@@ -26 +26 @@
  *
  */
+
 #include "CameraManager.h"
 
@@ -37 +38 @@
 #include "core/GUIManager.h"
 #include "core/ObjectList.h"
+#include "core/ScopedSingletonManager.h"
 #include "tools/Shader.h"
 #include "graphics/Camera.h"
@@ -43 +45 @@
 namespace orxonox
 {
+    ManageScopedSingleton(CameraManager, ScopeID::Graphics);
     CameraManager* CameraManager::singletonPtr_s = 0;
 

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

@@ -41 +41 @@
 #include <list>
 #include "util/OgreForwardRefs.h"
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "core/OrxonoxClass.h"
 #include "core/SmartPtr.h"
@@ -47 +47 @@
 namespace orxonox
 {
-    class _OrxonoxExport CameraManager : public ScopedSingleton<CameraManager, ScopeID::Graphics>, public OrxonoxClass
+    class _OrxonoxExport CameraManager : public Singleton<CameraManager>, public OrxonoxClass
     {
-            friend class ScopedSingleton<CameraManager, ScopeID::Graphics>;
+            friend class Singleton<CameraManager>;
         public:
             CameraManager();

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

@@ -36 +36 @@
 #include "core/CoreIncludes.h"
 #include "core/Loader.h"
+#include "core/ScopedSingletonManager.h"
 #include "PlayerManager.h"
 #include "Level.h"
@@ -43 +44 @@
     SetCommandLineArgument(level, "").shortcut("l").information("Default level file (overrides LevelManager::defaultLevelName_ configValue)");
 
+    ManageScopedSingleton(LevelManager, ScopeID::Root);
     LevelManager* LevelManager::singletonPtr_s = 0;
 

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

@@ -36 +36 @@
 #include <string>
 
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "core/OrxonoxClass.h"
 
@@ -44 +44 @@
     class _OrxonoxExport LevelManager
     // tolua_end
-        : public ScopedSingleton<LevelManager, ScopeID::Root>, public OrxonoxClass
+        : public Singleton<LevelManager>, public OrxonoxClass
     { // tolua_export
-            friend class ScopedSingleton<LevelManager, ScopeID::Root>;
+            friend class Singleton<LevelManager>;
         public:
             LevelManager();
@@ -63 +63 @@
 
             static LevelManager* getInstancePtr() { return singletonPtr_s; }
-            static LevelManager& getInstance()    { return ScopedSingleton<LevelManager, ScopeID::Root>::getInstance(); } // tolua_export
+            static LevelManager& getInstance()    { return Singleton<LevelManager>::getInstance(); } // tolua_export
 
         private:

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

@@ -31 +31 @@
 #include "core/CoreIncludes.h"
 #include "core/GameMode.h"
+#include "core/ScopedSingletonManager.h"
 #include "Level.h"
 #include "infos/HumanPlayer.h"
@@ -38 +39 @@
 {
     PlayerManager* PlayerManager::singletonPtr_s = 0;
+    ManageScopedSingleton(PlayerManager, ScopeID::Root);
 
     PlayerManager::PlayerManager()

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

@@ -34 +34 @@
 #include <cassert>
 #include <map>
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "network/ClientConnectionListener.h"
 
 namespace orxonox
 {
-    class _OrxonoxExport PlayerManager : public ScopedSingleton<PlayerManager, ScopeID::Root>, public ClientConnectionListener
+    class _OrxonoxExport PlayerManager : public Singleton<PlayerManager>, public ClientConnectionListener
     {
-            friend class ScopedSingleton<PlayerManager, ScopeID::Root>;
+            friend class Singleton<PlayerManager>;
         public:
             PlayerManager();

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

@@ -48 +48 @@
 #include "core/ConfigValueIncludes.h"
 #include "core/ConsoleCommand.h"
+#include "core/ScopedSingletonManager.h"
 #include "core/input/InputManager.h"
 #include "core/input/InputState.h"
@@ -61 +62 @@
 
     InGameConsole* InGameConsole::singletonPtr_s = 0;
+    ManageScopedSingleton(InGameConsole, ScopeID::Graphics);
 
     /**

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

@@ -36 +36 @@
 
 #include "util/OgreForwardRefs.h"
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "core/Shell.h"
 #include "core/WindowEventListener.h"
@@ -42 +42 @@
 namespace orxonox
 {
-    class _OrxonoxExport InGameConsole : public ScopedSingleton<InGameConsole, ScopeID::Graphics>, public ShellListener, public WindowEventListener
+    class _OrxonoxExport InGameConsole : public Singleton<InGameConsole>, public ShellListener, public WindowEventListener
     {
-        friend class ScopedSingleton<InGameConsole, ScopeID::Graphics>;
+        friend class Singleton<InGameConsole>;
     public: // functions
         InGameConsole();

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

@@ -32 +32 @@
 
 #include "util/Math.h"
+#include "core/ScopedSingletonManager.h"
 #include "CameraManager.h"
 #include "graphics/Camera.h"
@@ -39 +40 @@
 {
     SoundManager* SoundManager::singletonPtr_s = NULL;
+    ManageScopedSingleton(SoundManager, ScopeID::Graphics);
 
     /**

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

@@ -32 +32 @@
 #include <cassert>
 #include <list>
-#include "util/ScopedSingleton.h"
+#include "util/Singleton.h"
 #include "tools/interfaces/Tickable.h"
 
@@ -43 +43 @@
      *
      */
-    class _OrxonoxExport SoundManager : public ScopedSingleton<SoundManager, ScopeID::Graphics>, public Tickable
+    class _OrxonoxExport SoundManager : public Singleton<SoundManager>, public Tickable
     {
-        friend class ScopedSingleton<SoundManager, ScopeID::Graphics>;
+        friend class Singleton<SoundManager>;
     public:
         SoundManager();