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 QDBUSARGUMENT_H
6#define QDBUSARGUMENT_H
7
8#include <QtDBus/qtdbusglobal.h>
9#include <QtCore/qbytearray.h>
10#include <QtCore/qhash.h>
11#include <QtCore/qglobal.h>
12#include <QtCore/qlist.h>
13#include <QtCore/qmap.h>
14#include <QtCore/qstring.h>
15#include <QtCore/qstringlist.h>
16#include <QtCore/qvariant.h>
17#include <QtDBus/qdbusextratypes.h>
18
19#include <tuple>
20
21#ifndef QT_NO_DBUS
22
23QT_BEGIN_NAMESPACE
24
25
26class QDBusUnixFileDescriptor;
27
28class QDBusArgumentPrivate;
29class QDBusDemarshaller;
30class QDBusMarshaller;
31class Q_DBUS_EXPORT QDBusArgument
32{
33public:
34 enum ElementType {
35 BasicType,
36 VariantType,
37 ArrayType,
38 StructureType,
39 MapType,
40 MapEntryType,
41 UnknownType = -1
42 };
43
44 QDBusArgument();
45 QDBusArgument(const QDBusArgument &other);
46 QDBusArgument(QDBusArgument &&other) noexcept : d(other.d) { other.d = nullptr; }
47 QDBusArgument &operator=(QDBusArgument &&other) noexcept { swap(other); return *this; }
48 QDBusArgument &operator=(const QDBusArgument &other);
49 ~QDBusArgument();
50
51 void swap(QDBusArgument &other) noexcept { qt_ptr_swap(lhs&: d, rhs&: other.d); }
52
53 // used for marshalling (Qt -> D-Bus)
54 QDBusArgument &operator<<(uchar arg);
55 QDBusArgument &operator<<(bool arg);
56 QDBusArgument &operator<<(short arg);
57 QDBusArgument &operator<<(ushort arg);
58 QDBusArgument &operator<<(int arg);
59 QDBusArgument &operator<<(uint arg);
60 QDBusArgument &operator<<(qlonglong arg);
61 QDBusArgument &operator<<(qulonglong arg);
62 QDBusArgument &operator<<(double arg);
63 QDBusArgument &operator<<(const QString &arg);
64 QDBusArgument &operator<<(const QDBusVariant &arg);
65 QDBusArgument &operator<<(const QDBusObjectPath &arg);
66 QDBusArgument &operator<<(const QDBusSignature &arg);
67 QDBusArgument &operator<<(const QDBusUnixFileDescriptor &arg);
68 QDBusArgument &operator<<(const QStringList &arg);
69 QDBusArgument &operator<<(const QByteArray &arg);
70
71 void beginStructure();
72 void endStructure();
73 void beginArray(int elementMetaTypeId)
74 { beginArray(elementMetaType: QMetaType(elementMetaTypeId)); }
75 void beginArray(QMetaType elementMetaType);
76 void endArray();
77 void beginMap(int keyMetaTypeId, int valueMetaTypeId)
78 { beginMap(keyMetaType: QMetaType(keyMetaTypeId), valueMetaType: QMetaType(valueMetaTypeId)); }
79 void beginMap(QMetaType keyMetaType, QMetaType valueMetaType);
80 void endMap();
81 void beginMapEntry();
82 void endMapEntry();
83
84 void appendVariant(const QVariant &v);
85
86 // used for de-marshalling (D-Bus -> Qt)
87 QString currentSignature() const;
88 ElementType currentType() const;
89
90 const QDBusArgument &operator>>(uchar &arg) const;
91 const QDBusArgument &operator>>(bool &arg) const;
92 const QDBusArgument &operator>>(short &arg) const;
93 const QDBusArgument &operator>>(ushort &arg) const;
94 const QDBusArgument &operator>>(int &arg) const;
95 const QDBusArgument &operator>>(uint &arg) const;
96 const QDBusArgument &operator>>(qlonglong &arg) const;
97 const QDBusArgument &operator>>(qulonglong &arg) const;
98 const QDBusArgument &operator>>(double &arg) const;
99 const QDBusArgument &operator>>(QString &arg) const;
100 const QDBusArgument &operator>>(QDBusVariant &arg) const;
101 const QDBusArgument &operator>>(QDBusObjectPath &arg) const;
102 const QDBusArgument &operator>>(QDBusSignature &arg) const;
103 const QDBusArgument &operator>>(QDBusUnixFileDescriptor &arg) const;
104 const QDBusArgument &operator>>(QStringList &arg) const;
105 const QDBusArgument &operator>>(QByteArray &arg) const;
106
107 void beginStructure() const;
108 void endStructure() const;
109 void beginArray() const;
110 void endArray() const;
111 void beginMap() const;
112 void endMap() const;
113 void beginMapEntry() const;
114 void endMapEntry() const;
115 bool atEnd() const;
116
117 QVariant asVariant() const;
118
119protected:
120 QDBusArgument(QDBusArgumentPrivate *d);
121 friend class QDBusArgumentPrivate;
122 mutable QDBusArgumentPrivate *d;
123
124private:
125 template <typename... T>
126 friend QDBusArgument &operator<<(QDBusArgument &argument, const std::tuple<T...> &tuple)
127 {
128 static_assert(sizeof...(T) != 0, "D-Bus doesn't allow empty structs");
129 argument.beginStructure();
130 std::apply([&argument](const auto &...elements) { (argument << ... << elements); }, tuple);
131 argument.endStructure();
132 return argument;
133 }
134
135 template <typename... T>
136 friend const QDBusArgument &operator>>(const QDBusArgument &argument, std::tuple<T...> &tuple)
137 {
138 static_assert(sizeof...(T) != 0, "D-Bus doesn't allow empty structs");
139 argument.beginStructure();
140 std::apply([&argument](auto &...elements) { (argument >> ... >> elements); }, tuple);
141 argument.endStructure();
142 return argument;
143 }
144};
145Q_DECLARE_SHARED(QDBusArgument)
146
147QT_END_NAMESPACE
148QT_DECL_METATYPE_EXTERN(QDBusArgument, Q_DBUS_EXPORT)
149QT_BEGIN_NAMESPACE
150
151template<typename T> inline T qdbus_cast(const QDBusArgument &arg)
152{
153 T item;
154 arg >> item;
155 return item;
156}
157
158template<typename T> inline T qdbus_cast(const QVariant &v)
159{
160 if (v.metaType() == QMetaType::fromType<QDBusArgument>())
161 return qdbus_cast<T>(qvariant_cast<QDBusArgument>(v));
162 else
163 return qvariant_cast<T>(v);
164}
165
166// specialize for QVariant, allowing it to be used in place of QDBusVariant
167template<> inline QVariant qdbus_cast<QVariant>(const QDBusArgument &arg)
168{
169 QDBusVariant item;
170 arg >> item;
171 return item.variant();
172}
173template<> inline QVariant qdbus_cast<QVariant>(const QVariant &v)
174{
175 return qdbus_cast<QDBusVariant>(v).variant();
176}
177
178Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QVariant &v);
179
180// QVariant types
181#ifndef QDBUS_NO_SPECIALTYPES
182
183Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QDate &date);
184Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QDate &date);
185
186Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QTime &time);
187Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QTime &time);
188
189Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QDateTime &dt);
190Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QDateTime &dt);
191
192Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QRect &rect);
193Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QRect &rect);
194
195Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QRectF &rect);
196Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QRectF &rect);
197
198Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QSize &size);
199Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QSize &size);
200
201Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QSizeF &size);
202Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QSizeF &size);
203
204Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QPoint &pt);
205Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QPoint &pt);
206
207Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QPointF &pt);
208Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QPointF &pt);
209
210Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QLine &line);
211Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QLine &line);
212
213Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QLineF &line);
214Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QLineF &line);
215#endif
216
217template<template <typename> class Container, typename T,
218 typename = typename Container<T>::iterator>
219inline QDBusArgument &operator<<(QDBusArgument &arg, const Container<T> &list)
220{
221 arg.beginArray(QMetaType::fromType<T>());
222 typename Container<T>::const_iterator it = list.begin();
223 typename Container<T>::const_iterator end = list.end();
224 for ( ; it != end; ++it)
225 arg << *it;
226 arg.endArray();
227 return arg;
228}
229
230template<template <typename> class Container, typename T,
231 typename = typename Container<T>::iterator>
232inline const QDBusArgument &operator>>(const QDBusArgument &arg, Container<T> &list)
233{
234 arg.beginArray();
235 list.clear();
236 while (!arg.atEnd()) {
237 T item;
238 arg >> item;
239 list.push_back(item);
240 }
241
242 arg.endArray();
243 return arg;
244}
245
246inline QDBusArgument &operator<<(QDBusArgument &arg, const QVariantList &list)
247{
248 arg.beginArray(elementMetaType: QMetaType::fromType<QDBusVariant>());
249 for (const QVariant &value : list)
250 arg << QDBusVariant(value);
251 arg.endArray();
252 return arg;
253}
254
255// Specializations for associative containers
256template <template <typename, typename> class Container, typename Key, typename T,
257 QtPrivate::IfAssociativeIteratorHasKeyAndValue<typename Container<Key, T>::iterator> = true>
258inline QDBusArgument &operator<<(QDBusArgument &arg, const Container<Key, T> &map)
259{
260 arg.beginMap(QMetaType::fromType<Key>(), QMetaType::fromType<T>());
261 auto it = map.begin();
262 auto end = map.end();
263 for ( ; it != end; ++it) {
264 arg.beginMapEntry();
265 arg << it.key() << it.value();
266 arg.endMapEntry();
267 }
268 arg.endMap();
269 return arg;
270}
271
272template <template <typename, typename> class Container, typename Key, typename T,
273 QtPrivate::IfAssociativeIteratorHasFirstAndSecond<typename Container<Key, T>::iterator> = true>
274inline QDBusArgument &operator<<(QDBusArgument &arg, const Container<Key, T> &map)
275{
276 arg.beginMap(QMetaType::fromType<Key>(), QMetaType::fromType<T>());
277 auto it = map.begin();
278 auto end = map.end();
279 for ( ; it != end; ++it) {
280 arg.beginMapEntry();
281 arg << it->first << it->second;
282 arg.endMapEntry();
283 }
284 arg.endMap();
285 return arg;
286}
287
288template <template <typename, typename> class Container, typename Key, typename T,
289 QtPrivate::IfAssociativeIteratorHasKeyAndValue<typename Container<Key, T>::iterator> = true>
290inline const QDBusArgument &operator>>(const QDBusArgument &arg, Container<Key, T> &map)
291{
292 arg.beginMap();
293 map.clear();
294 while (!arg.atEnd()) {
295 Key key;
296 T value;
297 arg.beginMapEntry();
298 arg >> key >> value;
299 map.insert(key, value);
300 arg.endMapEntry();
301 }
302 arg.endMap();
303 return arg;
304}
305
306inline QDBusArgument &operator<<(QDBusArgument &arg, const QVariantMap &map)
307{
308 arg.beginMap(keyMetaType: QMetaType::fromType<QString>(), valueMetaType: QMetaType::fromType<QDBusVariant>());
309 for (const auto &[key, value] : map.asKeyValueRange()) {
310 arg.beginMapEntry();
311 arg << key << QDBusVariant(value);
312 arg.endMapEntry();
313 }
314 arg.endMap();
315 return arg;
316}
317
318inline QDBusArgument &operator<<(QDBusArgument &arg, const QVariantHash &map)
319{
320 arg.beginMap(keyMetaType: QMetaType::fromType<QString>(), valueMetaType: QMetaType::fromType<QDBusVariant>());
321 for (const auto &[key, value] : map.asKeyValueRange()) {
322 arg.beginMapEntry();
323 arg << key << QDBusVariant(value);
324 arg.endMapEntry();
325 }
326 arg.endMap();
327 return arg;
328}
329
330template <typename T1, typename T2>
331inline QDBusArgument &operator<<(QDBusArgument &arg, const std::pair<T1, T2> &pair)
332{
333 arg.beginStructure();
334 arg << pair.first << pair.second;
335 arg.endStructure();
336 return arg;
337}
338
339template <typename T1, typename T2>
340inline const QDBusArgument &operator>>(const QDBusArgument &arg, std::pair<T1, T2> &pair)
341{
342 arg.beginStructure();
343 arg >> pair.first >> pair.second;
344 arg.endStructure();
345 return arg;
346}
347
348QT_END_NAMESPACE
349
350#endif // QT_NO_DBUS
351#endif
352

source code of qtbase/src/dbus/qdbusargument.h