ryzom/common/src/game_share/singleton_registry.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /*
  18
  19   NOTE: The following extension would be intelligent:
  20   ---------------------------------------------------
  21   - add 'preInit', 'preServiceUpdate', 'preTickUpdate' and 'preRelease' methods
  22   - add 'postInit', 'postServiceUpdate', 'postTickUpdate' and 'postRelease' methods
  23   - call all 'preXXX' methods followed by all XXX methods followed by all postXXX methods
  24   => This allows one to open log files etc in pre-init, start counters in pre-update, stop counters in post-update, etc...
  25
  26 */
  27
  28 #ifndef SINGLETON_REGISTRY_H
  29 #define SINGLETON_REGISTRY_H
  30
  31
  32 //-------------------------------------------------------------------------------------------------
  33 // includes
  34 //-------------------------------------------------------------------------------------------------
  35
  36 #include <set>
  37
  38 //-------------------------------------------------------------------------------------------------
  39 // class IServiceSingleton
  40 //-------------------------------------------------------------------------------------------------
  41
  42 class IServiceSingleton
  43 {
  44 public:
  45         // overloadable method called at service initialisation
  46         virtual void init()                             {}
  47
  48         // overloadable method called in the service update
  49         virtual void serviceUpdate()    {}
  50
  51         // overloadable method called in the tick update
  52         virtual void tickUpdate()               {}
  53
  54         // overloadable method called at service release
  55         virtual void release()                  {}
  56
  57 protected:
  58         // protect from untrolled instantiation
  59         // this method registers the singleton with the singleton registry
  60         IServiceSingleton();
  61         virtual ~IServiceSingleton() {}
  62
  63 private:
  64         // prohibit copy
  65         IServiceSingleton(const IServiceSingleton&);
  66 };
  67
  68
  69 //-------------------------------------------------------------------------------------------------
  70 // class CSingletonRegistry
  71 //-------------------------------------------------------------------------------------------------
  72
  73 class CSingletonRegistry
  74 {
  75 public:
  76         // public interface for getting hold of the singleton instance
  77         static CSingletonRegistry* getInstance();
  78
  79         // registration of an IServiceSingleton object with the singleton
  80         void registerSingleton(IServiceSingleton*);
  81
  82         // methods called from the service loop
  83         void init();
  84         void serviceUpdate();
  85         void tickUpdate();
  86         void release();
  87
  88 private:
  89         // prohibit uncontrolled instantiation
  90         CSingletonRegistry() {}
  91         CSingletonRegistry(const CSingletonRegistry&);
  92
  93         typedef std::set<IServiceSingleton*> TSingletons;
  94         TSingletons _Singletons;
  95 };
  96
  97
  98 //-------------------------------------------------------------------------------------------------
  99 // inlines IServiceSingleton
 100 //-------------------------------------------------------------------------------------------------
 101
 102 inline IServiceSingleton::IServiceSingleton()
 103 {
 104         CSingletonRegistry::getInstance()->registerSingleton(this);
 105 }
 106
 107
 108 //-------------------------------------------------------------------------------------------------
 109 // inlines CSingletonRegistry
 110 //-------------------------------------------------------------------------------------------------
 111
 112 inline CSingletonRegistry* CSingletonRegistry::getInstance()
 113 {
 114         static CSingletonRegistry* instance= NULL;
 115         if (instance==NULL)
 116         {
 117                 instance=new CSingletonRegistry;
 118         }
 119         return instance;
 120 }
 121
 122 inline void CSingletonRegistry::registerSingleton(IServiceSingleton* singleton)
 123 {
 124         _Singletons.insert(singleton);
 125 }
 126
 127 inline void CSingletonRegistry::init()
 128 {
 129         for (TSingletons::iterator it=_Singletons.begin(); it!=_Singletons.end();++it)
 130                 (*it)->init();
 131 }
 132
 133 inline void CSingletonRegistry::tickUpdate()
 134 {
 135         for (TSingletons::iterator it=_Singletons.begin(); it!=_Singletons.end();++it)
 136                 (*it)->tickUpdate();
 137 }
 138
 139 inline void CSingletonRegistry::serviceUpdate()
 140 {
 141         for (TSingletons::iterator it=_Singletons.begin(); it!=_Singletons.end();++it)
 142                 (*it)->serviceUpdate();
 143 }
 144
 145 inline void CSingletonRegistry::release()
 146 {
 147         for (TSingletons::iterator it=_Singletons.begin(); it!=_Singletons.end();++it)
 148                 (*it)->release();
 149 }
 150
 151
 152 //-------------------------------------------------------------------------------------------------
 153 #endif