Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Aug 29, 2015, 5:35:59 PM (9 years ago)
Author:
landauf
Message:

renamed SmartPtr to StrongPtr (now we have weak and strong pointers)

Location:
code/branches/core7/src/libraries/core/object
Files:
4 edited
1 moved

Legend:

Unmodified
Added
Removed

  • code/branches/core7/src/libraries/core/object/DestroyLaterManager.cc

    r10464 r10555  
    5151    void DestroyLaterManager::postUpdate(const Clock& time)
    5252    {
    53         // clearing the list will destroy all smartpointers and thus all retained instances (as long as there are no other smart pointers pointing to them).
     53        // clearing the list will destroy all strong pointers and thus all retained instances (as long as there are no other strong pointers pointing to them).
    5454        this->retainedInstances_.clear();
    5555    }

  • code/branches/core7/src/libraries/core/object/DestroyLaterManager.h

    r10419 r10555  
    3434#include "util/Singleton.h"
    3535#include "core/UpdateListener.h"
    36 #include "SmartPtr.h"
     36#include "StrongPtr.h"
    3737
    3838namespace orxonox
    … …  
    5252
    5353        private:
    54             std::vector<SmartPtr<Destroyable> > retainedInstances_;
     54            std::vector<StrongPtr<Destroyable> > retainedInstances_;
    5555
    5656            static DestroyLaterManager* singletonPtr_s;

  • code/branches/core7/src/libraries/core/object/Destroyable.cc

    r10419 r10555  
    6161
    6262    /**
    63         @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.
    64         Always call destroy() instead of using 'delete' directly, otherwise smart pointers won't work.
     63        @brief Deletes the object if no @ref orxonox::StrongPtr "strong pointers" point to this object. Otherwise schedules the object to be deleted as soon as possible.
     64        Always call destroy() instead of using 'delete' directly, otherwise strong pointers won't work.
    6565    */
    6666    void Destroyable::destroy()
    … …  
    8181    void Destroyable::destroyLater()
    8282    {
    83         // register in DestroyLaterManager - this ensures that a smartPtr points to this object and keeps it alive for a while
     83        // register in DestroyLaterManager - this ensures that a strongPtr points to this object and keeps it alive for a while
    8484        DestroyLaterManager::getInstance().retain(this);
    8585
    86         // request destruction -> object will be deleted after all smartPtrs (including the one in DestroyLaterManager) were destroyed.
     86        // request destruction -> object will be deleted after all strongPtrs (including the one in DestroyLaterManager) were destroyed.
    8787        this->destroy();
    8888    }

  • code/branches/core7/src/libraries/core/object/Destroyable.h

    r10419 r10555  
    3030    @file
    3131    @ingroup Object
    32     @brief Declaration of Destroyable, the base class of all objects which can be used with SmartPtr and WeakPtr.
     32    @brief Declaration of Destroyable, the base class of all objects which can be used with StrongPtr and WeakPtr.
    3333*/
    3434
    … …  
    4343{
    4444    /**
    45         @brief Classes must inherit from this class if they should be used with SmartPtr or WeakPtr.
     45        @brief Classes must inherit from this class if they should be used with StrongPtr or WeakPtr.
    4646    */
    4747    class _CoreExport Destroyable
    4848    {
    4949        template <class T>
    50         friend class SmartPtr;
     50        friend class StrongPtr;
    5151
    5252        friend class DestructionListener;
    … …  
    5959            void destroyLater();
    6060
    61             /// Returns the number of @ref orxonox::SmartPtr "smart pointers" that point to this object.
     61            /// Returns the number of @ref orxonox::StrongPtr "strong pointers" that point to this object.
    6262            inline unsigned int getReferenceCount() const
    6363                { return this->referenceCount_; }
    6464
    6565        protected:
    66             /// 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
     66            /// This virtual function is called if destroy() is called and no StrongPtr points to this object. Used in some cases to create a new StrongPtr to
    6767            /// prevent destruction. Don't call this function directly - use destroy() instead.
    6868            virtual void preDestroy() {}
    6969
    7070        private:
    71             /// Increments the reference counter (for smart pointers).
     71            /// Increments the reference counter (for strong pointers).
    7272            inline void incrementReferenceCount()
    7373                { ++this->referenceCount_; }
    74             /// Decrements the reference counter (for smart pointers).
     74            /// Decrements the reference counter (for strong pointers).
    7575            inline void decrementReferenceCount()
    7676            {
    … …  
    8787                { this->destructionListeners_.erase(pointer); }
    8888
    89             int referenceCount_;                                    //!< Counts the references from smart pointers to this object
     89            int referenceCount_;                                    //!< Counts the references from strong pointers to this object
    9090            bool requestedDestruction_;                             //!< Becomes true after someone called delete on this object
    9191            std::set<DestructionListener*> destructionListeners_;   //!< All destruction listeners (for example weak pointers which point to this object and like to get notified if it dies)

  • code/branches/core7/src/libraries/core/object/StrongPtr.h

    r10553 r10555  
    3030
    3131/**
    32     @defgroup SmartPtr SmartPtr<T> and WeakPtr<T>
     32    @defgroup SmartPtr StrongPtr<T> and WeakPtr<T>
    3333    @ingroup Object
    3434*/
    … …  
    3737    @file
    3838    @ingroup Object SmartPtr
    39     @brief Definition of SmartPtr<T>, wraps a pointer to an object and keeps it alive.
    40 
    41     @anchor SmartPtrExample
    42 
    43     orxonox::SmartPtr is an implementation of a smart pointer - it wraps a pointer to an
    44     object  and keeps this object alive until no SmartPtr points to this object anymore.
    45     In contrast to orxonox::SharedPtr, SmartPtr works only with classes that are derived
     39    @brief Definition of StrongPtr<T>, wraps a pointer to an object and keeps it alive.
     40
     41    @anchor StrongPtrExample
     42
     43    orxonox::StrongPtr is an implementation of a smart pointer - it wraps a pointer to an
     44    object  and keeps this object alive until no StrongPtr points to this object anymore.
     45    In contrast to orxonox::SharedPtr, StrongPtr works only with classes that are derived
    4646    from orxonox::Destroyable, because it's an intrusive implementation, meaning the
    4747    reference counter is stored in the object itself.
    4848
    49     It's possible to use normal pointers and smart pointers to an object simultaneously.
    50     You don't have to use SmartPtr all the time, you can create a SmartPtr for an object
     49    It's possible to use normal pointers and strong pointers to an object simultaneously.
     50    You don't have to use StrongPtr all the time, you can create a StrongPtr for an object
    5151    at any time and also convert it back to a normal pointer if you like. This is possible
    52     because the reference counter is stored in the object itself and not in SmartPtr (in
     52    because the reference counter is stored in the object itself and not in StrongPtr (in
    5353    contrast to SharedPtr).
    5454
    5555    @b Important: If you want to delete an object, you must not use @c delete @c object but
    56     rather @c object->destroy(). This function will check if there are smart pointers
    57     pointing to the object. If yes, the object will be kept alive until all smart pointes
     56    rather @c object->destroy(). This function will check if there are strong pointers
     57    pointing to the object. If yes, the object will be kept alive until all strong pointers
    5858    are destroyed. If no, the object is deleted instantly.
    5959
    60     If all smart pointers that point to an object are destroyed, but you never called
    61     @c object->destroy() before, the object will not be deleted! All a SmartPtr will do
     60    If all strong pointers that point to an object are destroyed, but you never called
     61    @c object->destroy() before, the object will not be deleted! All a StrongPtr will do
    6262    is to really just keep an object alive, but it will not delete it automatically
    6363    unless you tried to destroy it before.
    … …  
    6868    {
    6969        public:
    70             void setObject(OtherClass* object)              // passes a normal pointer which will be stored in a SmartPtr
     70            void setObject(OtherClass* object)              // passes a normal pointer which will be stored in a StrongPtr
    7171                { this->object_ = object; }
    7272
    73             OtherClass* getObject() const                   // converts the SmartPtr to a normal pointer and returns it
     73            OtherClass* getObject() const                   // converts the StrongPtr to a normal pointer and returns it
    7474                { return this->object_; }
    7575
    7676        private:
    77             SmartPtr<OtherClass> object_;                   // a pointer to an instance of OtherClass is stored in a SmartPtr
     77            StrongPtr<OtherClass> object_;                  // a pointer to an instance of OtherClass is stored in a StrongPtr
    7878    };
    7979    @endcode
    … …  
    8585    MyClass* myclass = new MyClass();                       // create an instance of MyClass
    8686    OtherClass* object = new OtherClass();                  // create an instance of OtherClass
    87     myclass->setObject(object);                             // the object is now stored in a SmartPtr inside myclass
    88 
    89     object->destroy();                                      // we try to destroy object, but there's still a SmartPtr pointing at it.
    90 
    91     # object still exists at this point (because a SmartPtr points at it)
    92 
    93     delete myclass;                                         // now we delete myclass, which also destroys the SmartPtr
    94 
    95     # object doesn't exist anymore (because the SmartPtr is now destroyed)
     87    myclass->setObject(object);                             // the object is now stored in a StrongPtr inside myclass
     88
     89    object->destroy();                                      // we try to destroy object, but there's still a StrongPtr pointing at it.
     90
     91    # object still exists at this point (because a StrongPtr points at it)
     92
     93    delete myclass;                                         // now we delete myclass, which also destroys the StrongPtr
     94
     95    # object doesn't exist anymore (because the StrongPtr is now destroyed)
    9696    @endcode
    9797
    … …  
    100100    MyClass* myclass = new MyClass();                       // create an instance of MyClass
    101101    OtherClass* object = new OtherClass();                  // create an instance of OtherClass
    102     myclass->setObject(object);                             // the object is now stored in a SmartPtr inside myclass
    103 
    104     delete myclass;                                         // we delete myclass, which also destroys the SmartPtr
     102    myclass->setObject(object);                             // the object is now stored in a StrongPtr inside myclass
     103
     104    delete myclass;                                         // we delete myclass, which also destroys the StrongPtr
    105105
    106106    # object still exists at this point (because destroy() was not called yet)
    … …  
    112112
    113113    Note that in any case @c object->destroy() has to be called to delete the object.
    114     However if a SmartPtr points at it, the destruction is delayed until all SmartPtr
     114    However if a StrongPtr points at it, the destruction is delayed until all StrongPtr
    115115    are destroyed.
    116116*/
    117117
    118 #ifndef _SmartPtr_H__
    119 #define _SmartPtr_H__
     118#ifndef _StrongPtr_H__
     119#define _StrongPtr_H__
    120120
    121121#include "core/CorePrereqs.h"
    … …  
    129129{
    130130    /**
    131         @brief A smart pointer which wraps a pointer to an object and keeps this object alive as long as the smart pointer exists.
    132 
    133         @see See @ref SmartPtrExample "this description" for more information and an example.
     131        @brief A strong pointer which wraps a pointer to an object and keeps this object alive as long as the strong pointer exists.
     132
     133        @see See @ref StrongPtrExample "this description" for more information and an example.
    134134    */
    135135    template <class T>
    136     class SmartPtr
     136    class StrongPtr
    137137    {
    138138        public:
    139             /// Constructor: Initializes the smart pointer with a null pointer.
    140             inline SmartPtr() : pointer_(0), base_(0)
    141             {
    142             }
    143 
    144             /// Constructor: Initializes the smart pointer with a pointer to an object. @param pointer The pointer @param bAddRef If true, the reference counter is increased. Don't set this to false unless you know exactly what you're doing! (for example to avoid circular references if the @c this pointer of the possessing object is stored)
    145             inline SmartPtr(T* pointer, bool bAddRef = true) : pointer_(pointer), base_(pointer)
     139            /// Constructor: Initializes the strong pointer with a null pointer.
     140            inline StrongPtr() : pointer_(0), base_(0)
     141            {
     142            }
     143
     144            /// Constructor: Initializes the strong pointer with a pointer to an object. @param pointer The pointer @param bAddRef If true, the reference counter is increased. Don't set this to false unless you know exactly what you're doing! (for example to avoid circular references if the @c this pointer of the possessing object is stored)
     145            inline StrongPtr(T* pointer, bool bAddRef = true) : pointer_(pointer), base_(pointer)
    146146            {
    147147                if (this->base_ && bAddRef)
    … …  
    150150
    151151            /// Copy-constructor
    152             inline SmartPtr(const SmartPtr& other) : pointer_(other.pointer_), base_(other.base_)
     152            inline StrongPtr(const StrongPtr& other) : pointer_(other.pointer_), base_(other.base_)
    153153            {
    154154                if (this->base_)
    … …  
    156156            }
    157157
    158             /// Copy-constructor for smart pointers to objects of another class.
     158            /// Copy-constructor for strong pointers to objects of another class.
    159159            template <class O>
    160             inline SmartPtr(const SmartPtr<O>& other) : pointer_(other.get()), base_(other.base_)
     160            inline StrongPtr(const StrongPtr<O>& other) : pointer_(other.get()), base_(other.base_)
    161161            {
    162162                if (this->base_)
    … …  
    164164            }
    165165
    166             /// Constructor: Initializes the smart pointer with the pointer that is stored in a WeakPtr.
     166            /// Constructor: Initializes the strong pointer with the pointer that is stored in a WeakPtr.
    167167            template <class O>
    168             inline SmartPtr(const WeakPtr<O>& other) : pointer_(other.get()), base_(other.getBase())
     168            inline StrongPtr(const WeakPtr<O>& other) : pointer_(other.get()), base_(other.getBase())
    169169            {
    170170                if (this->base_)
    … …  
    173173
    174174            /// Destructor: Decrements the reference counter.
    175             inline ~SmartPtr()
     175            inline ~StrongPtr()
    176176            {
    177177                if (this->base_)
    … …  
    180180
    181181            /// Assigns a new pointer.
    182             inline SmartPtr& operator=(T* pointer)
    183             {
    184                 SmartPtr(pointer).swap(*this);
     182            inline StrongPtr& operator=(T* pointer)
     183            {
     184                StrongPtr(pointer).swap(*this);
    185185                return *this;
    186186            }
    187187
    188             /// Assigns the wrapped pointer of another SmartPtr.
    189             inline SmartPtr& operator=(const SmartPtr& other)
    190             {
    191                 SmartPtr(other).swap(*this);
     188            /// Assigns the wrapped pointer of another StrongPtr.
     189            inline StrongPtr& operator=(const StrongPtr& other)
     190            {
     191                StrongPtr(other).swap(*this);
    192192                return *this;
    193193            }
    194194
    195             /// Assigns the wrapped pointer of a SmartPtr of another class
     195            /// Assigns the wrapped pointer of a StrongPtr of another class
    196196            template <class O>
    197             inline SmartPtr& operator=(const SmartPtr<O>& other)
    198             {
    199                 SmartPtr(other).swap(*this);
     197            inline StrongPtr& operator=(const StrongPtr<O>& other)
     198            {
     199                StrongPtr(other).swap(*this);
    200200                return *this;
    201201            }
    … …  
    203203            /// Assigns the wrapped pointer of a WeakPtr.
    204204            template <class O>
    205             inline SmartPtr& operator=(const WeakPtr<O>& other)
    206             {
    207                 SmartPtr(other).swap(*this);
     205            inline StrongPtr& operator=(const WeakPtr<O>& other)
     206            {
     207                StrongPtr(other).swap(*this);
    208208                return *this;
    209209            }
    … …  
    221221            }
    222222
    223             /// Implicitly converts the SmartPtr to a pointer of type @c T*
     223            /// Implicitly converts the StrongPtr to a pointer of type @c T*
    224224            inline operator T*() const
    225225            {
    … …  
    247247            }
    248248
    249             /// Swaps the contents of two smart pointers.
    250             inline void swap(SmartPtr& other)
     249            /// Swaps the contents of two strong pointers.
     250            inline void swap(StrongPtr& other)
    251251            {
    252252                {
    … …  
    262262            }
    263263
    264             /// Resets the smart pointer (equivalent to assigning a NULL pointer).
     264            /// Resets the strong pointer (equivalent to assigning a NULL pointer).
    265265            inline void reset()
    266266            {
    267                 SmartPtr().swap(*this);
     267                StrongPtr().swap(*this);
    268268            }
    269269
    270270        private:
    271271            T* pointer_;            ///< The wrapped pointer to an object of type @a T
    272             Destroyable* base_;    ///< The wrapped pointer, casted up to Destroyable (this is needed because with just a T* pointer, SmartPtr couln't be used with forward declarations)
     272            Destroyable* base_;    ///< The wrapped pointer, casted up to Destroyable (this is needed because with just a T* pointer, StrongPtr couln't be used with forward declarations)
    273273    };
    274274
    275     /// Swaps the contents of two smart pointers.
     275    /// Swaps the contents of two strong pointers.
    276276    template <class T>
    277     void swap(SmartPtr<T>& a, SmartPtr<T>& b)
     277    void swap(StrongPtr<T>& a, StrongPtr<T>& b)
    278278    {
    279279        a.swap(b);
    280280    }
    281281
    282     /// Uses a static_cast to cast a pointer of type U* to a pointer of type T* and returns it in a new SmartPtr<T>.
     282    /// Uses a static_cast to cast a pointer of type U* to a pointer of type T* and returns it in a new StrongPtr<T>.
    283283    template <class T, class U>
    284     SmartPtr<T> static_pointer_cast(const SmartPtr<U>& p)
     284    StrongPtr<T> static_pointer_cast(const StrongPtr<U>& p)
    285285    {
    286286        return static_cast<T*>(p.get());
    287287    }
    288288
    289     /// Uses a const_cast to cast a pointer of type U* to a pointer of type T* and returns it in a new SmartPtr<T>.
     289    /// Uses a const_cast to cast a pointer of type U* to a pointer of type T* and returns it in a new StrongPtr<T>.
    290290    template <class T, class U>
    291     SmartPtr<T> const_pointer_cast(const SmartPtr<U>& p)
     291    StrongPtr<T> const_pointer_cast(const StrongPtr<U>& p)
    292292    {
    293293        return const_cast<T*>(p.get());
    294294    }
    295295
    296     /// Uses a dynamic_cast to cast a pointer of type U* to a pointer of type T* and returns it in a new SmartPtr<T>.
     296    /// Uses a dynamic_cast to cast a pointer of type U* to a pointer of type T* and returns it in a new StrongPtr<T>.
    297297    template <class T, class U>
    298     SmartPtr<T> dynamic_pointer_cast(const SmartPtr<U>& p)
     298    StrongPtr<T> dynamic_pointer_cast(const StrongPtr<U>& p)
    299299    {
    300300        return orxonox_cast<T*>(p.get());
    … …  
    302302}
    303303
    304 #endif /* _SmartPtr_H__ */
     304#endif /* _StrongPtr_H__ */
Note: See TracChangeset for help on using the changeset viewer.