1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQml module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLABSTRACTPROFILERADAPTER_P_H
41#define QQMLABSTRACTPROFILERADAPTER_P_H
42
43#include <private/qtqmlglobal_p.h>
44#include <private/qqmlprofilerdefinitions_p.h>
45
46#include <QtCore/QObject>
47#include <QtCore/QElapsedTimer>
48
49//
50// W A R N I N G
51// -------------
52//
53// This file is not part of the Qt API. It exists purely as an
54// implementation detail. This header file may change from version to
55// version without notice, or even be removed.
56//
57// We mean it.
58//
59
60QT_BEGIN_NAMESPACE
61
62QT_REQUIRE_CONFIG(qml_debug);
63
64class QQmlProfilerService;
65class Q_QML_PRIVATE_EXPORT QQmlAbstractProfilerAdapter : public QObject, public QQmlProfilerDefinitions {
66 Q_OBJECT
67
68public:
69 static const int s_numMessagesPerBatch = 1000;
70
71 QQmlAbstractProfilerAdapter(QObject *parent = nullptr) :
72 QObject(parent), service(nullptr), waiting(true), featuresEnabled(0) {}
73 ~QQmlAbstractProfilerAdapter() override {}
74 void setService(QQmlProfilerService *new_service) { service = new_service; }
75
76 virtual qint64 sendMessages(qint64 until, QList<QByteArray> &messages) = 0;
77
78 void startProfiling(quint64 features);
79
80 void stopProfiling();
81
82 void reportData() { emit dataRequested(); }
83
84 void stopWaiting() { waiting = false; }
85 void startWaiting() { waiting = true; }
86
87 bool isRunning() const { return featuresEnabled != 0; }
88 quint64 features() const { return featuresEnabled; }
89
90 void synchronize(const QElapsedTimer &t) { emit referenceTimeKnown(t); }
91
92signals:
93 void profilingEnabled(quint64 features);
94 void profilingEnabledWhileWaiting(quint64 features);
95
96 void profilingDisabled();
97 void profilingDisabledWhileWaiting();
98
99 void dataRequested();
100 void referenceTimeKnown(const QElapsedTimer &timer);
101
102protected:
103 QQmlProfilerService *service;
104
105private:
106 bool waiting;
107 quint64 featuresEnabled;
108};
109
110class Q_QML_PRIVATE_EXPORT QQmlAbstractProfilerAdapterFactory : public QObject
111{
112 Q_OBJECT
113public:
114 virtual QQmlAbstractProfilerAdapter *create(const QString &key) = 0;
115};
116
117#define QQmlAbstractProfilerAdapterFactory_iid "org.qt-project.Qt.QQmlAbstractProfilerAdapterFactory"
118
119QT_END_NAMESPACE
120
121#endif // QQMLABSTRACTPROFILERADAPTER_P_H
122