Deprecate QDeclarativeDebugHelper class
authorKai Koehne <kai.koehne@nokia.com>
Wed, 24 Aug 2011 13:14:59 +0000 (15:14 +0200)
committerQt by Nokia <qt-info@nokia.com>
Fri, 26 Aug 2011 10:13:45 +0000 (12:13 +0200)
This was a helper class for enable debugging in 4.7. Since Qt 4.8 you
should just say CONFIG += declarative_debug

Change-Id: I51dabaec36e175a097721570061aad38c3f828d1
Reviewed-on: http://codereview.qt.nokia.com/3507
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Aurindam Jana <aurindam.jana@nokia.com>
16 files changed:
src/declarative/debugger/qdeclarativedebughelper.cpp
src/declarative/debugger/qdeclarativedebughelper_p.h
src/plugins/qmltooling/qmldbg_inspector/abstractviewinspector.cpp
src/plugins/qmltooling/qmldbg_inspector/sgviewinspector.cpp
src/qmltest/qmltest.pro
src/qmltest/quicktest.cpp
tests/auto/declarative/declarative.pro
tests/auto/declarative/qdeclarativedebug/qdeclarativedebug.pro
tests/auto/declarative/qdeclarativedebug/tst_qdeclarativedebug.cpp
tests/auto/declarative/qdeclarativedebugclient/qdeclarativedebugclient.pro
tests/auto/declarative/qdeclarativedebugclient/tst_qdeclarativedebugclient.cpp
tests/auto/declarative/qdeclarativedebughelper/private_headers/qdeclarativedebughelper_p.h [deleted file]
tests/auto/declarative/qdeclarativedebughelper/qdeclarativedebughelper.pro [deleted file]
tests/auto/declarative/qdeclarativedebughelper/tst_qdeclarativedebughelper.cpp [deleted file]
tests/auto/declarative/qdeclarativedebugservice/qdeclarativedebugservice.pro
tests/auto/declarative/qdeclarativedebugservice/tst_qdeclarativedebugservice.cpp

index 5f5d875..cbe4a85 100644 (file)
@@ -58,6 +58,7 @@ void QDeclarativeDebugHelper::setAnimationSlowDownFactor(qreal factor)
 }
 
 void QDeclarativeDebugHelper::enableDebugging() {
+    qWarning("QDeclarativeDebugHelper::enableDebugging() is deprecated! Add CONFIG += declarative_debug to your .pro file instead.");
 #ifndef QDECLARATIVE_NO_DEBUG_PROTOCOL
     if (!QDeclarativeEnginePrivate::qml_debugging_enabled) {
         qWarning("Qml debugging is enabled. Only use this in a safe environment!");
index 6018711..d9ed579 100644 (file)
@@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE
 
 class QDeclarativeEngine;
 
+#ifndef QT_BUILD_DECLARATIVE_LIB
+#warning Use of this header file is deprecated! Add CONFIG += declarative_debug to your .pro file instead.
+#endif
+
 // Helper methods to access private API through a stable interface
 // This is used in the qmljsdebugger library of QtCreator.
 class Q_DECLARATIVE_EXPORT QDeclarativeDebugHelper
index 3323d54..03cd794 100644 (file)
@@ -47,7 +47,7 @@
 
 #include <QtDeclarative/QDeclarativeEngine>
 #include <QtDeclarative/QDeclarativeComponent>
-#include <QtDeclarative/private/qdeclarativedebughelper_p.h>
+#include <QtCore/private/qabstractanimation_p.h>
 #include "QtDeclarative/private/qdeclarativeinspectorservice_p.h"
 
 #include <QtGui/QVBoxLayout>
@@ -180,7 +180,8 @@ void AbstractViewInspector::animationSpeedChangeRequested(qreal factor)
     }
 
     const float effectiveFactor = m_animationPaused ? 0 : factor;
-    QDeclarativeDebugHelper::setAnimationSlowDownFactor(effectiveFactor);
+    QUnifiedTimer::instance()->setSlowModeEnabled(effectiveFactor != 1.0);
+    QUnifiedTimer::instance()->setSlowdownFactor(effectiveFactor);
 }
 
 void AbstractViewInspector::animationPausedChangeRequested(bool paused)
@@ -191,7 +192,8 @@ void AbstractViewInspector::animationPausedChangeRequested(bool paused)
     }
 
     const float effectiveFactor = paused ? 0 : m_slowDownFactor;
-    QDeclarativeDebugHelper::setAnimationSlowDownFactor(effectiveFactor);
+    QUnifiedTimer::instance()->setSlowModeEnabled(effectiveFactor != 1.0);
+    QUnifiedTimer::instance()->setSlowdownFactor(effectiveFactor);
 }
 
 void AbstractViewInspector::setShowAppOnTop(bool appOnTop)
index bb9ad52..497e51d 100644 (file)
@@ -46,7 +46,6 @@
 #include "sgselectiontool.h"
 
 #include <QtDeclarative/private/qdeclarativeinspectorservice_p.h>
-#include <QtDeclarative/private/qdeclarativedebughelper_p.h>
 #include <QtDeclarative/private/qsgitem_p.h>
 
 #include <QtDeclarative/QSGView>
index 418136a..b19ad55 100644 (file)
@@ -4,7 +4,7 @@ TARGET     = QtQuickTest
 QPRO_PWD   = $$PWD
 
 CONFIG += module
-CONFIG += dll warn_on
+CONFIG += dll warn_on declarative_debug
 MODULE_PRI += ../../modules/qt_qmltest.pri
 
 QT += testlib-private declarative testlib qtquick1
index 3164d9e..7c20708 100644 (file)
 
 QT_BEGIN_NAMESPACE
 
-// Copied from qdeclarativedebughelper_p.h in Qt, to avoid a dependency
-// on a private header from Qt.
-class Q_DECLARATIVE_EXPORT QDeclarativeDebugHelper
-{
-public:
-    static QJSEngine *getScriptEngine(QDeclarativeEngine *engine);
-    static void setAnimationSlowDownFactor(qreal factor);
-    static void enableDebugging();
-};
 
 class QTestRootObject : public QObject
 {
index a99656a..00717da 100644 (file)
@@ -33,7 +33,6 @@ PRIVATETESTS += \
     qdeclarativeconnection \
     qdeclarativedebug \
     qdeclarativedebugclient \
-    qdeclarativedebughelper \
     qdeclarativedebugservice \
     qdeclarativeecmascript \
     qdeclarativeimageprovider \
index cd55772..7e04cb8 100644 (file)
@@ -6,6 +6,6 @@ HEADERS += ../shared/debugutil_p.h
 SOURCES += tst_qdeclarativedebug.cpp \
            ../shared/debugutil.cpp
 
-CONFIG += parallel_test
+CONFIG += parallel_test declarative_debug
 
 QT += core-private gui-private declarative-private
index ade51c4..8ad5e31 100644 (file)
 #include <private/qdeclarativebinding_p.h>
 #include <private/qdeclarativedebug_p.h>
 #include <private/qdeclarativeenginedebug_p.h>
-#include <private/qdeclarativedebugclient_p.h>
 #include <private/qdeclarativedebugservice_p.h>
 #include <private/qdeclarativemetatype_p.h>
 #include <private/qdeclarativeproperty_p.h>
-#include <private/qdeclarativedebughelper_p.h>
 
 #include "../../../shared/util.h"
 #include "../shared/debugutil_p.h"
@@ -296,9 +294,6 @@ void tst_QDeclarativeDebug::initTestCase()
     qRegisterMetaType<QDeclarativeDebugWatch::State>();
     qmlRegisterType<NonScriptProperty>("Test", 1, 0, "NonScriptPropertyElement");
 
-    QTest::ignoreMessage(QtWarningMsg, "Qml debugging is enabled. Only use this in a safe environment!");
-    QDeclarativeDebugHelper::enableDebugging();
-
     QTest::ignoreMessage(QtWarningMsg, "QDeclarativeDebugServer: Waiting for connection on port 3768...");
     m_engine = new QDeclarativeEngine(this);
 
index 189133a..28e25e9 100644 (file)
@@ -5,4 +5,8 @@ macx:CONFIG -= app_bundle
 HEADERS += ../shared/debugutil_p.h
 SOURCES += tst_qdeclarativedebugclient.cpp \
            ../shared/debugutil.cpp
+
+CONFIG += declarative_debug
+
 QT += core-private gui-private declarative-private
+
index d41cfa3..d7f53c9 100644 (file)
@@ -49,9 +49,7 @@
 
 #include <private/qdeclarativedebug_p.h>
 #include <private/qdeclarativeenginedebug_p.h>
-#include <private/qdeclarativedebugclient_p.h>
 #include <private/qdeclarativedebugservice_p.h>
-#include <private/qdeclarativedebughelper_p.h>
 
 #include "../../../shared/util.h"
 #include "../shared/debugutil_p.h"
@@ -73,9 +71,6 @@ private slots:
 
 void tst_QDeclarativeDebugClient::initTestCase()
 {
-    QTest::ignoreMessage(QtWarningMsg, "Qml debugging is enabled. Only use this in a safe environment!");
-    QDeclarativeDebugHelper::enableDebugging();
-
     QTest::ignoreMessage(QtWarningMsg, "QDeclarativeDebugServer: Waiting for connection on port 13770...");
     new QDeclarativeEngine(this);
 
diff --git a/tests/auto/declarative/qdeclarativedebughelper/private_headers/qdeclarativedebughelper_p.h b/tests/auto/declarative/qdeclarativedebughelper/private_headers/qdeclarativedebughelper_p.h
deleted file mode 100644 (file)
index c08f6fd..0000000
+++ /dev/null
@@ -1,71 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
-** All rights reserved.
-** Contact: Nokia Corporation (qt-info@nokia.com)
-**
-** This file is part of the QtDeclarative module of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:LGPL$
-** GNU Lesser General Public License Usage
-** 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.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU General
-** Public License version 3.0 as published by the Free Software Foundation
-** and appearing in the file LICENSE.GPL included in the packaging of this
-** file. Please review the following information to ensure the GNU General
-** Public License version 3.0 requirements will be met:
-** http://www.gnu.org/copyleft/gpl.html.
-**
-** Other Usage
-** Alternatively, this file may be used in accordance with the terms and
-** conditions contained in a signed written agreement between you and Nokia.
-**
-**
-**
-**
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-#ifndef QDECLARATIVEDEBUGHELPER_P_H
-#define QDECLARATIVEDEBUGHELPER_P_H
-
-#include <QtCore/qglobal.h>
-
-QT_BEGIN_HEADER
-
-QT_BEGIN_NAMESPACE
-
-class QJSEngine;
-class QDeclarativeEngine;
-
-// Helper methods to access private API through a stable interface
-// This is used in the qmljsdebugger library of QtCreator.
-class Q_DECLARATIVE_EXPORT QDeclarativeDebugHelper
-{
-public:
-    static QJSEngine *getScriptEngine(QDeclarativeEngine *engine);
-    static void setAnimationSlowDownFactor(qreal factor);
-
-    // Enables remote debugging functionality
-    // Only use this for debugging in a safe environment!
-    static void enableDebugging();
-};
-
-QT_END_NAMESPACE
-
-QT_END_HEADER
-
-#endif // QDECLARATIVEDEBUGHELPER_P_H
diff --git a/tests/auto/declarative/qdeclarativedebughelper/qdeclarativedebughelper.pro b/tests/auto/declarative/qdeclarativedebughelper/qdeclarativedebughelper.pro
deleted file mode 100644 (file)
index 1e62c12..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-load(qttest_p4)
-contains(QT_CONFIG,declarative): QT += network declarative
-macx:CONFIG -= app_bundle
-
-SOURCES += tst_qdeclarativedebughelper.cpp
-QT += core-private gui-private declarative-private
diff --git a/tests/auto/declarative/qdeclarativedebughelper/tst_qdeclarativedebughelper.cpp b/tests/auto/declarative/qdeclarativedebughelper/tst_qdeclarativedebughelper.cpp
deleted file mode 100644 (file)
index f67d5c5..0000000
+++ /dev/null
@@ -1,112 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2011 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$
-** GNU Lesser General Public License Usage
-** 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.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU General
-** Public License version 3.0 as published by the Free Software Foundation
-** and appearing in the file LICENSE.GPL included in the packaging of this
-** file. Please review the following information to ensure the GNU General
-** Public License version 3.0 requirements will be met:
-** http://www.gnu.org/copyleft/gpl.html.
-**
-** Other Usage
-** Alternatively, this file may be used in accordance with the terms and
-** conditions contained in a signed written agreement between you and Nokia.
-**
-**
-**
-**
-**
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-#include <qtest.h>
-
-#include <QDeclarativeEngine>
-#include <private/qdeclarativeengine_p.h>
-#include <QAbstractAnimation>
-#include <private/qabstractanimation_p.h>
-
-// We have copied the header which is used in the qmljsdebugger (part of QtCreator)
-// to catch BC changes. Don't update it unless you know what you are doing!
-#include "private_headers/qdeclarativedebughelper_p.h"
-
-class tst_qdeclarativedebughelper : public QObject {
-    Q_OBJECT
-private slots:
-    void setAnimationSlowDownFactor();
-    void enableDebugging();
-};
-
-class TestAnimation : public QAbstractAnimation {
-public:
-    int updateCalled;
-
-    TestAnimation() : updateCalled(0) {}
-
-    virtual void updateCurrentTime(int /*currentTime*/) {
-        updateCalled++;
-    }
-    virtual int duration() const {
-        return 100;
-    }
-};
-
-void tst_qdeclarativedebughelper::setAnimationSlowDownFactor()
-{
-    TestAnimation animation;
-
-    // first check whether setup works
-    QCOMPARE(animation.updateCalled, 0);
-    animation.start();
-    QTest::qWait(animation.totalDuration() + 150);
-#ifdef Q_OS_WIN
-    if (animation.state() != QAbstractAnimation::Stopped)
-        QEXPECT_FAIL("", "On windows, consistent timing is not working properly due to bad timer resolution", Abort);
-#endif
-    QCOMPARE(animation.state(), QAbstractAnimation::Stopped);
-    QVERIFY(animation.updateCalled > 1);
-
-    // check if we can pause all animations
-    animation.updateCalled = 0;
-    QDeclarativeDebugHelper::setAnimationSlowDownFactor(0.0);
-    animation.start();
-    QTest::qWait(animation.totalDuration() + 150);
-    QVERIFY(animation.updateCalled <= 1); // updateCurrentTime seems to be called at  least once
-
-    // now run them again
-    animation.updateCalled = 0;
-    QDeclarativeDebugHelper::setAnimationSlowDownFactor(2.0);
-    animation.start();
-    QTest::qWait(animation.totalDuration() + 150);
-    QVERIFY(animation.updateCalled > 1);
-}
-
-void tst_qdeclarativedebughelper::enableDebugging()
-{
-    QTest::ignoreMessage(QtWarningMsg, "Qml debugging is enabled. Only use this in a safe environment!");
-    QDeclarativeDebugHelper::enableDebugging();
-}
-
-QTEST_MAIN(tst_qdeclarativedebughelper)
-
-#include "tst_qdeclarativedebughelper.moc"
-
index 785e8a7..999e192 100644 (file)
@@ -6,6 +6,6 @@ HEADERS += ../shared/debugutil_p.h
 SOURCES += tst_qdeclarativedebugservice.cpp \
            ../shared/debugutil.cpp
 
-CONFIG += parallel_test
+CONFIG += parallel_test declarative_debug
 
 QT += core-private gui-private declarative-private
index 3fa8bba..74f549c 100644 (file)
@@ -46,7 +46,6 @@
 #include <QThread>
 
 #include <QtDeclarative/qdeclarativeengine.h>
-#include <private/qdeclarativedebughelper_p.h>
 
 #include <private/qdeclarativedebug_p.h>
 #include <private/qdeclarativeenginedebug_p.h>
@@ -76,9 +75,6 @@ private slots:
 
 void tst_QDeclarativeDebugService::initTestCase()
 {
-    QTest::ignoreMessage(QtWarningMsg, "Qml debugging is enabled. Only use this in a safe environment!");
-    QDeclarativeDebugHelper::enableDebugging();
-
     QTest::ignoreMessage(QtWarningMsg, "QDeclarativeDebugServer: Waiting for connection on port 13769...");
     new QDeclarativeEngine(this);