QSharedPointer Class

The QSharedPointer class holds a strong reference to a shared pointer. More...

Header:	#include <QSharedPointer>
qmake:	QT += core
Since:	Qt 4.5

This class was introduced in Qt 4.5.

• List of all members, including inherited members

Note: All functions in this class are reentrant.

Public Functions

	QSharedPointer(const QWeakPointer<T> &other)
	QSharedPointer(const QSharedPointer<T> &other)
	QSharedPointer(std::nullptr_t, Deleter d)
	QSharedPointer(std::nullptr_t)
	QSharedPointer(X *ptr, Deleter d)
	QSharedPointer(X *ptr)
	QSharedPointer()
QSharedPointer<T> &	operator=(const QWeakPointer<T> &other)
QSharedPointer<T> &	operator=(const QSharedPointer<T> &other)
	~QSharedPointer()
void	clear()
QSharedPointer<X>	constCast() const
T *	data() const
QSharedPointer<X>	dynamicCast() const
T *	get() const
bool	isNull() const
QSharedPointer<X>	objectCast() const
void	reset()
void	reset(T *t)
void	reset(T *t, Deleter deleter)
QSharedPointer<X>	staticCast() const
void	swap(QSharedPointer<T> &other)
QWeakPointer<T>	toWeakRef() const
bool	operator bool() const
bool	operator!() const
T &	operator*() const
T *	operator->() const

Static Public Members

QSharedPointer<T>

create(Args &&... args)

Related Non-Members

QSharedPointer<X>	qSharedPointerCast(const QSharedPointer<T> &other)
QSharedPointer<X>	qSharedPointerCast(const QWeakPointer<T> &other)
QSharedPointer<X>	qSharedPointerConstCast(const QSharedPointer<T> &src)
QSharedPointer<X>	qSharedPointerConstCast(const QWeakPointer<T> &src)
QSharedPointer<X>	qSharedPointerDynamicCast(const QSharedPointer<T> &src)
QSharedPointer<X>	qSharedPointerDynamicCast(const QWeakPointer<T> &src)
QSharedPointer<X>	qSharedPointerObjectCast(const QSharedPointer<T> &src)
QSharedPointer<X>	qSharedPointerObjectCast(const QWeakPointer<T> &src)
std::shared_ptr<X>	qSharedPointerObjectCast(const std::shared_ptr<T> &src)
std::shared_ptr<X>	qSharedPointerObjectCast(std::shared_ptr<T> &&src)
std::shared_ptr<X>	qobject_pointer_cast(const std::shared_ptr<T> &src)
std::shared_ptr<X>	qobject_pointer_cast(std::shared_ptr<T> &&src)
bool	operator!=(const QSharedPointer<T> &ptr1, const QSharedPointer<X> &ptr2)
bool	operator!=(const QSharedPointer<T> &lhs, std::nullptr_t)
bool	operator!=(const QSharedPointer<T> &ptr1, const X *ptr2)
bool	operator!=(std::nullptr_t, const QSharedPointer<T> &rhs)
bool	operator!=(const T *ptr1, const QSharedPointer<X> &ptr2)
QDebug	operator<<(QDebug debug, const QSharedPointer<T> &ptr)
bool	operator==(const QSharedPointer<T> &ptr1, const QSharedPointer<X> &ptr2)
bool	operator==(const QSharedPointer<T> &lhs, std::nullptr_t)
bool	operator==(const QSharedPointer<T> &ptr1, const X *ptr2)
bool	operator==(std::nullptr_t, const QSharedPointer<T> &rhs)
bool	operator==(const T *ptr1, const QSharedPointer<X> &ptr2)

Detailed Description

The QSharedPointer is an automatic, shared pointer in C++. It behaves exactly like a normal pointer for normal purposes, including respect for constness.

QSharedPointer will delete the pointer it is holding when it goes out of scope, provided no other QSharedPointer objects are referencing it.

A QSharedPointer object can be created from a normal pointer, another QSharedPointer object or by promoting a QWeakPointer object to a strong reference.

Thread-Safety

QSharedPointer and QWeakPointer are reentrant classes. This means that, in general, a given QSharedPointer or QWeakPointer object cannot be accessed by multiple threads at the same time without synchronization.

Different QSharedPointer and QWeakPointer objects can safely be accessed by multiple threads at the same time. This includes the case where they hold pointers to the same object; the reference counting mechanism is atomic, and no manual synchronization is required.

It should be noted that, while the pointer value can be accessed in this manner (that is, by multiple threads at the same time, without synchronization), QSharedPointer and QWeakPointer provide no guarantee about the object being pointed to. The specific thread-safety and reentrancy rules for that object still apply.

Other Pointer Classes

Qt also provides two other pointer wrapper classes: QPointer and QSharedDataPointer. They are incompatible with one another, since each has its very different use case.

QSharedPointer holds a shared pointer by means of an external reference count (i.e., a reference counter placed outside the object). Like its name indicates, the pointer value is shared among all instances of QSharedPointer and QWeakPointer. The contents of the object pointed to by the pointer should not be considered shared, however: there is only one object. For that reason, QSharedPointer does not provide a way to detach or make copies of the pointed object.

QSharedDataPointer, on the other hand, holds a pointer to shared data (i.e., a class derived from QSharedData). It does so by means of an internal reference count, placed in the QSharedData base class. This class can, therefore, detach based on the type of access made to the data being guarded: if it's a non-const access, it creates a copy atomically for the operation to complete.

QExplicitlySharedDataPointer is a variant of QSharedDataPointer, except that it only detaches if QExplicitlySharedDataPointer::detach() is explicitly called (hence the name).

QScopedPointer simply holds a pointer to a heap allocated object and deletes it in its destructor. This class is useful when an object needs to be heap allocated and deleted, but no more. QScopedPointer is lightweight, it makes no use of additional structure or reference counting.

Finally, QPointer holds a pointer to a QObject-derived object, but it does so weakly. QWeakPointer has the same functionality, but its use for that function is deprecated.

Optional Pointer Tracking

A feature of QSharedPointer that can be enabled at compile-time for debugging purposes is a pointer tracking mechanism. When enabled, QSharedPointer registers in a global set all the pointers that it tracks. This allows one to catch mistakes like assigning the same pointer to two QSharedPointer objects.

This function is enabled by defining the QT_SHAREDPOINTER_TRACK_POINTERS macro before including the QSharedPointer header.

It is safe to use this feature even with code compiled without the feature. QSharedPointer will ensure that the pointer is removed from the tracker even from code compiled without pointer tracking.

Note, however, that the pointer tracking feature has limitations on multiple- or virtual-inheritance (that is, in cases where two different pointer addresses can refer to the same object). In that case, if a pointer is cast to a different type and its value changes, QSharedPointer's pointer tracking mechanism may fail to detect that the object being tracked is the same.

See also QSharedDataPointer, QWeakPointer, QScopedPointer, and QEnableSharedFromThis.

Member Function Documentation

QSharedPointer::QSharedPointer(const QWeakPointer<T> &other)

Creates a QSharedPointer by promoting the weak reference other to strong reference and sharing its pointer.

If T is a derived type of the template parameter of this class, QSharedPointer will perform an automatic cast. Otherwise, you will get a compiler error.

See also QWeakPointer::toStrongRef().

QSharedPointer::QSharedPointer(const QSharedPointer<T> &other)

Creates a QSharedPointer object that shares other's pointer.

If T is a derived type of the template parameter of this class, QSharedPointer will perform an automatic cast. Otherwise, you will get a compiler error.

QSharedPointer::QSharedPointer(std::nullptr_t, Deleter d)

Creates a QSharedPointer that is null. This is equivalent to the QSharedPointer default constructor.

The deleter parameter d specifies the custom deleter for this object. The custom deleter is called, instead of the operator delete(), when the strong reference count drops to 0.

This function was introduced in Qt 5.8.

QSharedPointer::QSharedPointer(std::nullptr_t)

Creates a QSharedPointer that is null. This is equivalent to the QSharedPointer default constructor.

This function was introduced in Qt 5.8.

QSharedPointer::QSharedPointer(X *ptr, Deleter d)

Creates a QSharedPointer that points to ptr. The pointer ptr becomes managed by this QSharedPointer and must not be passed to another QSharedPointer object or deleted outside this object.

The deleter parameter d specifies the custom deleter for this object. The custom deleter is called, instead of the operator delete(), when the strong reference count drops to 0. This is useful, for instance, for calling deleteLater() on a QObject instead:

    static void doDeleteLater(MyObject *obj)
    {
        obj->deleteLater();
    }

    void otherFunction()
    {
        QSharedPointer<MyObject> obj =
            QSharedPointer<MyObject>(new MyObject, doDeleteLater);

        // continue using obj
        obj.clear();    // calls obj->deleteLater();
    }

Note that the custom deleter function will be called with a pointer to type X, even if the QSharedPointer template parameter T is not the same.

It is also possible to specify a member function directly, as in:

    QSharedPointer<MyObject> obj =
        QSharedPointer<MyObject>(new MyObject, &QObject::deleteLater);

See also clear().

QSharedPointer::QSharedPointer(X *ptr)

Creates a QSharedPointer that points to ptr. The pointer ptr becomes managed by this QSharedPointer and must not be passed to another QSharedPointer object or deleted outside this object.

Since Qt 5.8, when the last reference to this QSharedPointer gets destroyed, ptr will be deleted by calling X's destructor (even if X is not the same as QSharedPointer's template parameter T). Previously, the destructor for T was called.

QSharedPointer::QSharedPointer()

Creates a QSharedPointer that is null (the object is holding a reference to nullptr).

QSharedPointer<T> &QSharedPointer::operator=(const QWeakPointer<T> &other)

Promotes other to a strong reference and makes this object share a reference to the pointer referenced by it. The current pointer reference is discarded and, if it was the last, the pointer will be deleted.

If T is a derived type of the template parameter of this class, QSharedPointer will perform an automatic cast. Otherwise, you will get a compiler error.

QSharedPointer<T> &QSharedPointer::operator=(const QSharedPointer<T> &other)

Makes this object share other's pointer. The current pointer reference is discarded and, if it was the last, the pointer will be deleted.

If T is a derived type of the template parameter of this class, QSharedPointer will perform an automatic cast. Otherwise, you will get a compiler error.

QSharedPointer::~QSharedPointer()

Destroys this QSharedPointer object. If it is the last reference to the pointer stored, this will delete the pointer as well.

void QSharedPointer::clear()

Clears this QSharedPointer object, dropping the reference that it may have had to the pointer. If this was the last reference, then the pointer itself will be deleted.

QSharedPointer<X> QSharedPointer::constCast() const

Performs a const_cast from this pointer's type to X and returns a QSharedPointer that shares the reference. This function can be used for up- and for down-casting, but is more useful for up-casting.

See also isNull() and qSharedPointerConstCast().

[static] QSharedPointer<T> QSharedPointer::create(Args &&... args)

This is an overloaded function.

Creates a QSharedPointer object and allocates a new item of type T. The QSharedPointer internals and the object are allocated in one single memory allocation, which could help reduce memory fragmentation in a long-running application.

This function will attempt to call a constructor for type T that can accept all the arguments passed (args). Arguments will be perfectly-forwarded.

This function was introduced in Qt 5.1.

T *QSharedPointer::data() const

Returns the value of the pointer referenced by this object.

Note: do not delete the pointer returned by this function or pass it to another function that could delete it, including creating QSharedPointer or QWeakPointer objects.

QSharedPointer<X> QSharedPointer::dynamicCast() const

Performs a dynamic cast from this pointer's type to X and returns a QSharedPointer that shares the reference. If this function is used to up-cast, then QSharedPointer will perform a dynamic_cast, which means that if the object being pointed by this QSharedPointer is not of type X, the returned object will be null.

Note: the template type X must have the same const and volatile qualifiers as the template of this object, or the cast will fail. Use constCast() if you need to drop those qualifiers.

See also qSharedPointerDynamicCast().

T *QSharedPointer::get() const

Same as data().

This function is provided for API compatibility with std::shared_ptr.

This function was introduced in Qt 5.11.

bool QSharedPointer::isNull() const

Returns true if this object refers to nullptr.

QSharedPointer<X> QSharedPointer::objectCast() const

Performs a qobject_cast() from this pointer's type to X and returns a QSharedPointer that shares the reference. If this function is used to up-cast, then QSharedPointer will perform a qobject_cast, which means that if the object being pointed by this QSharedPointer is not of type X, the returned object will be null.

Note: the template type X must have the same const and volatile qualifiers as the template of this object, or the cast will fail. Use constCast() if you need to drop those qualifiers.

This function was introduced in Qt 4.6.

See also qSharedPointerObjectCast().

void QSharedPointer::reset()

Same as clear(). For std::shared_ptr compatibility.

This function was introduced in Qt 5.0.

void QSharedPointer::reset(T *t)

Resets this QSharedPointer object to point to t instead. Equivalent to:

    QSharedPointer<T> other(t); this->swap(other);

This function was introduced in Qt 5.0.

void QSharedPointer::reset(T *t, Deleter deleter)

Resets this QSharedPointer object to point to t instead, with the Deleter deleter. Equivalent to:

    QSharedPointer<T> other(t, deleter); this->swap(other);

This function was introduced in Qt 5.0.

QSharedPointer<X> QSharedPointer::staticCast() const

Performs a static cast from this pointer's type to X and returns a QSharedPointer that shares the reference. This function can be used for up- and for down-casting, but is more useful for up-casting.

Note: the template type X must have the same const and volatile qualifiers as the template of this object, or the cast will fail. Use constCast() if you need to drop those qualifiers.

See also dynamicCast(), constCast(), and qSharedPointerCast().

void QSharedPointer::swap(QSharedPointer<T> &other)

Swaps this shared pointer instance with other. This function is very fast and never fails.

This function was introduced in Qt 5.3.

QWeakPointer<T> QSharedPointer::toWeakRef() const

Returns a weak reference object that shares the pointer referenced by this object.

See also QWeakPointer::QWeakPointer().

bool QSharedPointer::operator bool() const

Returns true if the contained pointer is not nullptr. This function is suitable for use in if-constructs, like:

    if (sharedptr) { ... }

See also isNull().

bool QSharedPointer::operator!() const

Returns true if this object refers to nullptr. This function is suitable for use in if-constructs, like:

    if (!sharedptr) { ... }

See also isNull().

T &QSharedPointer::operator*() const

Provides access to the shared pointer's members.

If the contained pointer is nullptr, behavior is undefined.

See also isNull().

T *QSharedPointer::operator->() const

Provides access to the shared pointer's members.

If the contained pointer is nullptr, behavior is undefined.

See also isNull().