author | Eckhart Koeppen <eckhart.koppen@nokia.com> |
Thu, 29 Apr 2010 15:15:16 +0300 | |
branch | RCL_3 |
changeset 16 | 4b6ee5efea19 |
parent 4 | 3b1da2848fc7 |
permissions | -rw-r--r-- |
0 | 1 |
/**************************************************************************** |
2 |
** |
|
4
3b1da2848fc7
Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
3
diff
changeset
|
3 |
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
0 | 4 |
** All rights reserved. |
5 |
** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 |
** |
|
7 |
** This file is part of the QtDBus module of the Qt Toolkit. |
|
8 |
** |
|
9 |
** $QT_BEGIN_LICENSE:LGPL$ |
|
10 |
** No Commercial Usage |
|
11 |
** This file contains pre-release code and may not be distributed. |
|
12 |
** You may use this file in accordance with the terms and conditions |
|
13 |
** contained in the Technology Preview License Agreement accompanying |
|
14 |
** this package. |
|
15 |
** |
|
16 |
** GNU Lesser General Public License Usage |
|
17 |
** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 |
** General Public License version 2.1 as published by the Free Software |
|
19 |
** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 |
** packaging of this file. Please review the following information to |
|
21 |
** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 |
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 |
** |
|
24 |
** In addition, as a special exception, Nokia gives you certain additional |
|
25 |
** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 |
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 |
** |
|
28 |
** If you have questions regarding the use of this file, please contact |
|
29 |
** Nokia at qt-info@nokia.com. |
|
30 |
** |
|
31 |
** |
|
32 |
** |
|
33 |
** |
|
34 |
** |
|
35 |
** |
|
36 |
** |
|
37 |
** |
|
38 |
** $QT_END_LICENSE$ |
|
39 |
** |
|
40 |
****************************************************************************/ |
|
41 |
||
42 |
#include "qdbusmetatype.h" |
|
43 |
||
44 |
#include <string.h> |
|
3
41300fa6a67c
Revision: 201003
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
0
diff
changeset
|
45 |
#include "qdbus_symbols_p.h" |
0 | 46 |
|
47 |
#include <qbytearray.h> |
|
48 |
#include <qglobal.h> |
|
49 |
#include <qreadwritelock.h> |
|
50 |
#include <qvector.h> |
|
51 |
||
52 |
#include "qdbusmessage.h" |
|
53 |
#include "qdbusutil_p.h" |
|
54 |
#include "qdbusmetatype_p.h" |
|
55 |
#include "qdbusargument_p.h" |
|
56 |
||
57 |
Q_DECLARE_METATYPE(QList<bool>) |
|
58 |
Q_DECLARE_METATYPE(QList<short>) |
|
59 |
Q_DECLARE_METATYPE(QList<ushort>) |
|
60 |
Q_DECLARE_METATYPE(QList<int>) |
|
61 |
Q_DECLARE_METATYPE(QList<uint>) |
|
62 |
Q_DECLARE_METATYPE(QList<qlonglong>) |
|
63 |
Q_DECLARE_METATYPE(QList<qulonglong>) |
|
64 |
Q_DECLARE_METATYPE(QList<double>) |
|
65 |
||
66 |
QT_BEGIN_NAMESPACE |
|
67 |
||
68 |
class QDBusCustomTypeInfo |
|
69 |
{ |
|
70 |
public: |
|
71 |
QDBusCustomTypeInfo() : signature(0, '\0'), marshall(0), demarshall(0) |
|
72 |
{ } |
|
73 |
||
74 |
// Suggestion: |
|
75 |
// change 'signature' to char* and make QDBusCustomTypeInfo a Movable type |
|
76 |
QByteArray signature; |
|
77 |
QDBusMetaType::MarshallFunction marshall; |
|
78 |
QDBusMetaType::DemarshallFunction demarshall; |
|
79 |
}; |
|
80 |
||
81 |
template<typename T> |
|
82 |
inline static void registerHelper(T * = 0) |
|
83 |
{ |
|
84 |
void (*mf)(QDBusArgument &, const T *) = qDBusMarshallHelper<T>; |
|
85 |
void (*df)(const QDBusArgument &, T *) = qDBusDemarshallHelper<T>; |
|
86 |
QDBusMetaType::registerMarshallOperators(qMetaTypeId<T>(), |
|
87 |
reinterpret_cast<QDBusMetaType::MarshallFunction>(mf), |
|
88 |
reinterpret_cast<QDBusMetaType::DemarshallFunction>(df)); |
|
89 |
} |
|
90 |
||
91 |
int QDBusMetaTypeId::message; |
|
92 |
int QDBusMetaTypeId::argument; |
|
93 |
int QDBusMetaTypeId::variant; |
|
94 |
int QDBusMetaTypeId::objectpath; |
|
95 |
int QDBusMetaTypeId::signature; |
|
96 |
int QDBusMetaTypeId::error; |
|
97 |
||
98 |
void QDBusMetaTypeId::init() |
|
99 |
{ |
|
100 |
static volatile bool initialized = false; |
|
101 |
||
102 |
// reentrancy is not a problem since everything else is locked on their own |
|
103 |
// set the guard variable at the end |
|
104 |
if (!initialized) { |
|
105 |
// register our types with QtCore |
|
106 |
message = qRegisterMetaType<QDBusMessage>("QDBusMessage"); |
|
107 |
argument = qRegisterMetaType<QDBusArgument>("QDBusArgument"); |
|
108 |
variant = qRegisterMetaType<QDBusVariant>("QDBusVariant"); |
|
109 |
objectpath = qRegisterMetaType<QDBusObjectPath>("QDBusObjectPath"); |
|
110 |
signature = qRegisterMetaType<QDBusSignature>("QDBusSignature"); |
|
111 |
error = qRegisterMetaType<QDBusError>("QDBusError"); |
|
112 |
||
113 |
#ifndef QDBUS_NO_SPECIALTYPES |
|
114 |
// and register QtCore's with us |
|
115 |
registerHelper<QDate>(); |
|
116 |
registerHelper<QTime>(); |
|
117 |
registerHelper<QDateTime>(); |
|
118 |
registerHelper<QRect>(); |
|
119 |
registerHelper<QRectF>(); |
|
120 |
registerHelper<QSize>(); |
|
121 |
registerHelper<QSizeF>(); |
|
122 |
registerHelper<QPoint>(); |
|
123 |
registerHelper<QPointF>(); |
|
124 |
registerHelper<QLine>(); |
|
125 |
registerHelper<QLineF>(); |
|
126 |
registerHelper<QVariantList>(); |
|
127 |
registerHelper<QVariantMap>(); |
|
128 |
||
129 |
qDBusRegisterMetaType<QList<bool> >(); |
|
130 |
qDBusRegisterMetaType<QList<short> >(); |
|
131 |
qDBusRegisterMetaType<QList<ushort> >(); |
|
132 |
qDBusRegisterMetaType<QList<int> >(); |
|
133 |
qDBusRegisterMetaType<QList<uint> >(); |
|
134 |
qDBusRegisterMetaType<QList<qlonglong> >(); |
|
135 |
qDBusRegisterMetaType<QList<qulonglong> >(); |
|
136 |
qDBusRegisterMetaType<QList<double> >(); |
|
137 |
qDBusRegisterMetaType<QList<QDBusObjectPath> >(); |
|
138 |
qDBusRegisterMetaType<QList<QDBusSignature> >(); |
|
139 |
#endif |
|
140 |
||
141 |
initialized = true; |
|
142 |
} |
|
143 |
} |
|
144 |
||
145 |
Q_GLOBAL_STATIC(QVector<QDBusCustomTypeInfo>, customTypes) |
|
146 |
Q_GLOBAL_STATIC(QReadWriteLock, customTypesLock) |
|
147 |
||
148 |
/*! |
|
149 |
\class QDBusMetaType |
|
150 |
\brief Meta-type registration system for the QtDBus module. |
|
151 |
\internal |
|
152 |
||
153 |
The QDBusMetaType class allows you to register class types for |
|
154 |
marshalling and demarshalling over D-Bus. D-Bus supports a very |
|
155 |
limited set of primitive types, but allows one to extend the type |
|
156 |
system by creating compound types, such as arrays (lists) and |
|
157 |
structs. In order to use them with QtDBus, those types must be |
|
158 |
registered. |
|
159 |
||
160 |
See \l {qdbustypesystem.html}{QtDBus type system} for more |
|
161 |
information on the type system and how to register additional |
|
162 |
types. |
|
163 |
||
164 |
\sa {qdbustypesystem.html}{QtDBus type system}, |
|
165 |
qDBusRegisterMetaType(), QMetaType, QVariant, QDBusArgument |
|
166 |
*/ |
|
167 |
||
168 |
/*! |
|
169 |
\fn int qDBusRegisterMetaType() |
|
170 |
\relates QDBusArgument |
|
171 |
\threadsafe |
|
172 |
\since 4.2 |
|
173 |
||
174 |
Registers \c{T} with the |
|
175 |
\l {qdbustypesystem.html}{QtDBus type system} and the Qt \l |
|
176 |
{QMetaType}{meta-type system}, if it's not already registered. |
|
177 |
||
178 |
To register a type, it must be declared as a meta-type with the |
|
179 |
Q_DECLARE_METATYPE() macro, and then registered as in the |
|
180 |
following example: |
|
181 |
||
182 |
\snippet doc/src/snippets/code/src_qdbus_qdbusmetatype.cpp 0 |
|
183 |
||
184 |
If \c{T} isn't a type derived from one of |
|
185 |
Qt's \l{container classes}, the \c{operator<<} and |
|
186 |
\c{operator>>} streaming operators between \c{T} and QDBusArgument |
|
187 |
must be already declared. See the \l {qdbustypesystem.html}{QtDBus |
|
188 |
type system} page for more information on how to declare such |
|
189 |
types. |
|
190 |
||
191 |
This function returns the Qt meta type id for the type (the same |
|
192 |
value that is returned from qRegisterMetaType()). |
|
193 |
||
194 |
\sa {qdbustypesystem.html}{QtDBus type system}, qRegisterMetaType(), QMetaType |
|
195 |
*/ |
|
196 |
||
197 |
/*! |
|
198 |
\typedef QDBusMetaType::MarshallFunction |
|
199 |
\internal |
|
200 |
*/ |
|
201 |
||
202 |
/*! |
|
203 |
\typedef QDBusMetaType::DemarshallFunction |
|
204 |
\internal |
|
205 |
*/ |
|
206 |
||
207 |
/*! |
|
208 |
\internal |
|
209 |
Registers the marshalling and demarshalling functions for meta |
|
210 |
type \a id. |
|
211 |
*/ |
|
212 |
void QDBusMetaType::registerMarshallOperators(int id, MarshallFunction mf, |
|
213 |
DemarshallFunction df) |
|
214 |
{ |
|
215 |
QByteArray var; |
|
216 |
QVector<QDBusCustomTypeInfo> *ct = customTypes(); |
|
217 |
if (id < 0 || !mf || !df || !ct) |
|
218 |
return; // error! |
|
219 |
||
220 |
QWriteLocker locker(customTypesLock()); |
|
221 |
if (id >= ct->size()) |
|
222 |
ct->resize(id + 1); |
|
223 |
QDBusCustomTypeInfo &info = (*ct)[id]; |
|
224 |
info.marshall = mf; |
|
225 |
info.demarshall = df; |
|
226 |
} |
|
227 |
||
228 |
/*! |
|
229 |
\internal |
|
230 |
Executes the marshalling of type \a id (whose data is contained in |
|
231 |
\a data) to the D-Bus marshalling argument \a arg. Returns true if |
|
232 |
the marshalling succeeded, or false if an error occurred. |
|
233 |
*/ |
|
234 |
bool QDBusMetaType::marshall(QDBusArgument &arg, int id, const void *data) |
|
235 |
{ |
|
236 |
QDBusMetaTypeId::init(); |
|
237 |
||
238 |
MarshallFunction mf; |
|
239 |
{ |
|
240 |
QReadLocker locker(customTypesLock()); |
|
241 |
QVector<QDBusCustomTypeInfo> *ct = customTypes(); |
|
242 |
if (id >= ct->size()) |
|
243 |
return false; // non-existant |
|
244 |
||
245 |
const QDBusCustomTypeInfo &info = (*ct).at(id); |
|
246 |
if (!info.marshall) { |
|
247 |
mf = 0; // make gcc happy |
|
248 |
return false; |
|
249 |
} else |
|
250 |
mf = info.marshall; |
|
251 |
} |
|
252 |
||
253 |
mf(arg, data); |
|
254 |
return true; |
|
255 |
} |
|
256 |
||
257 |
/*! |
|
258 |
\internal |
|
259 |
Executes the demarshalling of type \a id (whose data will be placed in |
|
260 |
\a data) from the D-Bus marshalling argument \a arg. Returns true if |
|
261 |
the demarshalling succeeded, or false if an error occurred. |
|
262 |
*/ |
|
263 |
bool QDBusMetaType::demarshall(const QDBusArgument &arg, int id, void *data) |
|
264 |
{ |
|
265 |
QDBusMetaTypeId::init(); |
|
266 |
||
267 |
DemarshallFunction df; |
|
268 |
{ |
|
269 |
QReadLocker locker(customTypesLock()); |
|
270 |
QVector<QDBusCustomTypeInfo> *ct = customTypes(); |
|
271 |
if (id >= ct->size()) |
|
272 |
return false; // non-existant |
|
273 |
||
274 |
const QDBusCustomTypeInfo &info = (*ct).at(id); |
|
275 |
if (!info.demarshall) { |
|
276 |
df = 0; // make gcc happy |
|
277 |
return false; |
|
278 |
} else |
|
279 |
df = info.demarshall; |
|
280 |
} |
|
281 |
||
282 |
QDBusArgument copy = arg; |
|
283 |
df(copy, data); |
|
284 |
return true; |
|
285 |
} |
|
286 |
||
287 |
/*! |
|
288 |
\fn QDBusMetaType::signatureToType(const char *signature) |
|
289 |
\internal |
|
290 |
||
291 |
Returns the Qt meta type id for the given D-Bus signature for exactly one full type, given |
|
292 |
by \a signature. |
|
293 |
||
294 |
Note: this function only handles the basic D-Bus types. |
|
295 |
||
296 |
\sa QDBusUtil::isValidSingleSignature(), typeToSignature(), |
|
297 |
QVariant::type(), QVariant::userType() |
|
298 |
*/ |
|
299 |
int QDBusMetaType::signatureToType(const char *signature) |
|
300 |
{ |
|
301 |
if (!signature) |
|
302 |
return QVariant::Invalid; |
|
303 |
||
304 |
QDBusMetaTypeId::init(); |
|
305 |
switch (signature[0]) |
|
306 |
{ |
|
307 |
case DBUS_TYPE_BOOLEAN: |
|
308 |
return QVariant::Bool; |
|
309 |
||
310 |
case DBUS_TYPE_BYTE: |
|
311 |
return QMetaType::UChar; |
|
312 |
||
313 |
case DBUS_TYPE_INT16: |
|
314 |
return QMetaType::Short; |
|
315 |
||
316 |
case DBUS_TYPE_UINT16: |
|
317 |
return QMetaType::UShort; |
|
318 |
||
319 |
case DBUS_TYPE_INT32: |
|
320 |
return QVariant::Int; |
|
321 |
||
322 |
case DBUS_TYPE_UINT32: |
|
323 |
return QVariant::UInt; |
|
324 |
||
325 |
case DBUS_TYPE_INT64: |
|
326 |
return QVariant::LongLong; |
|
327 |
||
328 |
case DBUS_TYPE_UINT64: |
|
329 |
return QVariant::ULongLong; |
|
330 |
||
331 |
case DBUS_TYPE_DOUBLE: |
|
332 |
return QVariant::Double; |
|
333 |
||
334 |
case DBUS_TYPE_STRING: |
|
335 |
return QVariant::String; |
|
336 |
||
337 |
case DBUS_TYPE_OBJECT_PATH: |
|
338 |
return QDBusMetaTypeId::objectpath; |
|
339 |
||
340 |
case DBUS_TYPE_SIGNATURE: |
|
341 |
return QDBusMetaTypeId::signature; |
|
342 |
||
343 |
case DBUS_TYPE_VARIANT: |
|
344 |
return QDBusMetaTypeId::variant; |
|
345 |
||
346 |
case DBUS_TYPE_ARRAY: // special case |
|
347 |
switch (signature[1]) { |
|
348 |
case DBUS_TYPE_BYTE: |
|
349 |
return QVariant::ByteArray; |
|
350 |
||
351 |
case DBUS_TYPE_STRING: |
|
352 |
return QVariant::StringList; |
|
353 |
||
354 |
case DBUS_TYPE_VARIANT: |
|
355 |
return QVariant::List; |
|
356 |
||
357 |
case DBUS_TYPE_OBJECT_PATH: |
|
358 |
return qMetaTypeId<QList<QDBusObjectPath> >(); |
|
359 |
||
360 |
case DBUS_TYPE_SIGNATURE: |
|
361 |
return qMetaTypeId<QList<QDBusSignature> >(); |
|
362 |
||
363 |
} |
|
364 |
// fall through |
|
365 |
default: |
|
366 |
return QVariant::Invalid; |
|
367 |
} |
|
368 |
} |
|
369 |
||
370 |
/*! |
|
371 |
\fn QDBusMetaType::typeToSignature(int type) |
|
372 |
\internal |
|
373 |
||
374 |
Returns the D-Bus signature equivalent to the supplied meta type id \a type. |
|
375 |
||
376 |
More types can be registered with the qDBusRegisterMetaType() function. |
|
377 |
||
378 |
\sa QDBusUtil::isValidSingleSignature(), signatureToType(), |
|
379 |
QVariant::type(), QVariant::userType() |
|
380 |
*/ |
|
381 |
const char *QDBusMetaType::typeToSignature(int type) |
|
382 |
{ |
|
383 |
// check if it's a static type |
|
384 |
switch (type) |
|
385 |
{ |
|
386 |
case QMetaType::UChar: |
|
387 |
return DBUS_TYPE_BYTE_AS_STRING; |
|
388 |
||
389 |
case QVariant::Bool: |
|
390 |
return DBUS_TYPE_BOOLEAN_AS_STRING; |
|
391 |
||
392 |
case QMetaType::Short: |
|
393 |
return DBUS_TYPE_INT16_AS_STRING; |
|
394 |
||
395 |
case QMetaType::UShort: |
|
396 |
return DBUS_TYPE_UINT16_AS_STRING; |
|
397 |
||
398 |
case QVariant::Int: |
|
399 |
return DBUS_TYPE_INT32_AS_STRING; |
|
400 |
||
401 |
case QVariant::UInt: |
|
402 |
return DBUS_TYPE_UINT32_AS_STRING; |
|
403 |
||
404 |
case QVariant::LongLong: |
|
405 |
return DBUS_TYPE_INT64_AS_STRING; |
|
406 |
||
407 |
case QVariant::ULongLong: |
|
408 |
return DBUS_TYPE_UINT64_AS_STRING; |
|
409 |
||
410 |
case QVariant::Double: |
|
411 |
return DBUS_TYPE_DOUBLE_AS_STRING; |
|
412 |
||
413 |
case QVariant::String: |
|
414 |
return DBUS_TYPE_STRING_AS_STRING; |
|
415 |
||
416 |
case QVariant::StringList: |
|
417 |
return DBUS_TYPE_ARRAY_AS_STRING |
|
418 |
DBUS_TYPE_STRING_AS_STRING; // as |
|
419 |
||
420 |
case QVariant::ByteArray: |
|
421 |
return DBUS_TYPE_ARRAY_AS_STRING |
|
422 |
DBUS_TYPE_BYTE_AS_STRING; // ay |
|
423 |
} |
|
424 |
||
425 |
QDBusMetaTypeId::init(); |
|
426 |
if (type == QDBusMetaTypeId::variant) |
|
427 |
return DBUS_TYPE_VARIANT_AS_STRING; |
|
428 |
else if (type == QDBusMetaTypeId::objectpath) |
|
429 |
return DBUS_TYPE_OBJECT_PATH_AS_STRING; |
|
430 |
else if (type == QDBusMetaTypeId::signature) |
|
431 |
return DBUS_TYPE_SIGNATURE_AS_STRING; |
|
432 |
||
433 |
// try the database |
|
434 |
QVector<QDBusCustomTypeInfo> *ct = customTypes(); |
|
435 |
{ |
|
436 |
QReadLocker locker(customTypesLock()); |
|
437 |
if (type >= ct->size()) |
|
438 |
return 0; // type not registered with us |
|
439 |
||
440 |
const QDBusCustomTypeInfo &info = (*ct).at(type); |
|
441 |
||
442 |
if (!info.signature.isNull()) |
|
443 |
return info.signature; |
|
444 |
||
445 |
if (!info.marshall) |
|
446 |
return 0; // type not registered with us |
|
447 |
} |
|
448 |
||
449 |
// call to user code to construct the signature type |
|
450 |
QDBusCustomTypeInfo *info; |
|
451 |
{ |
|
452 |
// createSignature will never return a null QByteArray |
|
453 |
// if there was an error, it'll return "" |
|
454 |
QByteArray signature = QDBusArgumentPrivate::createSignature(type); |
|
455 |
||
456 |
// re-acquire lock |
|
457 |
QWriteLocker locker(customTypesLock()); |
|
458 |
info = &(*ct)[type]; |
|
459 |
info->signature = signature; |
|
460 |
} |
|
461 |
return info->signature; |
|
462 |
} |
|
463 |
||
464 |
QT_END_NAMESPACE |