Added new observer_ptr templated smart pointer to allow one to retain pointers

to objects but have the pointer reset to null if that object is deleted.
This commit is contained in:
Robert Osfield
2006-02-27 19:44:33 +00:00
parent 10d139fc1f
commit 8f2ffb7c2d
3 changed files with 169 additions and 10 deletions

View File

@@ -33,8 +33,9 @@
namespace osg {
#ifndef OSG_JAVA_BUILD
// forward declar, declared after Referenced below.
// forward declare, declared after Referenced below.
class DeleteHandler;
class Observer;
/** Base class from providing referencing counted objects.*/
class OSG_EXPORT Referenced
@@ -76,6 +77,11 @@ class OSG_EXPORT Referenced
/** Return the number pointers currently referencing this object. */
inline int referenceCount() const { return _refCount; }
/** Add a Observer that is observering this object, notify the Observer when this object gets deleted.*/
void addObserver(Observer* observer_ptr);
/** Add a Observer that is observering this object, notify the Observer when this object gets deleted.*/
void removeObserver(Observer* observer_ptr);
public:
@@ -98,9 +104,11 @@ class OSG_EXPORT Referenced
protected:
virtual ~Referenced();
mutable OpenThreads::Mutex* _refMutex;
mutable OpenThreads::Mutex* _refMutex;
mutable int _refCount;
mutable int _refCount;
void* _observers;
};

103
include/osg/observer_ptr Normal file
View File

@@ -0,0 +1,103 @@
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2005 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#ifndef OSG_OBSERVER_PTR
#define OSG_OBSERVER_PTR
namespace osg {
class Observer
{
public:
virtual ~Observer() {}
virtual void objectDeleted(void*) {}
};
/** Smart pointer for observed objects, that automatically set pointers to them to null when they deleted.*/
template<class T>
class observer_ptr : public Observer
{
public:
typedef T element_type;
observer_ptr() :_ptr(0L) {}
observer_ptr(T* t):_ptr(t) { if (_ptr) _ptr->addObserver(this); }
observer_ptr(const observer_ptr& rp):Observer(), _ptr(rp._ptr) { if (_ptr) _ptr->addObserver(this); }
~observer_ptr() { if (_ptr) _ptr->removeObserver(this); _ptr=0; }
inline observer_ptr& operator = (const observer_ptr& rp)
{
if (_ptr==rp._ptr) return *this;
if (_ptr) _ptr->removeObserver(this);
_ptr = rp._ptr;
if (_ptr) _ptr->addObserver(this);
return *this;
}
inline observer_ptr& operator = (T* ptr)
{
if (_ptr==ptr) return *this;
if (_ptr) _ptr->removeObserver(this);
_ptr = ptr;
if (_ptr) _ptr->addObserver(this);
return *this;
}
virtual void objectDeleted(void* ptr)
{
if (_ptr==ptr)
{
_ptr = 0;
}
}
// comparison operators for observer_ptr.
inline bool operator == (const observer_ptr& rp) const { return (_ptr==rp._ptr); }
inline bool operator != (const observer_ptr& rp) const { return (_ptr!=rp._ptr); }
inline bool operator < (const observer_ptr& rp) const { return (_ptr<rp._ptr); }
inline bool operator > (const observer_ptr& rp) const { return (_ptr>rp._ptr); }
// comparison operator for const T*.
inline bool operator == (const T* ptr) const { return (_ptr==ptr); }
inline bool operator != (const T* ptr) const { return (_ptr!=ptr); }
inline bool operator < (const T* ptr) const { return (_ptr<ptr); }
inline bool operator > (const T* ptr) const { return (_ptr>ptr); }
inline T& operator*() { return *_ptr; }
inline const T& operator*() const { return *_ptr; }
inline T* operator->() { return _ptr; }
inline const T* operator->() const { return _ptr; }
inline bool operator!() const { return _ptr==0L; }
inline bool valid() const { return _ptr!=0L; }
inline T* get() { return _ptr; }
inline const T* get() const { return _ptr; }
private:
T* _ptr;
};
}
#endif