Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qsharedpointer.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QSHAREDPOINTER_H
6#define QSHAREDPOINTER_H
7
8#include <QtCore/qglobal.h>
9#include <QtCore/qatomic.h>
10#include <QtCore/qshareddata.h>
11
12#ifndef Q_QDOC
13# include <QtCore/qsharedpointer_impl.h>
14#else
15
16#include <memory> // for std::shared_ptr
17
18QT_BEGIN_NAMESPACE
19
20
21// These classes are here to fool qdoc into generating a better documentation
22
23template <class T>
24class QSharedPointer
25{
26public:
27 // basic accessor functions
28 T *data() const;
29 T *get() const;
30 bool isNull() const;
31 operator bool() const;
32 bool operator!() const;
33 T &operator*() const;
34 T *operator->() const;
35
36 // constructors
37 QSharedPointer();
38 template <typename X> explicit QSharedPointer(X *ptr);
39 template <typename X, typename Deleter> QSharedPointer(X *ptr, Deleter d);
40 QSharedPointer(std::nullptr_t);
41 template <typename Deleter> QSharedPointer(std::nullptr_t, Deleter d);
42 QSharedPointer(const QSharedPointer<T> &other);
43 QSharedPointer(const QWeakPointer<T> &other);
44 QSharedPointer(QSharedPointer<T> &&other) noexcept;
45
46 ~QSharedPointer() { }
47
48 QSharedPointer<T> &operator=(const QSharedPointer<T> &other);
49 QSharedPointer<T> &operator=(QSharedPointer<T> &&other) noexcept;
50 QSharedPointer<T> &operator=(const QWeakPointer<T> &other);
51
52 template <class X>
53 QSharedPointer(QSharedPointer<X> && other) noexcept;
54 template <class X>
55 QSharedPointer &operator=(QSharedPointer<X> && other) noexcept;
56
57 void swap(QSharedPointer<T> &other) noexcept;
58
59 QWeakPointer<T> toWeakRef() const;
60
61 void clear();
62
63 void reset();
64 void reset(T *t);
65 template <typename Deleter>
66 void reset(T *t, Deleter deleter);
67
68 // casts:
69 template <class X> QSharedPointer<X> staticCast() const &;
70 template <class X> QSharedPointer<X> staticCast() &&;
71 template <class X> QSharedPointer<X> dynamicCast() const &;
72 template <class X> QSharedPointer<X> dynamicCast() &&;
73 template <class X> QSharedPointer<X> constCast() const &;
74 template <class X> QSharedPointer<X> constCast() &&;
75 template <class X> QSharedPointer<X> objectCast() const &;
76 template <class X> QSharedPointer<X> objectCast() &&;
77
78 template <typename... Args>
79 static inline QSharedPointer<T> create(Args &&... args);
80
81 // owner-based comparisons
82 template <typename X>
83 bool owner_before(const QSharedPointer<X> &other) const noexcept;
84 template <typename X>
85 bool owner_before(const QWeakPointer<X> &other) const noexcept;
86
87 template <typename X>
88 bool owner_equal(const QSharedPointer<X> &other) const noexcept;
89 template <typename X>
90 bool owner_equal(const QWeakPointer<X> &other) const noexcept;
91
92 size_t owner_hash() const noexcept;
93};
94
95template <class T>
96size_t qHash(const QSharedPointer<T> &key, size_t seed = 0) noexcept;
97
98template <class T>
99class QWeakPointer
100{
101public:
102 // basic accessor functions
103 bool isNull() const;
104 operator bool() const;
105 bool operator!() const;
106
107 // constructors:
108 QWeakPointer();
109 QWeakPointer(const QWeakPointer<T> &other) noexcept;
110 QWeakPointer(QWeakPointer<T> &&other) noexcept;
111 QWeakPointer(const QSharedPointer<T> &other);
112
113 ~QWeakPointer();
114
115 QWeakPointer<T> &operator=(const QWeakPointer<T> &other) noexcept;
116 QWeakPointer<T> &operator=(QWeakPointer<T> &&other) noexcept;
117 QWeakPointer<T> &operator=(const QSharedPointer<T> &other);
118
119 void swap(QWeakPointer<T> &other) noexcept;
120
121 void clear();
122
123 QSharedPointer<T> toStrongRef() const;
124 QSharedPointer<T> lock() const;
125
126 // owner-based comparisons
127 template <typename X>
128 bool owner_before(const QWeakPointer<X> &other) const noexcept;
129 template <typename X>
130 bool owner_before(const QSharedPointer<X> &other) const noexcept;
131
132 template <typename X>
133 bool owner_equal(const QWeakPointer<X> &other) const noexcept;
134 template <typename X>
135 bool owner_equal(const QSharedPointer<X> &other) const noexcept;
136
137 size_t owner_hash() const noexcept;
138};
139
140template <class T>
141class QEnableSharedFromThis
142{
143public:
144 QSharedPointer<T> sharedFromThis();
145 QSharedPointer<const T> sharedFromThis() const;
146};
147
148template<class T, class X> bool operator==(const QSharedPointer<T> &ptr1, const QSharedPointer<X> &ptr2);
149template<class T, class X> bool operator!=(const QSharedPointer<T> &ptr1, const QSharedPointer<X> &ptr2);
150template<class T, class X> bool operator==(const QSharedPointer<T> &ptr1, const X *ptr2);
151template<class T, class X> bool operator!=(const QSharedPointer<T> &ptr1, const X *ptr2);
152template<class T, class X> bool operator==(const T *ptr1, const QSharedPointer<X> &ptr2);
153template<class T, class X> bool operator!=(const T *ptr1, const QSharedPointer<X> &ptr2);
154template<class T, class X> bool operator==(const QWeakPointer<T> &ptr1, const QSharedPointer<X> &ptr2);
155template<class T, class X> bool operator!=(const QWeakPointer<T> &ptr1, const QSharedPointer<X> &ptr2);
156template<class T, class X> bool operator==(const QSharedPointer<T> &ptr1, const QWeakPointer<X> &ptr2);
157template<class T, class X> bool operator!=(const QSharedPointer<T> &ptr1, const QWeakPointer<X> &ptr2);
158template<class T> bool operator==(const QSharedPointer<T> &lhs, std::nullptr_t);
159template<class T> bool operator!=(const QSharedPointer<T> &lhs, std::nullptr_t);
160template<class T> bool operator==(std::nullptr_t, const QSharedPointer<T> &rhs);
161template<class T> bool operator!=(std::nullptr_t, const QSharedPointer<T> &rhs);
162template<class T> bool operator==(const QWeakPointer<T> &lhs, std::nullptr_t);
163template<class T> bool operator!=(const QWeakPointer<T> &lhs, std::nullptr_t);
164template<class T> bool operator==(std::nullptr_t, const QWeakPointer<T> &rhs);
165template<class T> bool operator!=(std::nullptr_t, const QWeakPointer<T> &rhs);
166
167template <class X, class T> QSharedPointer<X> qSharedPointerCast(const QSharedPointer<T> &other);
168template <class X, class T> QSharedPointer<X> qSharedPointerCast(QSharedPointer<T> &&other);
169template <class X, class T> QSharedPointer<X> qSharedPointerCast(const QWeakPointer<T> &other);
170template <class X, class T> QSharedPointer<X> qSharedPointerDynamicCast(const QSharedPointer<T> &src);
171template <class X, class T> QSharedPointer<X> qSharedPointerDynamicCast(QSharedPointer<T> &&src);
172template <class X, class T> QSharedPointer<X> qSharedPointerDynamicCast(const QWeakPointer<T> &src);
173template <class X, class T> QSharedPointer<X> qSharedPointerConstCast(const QSharedPointer<T> &src);
174template <class X, class T> QSharedPointer<X> qSharedPointerConstCast(QSharedPointer<T> &&src);
175template <class X, class T> QSharedPointer<X> qSharedPointerConstCast(const QWeakPointer<T> &src);
176template <class X, class T> QSharedPointer<X> qSharedPointerObjectCast(const QSharedPointer<T> &src);
177template <class X, class T> QSharedPointer<X> qSharedPointerObjectCast(QSharedPointer<T> &&src);
178template <class X, class T> QSharedPointer<X> qSharedPointerObjectCast(const QWeakPointer<T> &src);
179template <typename X, class T> std::shared_ptr<X> qobject_pointer_cast(const std::shared_ptr<T> &src);
180template <typename X, class T> std::shared_ptr<X> qobject_pointer_cast(std::shared_ptr<T> &&src);
181template <typename X, class T> std::shared_ptr<X> qSharedPointerObjectCast(const std::shared_ptr<T> &src);
182template <typename X, class T> std::shared_ptr<X> qSharedPointerObjectCast(std::shared_ptr<T> &&src);
183
184template <class X, class T> QWeakPointer<X> qWeakPointerCast(const QWeakPointer<T> &src);
185
186QT_END_NAMESPACE
187
188#endif // Q_QDOC
189
190#endif // QSHAREDPOINTER_H
QT_END_NAMESPACE::KnownPointers
Definition qsharedpointer.cpp:1624
QT_END_NAMESPACE::KnownPointers::dPointers
QHash< const void *, Data > dPointers
Definition qsharedpointer.cpp:1627
QT_END_NAMESPACE::KnownPointers::mutex
QMutex mutex
Definition qsharedpointer.cpp:1626
QT_END_NAMESPACE::KnownPointers::dataPointers
QHash< const volatile void *, const void * > dataPointers
Definition qsharedpointer.cpp:1628
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qrandomaccessasyncfile_darwin.mm:17
QT_END_NAMESPACE::Data
Definition qsharedpointer.cpp:1616
QT_END_NAMESPACE::Data::pointer
const volatile void * pointer
Definition qsharedpointer.cpp:1617