Changeset 5850

Timestamp:

Oct 1, 2009, 11:44:53 AM (15 years ago)

Author:

rgrieder

Message:

Moved the singleton creation/destruction mess to the Core class by using just two possible Scopes:

• ScopeID::Root for singletons that may always persists
• ScopeID::Graphics for singletons that only work when graphics was loaded

Location:

code/branches/core5/src

Files:

• libraries/core/Core.cc (modified) (5 diffs)
• libraries/core/Core.h (modified) (2 diffs)
• libraries/util/Scope.h (modified) (4 diffs)
• libraries/util/ScopedSingleton.h (modified) (3 diffs)
• modules/questsystem/QuestManager.h (modified) (3 diffs)
• modules/questsystem/notifications/NotificationManager.h (modified) (2 diffs)
• orxonox/CameraManager.cc (modified) (2 diffs)
• orxonox/CameraManager.h (modified) (1 diff)
• orxonox/LevelManager.h (modified) (3 diffs)
• orxonox/PlayerManager.h (modified) (1 diff)
• orxonox/gamestates/GSGraphics.cc (modified) (5 diffs)
• orxonox/gamestates/GSGraphics.h (modified) (1 diff)
• orxonox/gamestates/GSLevel.cc (modified) (6 diffs)
• orxonox/gamestates/GSLevel.h (modified) (2 diffs)
• orxonox/gamestates/GSRoot.cc (modified) (3 diffs)
• orxonox/gamestates/GSRoot.h (modified) (1 diff)
• orxonox/overlays/InGameConsole.cc (modified) (1 diff)
• orxonox/overlays/InGameConsole.h (modified) (2 diffs)
• orxonox/sound/SoundManager.h (modified) (2 diffs)

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

@@ -264 +264 @@
         // create a shell
         this->shell_.reset(new Shell());
+
+        // Create singletons that always exist (in other libraries)
+        this->rootScope_.reset(new Scope<ScopeID::Root>());
     }
 
@@ -289 +292 @@
             inputManager_->getMousePosition(), graphicsManager_->isFullScreen()));
 
+        // Create singletons associated with graphics (in other libraries)
+        graphicsScope_.reset(new Scope<ScopeID::Graphics>());
+
         unloader.Dismiss();
 
@@ -296 +302 @@
     void Core::unloadGraphics()
     {
-        this->guiManager_.reset();;
-        this->inputManager_.reset();;
+        this->graphicsScope_.reset();
+        this->guiManager_.reset();
+        this->inputManager_.reset();
         this->graphicsManager_.reset();
 
@@ -420 +427 @@
     void Core::preUpdate(const Clock& time)
     {
+        // singletons from other libraries
+        Scope<ScopeID::Root>::update(time);
         if (this->bGraphicsLoaded_)
         {
@@ -426 +435 @@
             // process gui events
             this->guiManager_->update(time);
+            // graphics singletons from other libraries
+            Scope<ScopeID::Graphics>::update(time);
         }
         // process thread commands

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

@@ -36 +36 @@
 #include <boost/scoped_ptr.hpp>
 #include "util/OutputHandler.h"
+#include "util/Scope.h"
 #include "util/ScopeGuard.h"
 #include "util/Singleton.h"
@@ -100 +101 @@
             scoped_ptr<InputManager>      inputManager_;        //!< Interface to OIS
             scoped_ptr<GUIManager>        guiManager_;          //!< Interface to GUI
+            scoped_ptr<Scope<ScopeID::Root> >     rootScope_;
+            scoped_ptr<Scope<ScopeID::Graphics> > graphicsScope_;
 
             bool                          bGraphicsLoaded_;

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

@@ -31 +31 @@
 
 #include "UtilPrereqs.h"
+
 #include <cassert>
+#include <map>
 #include <set>
-#include <map>
 #include "Debug.h"
 
@@ -45 +46 @@
         enum Value
         {
-            GSRoot,
-            GSGraphics,
-            GSLevel
+            Root,
+            Graphics
         };
     }
 
-    class ScopeListener; // Forward declaration
+    // Forward declarations
+    class ScopeListener;
+    class Clock;
 
     /**
@@ -87 +89 @@
             //! 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:
@@ -136 +140 @@
                 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/ScopedSingleton.h

@@ -37 +37 @@
 namespace orxonox
 {
+    class Clock;
     /**
     @brief
@@ -59 +60 @@
                 assert(Scope<scope>::isActive());
 
-                if (!T::singletonPtr_s && Scope<scope>::isActive())
+                if (!T::singletonPtr_s)
                     T::singletonPtr_s = new T();
 
                 return *T::singletonPtr_s;
             }
+
+            //! Update method for singletons like the ingame console
+            virtual void updated(const Clock& time) { static_cast<T*>(this)->update(time); }
+            //! Empty update method for the static polymorphism
+            void update(const Clock& time) { }
 
         protected:
@@ -85 +91 @@
             {
                 // The ScopedSingleton shouldn't be active bevor the scope is activated -> always assertion failed
-                assert(T::singletonPtr_s == 0 && false);
+                assert(false);
             }
 

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

@@ -50 +50 @@
 namespace orxonox
 {
-
-    typedef ScopedSingleton<QuestManager, ScopeID::GSLevel> ScopedSingletonQuestManagerGSLevel; // workaround for tolua
-
     /**
     @brief
@@ -60 +57 @@
         Damian 'Mozork' Frick
     */
-    class _QuestsystemExport QuestManager : public ScopedSingletonQuestManagerGSLevel, public orxonox::OrxonoxClass
-    {
+    class _QuestsystemExport QuestManager
 // tolua_end
+        : public ScopedSingleton<QuestManager, ScopeID::Root>, public orxonox::OrxonoxClass
+    { // tolua_export
 
-            friend class ScopedSingleton<QuestManager, ScopeID::GSLevel>;
+            friend class ScopedSingleton<QuestManager, ScopeID::Root>;
             friend class QuestGUI;
 
@@ -72 +70 @@
 
             //! Returns a reference to the single instance of the Quest Manager.
-            static QuestManager& getInstance() { return ScopedSingleton<QuestManager, ScopeID::GSLevel>::getInstance(); } // tolua_export
+            static QuestManager& getInstance() { return ScopedSingleton<QuestManager, ScopeID::Root>::getInstance(); } // tolua_export
 
             //! Retreive the main window for the GUI. 

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

@@ -46 +46 @@
 namespace orxonox
 {
-
     /**
     @brief
@@ -54 +53 @@
         Damian 'Mozork' Frick
     */
-    class _QuestsystemExport NotificationManager : public ScopedSingleton<NotificationManager, ScopeID::GSLevel>, public OrxonoxClass
+    class _QuestsystemExport NotificationManager : public ScopedSingleton<NotificationManager, ScopeID::Root>, public OrxonoxClass
     {
-            friend class ScopedSingleton<NotificationManager, ScopeID::GSLevel>;
+            friend class ScopedSingleton<NotificationManager, ScopeID::Root>;
         public:
             NotificationManager();

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

@@ -34 +34 @@
 #include "util/StringUtils.h"
 #include "core/GameMode.h"
+#include "core/GraphicsManager.h"
 #include "core/GUIManager.h"
 #include "core/ObjectList.h"
@@ -44 +45 @@
     CameraManager* CameraManager::singletonPtr_s = 0;
 
-    CameraManager::CameraManager(Ogre::Viewport* viewport)
-        : viewport_(viewport)
+    CameraManager::CameraManager()
+        : viewport_(GraphicsManager::getInstance().getViewport())
     {
         this->fallbackCamera_ = 0;

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

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

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

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

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

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

code/branches/core5/src/orxonox/gamestates/GSGraphics.cc

@@ -46 +46 @@
 #include "core/Loader.h"
 #include "core/XMLFile.h"
-#include "overlays/InGameConsole.h"
-#include "sound/SoundManager.h"
 
 // HACK:
@@ -58 +56 @@
     GSGraphics::GSGraphics(const GameStateInfo& info)
         : GameState(info)
-        , console_(0)
-        , soundManager_(0)
         , masterKeyBinder_(0)
         , masterInputState_(0)
@@ -100 +96 @@
         masterKeyBinder_->loadBindings("masterKeybindings.ini");
 
-        // Load the SoundManager
-        soundManager_ = new SoundManager();
-
-        // Load the InGameConsole
-        console_ = new InGameConsole();
-        console_->initialise();
-
         // add console command to toggle GUI
         this->ccToggleGUI_ = createConsoleCommand(createFunctor(&GSGraphics::toggleGUI, this), "toggleGUI");
@@ -131 +120 @@
 */
 
-        this->console_->destroy();
-
         Loader::unload(this->debugOverlay_);
         delete this->debugOverlay_;
-
-        this->soundManager_->destroy();
 
         // HACK: (destroys a resource smart pointer)
@@ -170 +155 @@
             Game::getInstance().requestState("mainMenu");
         }
-
-        this->console_->update(time);
     }
 }

code/branches/core5/src/orxonox/gamestates/GSGraphics.h

@@ -60 +60 @@
 
     private:
-        // managed singletons
-        InGameConsole*        console_;
-        SoundManager*         soundManager_;        //!< Keeps track of SoundBase objects
-
         KeyBinder*            masterKeyBinder_;     //!< Key binder for master key bindings
         InputState*           masterInputState_;    //!< Special input state for master input

code/branches/core5/src/orxonox/gamestates/GSLevel.cc

@@ -41 +41 @@
 #include "core/Game.h"
 #include "core/GameMode.h"
-#include "core/GraphicsManager.h"
 #include "core/GUIManager.h"
 #include "core/Loader.h"
 #include "core/XMLFile.h"
 
-#include "tools/interfaces/Tickable.h"
-#include "CameraManager.h"
 #include "LevelManager.h"
 #include "PlayerManager.h"
-#include "infos/HumanPlayer.h"
 
 namespace orxonox
@@ -65 +61 @@
         , guiMouseOnlyInputState_(0)
         , guiKeysOnlyInputState_(0)
-        , cameraManager_(0)
     {
         RegisterObject(GSLevel);
@@ -98 +93 @@
             guiKeysOnlyInputState_ = InputManager::getInstance().createInputState("guiKeysOnly");
             guiKeysOnlyInputState_->setKeyHandler(GUIManager::getInstancePtr());
-
-            // create the global CameraManager
-            this->cameraManager_ = new CameraManager(GraphicsManager::getInstance().getViewport());
-        }
-
-        this->playerManager_ = new PlayerManager();
-
-        this->scope_GSLevel_ = new Scope<ScopeID::GSLevel>();
+        }
 
         if (GameMode::isMaster())
@@ -126 +114 @@
             
             // connect the HumanPlayer to the game
-            this->playerManager_->clientConnected(0);
+            PlayerManager::getInstance().clientConnected(0);
         }
     }
@@ -165 +153 @@
         {
             // disconnect the HumanPlayer
-            this->playerManager_->clientDisconnected(0);
+            PlayerManager::getInstance().clientDisconnected(0);
             
             // unload all compositors (this is only necessary because we don't yet destroy all resources!)
@@ -184 +172 @@
         if (GameMode::isMaster())
             this->unloadLevel();
-
-        if (this->cameraManager_)
-        {
-            delete this->cameraManager_;
-            this->cameraManager_ = 0;
-        }
-
-        if (this->playerManager_)
-        {
-            this->playerManager_->destroy();
-            this->playerManager_ = 0;
-        }
-
-        if (this->scope_GSLevel_)
-        {
-            delete this->scope_GSLevel_;
-            this->scope_GSLevel_ = NULL;
-        }
 
         if (GameMode::showsGraphics())

code/branches/core5/src/orxonox/gamestates/GSLevel.h

@@ -33 +33 @@
 
 #include <string>
-#include "util/Scope.h"
 #include "core/OrxonoxClass.h"
 #include "core/GameState.h"
@@ -67 +66 @@
         InputState*              guiMouseOnlyInputState_;  //!< input state if we only need the mouse to use the GUI
         InputState*              guiKeysOnlyInputState_;   //!< input state if we only need the keys to use the GUI
-        CameraManager*           cameraManager_;           //!< camera manager for this level
-        PlayerManager*           playerManager_;           //!< player manager for this level
-        Scope<ScopeID::GSLevel>* scope_GSLevel_;
 
         //##### ConfigValues #####

code/branches/core5/src/orxonox/gamestates/GSRoot.cc

@@ -37 +37 @@
 #include "tools/interfaces/TimeFactorListener.h"
 #include "tools/interfaces/Tickable.h"
-#include "LevelManager.h"
 
 namespace orxonox
@@ -70 +69 @@
         this->ccPause_ = createConsoleCommand(createFunctor(&GSRoot::pause, this), "pause");
         CommandExecutor::addConsoleCommandShortcut(this->ccPause_).accessLevel(AccessLevel::Offline);
-
-        // create the LevelManager
-        this->levelManager_ = new LevelManager();
     }
 
@@ -90 +86 @@
         }
 */
-
-        this->levelManager_->destroy();
     }
 

code/branches/core5/src/orxonox/gamestates/GSRoot.h

@@ -56 +56 @@
         float                 timeFactorPauseBackup_;
 
-        LevelManager*         levelManager_;            //!< global level manager
-
         // console commands
         ConsoleCommand*       ccSetTimeFactor_;

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

@@ -85 +85 @@
 
         this->setConfigValues();
+        this->initialise();
     }
 

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

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

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

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