src/testlib/qsignalspy.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 QtTest 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 QSIGNALSPY_H
  43 #define QSIGNALSPY_H
  44
  45 #include <QtCore/qbytearray.h>
  46 #include <QtCore/qlist.h>
  47 #include <QtCore/qobject.h>
  48 #include <QtCore/qmetaobject.h>
  49 #include <QtCore/qvariant.h>
  50 #include <QtCore/qvector.h>
  51 #include <QtTest/qtesteventloop.h>
  52
  53 QT_BEGIN_HEADER
  54
  55 QT_BEGIN_NAMESPACE
  56
  57
  58 class QVariant;
  59
  60 class QSignalSpy: public QObject, public QList<QList<QVariant> >
  61 {
  62 public:
  63     explicit QSignalSpy(const QObject *obj, const char *aSignal)
  64         : m_waiting(false)
  65     {
  66 #ifdef Q_CC_BOR
  67         const int memberOffset = QObject::staticMetaObject.methodCount();
  68 #else
  69         static const int memberOffset = QObject::staticMetaObject.methodCount();
  70 #endif
  71         if (!obj) {
  72             qWarning("QSignalSpy: Cannot spy on a null object");
  73             return;
  74         }
  75
  76         if (!aSignal) {
  77             qWarning("QSignalSpy: Null signal name is not valid");
  78             return;
  79         }
  80
  81         if (((aSignal[0] - '0') & 0x03) != QSIGNAL_CODE) {
  82             qWarning("QSignalSpy: Not a valid signal, use the SIGNAL macro");
  83             return;
  84         }
  85
  86         const QByteArray ba = QMetaObject::normalizedSignature(aSignal + 1);
  87         const QMetaObject * const mo = obj->metaObject();
  88         const int sigIndex = mo->indexOfMethod(ba.constData());
  89         if (sigIndex < 0) {
  90             qWarning("QSignalSpy: No such signal: '%s'", ba.constData());
  91             return;
  92         }
  93
  94         if (!QMetaObject::connect(obj, sigIndex, this, memberOffset,
  95                     Qt::DirectConnection, 0)) {
  96             qWarning("QSignalSpy: QMetaObject::connect returned false. Unable to connect.");
  97             return;
  98         }
  99         sig = ba;
 100         initArgs(mo->method(sigIndex));
 101     }
 102
 103     inline bool isValid() const { return !sig.isEmpty(); }
 104     inline QByteArray signal() const { return sig; }
 105
 106     bool wait(int timeout = 5000)
 107     {
 108         Q_ASSERT(!m_waiting);
 109         const int origCount = count();
 110         m_waiting = true;
 111         m_loop.enterLoopMSecs(timeout);
 112         m_waiting = false;
 113         return count() > origCount;
 114     }
 115
 116     int qt_metacall(QMetaObject::Call call, int methodId, void **a) Q_DECL_OVERRIDE
 117     {
 118         methodId = QObject::qt_metacall(call, methodId, a);
 119         if (methodId < 0)
 120             return methodId;
 121
 122         if (call == QMetaObject::InvokeMetaMethod) {
 123             if (methodId == 0) {
 124                 appendArgs(a);
 125             }
 126             --methodId;
 127         }
 128         return methodId;
 129     }
 130
 131 private:
 132     void initArgs(const QMetaMethod &member)
 133     {
 134         const QList<QByteArray> params = member.parameterTypes();
 135         args.reserve(params.size());
 136         for (int i = 0; i < params.count(); ++i) {
 137             const int tp = QMetaType::type(params.at(i).constData());
 138             if (tp == QMetaType::UnknownType) {
 139                 Q_ASSERT(tp != QMetaType::Void); // void parameter => metaobject is corrupt
 140                 qWarning("Don't know how to handle '%s', use qRegisterMetaType to register it.",
 141                          params.at(i).constData());
 142             }
 143             args << tp;
 144         }
 145     }
 146
 147     void appendArgs(void **a)
 148     {
 149         QList<QVariant> list;
 150         list.reserve(args.count());
 151         for (int i = 0; i < args.count(); ++i) {
 152             const QMetaType::Type type = static_cast<QMetaType::Type>(args.at(i));
 153             if (type == QMetaType::QVariant)
 154                 list << *reinterpret_cast<QVariant *>(a[i + 1]);
 155             else
 156                 list << QVariant(type, a[i + 1]);
 157         }
 158         append(list);
 159
 160         if (m_waiting)
 161             m_loop.exitLoop();
 162     }
 163
 164     // the full, normalized signal name
 165     QByteArray sig;
 166     // holds the QMetaType types for the argument list of the signal
 167     QVector<int> args;
 168
 169     QTestEventLoop m_loop;
 170     bool m_waiting;
 171 };
 172
 173 QT_END_NAMESPACE
 174
 175 QT_END_HEADER
 176
 177 #endif