1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtDBus module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QDBUSARGUMENT_H
43 #define QDBUSARGUMENT_H
45 #include <QtCore/qbytearray.h>
46 #include <QtCore/qhash.h>
47 #include <QtCore/qglobal.h>
48 #include <QtCore/qlist.h>
49 #include <QtCore/qmap.h>
50 #include <QtCore/qstring.h>
51 #include <QtCore/qstringlist.h>
52 #include <QtCore/qvariant.h>
53 #include <QtDBus/qdbusextratypes.h>
54 #include <QtDBus/qdbusmacros.h>
63 class QDBusUnixFileDescriptor;
65 class QDBusArgumentPrivate;
66 class QDBusDemarshaller;
67 class QDBusMarshaller;
68 class Q_DBUS_EXPORT QDBusArgument
82 QDBusArgument(const QDBusArgument &other);
83 QDBusArgument &operator=(const QDBusArgument &other);
86 // used for marshalling (Qt -> D-BUS)
87 QDBusArgument &operator<<(uchar arg);
88 QDBusArgument &operator<<(bool arg);
89 QDBusArgument &operator<<(short arg);
90 QDBusArgument &operator<<(ushort arg);
91 QDBusArgument &operator<<(int arg);
92 QDBusArgument &operator<<(uint arg);
93 QDBusArgument &operator<<(qlonglong arg);
94 QDBusArgument &operator<<(qulonglong arg);
95 QDBusArgument &operator<<(double arg);
96 QDBusArgument &operator<<(const QString &arg);
97 QDBusArgument &operator<<(const QDBusVariant &arg);
98 QDBusArgument &operator<<(const QDBusObjectPath &arg);
99 QDBusArgument &operator<<(const QDBusSignature &arg);
100 QDBusArgument &operator<<(const QDBusUnixFileDescriptor &arg);
101 QDBusArgument &operator<<(const QStringList &arg);
102 QDBusArgument &operator<<(const QByteArray &arg);
104 void beginStructure();
106 void beginArray(int elementMetaTypeId);
108 void beginMap(int keyMetaTypeId, int valueMetaTypeId);
110 void beginMapEntry();
113 void appendVariant(const QVariant &v);
115 // used for de-marshalling (D-BUS -> Qt)
116 QString currentSignature() const;
117 ElementType currentType() const;
119 const QDBusArgument &operator>>(uchar &arg) const;
120 const QDBusArgument &operator>>(bool &arg) const;
121 const QDBusArgument &operator>>(short &arg) const;
122 const QDBusArgument &operator>>(ushort &arg) const;
123 const QDBusArgument &operator>>(int &arg) const;
124 const QDBusArgument &operator>>(uint &arg) const;
125 const QDBusArgument &operator>>(qlonglong &arg) const;
126 const QDBusArgument &operator>>(qulonglong &arg) const;
127 const QDBusArgument &operator>>(double &arg) const;
128 const QDBusArgument &operator>>(QString &arg) const;
129 const QDBusArgument &operator>>(QDBusVariant &arg) const;
130 const QDBusArgument &operator>>(QDBusObjectPath &arg) const;
131 const QDBusArgument &operator>>(QDBusSignature &arg) const;
132 const QDBusArgument &operator>>(QDBusUnixFileDescriptor &arg) const;
133 const QDBusArgument &operator>>(QStringList &arg) const;
134 const QDBusArgument &operator>>(QByteArray &arg) const;
136 void beginStructure() const;
137 void endStructure() const;
138 void beginArray() const;
139 void endArray() const;
140 void beginMap() const;
142 void beginMapEntry() const;
143 void endMapEntry() const;
146 QVariant asVariant() const;
149 QDBusArgument(QDBusArgumentPrivate *d);
150 friend class QDBusArgumentPrivate;
151 mutable QDBusArgumentPrivate *d;
155 Q_DECLARE_METATYPE(QDBusArgument)
158 template<typename T> inline T qdbus_cast(const QDBusArgument &arg
169 template<typename T> inline T qdbus_cast(const QVariant &v
175 int id = v.userType();
176 if (id == qMetaTypeId<QDBusArgument>())
177 return qdbus_cast<T>(qvariant_cast<QDBusArgument>(v));
179 return qvariant_cast<T>(v);
182 // specialize for QVariant, allowing it to be used in place of QDBusVariant
183 template<> inline QVariant qdbus_cast<QVariant>(const QDBusArgument &arg, QVariant *)
187 return item.variant();
189 template<> inline QVariant qdbus_cast<QVariant>(const QVariant &v, QVariant *)
191 return qdbus_cast<QDBusVariant>(v).variant();
194 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QVariant &v);
197 #ifndef QDBUS_NO_SPECIALTYPES
199 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QDate &date);
200 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QDate &date);
202 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QTime &time);
203 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QTime &time);
205 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QDateTime &dt);
206 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QDateTime &dt);
208 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QRect &rect);
209 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QRect &rect);
211 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QRectF &rect);
212 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QRectF &rect);
214 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QSize &size);
215 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QSize &size);
217 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QSizeF &size);
218 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QSizeF &size);
220 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QPoint &pt);
221 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QPoint &pt);
223 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QPointF &pt);
224 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QPointF &pt);
226 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QLine &line);
227 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QLine &line);
229 Q_DBUS_EXPORT const QDBusArgument &operator>>(const QDBusArgument &a, QLineF &line);
230 Q_DBUS_EXPORT QDBusArgument &operator<<(QDBusArgument &a, const QLineF &line);
233 template<template <typename> class Container, typename T>
234 inline QDBusArgument &operator<<(QDBusArgument &arg, const Container<T> &list)
236 int id = qMetaTypeId<T>();
238 typename Container<T>::const_iterator it = list.begin();
239 typename Container<T>::const_iterator end = list.end();
240 for ( ; it != end; ++it)
246 template<template <typename> class Container, typename T>
247 inline const QDBusArgument &operator>>(const QDBusArgument &arg, Container<T> &list)
251 while (!arg.atEnd()) {
254 list.push_back(item);
261 // QList specializations
263 inline QDBusArgument &operator<<(QDBusArgument &arg, const QList<T> &list)
265 int id = qMetaTypeId<T>();
267 typename QList<T>::ConstIterator it = list.constBegin();
268 typename QList<T>::ConstIterator end = list.constEnd();
269 for ( ; it != end; ++it)
276 inline const QDBusArgument &operator>>(const QDBusArgument &arg, QList<T> &list)
280 while (!arg.atEnd()) {
283 list.push_back(item);
290 inline QDBusArgument &operator<<(QDBusArgument &arg, const QVariantList &list)
292 int id = qMetaTypeId<QDBusVariant>();
294 QVariantList::ConstIterator it = list.constBegin();
295 QVariantList::ConstIterator end = list.constEnd();
296 for ( ; it != end; ++it)
297 arg << QDBusVariant(*it);
302 // QMap specializations
303 template<typename Key, typename T>
304 inline QDBusArgument &operator<<(QDBusArgument &arg, const QMap<Key, T> &map)
306 int kid = qMetaTypeId<Key>();
307 int vid = qMetaTypeId<T>();
308 arg.beginMap(kid, vid);
309 typename QMap<Key, T>::ConstIterator it = map.constBegin();
310 typename QMap<Key, T>::ConstIterator end = map.constEnd();
311 for ( ; it != end; ++it) {
313 arg << it.key() << it.value();
320 template<typename Key, typename T>
321 inline const QDBusArgument &operator>>(const QDBusArgument &arg, QMap<Key, T> &map)
325 while (!arg.atEnd()) {
330 map.insertMulti(key, value);
337 inline QDBusArgument &operator<<(QDBusArgument &arg, const QVariantMap &map)
339 arg.beginMap(QVariant::String, qMetaTypeId<QDBusVariant>());
340 QVariantMap::ConstIterator it = map.constBegin();
341 QVariantMap::ConstIterator end = map.constEnd();
342 for ( ; it != end; ++it) {
344 arg << it.key() << QDBusVariant(it.value());
351 // QHash specializations
352 template<typename Key, typename T>
353 inline QDBusArgument &operator<<(QDBusArgument &arg, const QHash<Key, T> &map)
355 int kid = qMetaTypeId<Key>();
356 int vid = qMetaTypeId<T>();
357 arg.beginMap(kid, vid);
358 typename QHash<Key, T>::ConstIterator it = map.constBegin();
359 typename QHash<Key, T>::ConstIterator end = map.constEnd();
360 for ( ; it != end; ++it) {
362 arg << it.key() << it.value();
369 template<typename Key, typename T>
370 inline const QDBusArgument &operator>>(const QDBusArgument &arg, QHash<Key, T> &map)
374 while (!arg.atEnd()) {
379 map.insertMulti(key, value);
386 inline QDBusArgument &operator<<(QDBusArgument &arg, const QVariantHash &map)
388 arg.beginMap(QVariant::String, qMetaTypeId<QDBusVariant>());
389 QVariantHash::ConstIterator it = map.constBegin();
390 QVariantHash::ConstIterator end = map.constEnd();
391 for ( ; it != end; ++it) {
393 arg << it.key() << QDBusVariant(it.value());