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 QQMLDEBUGCONNECTOR_H
41#define QQMLDEBUGCONNECTOR_H
42
43#include <QtQml/qtqmlglobal.h>
44#include <QtQml/qjsengine.h>
45#include <QtCore/QVariantList>
46
47#if QT_CONFIG(qml_debug)
48#include <private/qqmldebugservice_p.h>
49#endif
50
51//
52// W A R N I N G
53// -------------
54//
55// This file is not part of the Qt API. It exists purely as an
56// implementation detail. This header file may change from version to
57// version without notice, or even be removed.
58//
59// We mean it.
60//
61
62QT_BEGIN_NAMESPACE
63
64#if !QT_CONFIG(qml_debug)
65
66class Q_QML_PRIVATE_EXPORT QQmlDebugConnector
67{
68public:
69 static QQmlDebugConnector *instance() { return nullptr; }
70
71 template<class Service>
72 static Service *service() { return nullptr; }
73
74 bool hasEngine(QJSEngine *) const { return false; }
75 void addEngine(QJSEngine *) {}
76 void removeEngine(QJSEngine *) {}
77
78 bool open(const QVariantHash &configuration = QVariantHash())
79 {
80 Q_UNUSED(configuration);
81 return false;
82 }
83};
84
85#else
86
87class QQmlDebugService;
88class Q_QML_PRIVATE_EXPORT QQmlDebugConnector : public QObject
89{
90 Q_OBJECT
91public:
92 static void setPluginKey(const QString &key);
93 static void setServices(const QStringList &services);
94 static QQmlDebugConnector *instance();
95 static int dataStreamVersion()
96 {
97 return s_dataStreamVersion;
98 }
99
100 virtual bool blockingMode() const = 0;
101
102 virtual QQmlDebugService *service(const QString &name) const = 0;
103
104 virtual void addEngine(QJSEngine *engine) = 0;
105 virtual void removeEngine(QJSEngine *engine) = 0;
106 virtual bool hasEngine(QJSEngine *engine) const = 0;
107
108 virtual bool addService(const QString &name, QQmlDebugService *service) = 0;
109 virtual bool removeService(const QString &name) = 0;
110
111 virtual bool open(const QVariantHash &configuration = QVariantHash()) = 0;
112
113 template<class Service>
114 static Service *service()
115 {
116 QQmlDebugConnector *inst = instance();
117 return inst ? static_cast<Service *>(inst->service(Service::s_key)) : nullptr;
118 }
119
120protected:
121 static QString commandLineArguments();
122 static int s_dataStreamVersion;
123};
124
125class Q_QML_PRIVATE_EXPORT QQmlDebugConnectorFactory : public QObject {
126 Q_OBJECT
127public:
128 virtual QQmlDebugConnector *create(const QString &key) = 0;
129 ~QQmlDebugConnectorFactory() override;
130};
131
132#define QQmlDebugConnectorFactory_iid "org.qt-project.Qt.QQmlDebugConnectorFactory"
133
134#endif
135
136QT_END_NAMESPACE
137
138#endif // QQMLDEBUGCONNECTOR_H
139