From efe4f0baddf10124581e4fcb88d55a52838b06a1 Mon Sep 17 00:00:00 2001
From: Piotr Dziwinski <piotrdz@gmail.com>
Date: Sun, 9 Sep 2012 17:51:10 +0200
Subject: Refactoring in src/common

- refactored CInstanceManager and some headers
- removed old headers
---
 src/common/iman.h | 108 ++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 97 insertions(+), 11 deletions(-)

(limited to 'src/common/iman.h')

diff --git a/src/common/iman.h b/src/common/iman.h
index 89b5206..44f143a 100644
--- a/src/common/iman.h
+++ b/src/common/iman.h
@@ -14,7 +14,10 @@
 // * You should have received a copy of the GNU General Public License
 // * along with this program. If not, see  http://www.gnu.org/licenses/.
 
-// iman.h
+/**
+ * \file iman.h
+ * \brief Instance manager for managed classes
+ */
 
 #pragma once
 
@@ -22,36 +25,119 @@
 #include <common/misc.h>
 
 
+/**
+ * \enum ManagedClassType
+ * \brief Type of class managed by CInstanceManager
+ */
 
-struct BaseClass
+// TODO: remove unnecessary, refactor to singletons, move to CRobotMain, keep others?
+
+enum ManagedClassType
 {
-    int     totalPossible;
-    int     totalUsed;
-    void**  classPointer;
+    //! CEventQueue
+    CLASS_EVENT         = 1,
+    //! Ui::CInterface
+    CLASS_INTERFACE     = 2,
+    //! CRobotMain
+    CLASS_MAIN          = 3,
+    //! Gfx::CEngine
+    CLASS_ENGINE        = 4,
+    //! Gfx::CTerrain
+    CLASS_TERRAIN       = 5,
+    //! CObject
+    CLASS_OBJECT        = 6,
+    //! CPhysics
+    CLASS_PHYSICS       = 7,
+    //! CBrain
+    CLASS_BRAIN         = 8,
+    //! Gfx::CCamera
+    CLASS_CAMERA        = 9,
+    //! Gfx::CLightManager
+    CLASS_LIGHT         = 10,
+    //! Gfx::CParticle
+    CLASS_PARTICULE     = 11,
+    //! CAuto; TODO: remove (unused)
+    CLASS_AUTO          = 12,
+    //! Ui::CDisplayText
+    CLASS_DISPLAYTEXT   = 13,
+    //! Gfx::CPyro
+    CLASS_PYRO          = 14,
+    //! Ui::CScript; TODO: remove (unused)
+    CLASS_SCRIPT        = 15,
+    //! Gfx::CText
+    CLASS_TEXT          = 16,
+    //! Ui::CStudio, Ui::CDisplayText; TODO: remove (unused)
+    CLASS_STUDIO        = 17,
+    //! Gfx::CWater
+    CLASS_WATER         = 18,
+    //! Gfx::CCloud; TODO: remove (unused)
+    CLASS_CLOUD         = 19,
+    //! CMotion; TODO: remove (unused)
+    CLASS_MOTION        = 20,
+    //! CSoundInterface
+    CLASS_SOUND         = 21,
+    //! Gfx::CPlanet
+    CLASS_PLANET        = 22,
+    //! CTaskManager; TODO: remove (unused)
+    CLASS_TASKMANAGER   = 23,
+    //! Ui::CMainDialog; TODO: remove (unused)
+    CLASS_DIALOG        = 24,
+    //! Ui::CMainMap; TODO: remove (unused)
+    CLASS_MAP           = 25,
+    //! Ui::CMainShort, CMainMovie; TODO: remove (unused)
+    CLASS_SHORT         = 26,
+    //! Gfx::CLightning; TODO: remove (unused)
+    CLASS_BLITZ         = 27,
+
+    //! Maximum (number of managed classes)
+    CLASS_MAX           = 30
 };
 
 
+/**
+ * \enum ManagedClassInstances
+ * \brief Instances of class managed by CInstanceManager
+ */
+struct ManagedClassInstances
+{
+    int     maxCount;
+    int     usedCount;
+    void**  instances;
+};
 
+/**
+ * \class CInstanceManager
+ * \brief Manager for instances of certain classes
+ *
+ * Instance manager (often shortened to iMan) allows to register instances of
+ * classes and search them.
+ */
 class CInstanceManager : public CSingleton<CInstanceManager>
 {
 public:
     CInstanceManager();
     ~CInstanceManager();
 
+    //! Remove all managed instances
     void    Flush();
-    void    Flush(ClassType classType);
-    bool    AddInstance(ClassType classType, void* pointer, int max=1);
-    bool    DeleteInstance(ClassType classType, void* pointer);
-    void*   SearchInstance(ClassType classType, int rank=0);
+    //! Removes instances of one type of class
+    void    Flush(ManagedClassType classType);
+    //! Registers new instance of class type
+    bool    AddInstance(ManagedClassType classType, void* instance, int max=1);
+    //! Deletes the registered instance of class type
+    bool    DeleteInstance(ManagedClassType classType, void* instance);
+    //! Seeks a class instance of given type
+    void*   SearchInstance(ManagedClassType classType, int rank=0);
 
     static CInstanceManager& GetInstance();
     static CInstanceManager* GetInstancePointer();
 
 protected:
-    void    Compress(ClassType classType);
+    //! Fills holes in instance table
+    void    Compress(ManagedClassType classType);
 
 protected:
-    BaseClass   m_table[CLASS_MAX];
+    ManagedClassInstances m_table[CLASS_MAX];
 };
 
 
-- 
cgit v1.2.3-1-g7c22