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 QQMLDEBUG_H |
41 | #define QQMLDEBUG_H |
42 | |
43 | #include <QtQml/qtqmlglobal.h> |
44 | #include <QtCore/qstring.h> |
45 | #include <QtCore/qvariant.h> |
46 | |
47 | QT_BEGIN_NAMESPACE |
48 | |
49 | #if QT_CONFIG(qml_debug) |
50 | |
51 | struct Q_QML_EXPORT QQmlDebuggingEnabler |
52 | { |
53 | enum StartMode { |
54 | DoNotWaitForClient, |
55 | WaitForClient |
56 | }; |
57 | |
58 | QQmlDebuggingEnabler(bool printWarning = true); |
59 | |
60 | static QStringList debuggerServices(); |
61 | static QStringList inspectorServices(); |
62 | static QStringList profilerServices(); |
63 | static QStringList nativeDebuggerServices(); |
64 | |
65 | static void setServices(const QStringList &services); |
66 | |
67 | static bool startTcpDebugServer(int port, StartMode mode = DoNotWaitForClient, |
68 | const QString &hostName = QString()); |
69 | static bool connectToLocalDebugger(const QString &socketFileName, |
70 | StartMode mode = DoNotWaitForClient); |
71 | static bool startDebugConnector(const QString &pluginName, |
72 | const QVariantHash &configuration = QVariantHash()); |
73 | }; |
74 | |
75 | // Execute code in constructor before first QQmlEngine is instantiated |
76 | #if defined(QT_QML_DEBUG_NO_WARNING) |
77 | static QQmlDebuggingEnabler qQmlEnableDebuggingHelper(false); |
78 | #elif defined(QT_QML_DEBUG) |
79 | static QQmlDebuggingEnabler qQmlEnableDebuggingHelper(true); |
80 | #endif |
81 | |
82 | #endif |
83 | |
84 | QT_END_NAMESPACE |
85 | |
86 | #endif // QQMLDEBUG_H |
87 | |