QSharedPointer 类保持共享指针强引用。 更多...
| 头： | #include <QSharedPointer> |
| CMake: |
find_package(Qt6 COMPONENTS Core REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
注意： 此类的所有函数 可重入 .
| 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 |
| QSharedPointer<T> | create (Args &&... args ) |
| 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 ) |
| std::shared_ptr<X> | qSharedPointerObjectCast (const std::shared_ptr<T> & src ) |
| std::shared_ptr<X> | qSharedPointerObjectCast (std::shared_ptr<T> && src ) |
| QSharedPointer<X> | qSharedPointerObjectCast (const QWeakPointer<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> & ptr1 , const X * ptr2 ) |
| bool | operator!= (const T * ptr1 , const QSharedPointer<X> & ptr2 ) |
| bool | operator!= (const QSharedPointer<T> & lhs , std::nullptr_t) |
| bool | operator!= (std::nullptr_t, const QSharedPointer<T> & rhs ) |
| QDebug | operator<< (QDebug debug , const QSharedPointer<T> & ptr ) |
| bool | operator== (const QSharedPointer<T> & ptr1 , const QSharedPointer<X> & ptr2 ) |
| bool | operator== (const QSharedPointer<T> & ptr1 , const X * ptr2 ) |
| bool | operator== (const T * ptr1 , const QSharedPointer<X> & ptr2 ) |
| bool | operator== (const QSharedPointer<T> & lhs , std::nullptr_t) |
| bool | operator== (std::nullptr_t, const QSharedPointer<T> & rhs ) |
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.
QSharedPointer and QWeakPointer are reentrant classes. This means that, in general, a given QSharedPointer or QWeakPointer 对象 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.
Qt 还提供了 2 个其它指针包裹器类： 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.
最后， 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.
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.
另请参阅 QSharedDataPointer , QWeakPointer , QScopedPointer ，和 QEnableSharedFromThis .
Creates a QSharedPointer by promoting the weak reference other to strong reference and sharing its pointer.
若
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.
另请参阅 QWeakPointer::toStrongRef ().
Creates a QSharedPointer object that shares other 's pointer.
若
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.
[since 5.8]
template <typename Deleter> 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.
该函数在 Qt 5.8 引入。
[since 5.8]
QSharedPointer::
QSharedPointer
(
std::nullptr_t
)
Creates a QSharedPointer that is null. This is equivalent to the QSharedPointer default constructor.
该函数在 Qt 5.8 引入。
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() 在 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);
另请参阅 clear ().
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.
Creates a QSharedPointer that is null (the object is holding a reference to
nullptr
).
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.
若
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.
Makes this object share other 's pointer. The current pointer reference is discarded and, if it was the last, the pointer will be deleted.
若
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 object. If it is the last reference to the pointer stored, this will delete the pointer as well.
清零此 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.
Performs a
const_cast
from this pointer's type to
X
并返回
QSharedPointer
that shares the reference. This function can be used for up- and for down-casting, but is more useful for up-casting.
另请参阅 isNull () 和 qSharedPointerConstCast ().
[static, since 5.1]
template <typename Args>
QSharedPointer
<
T
> QSharedPointer::
create
(
Args
&&...
args
)
这是重载函数。
创建
QSharedPointer
object and allocates a new item of type
T
。
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.
该函数在 Qt 5.1 引入。
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 对象。
Performs a dynamic cast from this pointer's type to
X
并返回
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.
另请参阅 qSharedPointerDynamicCast ().
[since 5.11]
T
*QSharedPointer::
get
() const
如同 data ().
This function is provided for API compatibility with
std::shared_ptr
.
该函数在 Qt 5.11 引入。
返回
true
if this object refers to
nullptr
.
Performs a
qobject_cast
() from this pointer's type to
X
并返回
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.
另请参阅 qSharedPointerObjectCast ().
[since 5.0]
void
QSharedPointer::
reset
()
如同 clear (). For std::shared_ptr compatibility.
该函数在 Qt 5.0 引入。
[since 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);
该函数在 Qt 5.0 引入。
[since 5.0]
template <typename Deleter>
void
QSharedPointer::
reset
(
T
*
t
,
Deleter
deleter
)
Resets this QSharedPointer object to point to t instead, with the Deleter deleter 。相当于：
QSharedPointer<T> other(t, deleter); this->swap(other);
该函数在 Qt 5.0 引入。
Performs a static cast from this pointer's type to
X
并返回
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.
另请参阅 dynamicCast (), constCast ()，和 qSharedPointerCast ().
[since 5.3]
void
QSharedPointer::
swap
(
QSharedPointer
<
T
> &
other
)
Swaps this shared pointer instance with other 。此函数非常快且从不失败。
该函数在 Qt 5.3 引入。
Returns a weak reference object that shares the pointer referenced by this object.
另请参阅 QWeakPointer::QWeakPointer ().
返回
true
if the contained pointer is not
nullptr
. This function is suitable for use in
if-constructs
, like:
if (sharedptr) { ... }
另请参阅 isNull ().
返回
true
if this object refers to
nullptr
. This function is suitable for use in
if-constructs
, like:
if (!sharedptr) { ... }
另请参阅 isNull ().
Provides access to the shared pointer's members.
If the contained pointer is
nullptr
, behavior is undefined.
另请参阅 isNull ().
Provides access to the shared pointer's members.
If the contained pointer is
nullptr
, behavior is undefined.
另请参阅 isNull ().
Returns a shared pointer to the pointer held by
other
, cast to type
X
. The types
T
and
X
must belong to one hierarchy for the
static_cast
to succeed.
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use
qSharedPointerConstCast
to cast away the constness.
另请参阅 QSharedPointer::staticCast (), qSharedPointerDynamicCast ()，和 qSharedPointerConstCast ().
Returns a shared pointer to the pointer held by
other
, cast to type
X
. The types
T
and
X
must belong to one hierarchy for the
static_cast
to succeed.
other object is converted first to a strong reference. If that conversion fails (because the object it's pointing to has already been deleted), this function returns a null QSharedPointer .
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use
qSharedPointerConstCast
to cast away the constness.
另请参阅 QWeakPointer::toStrongRef (), qSharedPointerDynamicCast ()，和 qSharedPointerConstCast ().
Returns a shared pointer to the pointer held by
src
, cast to type
X
. The types
T
and
X
must belong to one hierarchy for the
const_cast
to succeed. The
const
and
volatile
differences between
T
and
X
被忽略。
另请参阅 QSharedPointer::constCast (), qSharedPointerCast ()，和 qSharedPointerDynamicCast ().
Returns a shared pointer to the pointer held by
src
, cast to type
X
. The types
T
and
X
must belong to one hierarchy for the
const_cast
to succeed. The
const
and
volatile
differences between
T
and
X
被忽略。
src object is converted first to a strong reference. If that conversion fails (because the object it's pointing to has already been deleted), this function returns a null QSharedPointer .
另请参阅 QWeakPointer::toStrongRef (), qSharedPointerCast ()，和 qSharedPointerDynamicCast ().
Returns a shared pointer to the pointer held by
src
, using a dynamic cast to type
X
to obtain an internal pointer of the appropriate type. If the
dynamic_cast
fails, the object returned will be null.
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use
qSharedPointerConstCast
to cast away the constness.
另请参阅 QSharedPointer::dynamicCast (), qSharedPointerCast ()，和 qSharedPointerConstCast ().
Returns a shared pointer to the pointer held by
src
, using a dynamic cast to type
X
to obtain an internal pointer of the appropriate type. If the
dynamic_cast
fails, the object returned will be null.
src object is converted first to a strong reference. If that conversion fails (because the object it's pointing to has already been deleted), this function also returns a null QSharedPointer .
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use
qSharedPointerConstCast
to cast away the constness.
另请参阅 QWeakPointer::toStrongRef (), qSharedPointerCast ()，和 qSharedPointerConstCast ().
The qSharedPointerObjectCast function is for casting a shared pointer.
Returns a shared pointer to the pointer held by
src
, using a
qobject_cast
() to type
X
to obtain an internal pointer of the appropriate type. If the
qobject_cast
fails, the object returned will be null.
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use
qSharedPointerConstCast
to cast away the constness.
另请参阅 QSharedPointer::objectCast (), qSharedPointerCast ()，和 qSharedPointerConstCast ().
[since 5.14]
template <typename X, typename T>
std::shared_ptr
<
X
>
qSharedPointerObjectCast
(const
std::shared_ptr
<
T
> &
src
)
Returns a shared pointer to the pointer held by
src
, using a
qobject_cast
() to type
X
to obtain an internal pointer of the appropriate type. If the
qobject_cast
fails, the object returned will be null.
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use const_pointer_cast to cast away the constness.
该函数在 Qt 5.14 引入。
[since 5.14]
template <typename X, typename T>
std::shared_ptr
<
X
>
qSharedPointerObjectCast
(
std::shared_ptr
<
T
> &&
src
)
Returns a shared pointer to the pointer held by
src
, using a
qobject_cast
() to type
X
to obtain an internal pointer of the appropriate type.
若
qobject_cast
succeeds, the function will return a valid shared pointer, and
src
is reset to null. If the
qobject_cast
fails, the object returned will be null, and
src
will not be modified.
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use const_pointer_cast to cast away the constness.
该函数在 Qt 5.14 引入。
The qSharedPointerObjectCast function is for casting a shared pointer.
Returns a shared pointer to the pointer held by
src
, using a
qobject_cast
() to type
X
to obtain an internal pointer of the appropriate type. If the
qobject_cast
fails, the object returned will be null.
src object is converted first to a strong reference. If that conversion fails (because the object it's pointing to has already been deleted), this function also returns a null QSharedPointer .
注意，
X
must have the same cv-qualifiers (
const
and
volatile
) that
T
has, or the code will fail to compile. Use
qSharedPointerConstCast
to cast away the constness.
另请参阅 QWeakPointer::toStrongRef (), qSharedPointerCast ()，和 qSharedPointerConstCast ().
[since 5.14]
template <typename X, typename T>
std::shared_ptr
<
X
>
qobject_pointer_cast
(const
std::shared_ptr
<
T
> &
src
)
Returns a shared pointer to the pointer held by src .
如同 qSharedPointerObjectCast ()。此函数为兼容 STL (标准模板库) 提供。
该函数在 Qt 5.14 引入。
[since 5.14]
template <typename X, typename T>
std::shared_ptr
<
X
>
qobject_pointer_cast
(
std::shared_ptr
<
T
> &&
src
)
如同 qSharedPointerObjectCast ()。此函数为兼容 STL (标准模板库) 提供。
该函数在 Qt 5.14 引入。
返回
true
if
ptr1
and
ptr2
refer to distinct pointers.
若
ptr2
's template parameter is different from
ptr1
's,
QSharedPointer
will attempt to perform an automatic
static_cast
to ensure that the pointers being compared are equal. If
ptr2
's template parameter is not a base or a derived type from
ptr1
's, you will get a compiler error.
返回
true
if
ptr1
and
ptr2
refer to distinct pointers.
若
ptr2
's type is different from
ptr1
's,
QSharedPointer
will attempt to perform an automatic
static_cast
to ensure that the pointers being compared are equal. If
ptr2
's type is not a base or a derived type from this
ptr1
's, you will get a compiler error.
返回
true
if the pointer
ptr1
is not the same pointer as that referenced by
ptr2
.
若
ptr2
's template parameter is different from
ptr1
's type,
QSharedPointer
will attempt to perform an automatic
static_cast
to ensure that the pointers being compared are equal. If
ptr2
's template parameter is not a base or a derived type from
ptr1
's type, you will get a compiler error.
[since 5.8]
template <typename T>
bool
operator!=
(const
QSharedPointer
<
T
> &
lhs
,
std::nullptr_t
)
返回
true
if
lhs
refers to a valid (i.e. non-null) pointer.
该函数在 Qt 5.8 引入。
另请参阅 QSharedPointer::isNull ().
[since 5.8]
template <typename T>
bool
operator!=
(
std::nullptr_t
, const
QSharedPointer
<
T
> &
rhs
)
返回
true
if
rhs
refers to a valid (i.e. non-null) pointer.
该函数在 Qt 5.8 引入。
另请参阅 QSharedPointer::isNull ().
[since 5.7]
template <typename T>
QDebug
operator<<
(
QDebug
debug
, const
QSharedPointer
<
T
> &
ptr
)
Writes the pointer tracked by ptr 到 debug 对象 debug 为调试目的。
该函数在 Qt 5.7 引入。
另请参阅 调试技术 .
返回
true
if
ptr1
and
ptr2
refer to the same pointer.
若
ptr2
's template parameter is different from
ptr1
's,
QSharedPointer
will attempt to perform an automatic
static_cast
to ensure that the pointers being compared are equal. If
ptr2
's template parameter is not a base or a derived type from
ptr1
's, you will get a compiler error.
返回
true
if
ptr1
and
ptr2
refer to the same pointer.
若
ptr2
's type is different from
ptr1
's,
QSharedPointer
will attempt to perform an automatic
static_cast
to ensure that the pointers being compared are equal. If
ptr2
's type is not a base or a derived type from this
ptr1
's, you will get a compiler error.
返回
true
if the pointer
ptr1
is the same pointer as that referenced by
ptr2
.
若
ptr2
's template parameter is different from
ptr1
's type,
QSharedPointer
will attempt to perform an automatic
static_cast
to ensure that the pointers being compared are equal. If
ptr2
's template parameter is not a base or a derived type from
ptr1
's type, you will get a compiler error.
[since 5.8]
template <typename T>
bool
operator==
(const
QSharedPointer
<
T
> &
lhs
,
std::nullptr_t
)
返回
true
if
lhs
refers to
nullptr
.
该函数在 Qt 5.8 引入。
另请参阅 QSharedPointer::isNull ().
[since 5.8]
template <typename T>
bool
operator==
(
std::nullptr_t
, const
QSharedPointer
<
T
> &
rhs
)
返回
true
if
rhs
refers to
nullptr
.
该函数在 Qt 5.8 引入。
另请参阅 QSharedPointer::isNull ().