src/imports/testlib/SignalSpy.qml

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   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.
  16 **
  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.
  20 **
  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.
  28 **
  29 ** Other Usage
  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.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 import QtQuick 2.0
  43 import QtTest 1.0
  44
  45 Item {
  46     id: spy
  47     visible: false
  48
  49     TestUtil {
  50         id: util
  51     }
  52
  53     // Public API.
  54
  55     property variant target: null
  56     property string signalName: ""
  57     property int count: 0
  58
  59     function clear() {
  60         count = 0
  61         qtest_expectedCount = 0
  62     }
  63
  64     function wait(timeout) {
  65         if (timeout === undefined)
  66             timeout = 5000
  67         var expected = ++qtest_expectedCount
  68         var i = 0
  69         while (i < timeout && count < expected) {
  70             qtest_results.wait(50)
  71             i += 50
  72         }
  73         var success = (count >= expected)
  74         if (!qtest_results.verify(success, "wait for signal " + signalName, util.callerFile(), util.callerLine()))
  75             throw new Error("QtQuickTest::fail")
  76     }
  77
  78     // Internal implementation detail follows.
  79
  80     TestResult { id: qtest_results }
  81
  82     onTargetChanged: {
  83         qtest_update()
  84     }
  85     onSignalNameChanged: {
  86         qtest_update()
  87     }
  88
  89     property variant qtest_prevTarget: null
  90     property string qtest_prevSignalName: ""
  91     property int qtest_expectedCount: 0
  92
  93     function qtest_update() {
  94         if (qtest_prevTarget != null) {
  95             qtest_prevTarget[qtest_prevSignalName].disconnect(spy, "qtest_activated")
  96             qtest_prevTarget = null
  97             qtest_prevSignalName = ""
  98         }
  99         if (target != null && signalName != "") {
 100             var func = target[signalName]
 101             if (func === undefined) {
 102                 console.log("Signal '" + signalName + "' not found")
 103             } else {
 104                 qtest_prevTarget = target
 105                 qtest_prevSignalName = signalName
 106                 func.connect(spy.qtest_activated)
 107             }
 108         }
 109     }
 110
 111     function qtest_activated() {
 112         ++count
 113     }
 114 }