Move QtQuick profiling to own profiler adapter

The QtQuick parts of the QML profiler service thus become a proper
global profiler which can be independently enabled and disabled.

Change-Id: Ifad03801cab2be66a264fc46fdebdae582fcc99b
Reviewed-by: Kai Koehne <[email protected]>

1 files changed, 227 insertions, 0 deletions

diff --git a/src/quick/util/qquickprofiler_p.h b/src/quick/util/qquickprofiler_p.h
new file mode 100644
index 0000000000..d5ad0e9285
--- /dev/null
+++ b/src/quick/util/qquickprofiler_p.h
@@ -0,0 +1,227 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtQml module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia 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.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QQUICKPROFILER_P_H
+#define QQUICKPROFILER_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "private/qqmlabstractprofileradapter_p.h"
+#include <private/qabstractanimation_p.h>
+#include <QUrl>
+#include <QSize>
+#include <QMutex>
+
+QT_BEGIN_NAMESPACE
+
+#define Q_QUICK_PROFILE_IF_ENABLED(Code)\
+    if (QQuickProfiler::enabled) {\
+        Code;\
+    } else\
+        (void)0
+
+#define Q_QUICK_PROFILE(Method)\
+    Q_QUICK_PROFILE_IF_ENABLED(QQuickProfiler::Method)
+
+#define Q_QUICK_SG_PROFILE2(Type1, Type2, Params)\
+    Q_QUICK_PROFILE_IF_ENABLED((QQuickProfiler::sceneGraphFrame<Type1, Type2> Params))
+
+#define Q_QUICK_SG_PROFILE1(Type, Params) Q_QUICK_SG_PROFILE2(Type, Type, Params)
+
+
+// This struct is somewhat dangerous to use:
+// You can save values either with 32 or 64 bit precision. toByteArrays will
+// guess the precision from messageType. If you state the wrong messageType
+// you will get undefined results.
+// The messageType is itself a bit field. You can pack multiple messages into
+// one object, e.g. RangeStart and RangeLocation. Each one will be read
+// independently by toByteArrays. Thus you can only pack messages if their data
+// doesn't overlap. Again, it's up to you to figure that out.
+struct Q_AUTOTEST_EXPORT QQuickProfilerData
+{
+    QQuickProfilerData() {}
+
+    QQuickProfilerData(qint64 time, int messageType, int detailType, const QUrl &url, int x = 0,
+                       int y = 0, int framerate = 0, int count = 0) :
+        time(time), messageType(messageType), detailType(detailType), detailUrl(url), x(x), y(y),
+        framerate(framerate), count(count) {}
+
+    QQuickProfilerData(qint64 time, int messageType, int detailType, int framerate = 0,
+                       int count = 0) :
+        time(time), messageType(messageType), detailType(detailType), framerate(framerate),
+        count(count) {}
+
+    // Special ctor for scenegraph frames. Note that it's missing the QString/QUrl params.
+    // This is slightly ugly, but makes it easier to disambiguate between int and qint64 params.
+    QQuickProfilerData(qint64 time, int messageType, int detailType, qint64 d1, qint64 d2,
+                       qint64 d3, qint64 d4, qint64 d5) :
+        time(time), messageType(messageType), detailType(detailType), subtime_1(d1), subtime_2(d2),
+        subtime_3(d3), subtime_4(d4), subtime_5(d5) {}
+
+
+    qint64 time;
+    int messageType;        //bit field of Message
+    int detailType;
+
+    QUrl detailUrl;
+
+    union {
+        qint64 subtime_1;
+        int x;              //used for pixmaps
+    };
+
+    union {
+        qint64 subtime_2;
+        int y;              //used for pixmaps
+    };
+
+    union {
+        qint64 subtime_3;
+        int framerate;      //used by animation events
+    };
+
+    union {
+        qint64 subtime_4;
+        int count;          //used by animation events and for pixmaps
+    };
+
+    qint64 subtime_5;
+
+    void toByteArrays(QList<QByteArray> &messages) const;
+};
+
+Q_DECLARE_TYPEINFO(QQuickProfilerData, Q_MOVABLE_TYPE);
+
+class QQuickProfiler : public QQmlAbstractProfilerAdapter {
+    Q_OBJECT
+public:
+
+    template<EventType DetailType>
+    static void addEvent()
+    {
+        s_instance->processMessage(QQuickProfilerData(s_instance->timestamp(), 1 << Event,
+                1 << DetailType));
+    }
+
+    static void animationFrame(qint64 delta)
+    {
+        int animCount = QUnifiedTimer::instance()->runningAnimationCount();
+
+        if (animCount > 0 && delta > 0) {
+            s_instance->processMessage(QQuickProfilerData(s_instance->timestamp(), 1 << Event,
+                    1 << AnimationFrame, 1000 / (int)delta /* trim fps to integer */, animCount));
+        }
+    }
+
+    template<SceneGraphFrameType FrameType1, SceneGraphFrameType FrameType2>
+    static void sceneGraphFrame(qint64 value1, qint64 value2 = -1, qint64 value3 = -1,
+                                qint64 value4 = -1, qint64 value5 = -1)
+    {
+        s_instance->processMessage(QQuickProfilerData(s_instance->timestamp(), 1 << SceneGraphFrame,
+                1 << FrameType1 | 1 << FrameType2, value1, value2, value3, value4, value5));
+    }
+
+    template<PixmapEventType PixmapState>
+    static void pixmapStateChanged(const QUrl &url)
+    {
+        s_instance->processMessage(QQuickProfilerData(s_instance->timestamp(),
+                1 << PixmapCacheEvent, 1 << PixmapState, url));
+    }
+
+    static void pixmapLoadingFinished(const QUrl &url, const QSize &size)
+    {
+        s_instance->processMessage(QQuickProfilerData(s_instance->timestamp(),
+                1 << PixmapCacheEvent,
+                (1 << PixmapLoadingFinished) | ((size.width() > 0 && size.height() > 0) ? (1 << PixmapSizeKnown) : 0),
+                url, size.width(), size.height()));
+    }
+
+    template<PixmapEventType CountType>
+    static void pixmapCountChanged(const QUrl &url, int count)
+    {
+        s_instance->processMessage(QQuickProfilerData(s_instance->timestamp(),
+                1 << PixmapCacheEvent, 1 << CountType, url, 0, 0, 0, count));
+    }
+
+    qint64 timestamp() { return m_timer.nsecsElapsed(); }
+
+    qint64 sendMessages(qint64 until, QList<QByteArray> &messages);
+
+    static bool enabled;
+
+    static void initialize();
+
+    virtual ~QQuickProfiler();
+
+protected:
+    int next;
+    static QQuickProfiler *s_instance;
+    QMutex m_dataMutex;
+    QElapsedTimer m_timer;
+    QVarLengthArray<QQuickProfilerData> m_data;
+
+    QQuickProfiler(QQmlProfilerService *service);
+
+    void processMessage(const QQuickProfilerData &message)
+    {
+        QMutexLocker lock(&m_dataMutex);
+        m_data.append(message);
+    }
+
+protected slots:
+    void startProfilingImpl();
+    void stopProfilingImpl();
+    void reportDataImpl();
+    void setTimer(const QElapsedTimer &t);
+};
+
+QT_END_NAMESPACE
+
+#endif