ROSE
0.11.96.11
|
Reference-counting intrusive smart pointer.
This class implements a reference-counting pointer to an object that inherits from SharedObject. See SharedObject for a detailed description of how to prepare objects to be referenced by SharedPointer.
Usage is similar to std::shared_ptr
to the extent that the number of pointers pointing to an object is recorded somewhere, and when that reference count reaches zero the object is destroyed and freed by calling delete
. The main difference is that SharedPointer stores the reference count in the object itself (i.e., "intrusive"). The effects are:
std::shared_ptr
and boost::shared_ptr
.Some best practices (see also, SharedObject):
Use SharedPointer if you need utmost speed, and are able to modify the definition of the pointee class to inherit from SharedObject, and are willing to always allocate all such objects on the heap not the stack, and don't need weak or unique pointers to such objects. Otherwise default to using std::shared_ptr
et. al. (or boost::shared_ptr
for C++03 and earlier).
Thread safety: Similar to raw pointers. Different threads can access different pointers to the same object, but operations on the pointer itself (such as assignment, comparison with null, and dereferencing in the presence of other writers needs to be synchronized by the callers.
Definition at line 68 of file SharedPointer.h.
#include <SharedPointer.h>
Public Types | |
typedef T | Pointee |
Public Member Functions | |
SharedPointer () | |
Constructs an empty shared pointer. | |
template<class Y > | |
SharedPointer (Y *rawPtr) | |
Constructs a shared pointer for an object. More... | |
~SharedPointer () | |
Conditionally deletes the pointed-to object. More... | |
SharedPointer & | operator= (const Sawyer::Nothing &) |
Assignment. More... | |
T & | operator* () const |
Reference to the pointed-to object. More... | |
T * | operator-> () const |
Dereference pointed-to object. More... | |
template<class U > | |
SharedPointer< U > | dynamicCast () const |
Dynamic cast. More... | |
bool | operator! () const |
Boolean complement. More... | |
operator unspecified_bool () const | |
Type for Boolean context. More... | |
Pointee * | getRawPointer () |
Obtain the pointed-to object. More... | |
Pointee * | getRawPointer () const |
SharedPointer (const SharedPointer &other) | |
Constructs a new pointer that shares ownership of the pointed-to object with the other pointer. More... | |
template<class Y > | |
SharedPointer (const SharedPointer< Y > &other) | |
Constructs a new pointer that shares ownership of the pointed-to object with the other pointer. More... | |
SharedPointer & | operator= (const SharedPointer &other) |
Assignment. More... | |
template<class Y > | |
SharedPointer & | operator= (const SharedPointer< Y > &other) |
Assignment. More... | |
template<class U > | |
bool | operator== (const SharedPointer< U > &other) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator!= (const SharedPointer< U > &other) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator< (const SharedPointer< U > &other) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator<= (const SharedPointer< U > &other) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator> (const SharedPointer< U > &other) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator>= (const SharedPointer< U > &other) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator== (const U *ptr) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator!= (const U *ptr) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator< (const U *ptr) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator<= (const U *ptr) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator> (const U *ptr) const |
Comparison of two pointers. More... | |
template<class U > | |
bool | operator>= (const U *ptr) const |
Comparison of two pointers. More... | |
|
inline |
Constructs a new pointer that shares ownership of the pointed-to object with the other
pointer.
The pointed-to object will only be deleted after both pointers are deleted.
Definition at line 105 of file SharedPointer.h.
|
inline |
Constructs a new pointer that shares ownership of the pointed-to object with the other
pointer.
The pointed-to object will only be deleted after both pointers are deleted.
Definition at line 109 of file SharedPointer.h.
|
inlineexplicit |
Constructs a shared pointer for an object.
If obj
is non-null then its reference count is incremented. It is possible to create any number of shared pointers to the same object using this constructor. The expression "delete obj" must be well formed and must not invoke undefined behavior.
Definition at line 120 of file SharedPointer.h.
|
inline |
Conditionally deletes the pointed-to object.
The object is deleted when its reference count reaches zero.
Definition at line 126 of file SharedPointer.h.
|
inline |
Assignment.
This pointer is caused to point to the same object as other
, decrementing the reference count for the object originally pointed to by this pointer and incrementing the reference count for the object pointed by other
.
Definition at line 134 of file SharedPointer.h.
|
inline |
Assignment.
This pointer is caused to point to the same object as other
, decrementing the reference count for the object originally pointed to by this pointer and incrementing the reference count for the object pointed by other
.
Definition at line 138 of file SharedPointer.h.
|
inline |
Assignment.
This pointer is caused to point to nothing.
Definition at line 150 of file SharedPointer.h.
|
inline |
Reference to the pointed-to object.
An assertion will fail if assertions are enabled and this method is invoked on an empty pointer.
Definition at line 159 of file SharedPointer.h.
|
inline |
Dereference pointed-to object.
The pointed-to object is returned. Returns null for empty pointers.
Definition at line 166 of file SharedPointer.h.
|
inline |
Dynamic cast.
Casts the specified pointer to a new pointer type using dynamic_cast.
Definition at line 177 of file SharedPointer.h.
Referenced by Sawyer::CommandLine::StringSetParser::with().
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 187 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 191 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 195 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 199 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 203 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 207 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Compares the underlying pointer with the specified pointer.
Definition at line 217 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 221 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 225 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 229 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 233 of file SharedPointer.h.
|
inline |
Comparison of two pointers.
Comparisons operators compare the underlying pointers to objects.
Definition at line 237 of file SharedPointer.h.
|
inline |
Boolean complement.
This operator allows shared pointers to be used in situations like this:
Definition at line 250 of file SharedPointer.h.
|
inline |
Type for Boolean context.
Implicit conversion to a type that can be used in a boolean context such as an if
or while
statement. For instance:
Definition at line 277 of file SharedPointer.h.
|
inline |
Obtain the pointed-to object.
The pointed-to object is returned. Returns null for empty pointers. An idiom for getting a raw pointer for a shared pointer that's known to be non-null is to dereference the shared pointer and then take the address:
Definition at line 300 of file SharedPointer.h.
Referenced by Sawyer::SharedPointer< ValueSaver >::operator!=(), Sawyer::SharedPointer< ValueSaver >::operator<(), Sawyer::SharedPointer< ValueSaver >::operator<=(), Sawyer::SharedPointer< ValueSaver >::operator=(), Sawyer::SharedPointer< ValueSaver >::operator==(), Sawyer::SharedPointer< ValueSaver >::operator>(), and Sawyer::SharedPointer< ValueSaver >::operator>=().