src/imports/testlib/SignalSpy.qml

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the test suite of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 import QtQuick 2.0
  43
  44 Item {
  45     id: spy
  46     visible: false
  47
  48     // Public API.
  49
  50     property variant target: null
  51     property string signalName: ""
  52     property int count: 0
  53
  54     function clear() {
  55         count = 0
  56         qtest_expectedCount = 0
  57     }
  58
  59     function wait(timeout) {
  60         if (timeout === undefined)
  61             timeout = 5000
  62         var expected = ++qtest_expectedCount
  63         var i = 0
  64         while (i < timeout && count < expected) {
  65             qtest_results.wait(50)
  66             i += 50
  67         }
  68         var success = (count >= expected)
  69         if (!qtest_results.verify(success, "wait for signal " + signalName, Qt.qtest_caller_file(), Qt.qtest_caller_line()))
  70             throw new Error("QtQuickTest::fail")
  71     }
  72
  73     // Internal implementation detail follows.
  74
  75     TestResult { id: qtest_results }
  76
  77     onTargetChanged: {
  78         qtest_update()
  79     }
  80     onSignalNameChanged: {
  81         qtest_update()
  82     }
  83
  84     property variant qtest_prevTarget: null
  85     property string qtest_prevSignalName: ""
  86     property int qtest_expectedCount: 0
  87
  88     function qtest_update() {
  89         if (qtest_prevTarget != null) {
  90             qtest_prevTarget[qtest_prevSignalName].disconnect(spy, "qtest_activated")
  91             qtest_prevTarget = null
  92             qtest_prevSignalName = ""
  93         }
  94         if (target != null && signalName != "") {
  95             var func = target[signalName]
  96             if (func === undefined) {
  97                 console.log("Signal '" + signalName + "' not found")
  98             } else {
  99                 qtest_prevTarget = target
 100                 qtest_prevSignalName = signalName
 101                 func.connect(spy.qtest_activated)
 102             }
 103         }
 104     }
 105
 106     function qtest_activated() {
 107         ++count
 108     }
 109 }