Avoids timer ticks when there are only pause animations running

When there are only pause animations running, the timer will stop and
restart when the closest pause animation finishes. While there are only
pause animations running, there are no additional timer ticks, but
if there is at least one animation running that is not a group or a pause,
then the global animation timer will restore it's update interval.

Includes a new auto-test for the QPauseAnimation class.

Task-number: QT-941
Reviewed-by: thierry
Reviewed-by: janarve

2 files changed, 397 insertions, 0 deletions

diff --git a/tests/auto/qpauseanimation/qpauseanimation.pro b/tests/auto/qpauseanimation/qpauseanimation.pro
new file mode 100644
index 0000000..4599cf0
--- /dev/null
+++ b/tests/auto/qpauseanimation/qpauseanimation.pro
@@ -0,0 +1,5 @@
+load(qttest_p4)
+QT = core gui
+SOURCES  += tst_qpauseanimation.cpp
+
+
diff --git a/tests/auto/qpauseanimation/tst_qpauseanimation.cpp b/tests/auto/qpauseanimation/tst_qpauseanimation.cpp
new file mode 100644
index 0000000..0c742af
--- /dev/null
+++ b/tests/auto/qpauseanimation/tst_qpauseanimation.cpp
@@ -0,0 +1,392 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QtTest>
+
+#include <QtCore/qpauseanimation.h>
+#include <QtCore/qpropertyanimation.h>
+#include <QtCore/qsequentialanimationgroup.h>
+
+#include <private/qabstractanimation_p.h>
+
+//TESTED_CLASS=QPauseAnimation
+//TESTED_FILES=
+
+class TestablePauseAnimation : public QPauseAnimation
+{
+    Q_OBJECT
+public:
+    TestablePauseAnimation(QObject *parent = 0)
+        : QPauseAnimation(parent),
+        m_updateCurrentTimeCount(0)
+    {
+    }
+
+    int m_updateCurrentTimeCount;
+protected:
+    void updateCurrentTime(int currentTime)
+    {
+        //qDebug() << this << "update current time: " << currentTime;
+        QPauseAnimation::updateCurrentTime(currentTime);
+        ++m_updateCurrentTimeCount;
+    }
+};
+
+class tst_QPauseAnimation : public QObject
+{
+  Q_OBJECT
+public:
+    tst_QPauseAnimation();
+    virtual ~tst_QPauseAnimation();
+
+public Q_SLOTS:
+    void init();
+    void cleanup();
+
+private slots:
+    void changeDirectionWhileRunning();
+    void noTimerUpdates_data();
+    void noTimerUpdates();
+    void mulitplePauseAnimations();
+    void pauseAndPropertyAnimations();
+    void pauseResume();
+    void sequentialPauseGroup();
+    void sequentialGroupWithPause();
+    void multipleSequentialGroups();
+    void zeroDuration();
+};
+
+tst_QPauseAnimation::tst_QPauseAnimation()
+{
+}
+
+tst_QPauseAnimation::~tst_QPauseAnimation()
+{
+}
+
+void tst_QPauseAnimation::init()
+{
+    qRegisterMetaType<QAbstractAnimation::State>("QAbstractAnimation::State");
+    qRegisterMetaType<QAbstractAnimation::DeletionPolicy>("QAbstractAnimation::DeletionPolicy");
+}
+
+void tst_QPauseAnimation::cleanup()
+{
+}
+
+void tst_QPauseAnimation::changeDirectionWhileRunning()
+{
+    QUnifiedTimer *timer = QUnifiedTimer::instance();
+    timer->setConsistentTiming(true);
+
+    TestablePauseAnimation animation;
+    animation.setDuration(400);
+    animation.start();
+    QTest::qWait(100);
+    QVERIFY(animation.state() == QAbstractAnimation::Running);
+    animation.setDirection(QAbstractAnimation::Backward);
+    QTest::qWait(animation.totalDuration() + 50);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+
+    timer->setConsistentTiming(false);
+}
+
+void tst_QPauseAnimation::noTimerUpdates_data()
+{
+    QTest::addColumn<int>("duration");
+    QTest::addColumn<int>("loopCount");
+
+    QTest::newRow("0") << 200 << 1;
+    QTest::newRow("1") << 160 << 1;
+    QTest::newRow("2") << 160 << 2;
+    QTest::newRow("3") << 200 << 3;
+}
+
+void tst_QPauseAnimation::noTimerUpdates()
+{
+    QUnifiedTimer *timer = QUnifiedTimer::instance();
+    timer->setConsistentTiming(true);
+
+    QFETCH(int, duration);
+    QFETCH(int, loopCount);
+
+    TestablePauseAnimation animation;
+    animation.setDuration(duration);
+    animation.setLoopCount(loopCount);
+    animation.start();
+    QTest::qWait(animation.totalDuration() + 100);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(animation.m_updateCurrentTimeCount, 2);
+
+    timer->setConsistentTiming(false);
+}
+
+void tst_QPauseAnimation::mulitplePauseAnimations()
+{
+    QUnifiedTimer *timer = QUnifiedTimer::instance();
+    timer->setConsistentTiming(true);
+
+    TestablePauseAnimation animation;
+    animation.setDuration(200);
+
+    TestablePauseAnimation animation2;
+    animation2.setDuration(800);
+
+    animation.start();
+    animation2.start();
+    QTest::qWait(animation.totalDuration() + 100);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation2.state() == QAbstractAnimation::Running);
+    QCOMPARE(animation.m_updateCurrentTimeCount, 2);
+    QCOMPARE(animation2.m_updateCurrentTimeCount, 2);
+
+    QTest::qWait(550);
+    QVERIFY(animation2.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(animation2.m_updateCurrentTimeCount, 3);
+
+    timer->setConsistentTiming(false);
+}
+
+void tst_QPauseAnimation::pauseAndPropertyAnimations()
+{
+    QUnifiedTimer *timer = QUnifiedTimer::instance();
+    timer->setConsistentTiming(true);
+
+    TestablePauseAnimation pause;
+    pause.setDuration(200);
+
+    QObject o;
+    o.setProperty("ole", 42);
+
+    QPropertyAnimation animation(&o, "ole");
+    animation.setEndValue(43);
+
+    pause.start();
+
+    QTest::qWait(100);
+    animation.start();
+
+    QVERIFY(animation.state() == QAbstractAnimation::Running);
+    QVERIFY(pause.state() == QAbstractAnimation::Running);
+    QCOMPARE(pause.m_updateCurrentTimeCount, 2);
+
+    QTest::qWait(animation.totalDuration() + 100);
+
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QVERIFY(pause.state() == QAbstractAnimation::Stopped);
+    QVERIFY(pause.m_updateCurrentTimeCount > 3);
+
+    timer->setConsistentTiming(false);
+}
+
+void tst_QPauseAnimation::pauseResume()
+{
+    TestablePauseAnimation animation;
+    animation.setDuration(400);
+    animation.start();
+    QVERIFY(animation.state() == QAbstractAnimation::Running);
+    QTest::qWait(200);
+    animation.pause();
+    QVERIFY(animation.state() == QAbstractAnimation::Paused);
+    animation.start();
+    QTest::qWait(250);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(animation.m_updateCurrentTimeCount, 3);
+}
+
+void tst_QPauseAnimation::sequentialPauseGroup()
+{
+    QSequentialAnimationGroup group;
+
+    TestablePauseAnimation animation1(&group);
+    animation1.setDuration(200);
+    TestablePauseAnimation animation2(&group);
+    animation2.setDuration(200);
+    TestablePauseAnimation animation3(&group);
+    animation3.setDuration(200);
+
+    group.start();
+
+    QVERIFY(group.state() == QAbstractAnimation::Running);
+    QVERIFY(animation1.state() == QAbstractAnimation::Running);
+    QVERIFY(animation2.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation3.state() == QAbstractAnimation::Stopped);
+
+    QTest::qWait(250);
+
+    QVERIFY(group.state() == QAbstractAnimation::Running);
+    QVERIFY(animation1.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(&animation2, group.currentAnimation());
+    QVERIFY(animation2.state() == QAbstractAnimation::Running);
+    QVERIFY(animation3.state() == QAbstractAnimation::Stopped);
+
+    QTest::qWait(250);
+
+    QVERIFY(group.state() == QAbstractAnimation::Running);
+    QVERIFY(animation1.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation2.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(&animation3, group.currentAnimation());
+    QVERIFY(animation3.state() == QAbstractAnimation::Running);
+
+    QTest::qWait(250);
+
+    QVERIFY(group.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation1.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation2.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation3.state() == QAbstractAnimation::Stopped);
+
+    QCOMPARE(animation1.m_updateCurrentTimeCount, 2);
+    QCOMPARE(animation2.m_updateCurrentTimeCount, 2);
+    QCOMPARE(animation3.m_updateCurrentTimeCount, 2);
+}
+
+void tst_QPauseAnimation::sequentialGroupWithPause()
+{
+    QSequentialAnimationGroup group;
+
+    QObject o;
+    o.setProperty("ole", 42);
+
+    QPropertyAnimation animation(&o, "ole", &group);
+    animation.setEndValue(43);
+    TestablePauseAnimation pause(&group);
+    pause.setDuration(250);
+
+    group.start();
+
+    QVERIFY(group.state() == QAbstractAnimation::Running);
+    QVERIFY(animation.state() == QAbstractAnimation::Running);
+    QVERIFY(pause.state() == QAbstractAnimation::Stopped);
+
+    QTest::qWait(300);
+
+    QVERIFY(group.state() == QAbstractAnimation::Running);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(&pause, group.currentAnimation());
+    QVERIFY(pause.state() == QAbstractAnimation::Running);
+
+    QTest::qWait(300);
+
+    QVERIFY(group.state() == QAbstractAnimation::Stopped);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QVERIFY(pause.state() == QAbstractAnimation::Stopped);
+
+    QCOMPARE(pause.m_updateCurrentTimeCount, 2);
+}
+
+void tst_QPauseAnimation::multipleSequentialGroups()
+{
+    QUnifiedTimer *timer = QUnifiedTimer::instance();
+    timer->setConsistentTiming(true);
+
+    QParallelAnimationGroup group;
+    group.setLoopCount(2);
+
+    QSequentialAnimationGroup subgroup1(&group);
+
+    QObject o;
+    o.setProperty("ole", 42);
+
+    QPropertyAnimation animation(&o, "ole", &subgroup1);
+    animation.setEndValue(43);
+    animation.setDuration(300);
+    TestablePauseAnimation pause(&subgroup1);
+    pause.setDuration(200);
+
+    QSequentialAnimationGroup subgroup2(&group);
+
+    o.setProperty("ole2", 42);
+    QPropertyAnimation animation2(&o, "ole2", &subgroup2);
+    animation2.setEndValue(43);
+    animation2.setDuration(200);
+    TestablePauseAnimation pause2(&subgroup2);
+    pause2.setDuration(250);
+
+    QSequentialAnimationGroup subgroup3(&group);
+
+    TestablePauseAnimation pause3(&subgroup3);
+    pause3.setDuration(400);
+
+    o.setProperty("ole3", 42);
+    QPropertyAnimation animation3(&o, "ole3", &subgroup3);
+    animation3.setEndValue(43);
+    animation3.setDuration(200);
+
+    QSequentialAnimationGroup subgroup4(&group);
+
+    TestablePauseAnimation pause4(&subgroup4);
+    pause4.setDuration(310);
+
+    TestablePauseAnimation pause5(&subgroup4);
+    pause5.setDuration(60);
+
+    group.start();
+
+    QVERIFY(group.state() == QAbstractAnimation::Running);
+    QVERIFY(subgroup1.state() == QAbstractAnimation::Running);
+    QVERIFY(subgroup2.state() == QAbstractAnimation::Running);
+    QVERIFY(subgroup3.state() == QAbstractAnimation::Running);
+    QVERIFY(subgroup4.state() == QAbstractAnimation::Running);
+
+    QTest::qWait(group.totalDuration() + 100);
+
+    QVERIFY(group.state() == QAbstractAnimation::Stopped);
+    QVERIFY(subgroup1.state() == QAbstractAnimation::Stopped);
+    QVERIFY(subgroup2.state() == QAbstractAnimation::Stopped);
+    QVERIFY(subgroup3.state() == QAbstractAnimation::Stopped);
+    QVERIFY(subgroup4.state() == QAbstractAnimation::Stopped);
+
+    QCOMPARE(pause5.m_updateCurrentTimeCount, 4);
+
+    timer->setConsistentTiming(false);
+}
+
+void tst_QPauseAnimation::zeroDuration()
+{
+    TestablePauseAnimation animation;
+    animation.start();
+    QTest::qWait(animation.totalDuration() + 100);
+    QVERIFY(animation.state() == QAbstractAnimation::Stopped);
+    QCOMPARE(animation.m_updateCurrentTimeCount, 1);
+}
+
+QTEST_MAIN(tst_QPauseAnimation)
+#include "tst_qpauseanimation.moc"