1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
|
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDBus module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qdbusargument.h"
#include <qatomic.h>
#include <qbytearray.h>
#include <qlist.h>
#include <qmap.h>
#include <qstring.h>
#include <qstringlist.h>
#include <qvariant.h>
#include <qdatetime.h>
#include <qrect.h>
#include <qline.h>
#include "qdbusargument_p.h"
#include "qdbusmetatype_p.h"
#include "qdbusutil_p.h"
#ifndef QT_NO_DBUS
QT_BEGIN_NAMESPACE
QDBusArgumentPrivate::~QDBusArgumentPrivate()
{
if (message)
q_dbus_message_unref(message);
}
QByteArray QDBusArgumentPrivate::createSignature(int id)
{
if (!qdbus_loadLibDBus())
return "";
QByteArray signature;
QDBusMarshaller *marshaller = new QDBusMarshaller;
marshaller->ba = &signature;
// run it
void *null = 0;
QVariant v(id, null);
QDBusArgument arg(marshaller);
QDBusMetaType::marshall(arg, v.userType(), v.constData());
arg.d = 0;
// delete it
bool ok = marshaller->ok;
delete marshaller;
if (signature.isEmpty() || !ok || !QDBusUtil::isValidSingleSignature(QString::fromLatin1(signature))) {
qWarning("QDBusMarshaller: type `%s' produces invalid D-BUS signature `%s' "
"(Did you forget to call beginStructure() ?)",
QVariant::typeToName( QVariant::Type(id) ),
signature.isEmpty() ? "<empty>" : signature.constData());
return "";
} else if ((signature.at(0) != DBUS_TYPE_ARRAY && signature.at(0) != DBUS_STRUCT_BEGIN_CHAR) ||
(signature.at(0) == DBUS_TYPE_ARRAY && (signature.at(1) == DBUS_TYPE_BYTE ||
signature.at(1) == DBUS_TYPE_STRING))) {
qWarning("QDBusMarshaller: type `%s' attempts to redefine basic D-BUS type '%s' (%s) "
"(Did you forget to call beginStructure() ?)",
QVariant::typeToName( QVariant::Type(id) ),
signature.constData(),
QVariant::typeToName( QVariant::Type(QDBusMetaType::signatureToType(signature))) );
return "";
}
return signature;
}
bool QDBusArgumentPrivate::checkWrite(QDBusArgumentPrivate *&d)
{
if (!d)
return false;
if (d->direction == Marshalling) {
if (!d->marshaller()->ok)
return false;
if (d->message && d->ref != 1) {
QDBusMarshaller *dd = new QDBusMarshaller;
dd->message = q_dbus_message_copy(d->message);
q_dbus_message_iter_init_append(dd->message, &dd->iterator);
if (!d->ref.deref())
delete d;
d = dd;
}
return true;
}
#ifdef QT_DEBUG
qFatal("QDBusArgument: write from a read-only object");
#else
qWarning("QDBusArgument: write from a read-only object");
#endif
return false;
}
bool QDBusArgumentPrivate::checkRead(QDBusArgumentPrivate *d)
{
if (!d)
return false;
if (d->direction == Demarshalling)
return true;
#ifdef QT_DEBUG
qFatal("QDBusArgument: read from a write-only object");
#else
qWarning("QDBusArgument: read from a write-only object");
#endif
return false;
}
bool QDBusArgumentPrivate::checkReadAndDetach(QDBusArgumentPrivate *&d)
{
if (!checkRead(d))
return false; // don't bother
if (d->ref == 1)
return true; // no need to detach
QDBusDemarshaller *dd = new QDBusDemarshaller;
dd->message = q_dbus_message_ref(d->message);
dd->iterator = static_cast<QDBusDemarshaller*>(d)->iterator;
if (!d->ref.deref())
delete d;
d = dd;
return true;
}
/*!
\class QDBusArgument
\inmodule QtDBus
\since 4.2
\brief The QDBusArgument class is used to marshall and demarshall D-Bus arguments.
The class is used to send arguments over D-Bus to remote
applications and to receive them back. D-Bus offers an extensible
type system, based on a few primitive types and associations of
them. See the \l {qdbustypesystem.html}{QtDBus type system} page
for more information on the type system.
QDBusArgument is the central class in the QtDBus type system,
providing functions to marshall and demarshall the primitive
types. The compound types are then created by association of one
or more of the primitive types in arrays, dictionaries or
structures.
The following example illustrates how a structure containing an
integer and a string can be constructed using the \l
{qdbustypesystem.html}{QtDBus type system}:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 0
The type has to be registered with qDBusRegisterMetaType() before
it can be used with QDBusArgument. Therefore, somewhere in your
program, you should add the following code:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 1
Once registered, a type can be used in outgoing method calls
(placed with QDBusAbstractInterface::call()), signal emissions
from registered objects or in incoming calls from remote
applications.
It is important to note that the \c{operator<<} and \c{operator>>}
streaming functions must always produce the same number of entries
in case of structures, both in reading and in writing (marshalling
and demarshalling), otherwise calls and signals may start to
silently fail.
The following example illustrates this wrong usage
in context of a class that may contain invalid data:
\badcode
// Wrongly marshall the MyTime data into a D-Bus argument
QDBusArgument &operator<<(QDBusArgument &argument, const MyTime &mytime)
{
argument.beginStructure();
if (mytime.isValid)
argument << true << mytime.hour
<< mytime.minute << mytime.second;
else
argument << false;
argument.endStructure();
return argument;
}
\endcode
In this example, both the \c{operator<<} and the \c{operator>>}
functions may produce a different number of reads/writes. This can
confuse the QtDBus type system and should be avoided.
\sa QDBusAbstractInterface, {qdbustypesystem.html}{The QtDBus type
system}, {usingadaptors.html}{Using Adaptors}, qdbus_cast()
*/
/*!
\enum QDBusArgument::ElementType
\since 4.5
This enum describes the type of element held by the argument.
\value BasicType A basic element, which is understood by
QVariant. The following types are considered basic: bool,
byte, short, ushort, int, uint, qint64, quint64, double,
QString, QByteArray, QDBusObjectPath, QDBusSignature
\value VariantType The variant element (QDBusVariant)
\value ArrayType An array element, usually represented by QList<T>
or QVector<T>. Note: QByteArray and associative maps are not
considered arrays, even if the D-Bus protocol transports them as such.
\value StructureType A custom type represented by a structure,
like QDateTime, QPoint, etc.
\value MapType An associative container, like QMap<Key, Value> or
QHash<Key, Value>
\value MapEntryType One entry in an associative container: both
the key and the value form one map-entry type.
\value UnknownType The type is unknown or we have reached the end
of the list.
\sa currentType()
*/
/*!
\fn qdbus_cast(const QDBusArgument &argument)
\relates QDBusArgument
\since 4.2
Attempts to demarshall the contents of \a argument into the type
\c{T}. For example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 2
Note that it is equivalent to the following:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 3
*/
/*!
Constructs an empty QDBusArgument argument.
An empty QDBusArgument object does not allow either reading or
writing to be performed.
*/
QDBusArgument::QDBusArgument()
{
if (!qdbus_loadLibDBus()) {
d = 0;
return;
}
QDBusMarshaller *dd = new QDBusMarshaller;
d = dd;
// create a new message with any type, we won't sent it anyways
dd->message = q_dbus_message_new(DBUS_MESSAGE_TYPE_METHOD_CALL);
q_dbus_message_iter_init_append(dd->message, &dd->iterator);
}
/*!
Constructs a copy of the \a other QDBusArgument object.
Both objects will therefore contain the same state from this point
forward. QDBusArguments are explicitly shared and, therefore, any
modification to either copy will affect the other one too.
*/
QDBusArgument::QDBusArgument(const QDBusArgument &other)
: d(other.d)
{
if (d)
d->ref.ref();
}
/*!
\internal
*/
QDBusArgument::QDBusArgument(QDBusArgumentPrivate *dd)
: d(dd)
{
}
/*!
Copies the \a other QDBusArgument object into this one.
Both objects will therefore contain the same state from this point
forward. QDBusArguments are explicitly shared and, therefore, any
modification to either copy will affect the other one too.
*/
QDBusArgument &QDBusArgument::operator=(const QDBusArgument &other)
{
qAtomicAssign(d, other.d);
return *this;
}
/*!
Disposes of the resources associated with this QDBusArgument
object.
*/
QDBusArgument::~QDBusArgument()
{
if (d && !d->ref.deref())
delete d;
}
/*!
Appends the primitive value \a arg of type \c{BYTE} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(uchar arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{BOOLEAN} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(bool arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{INT16} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(short arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{UINT16} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(ushort arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{INT32} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(int arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{UINT32} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(uint arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{INT64} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(qlonglong arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{UINT64} to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(qulonglong arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{DOUBLE} (double-precision
floating-point) to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(double arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{STRING} (Unicode character
string) to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(const QString &arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
\internal
Appends the primitive value \a arg of type \c{OBJECT_PATH} (path to a D-Bus
object) to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(const QDBusObjectPath &arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
\internal
Appends the primitive value \a arg of type \c{SIGNATURE} (D-Bus type
signature) to the D-Bus stream.
*/
QDBusArgument &QDBusArgument::operator<<(const QDBusSignature &arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the primitive value \a arg of type \c{VARIANT} to the D-Bus stream.
A D-Bus variant type can contain any type, including other
variants. It is similar to the Qt QVariant type.
*/
QDBusArgument &QDBusArgument::operator<<(const QDBusVariant &arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the QStringList given by \a arg as \c{ARRAY of STRING}
to the D-Bus stream.
QStringList and QByteArray are the only two non-primitive types
that are supported directly by QDBusArgument because of their
widespread usage in Qt applications.
Other arrays are supported through compound types in QtDBus.
*/
QDBusArgument &QDBusArgument::operator<<(const QStringList &arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\overload
Appends the QByteArray given by \a arg as \c{ARRAY of BYTE}
to the D-Bus stream.
QStringList and QByteArray are the only two non-primitive types
that are supported directly by QDBusArgument because of their
widespread usage in Qt applications.
Other arrays are supported through compound types in QtDBus.
*/
QDBusArgument &QDBusArgument::operator<<(const QByteArray &arg)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->append(arg);
return *this;
}
/*!
\internal
\since 4.5
Appends the variant \a v.
\sa asVariant()
*/
void QDBusArgument::appendVariant(const QVariant &v)
{
if (QDBusArgumentPrivate::checkWrite(d))
d->marshaller()->appendVariantInternal(v);
}
/*!
\internal
Returns the type signature of the D-Bus type this QDBusArgument
object is currently pointing to.
*/
QString QDBusArgument::currentSignature() const
{
if (!d)
return QString();
if (d->direction == QDBusArgumentPrivate::Demarshalling)
return d->demarshaller()->currentSignature();
else
return d->marshaller()->currentSignature();
}
/*!
\since 4.5
Returns the classification of the current element type. If an
error decoding the type occurs or if we're at the end of the
argument, this function returns QDBusArgument::UnknownType.
This function only makes sense when demarshalling arguments. If it
is used while marshalling, it will always return UnknownType.
*/
QDBusArgument::ElementType QDBusArgument::currentType() const
{
if (!d)
return UnknownType;
if (d->direction == QDBusArgumentPrivate::Demarshalling)
return d->demarshaller()->currentType();
return UnknownType;
}
/*!
Extracts one D-BUS primitive argument of type \c{BYTE} from the
D-BUS stream and puts it into \a arg.
*/
const QDBusArgument &QDBusArgument::operator>>(uchar &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toByte();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{BOOLEAN} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(bool &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toBool();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{UINT16} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(ushort &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toUShort();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{INT16} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(short &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toShort();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{INT32} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(int &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toInt();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{UINT32} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(uint &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toUInt();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{INT64} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(qlonglong &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toLongLong();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{UINT64} from the
D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(qulonglong &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toULongLong();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{DOUBLE}
(double-precision floating pount) from the D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(double &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toDouble();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{STRING} (Unicode
character string) from the D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(QString &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toString();
return *this;
}
/*!
\overload
\internal
Extracts one D-Bus primitive argument of type \c{OBJECT_PATH}
(D-Bus path to an object) from the D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(QDBusObjectPath &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toObjectPath();
return *this;
}
/*!
\overload
\internal
Extracts one D-Bus primitive argument of type \c{SIGNATURE} (D-Bus
type signature) from the D-Bus stream.
*/
const QDBusArgument &QDBusArgument::operator>>(QDBusSignature &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toSignature();
return *this;
}
/*!
\overload
Extracts one D-Bus primitive argument of type \c{VARIANT} from the
D-Bus stream.
A D-Bus variant type can contain any type, including other
variants. It is similar to the Qt QVariant type.
In case the variant contains a type not directly supported by
QDBusArgument, the value of the returned QDBusVariant will contain
another QDBusArgument. It is your responsibility to further
demarshall it into another type.
*/
const QDBusArgument &QDBusArgument::operator>>(QDBusVariant &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toVariant();
return *this;
}
/*!
\overload
Extracts an array of strings from the D-Bus stream and return it
as a QStringList.
QStringList and QByteArray are the only two non-primitive types
that are supported directly by QDBusArgument because of their
widespread usage in Qt applications.
Other arrays are supported through compound types in QtDBus.
*/
const QDBusArgument &QDBusArgument::operator>>(QStringList &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toStringList();
return *this;
}
/*!
\overload
Extracts an array of bytes from the D-Bus stream and return it
as a QByteArray.
QStringList and QByteArray are the only two non-primitive types
that are supported directly by QDBusArgument because of their
widespread usage in Qt applications.
Other arrays are supported through compound types in QtDBus.
*/
const QDBusArgument &QDBusArgument::operator>>(QByteArray &arg) const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
arg = d->demarshaller()->toByteArray();
return *this;
}
/*!
Opens a new D-Bus structure suitable for appending new arguments.
This function is used usually in \c{operator<<} streaming
operators, as in the following example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 4
Structures can contain other structures, so the following code is
also valid:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 5
\sa endStructure(), beginArray(), beginMap()
*/
void QDBusArgument::beginStructure()
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->beginStructure();
}
/*!
Closes a D-Bus structure opened with beginStructure(). This function must be called
same number of times that beginStructure() is called.
\sa beginStructure(), endArray(), endMap()
*/
void QDBusArgument::endStructure()
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->endStructure();
}
/*!
Opens a new D-Bus array suitable for appending elements of meta-type \a id.
This function is used usually in \c{operator<<} streaming
operators, as in the following example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 6
If the type you want to marshall is a QList, QVector or any of the
Qt's \l {Container Classes} that take one template parameter,
you need not declare an \c{operator<<} function for it, since
QtDBus provides generic templates to do the job of marshalling
the data. The same applies for STL's sequence containers, such
as \c {std::list}, \c {std::vector}, etc.
\sa endArray(), beginStructure(), beginMap()
*/
void QDBusArgument::beginArray(int id)
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->beginArray(id);
}
/*!
Closes a D-Bus array opened with beginArray(). This function must be called
same number of times that beginArray() is called.
\sa beginArray(), endStructure(), endMap()
*/
void QDBusArgument::endArray()
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->endArray();
}
/*!
Opens a new D-Bus map suitable for
appending elements. Maps are containers that associate one entry
(the key) to another (the value), such as Qt's QMap or QHash. The
ids of the map's key and value meta types must be passed in \a kid
and \a vid respectively.
This function is used usually in \c{operator<<} streaming
operators, as in the following example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 7
If the type you want to marshall is a QMap or QHash, you need not
declare an \c{operator<<} function for it, since QtDBus provides
generic templates to do the job of marshalling the data.
\sa endMap(), beginStructure(), beginArray(), beginMapEntry()
*/
void QDBusArgument::beginMap(int kid, int vid)
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->beginMap(kid, vid);
}
/*!
Closes a D-Bus map opened with beginMap(). This function must be called
same number of times that beginMap() is called.
\sa beginMap(), endStructure(), endArray()
*/
void QDBusArgument::endMap()
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->endMap();
}
/*!
Opens a D-Bus map entry suitable for
appending the key and value entries. This function is only valid
when a map has been opened with beginMap().
See beginMap() for an example of usage of this function.
\sa endMapEntry(), beginMap()
*/
void QDBusArgument::beginMapEntry()
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->beginMapEntry();
}
/*!
Closes a D-Bus map entry opened with beginMapEntry(). This function must be called
same number of times that beginMapEntry() is called.
\sa beginMapEntry()
*/
void QDBusArgument::endMapEntry()
{
if (QDBusArgumentPrivate::checkWrite(d))
d = d->marshaller()->endMapEntry();
}
/*!
Opens a D-Bus structure suitable for extracting elements.
This function is used usually in \c{operator>>} streaming
operators, as in the following example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 8
\sa endStructure(), beginArray(), beginMap()
*/
void QDBusArgument::beginStructure() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->beginStructure();
}
/*!
Closes the D-Bus structure and allow extracting of the next element
after the structure.
\sa beginStructure()
*/
void QDBusArgument::endStructure() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->endStructure();
}
/*!
Recurses into the D-Bus array to allow extraction of
the array elements.
This function is used usually in \c{operator>>} streaming
operators, as in the following example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 9
If the type you want to demarshall is a QList, QVector or any of the
Qt's \l {Container Classes} that take one template parameter, you
need not declare an \c{operator>>} function for it, since QtDBus
provides generic templates to do the job of demarshalling the data.
The same applies for STL's sequence containers, such as \c {std::list},
\c {std::vector}, etc.
\sa atEnd(), beginStructure(), beginMap()
*/
void QDBusArgument::beginArray() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->beginArray();
}
/*!
Closes the D-Bus array and allow extracting of the next element
after the array.
\sa beginArray()
*/
void QDBusArgument::endArray() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->endArray();
}
/*!
Recurses into the D-Bus map to allow extraction of
the map's elements.
This function is used usually in \c{operator>>} streaming
operators, as in the following example:
\snippet doc/src/snippets/code/src_qdbus_qdbusargument.cpp 10
If the type you want to demarshall is a QMap or QHash, you need not
declare an \c{operator>>} function for it, since QtDBus provides
generic templates to do the job of demarshalling the data.
\sa endMap(), beginStructure(), beginArray(), beginMapEntry()
*/
void QDBusArgument::beginMap() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->beginMap();
}
/*!
Closes the D-Bus map and allow extracting of the next element
after the map.
\sa beginMap()
*/
void QDBusArgument::endMap() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->endMap();
}
/*!
Recurses into the D-Bus map entry to allow extraction
of the key and value pair.
See beginMap() for an example of how this function is usually used.
\sa endMapEntry(), beginMap()
*/
void QDBusArgument::beginMapEntry() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->beginMapEntry();
}
/*!
Closes the D-Bus map entry and allow extracting of the next element
on the map.
\sa beginMapEntry()
*/
void QDBusArgument::endMapEntry() const
{
if (QDBusArgumentPrivate::checkReadAndDetach(d))
d = d->demarshaller()->endMapEntry();
}
/*!
Returns true if there are no more elements to be extracted from
this QDBusArgument. This function is usually used in QDBusArgument
objects returned from beginMap() and beginArray().
*/
bool QDBusArgument::atEnd() const
{
if (QDBusArgumentPrivate::checkRead(d))
return d->demarshaller()->atEnd();
return true; // at least, stop reading
}
/*!
\since 4.5
Returns the current argument in the form of a QVariant. Basic
types will be decoded and returned in the QVariant, but for
complex types, this function will return a QDBusArgument object in
the QVariant. It is the caller's responsibility to decode the
argument (for example, by calling asVariant() in it).
For example, if the current argument is an INT32, this function
will return a QVariant with an argument of type QVariant::Int. For
an array of INT32, it will return a QVariant containing a
QDBusArgument.
If an error occurs or if there are no more arguments to decode
(i.e., we are at the end of the argument list), this function will
return an invalid QVariant.
\sa atEnd()
*/
QVariant QDBusArgument::asVariant() const
{
if (QDBusArgumentPrivate::checkRead(d))
return d->demarshaller()->toVariantInternal();
return QVariant();
}
QT_END_NAMESPACE
// for optimization purposes, we include the marshallers here
#include "qdbusmarshaller.cpp"
#include "qdbusdemarshaller.cpp"
QT_BEGIN_NAMESPACE
// QDBusArgument operators
const QDBusArgument &operator>>(const QDBusArgument &a, QVariant &v)
{
QDBusVariant dbv;
a >> dbv;
v = dbv.variant();
return a;
}
// QVariant types
#ifndef QDBUS_NO_SPECIALTYPES
const QDBusArgument &operator>>(const QDBusArgument &a, QDate &date)
{
int y, m, d;
a.beginStructure();
a >> y >> m >> d;
a.endStructure();
if (y != 0 && m != 0 && d != 0)
date.setYMD(y, m, d);
else
date = QDate();
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QDate &date)
{
a.beginStructure();
if (date.isValid())
a << date.year() << date.month() << date.day();
else
a << 0 << 0 << 0;
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QTime &time)
{
int h, m, s, ms;
a.beginStructure();
a >> h >> m >> s >> ms;
a.endStructure();
if (h < 0)
time = QTime();
else
time.setHMS(h, m, s, ms);
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QTime &time)
{
a.beginStructure();
if (time.isValid())
a << time.hour() << time.minute() << time.second() << time.msec();
else
a << -1 << -1 << -1 << -1;
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QDateTime &dt)
{
QDate date;
QTime time;
int timespec;
a.beginStructure();
a >> date >> time >> timespec;
a.endStructure();
dt = QDateTime(date, time, Qt::TimeSpec(timespec));
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QDateTime &dt)
{
a.beginStructure();
a << dt.date() << dt.time() << int(dt.timeSpec());
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QRect &rect)
{
int x, y, width, height;
a.beginStructure();
a >> x >> y >> width >> height;
a.endStructure();
rect.setRect(x, y, width, height);
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QRect &rect)
{
a.beginStructure();
a << rect.x() << rect.y() << rect.width() << rect.height();
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QRectF &rect)
{
double x, y, width, height;
a.beginStructure();
a >> x >> y >> width >> height;
a.endStructure();
rect.setRect(qreal(x), qreal(y), qreal(width), qreal(height));
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QRectF &rect)
{
a.beginStructure();
a << double(rect.x()) << double(rect.y()) << double(rect.width()) << double(rect.height());
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QSize &size)
{
a.beginStructure();
a >> size.rwidth() >> size.rheight();
a.endStructure();
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QSize &size)
{
a.beginStructure();
a << size.width() << size.height();
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QSizeF &size)
{
double width, height;
a.beginStructure();
a >> width >> height;
a.endStructure();
size.setWidth(qreal(width));
size.setHeight(qreal(height));
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QSizeF &size)
{
a.beginStructure();
a << double(size.width()) << double(size.height());
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QPoint &pt)
{
a.beginStructure();
a >> pt.rx() >> pt.ry();
a.endStructure();
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QPoint &pt)
{
a.beginStructure();
a << pt.x() << pt.y();
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QPointF &pt)
{
double x, y;
a.beginStructure();
a >> x >> y;
a.endStructure();
pt.setX(qreal(x));
pt.setY(qreal(y));
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QPointF &pt)
{
a.beginStructure();
a << double(pt.x()) << double(pt.y());
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QLine &line)
{
QPoint p1, p2;
a.beginStructure();
a >> p1 >> p2;
a.endStructure();
line = QLine(p1, p2);
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QLine &line)
{
a.beginStructure();
a << line.p1() << line.p2();
a.endStructure();
return a;
}
const QDBusArgument &operator>>(const QDBusArgument &a, QLineF &line)
{
QPointF p1, p2;
a.beginStructure();
a >> p1 >> p2;
a.endStructure();
line = QLineF(p1, p2);
return a;
}
QDBusArgument &operator<<(QDBusArgument &a, const QLineF &line)
{
a.beginStructure();
a << line.p1() << line.p2();
a.endStructure();
return a;
}
#endif
QT_END_NAMESPACE
#endif // QT_NO_DBUS
|