src/dbus/qdbusreply.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtDBus module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDBUSREPLY_H
  43 #define QDBUSREPLY_H
  44
  45 #include <QtCore/qglobal.h>
  46 #include <QtCore/qvariant.h>
  47
  48 #include <QtDBus/qdbusmacros.h>
  49 #include <QtDBus/qdbusmessage.h>
  50 #include <QtDBus/qdbuserror.h>
  51 #include <QtDBus/qdbusextratypes.h>
  52 #include <QtDBus/qdbuspendingreply.h>
  53
  54 #ifndef QT_NO_DBUS
  55
  56 QT_BEGIN_HEADER
  57
  58 QT_BEGIN_NAMESPACE
  59
  60
  61 Q_DBUS_EXPORT void qDBusReplyFill(const QDBusMessage &reply, QDBusError &error, QVariant &data);
  62
  63 template<typename T>
  64 class QDBusReply
  65 {
  66     typedef T Type;
  67 public:
  68     inline QDBusReply(const QDBusMessage &reply)
  69     {
  70         *this = reply;
  71     }
  72     inline QDBusReply& operator=(const QDBusMessage &reply)
  73     {
  74         QVariant data(qMetaTypeId(&m_data), reinterpret_cast<void*>(0));
  75         qDBusReplyFill(reply, m_error, data);
  76         m_data = qvariant_cast<Type>(data);
  77         return *this;
  78     }
  79
  80     inline QDBusReply(const QDBusPendingCall &pcall)
  81     {
  82         *this = pcall;
  83     }
  84     inline QDBusReply &operator=(const QDBusPendingCall &pcall)
  85     {
  86         QDBusPendingCall other(pcall);
  87         other.waitForFinished();
  88         return *this = other.reply();
  89     }
  90     inline QDBusReply(const QDBusPendingReply<T> &reply)
  91     {
  92         *this = static_cast<QDBusPendingCall>(reply);
  93     }
  94
  95     inline QDBusReply(const QDBusError &dbusError = QDBusError())
  96         : m_error(dbusError), m_data(Type())
  97     {
  98     }
  99     inline QDBusReply& operator=(const QDBusError& dbusError)
 100     {
 101         m_error = dbusError;
 102         m_data = Type();
 103         return *this;
 104     }
 105
 106     inline QDBusReply& operator=(const QDBusReply& other)
 107     {
 108         m_error = other.m_error;
 109         m_data = other.m_data;
 110         return *this;
 111     }
 112
 113     inline bool isValid() const { return !m_error.isValid(); }
 114
 115     inline const QDBusError& error() { return m_error; }
 116
 117     inline Type value() const
 118     {
 119         return m_data;
 120     }
 121
 122     inline operator Type () const
 123     {
 124         return m_data;
 125     }
 126
 127 private:
 128     QDBusError m_error;
 129     Type m_data;
 130 };
 131
 132 # ifndef Q_QDOC
 133 // specialize for QVariant:
 134 template<> inline QDBusReply<QVariant>&
 135 QDBusReply<QVariant>::operator=(const QDBusMessage &reply)
 136 {
 137     void *null = 0;
 138     QVariant data(qMetaTypeId<QDBusVariant>(), null);
 139     qDBusReplyFill(reply, m_error, data);
 140     m_data = qvariant_cast<QDBusVariant>(data).variant();
 141     return *this;
 142 }
 143
 144 // specialize for void:
 145 template<>
 146 class QDBusReply<void>
 147 {
 148 public:
 149     inline QDBusReply(const QDBusMessage &reply)
 150         : m_error(reply)
 151     {
 152     }
 153     inline QDBusReply& operator=(const QDBusMessage &reply)
 154     {
 155         m_error = QDBusError(reply);
 156         return *this;
 157     }
 158     inline QDBusReply(const QDBusError &dbusError = QDBusError())
 159         : m_error(dbusError)
 160     {
 161     }
 162     inline QDBusReply(const QDBusPendingCall &pcall)
 163     {
 164         *this = pcall;
 165     }
 166     inline QDBusReply &operator=(const QDBusPendingCall &pcall)
 167     {
 168         QDBusPendingCall other(pcall);
 169         other.waitForFinished();
 170         return *this = other.reply();
 171     }
 172     inline QDBusReply& operator=(const QDBusError& dbusError)
 173     {
 174         m_error = dbusError;
 175         return *this;
 176     }
 177
 178     inline QDBusReply& operator=(const QDBusReply& other)
 179     {
 180         m_error = other.m_error;
 181         return *this;
 182     }
 183
 184     inline bool isValid() const { return !m_error.isValid(); }
 185
 186     inline const QDBusError& error() { return m_error; }
 187
 188 private:
 189     QDBusError m_error;
 190 };
 191 # endif
 192
 193 QT_END_NAMESPACE
 194
 195 QT_END_HEADER
 196
 197 #endif // QT_NO_DBUS
 198 #endif