2009-12-07 Benjamin Poulain <benjamin.poulain@nokia.com>
[WebKit-https.git] / WebKit / qt / tests / util.h
1 /*
2     Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
3
4     This library is free software; you can redistribute it and/or
5     modify it under the terms of the GNU Library General Public
6     License as published by the Free Software Foundation; either
7     version 2 of the License, or (at your option) any later version.
8
9     This library is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12     Library General Public License for more details.
13
14     You should have received a copy of the GNU Library General Public License
15     along with this library; see the file COPYING.LIB.  If not, write to
16     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17     Boston, MA 02110-1301, USA.
18 */
19 // Functions and macros that really need to be in QTestLib
20
21 #include <QEventLoop>
22 #include <QSignalSpy>
23 #include <QTimer>
24
25 /**
26  * Starts an event loop that runs until the given signal is received.
27  * Optionally the event loop
28  * can return earlier on a timeout.
29  *
30  * \return \p true if the requested signal was received
31  *         \p false on timeout
32  */
33 static bool waitForSignal(QObject* obj, const char* signal, int timeout = 10000)
34 {
35     QEventLoop loop;
36     QObject::connect(obj, signal, &loop, SLOT(quit()));
37     QTimer timer;
38     QSignalSpy timeoutSpy(&timer, SIGNAL(timeout()));
39     if (timeout > 0) {
40         QObject::connect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));
41         timer.setSingleShot(true);
42         timer.start(timeout);
43     }
44     loop.exec();
45     return timeoutSpy.isEmpty();
46 }
47
48 // Will try to wait for the condition while allowing event processing
49 #define QTRY_VERIFY(__expr) \
50     do { \
51         const int __step = 50; \
52         const int __timeout = 5000; \
53         if (!(__expr)) { \
54             QTest::qWait(0); \
55         } \
56         for (int __i = 0; __i < __timeout && !(__expr); __i+=__step) { \
57             QTest::qWait(__step); \
58         } \
59         QVERIFY(__expr); \
60     } while(0)
61
62 // Will try to wait for the condition while allowing event processing
63 #define QTRY_COMPARE(__expr, __expected) \
64     do { \
65         const int __step = 50; \
66         const int __timeout = 5000; \
67         if ((__expr) != (__expected)) { \
68             QTest::qWait(0); \
69         } \
70         for (int __i = 0; __i < __timeout && ((__expr) != (__expected)); __i+=__step) { \
71             QTest::qWait(__step); \
72         } \
73         QCOMPARE(__expr, __expected); \
74     } while(0)