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 QQMLDEBUGSERVICE_H
41#define QQMLDEBUGSERVICE_H
42
43#include <QtCore/qobject.h>
44#include <QtCore/qhash.h>
45
46#include <private/qtqmlglobal_p.h>
47
48//
49// W A R N I N G
50// -------------
51//
52// This file is not part of the Qt API. It exists purely as an
53// implementation detail. This header file may change from version to
54// version without notice, or even be removed.
55//
56// We mean it.
57//
58
59QT_REQUIRE_CONFIG(qml_debug);
60
61QT_BEGIN_NAMESPACE
62
63class QJSEngine;
64
65class QQmlDebugServicePrivate;
66class Q_QML_PRIVATE_EXPORT QQmlDebugService : public QObject
67{
68 Q_OBJECT
69 Q_DECLARE_PRIVATE(QQmlDebugService)
70
71public:
72 ~QQmlDebugService() override;
73
74 const QString &name() const;
75 float version() const;
76
77 enum State { NotConnected, Unavailable, Enabled };
78 State state() const;
79 void setState(State newState);
80
81 virtual void stateAboutToBeChanged(State) {}
82 virtual void stateChanged(State) {}
83 virtual void messageReceived(const QByteArray &) {}
84
85 virtual void engineAboutToBeAdded(QJSEngine *engine) { emit attachedToEngine(engine); }
86 virtual void engineAboutToBeRemoved(QJSEngine *engine) { emit detachedFromEngine(engine); }
87
88 virtual void engineAdded(QJSEngine *) {}
89 virtual void engineRemoved(QJSEngine *) {}
90
91 static const QHash<int, QObject *> &objectsForIds();
92 static int idForObject(QObject *);
93 static QObject *objectForId(int id) { return objectsForIds().value(id); }
94
95protected:
96 explicit QQmlDebugService(const QString &, float version, QObject *parent = nullptr);
97
98signals:
99 void attachedToEngine(QJSEngine *);
100 void detachedFromEngine(QJSEngine *);
101
102 void messageToClient(const QString &name, const QByteArray &message);
103 void messagesToClient(const QString &name, const QList<QByteArray> &messages);
104};
105
106QT_END_NAMESPACE
107
108#endif // QQMLDEBUGSERVICE_H
109
110

source code of qtdeclarative/src/qml/debugger/qqmldebugservice_p.h