aboutsummaryrefslogtreecommitdiffstats
path: root/src/qmldebug/qqmlenginedebugclient_p.h
blob: 0a01f2eac52bac7ceccb416b8500d718e3cd6497 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QQMLENGINEDEBUGCLIENT_H
#define QQMLENGINEDEBUGCLIENT_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/qqmldebugclient_p.h>
#include <private/qpacket_p.h>

#include <QtCore/qurl.h>
#include <QtCore/qvariant.h>

QT_BEGIN_NAMESPACE

struct QQmlEngineDebugPropertyReference
{
    qint32 objectDebugId = -1;
    QString name;
    QVariant value;
    QString valueTypeName;
    QString binding;
    bool hasNotifySignal = false;
};

struct QQmlEngineDebugFileReference
{
    QUrl url;
    qint32 lineNumber = -1;
    qint32 columnNumber = -1;
};

struct QQmlEngineDebugObjectReference
{
    qint32 debugId = -1;
    QString className;
    QString idString;
    QString name;
    QQmlEngineDebugFileReference source;
    qint32 contextDebugId = -1;
    QList<QQmlEngineDebugPropertyReference> properties;
    QList<QQmlEngineDebugObjectReference> children;
};

struct QQmlEngineDebugContextReference
{
    qint32 debugId = -1;
    QString name;
    QList<QQmlEngineDebugObjectReference> objects;
    QList<QQmlEngineDebugContextReference> contexts;
};

struct QQmlEngineDebugEngineReference
{
    qint32 debugId = -1;
    QString name;
};

class QQmlEngineDebugClientPrivate;
class QQmlEngineDebugClient : public QQmlDebugClient
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QQmlEngineDebugClient)

public:
    explicit QQmlEngineDebugClient(QQmlDebugConnection *conn);

    qint32 addWatch(const QQmlEngineDebugPropertyReference &,
                    bool *success);
    qint32 addWatch(const QQmlEngineDebugContextReference &, const QString &,
                    bool *success);
    qint32 addWatch(const QQmlEngineDebugObjectReference &, const QString &,
                    bool *success);
    qint32 addWatch(const QQmlEngineDebugObjectReference &,
                    bool *success);
    qint32 addWatch(const QQmlEngineDebugFileReference &,
                     bool *success);

    void removeWatch(qint32 watch, bool *success);

    qint32 queryAvailableEngines(bool *success);
    qint32 queryRootContexts(const QQmlEngineDebugEngineReference &,
                             bool *success);
    qint32 queryObject(const QQmlEngineDebugObjectReference &,
                       bool *success);
    qint32 queryObjectsForLocation(const QString &file,
           qint32 lineNumber, qint32 columnNumber, bool *success);
    qint32 queryObjectRecursive(const QQmlEngineDebugObjectReference &,
                                bool *success);
    qint32 queryObjectsForLocationRecursive(const QString &file,
           qint32 lineNumber, qint32 columnNumber, bool *success);
    qint32 queryExpressionResult(qint32 objectDebugId,
                                 const QString &expr,
                                 bool *success);
    qint32 queryExpressionResultBC(qint32 objectDebugId,
                                 const QString &expr,
                                 bool *success);
    qint32 setBindingForObject(qint32 objectDebugId, const QString &propertyName,
                               const QVariant &bindingExpression,
                               bool isLiteralValue,
                               const QString &source, qint32 line, bool *success);
    qint32 resetBindingForObject(qint32 objectDebugId,
                                 const QString &propertyName, bool *success);
    qint32 setMethodBody(qint32 objectDebugId, const QString &methodName,
                         const QString &methodBody, bool *success);

    qint32 getId();

    void decode(QPacket &ds, QQmlEngineDebugContextReference &);
    void decode(QPacket &ds, QQmlEngineDebugObjectReference &, bool simple);
    void decode(QPacket &ds, QList<QQmlEngineDebugObjectReference> &o, bool simple);

    QList<QQmlEngineDebugEngineReference> engines() const;
    QQmlEngineDebugContextReference rootContext() const;
    QQmlEngineDebugObjectReference object() const;
    QList<QQmlEngineDebugObjectReference> objects() const;
    QVariant resultExpr() const;
    bool valid() const;

signals:
    void newObject(qint32 objectId);
    void valueChanged(QByteArray,QVariant);
    void result();

protected:
    void messageReceived(const QByteArray &) override;
};

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QQmlEngineDebugObjectReference)

#endif // QQMLENGINEDEBUGCLIENT_H