Changeset 9570

Timestamp:

Mar 24, 2013, 8:51:37 PM (12 years ago)

Author:

landauf

Message:

moved functions and attributes needed to safely destroy objects from OrxonoxClass to Destroyable

Location:

code/branches/core6/src/libraries/core

Files:

• CorePrereqs.h (modified) (1 diff)
• class/Identifiable.h (modified) (1 diff)
• class/OrxonoxClass.cc (modified) (3 diffs)
• class/OrxonoxClass.h (modified) (2 diffs)
• object/CMakeLists.txt (modified) (1 diff)
• object/Destroyable.cc (copied) (copied from code/branches/core6/src/libraries/core/class/OrxonoxClass.cc) (4 diffs)
• object/Destroyable.h (copied) (copied from code/branches/core6/src/libraries/core/class/OrxonoxClass.h) (4 diffs)

code/branches/core6/src/libraries/core/CorePrereqs.h

@@ -143 +143 @@
     class Context;
     class Core;
+    class Destroyable;
     class DestructionListener;
     class DynLib;

code/branches/core6/src/libraries/core/class/Identifiable.h

@@ -57 +57 @@
             virtual ~Identifiable();
 
-            void destroy();
             void unregisterObject();
 

code/branches/core6/src/libraries/core/class/OrxonoxClass.cc

@@ -35 +35 @@
 
 #include <cassert>
-#include "core/object/MetaObjectList.h"
-#include "core/object/Context.h"
-#include "Identifier.h"
 
 namespace orxonox
@@ -46 +43 @@
     OrxonoxClass::OrxonoxClass()
     {
-        this->referenceCount_ = 0;
-        this->requestedDestruction_ = false;
     }
 
@@ -55 +50 @@
     OrxonoxClass::~OrxonoxClass()
     {
-        assert(this->referenceCount_ <= 0);
-
-        // notify all destruction listeners
-        for (std::set<DestructionListener*>::iterator it = this->destructionListeners_.begin(); it != this->destructionListeners_.end(); )
-            (*(it++))->objectDeleted();
-    }
-
-    /**
-        @brief Deletes the object if no @ref orxonox::SmartPtr "smart pointers" point to this object. Otherwise schedules the object to be deleted as soon as possible.
-    */
-    void OrxonoxClass::destroy()
-    {
-        assert(this); // Just in case someone tries to delete a NULL pointer
-        this->requestedDestruction_ = true;
-        if (this->referenceCount_ == 0)
-        {
-            this->preDestroy();
-            if (this->referenceCount_ == 0)
-                delete this;
-        }
     }
 }

code/branches/core6/src/libraries/core/class/OrxonoxClass.h

@@ -43 +43 @@
 #include "core/CorePrereqs.h"
 
-#include <set>
-//#include "Super.h"
 #include "Identifiable.h"
+#include "core/object/Destroyable.h"
 
 namespace orxonox
@@ -54 +53 @@
         The BaseObject and Interfaces are derived with @c virtual @c public @c OrxonoxClass from OrxonoxClass.
     */
-    class _CoreExport OrxonoxClass : public Identifiable
+    class _CoreExport OrxonoxClass : public Identifiable, public Destroyable
     {
-        template <class T>
-        friend class SmartPtr;
-
-        friend class DestructionListener;
-
         public:
             OrxonoxClass();
             virtual ~OrxonoxClass();
 
-            void destroy();
-
             /// Function to collect the SetConfigValue-macro calls.
             void setConfigValues() {};
-
-            /// Returns the number of @ref orxonox::SmartPtr "smart pointers" that point to this object.
-            inline unsigned int getReferenceCount() const
-                { return this->referenceCount_; }
-
-        protected:
-            /// This virtual function is called if destroy() is called and no SmartPtr points to this object. Used in some cases to create a new SmartPtr to prevent destruction.
-            virtual void preDestroy() {}
-
-        private:
-            /// Increments the reference counter (for smart pointers).
-            inline void incrementReferenceCount()
-                { ++this->referenceCount_; }
-            /// Decrements the reference counter (for smart pointers).
-            inline void decrementReferenceCount()
-            {
-                --this->referenceCount_;
-                if (this->referenceCount_ == 0 && this->requestedDestruction_)
-                    this->destroy();
-            }
-
-            /// Register a destruction listener (for example a weak pointer which points to this object).
-            inline void registerDestructionListener(DestructionListener* pointer)
-                { this->destructionListeners_.insert(pointer); }
-            /// Unegister a destruction listener (for example a weak pointer which pointed to this object before).
-            inline void unregisterDestructionListener(DestructionListener* pointer)
-                { this->destructionListeners_.erase(pointer); }
-
-            int referenceCount_;                                    //!< Counts the references from smart pointers to this object
-            bool requestedDestruction_;                             //!< Becomes true after someone called delete on this object
-            std::set<DestructionListener*> destructionListeners_;   //!< All destruction listeners (for example weak pointers which point to this object and like to get notified if it dies)
     };
-
-    /**
-        @brief This listener is used to inform weak pointers if an object of type OrxonoxClass gets destroyed.
-    */
-    class _CoreExport DestructionListener
-    {
-        friend class OrxonoxClass;
-
-        protected:
-            virtual ~DestructionListener() {}
-
-            inline void registerAsDestructionListener(OrxonoxClass* object)
-                { if (object) { object->registerDestructionListener(this); } }
-            inline void unregisterAsDestructionListener(OrxonoxClass* object)
-                { if (object) { object->unregisterDestructionListener(this); } }
-
-            virtual void objectDeleted() = 0;
-    };
-
 }
 

code/branches/core6/src/libraries/core/object/CMakeLists.txt

@@ -2 +2 @@
   Context.cc
   ContextObject.cc
+  Destroyable.cc
   MetaObjectList.cc
   ObjectListBase.cc

code/branches/core6/src/libraries/core/object/Destroyable.cc

@@ -29 +29 @@
 /**
     @file
-    @brief Implementation of OrxonoxClass.
+    @brief Implementation of Destroyable.
 */
 
-#include "OrxonoxClass.h"
+#include "Destroyable.h"
 
 #include <cassert>
-#include "core/object/MetaObjectList.h"
-#include "core/object/Context.h"
-#include "Identifier.h"
 
 namespace orxonox
@@ -44 +41 @@
         @brief Constructor: Sets the default values.
     */
-    OrxonoxClass::OrxonoxClass()
+    Destroyable::Destroyable()
     {
         this->referenceCount_ = 0;
@@ -53 +50 @@
         @brief Destructor: Notifies all DestructionListener (for example @ref WeakPtr "weak pointers") that this object is being deleted.
     */
-    OrxonoxClass::~OrxonoxClass()
+    Destroyable::~Destroyable()
     {
         assert(this->referenceCount_ <= 0);
@@ -65 +62 @@
         @brief Deletes the object if no @ref orxonox::SmartPtr "smart pointers" point to this object. Otherwise schedules the object to be deleted as soon as possible.
     */
-    void OrxonoxClass::destroy()
+    void Destroyable::destroy()
     {
         assert(this); // Just in case someone tries to delete a NULL pointer

code/branches/core6/src/libraries/core/object/Destroyable.h

@@ -28 +28 @@
 
 /**
-    @defgroup OrxonoxClass OrxonoxClass
-    @ingroup Class
+    @file
+    @ingroup Object
+    @brief Declaration of Destroyable, the base class of all objects which can be used with SmartPtr and WeakPtr.
 */
 
-/**
-    @file
-    @ingroup Class OrxonoxClass
-    @brief Declaration of OrxonoxClass, the base class of all objects and interfaces in Orxonox.
-*/
-
-#ifndef _OrxonoxClass_H__
-#define _OrxonoxClass_H__
+#ifndef _Destroyable_H__
+#define _Destroyable_H__
 
 #include "core/CorePrereqs.h"
 
 #include <set>
-//#include "Super.h"
-#include "Identifiable.h"
 
 namespace orxonox
 {
     /**
-        @brief The class all objects and interfaces of the game-logic (not the engine) are derived from.
-
-        The BaseObject and Interfaces are derived with @c virtual @c public @c OrxonoxClass from OrxonoxClass.
+        @brief Classes must inherit from this class if they should be used with SmartPtr or WeakPtr.
     */
-    class _CoreExport OrxonoxClass : public Identifiable
+    class _CoreExport Destroyable
     {
         template <class T>
@@ -62 +53 @@
 
         public:
-            OrxonoxClass();
-            virtual ~OrxonoxClass();
+            Destroyable();
+            virtual ~Destroyable();
 
             void destroy();
-
-            /// Function to collect the SetConfigValue-macro calls.
-            void setConfigValues() {};
 
             /// Returns the number of @ref orxonox::SmartPtr "smart pointers" that point to this object.
@@ -103 +91 @@
 
     /**
-        @brief This listener is used to inform weak pointers if an object of type OrxonoxClass gets destroyed.
+        @brief This listener is used to inform weak pointers if an object of type Destroyable gets destroyed.
     */
     class _CoreExport DestructionListener
     {
-        friend class OrxonoxClass;
+        friend class Destroyable;
 
         protected:
             virtual ~DestructionListener() {}
 
-            inline void registerAsDestructionListener(OrxonoxClass* object)
+            inline void registerAsDestructionListener(Destroyable* object)
                 { if (object) { object->registerDestructionListener(this); } }
-            inline void unregisterAsDestructionListener(OrxonoxClass* object)
+            inline void unregisterAsDestructionListener(Destroyable* object)
                 { if (object) { object->unregisterDestructionListener(this); } }
 
@@ -122 +110 @@
 }
 
-#endif /* _OrxonoxClass_H__ */
+#endif /* _Destroyable_H__ */