1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtSCriptTools 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 QSCRIPTDEBUGGERAGENT_P_H
41#define QSCRIPTDEBUGGERAGENT_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtScript/qscriptengineagent.h>
55
56#include <QtCore/qpair.h>
57
58#include "qscriptbreakpointdata_p.h"
59#include "qscriptscriptdata_p.h"
60
61QT_BEGIN_NAMESPACE
62
63class QScriptDebuggerBackendPrivate;
64
65class QScriptDebuggerAgentPrivate;
66class Q_AUTOTEST_EXPORT QScriptDebuggerAgent : public QScriptEngineAgent
67{
68public:
69 QScriptDebuggerAgent(QScriptDebuggerBackendPrivate *backend,
70 QScriptEngine *engine);
71 ~QScriptDebuggerAgent();
72
73 void enterStepIntoMode(int count = 1);
74 void enterStepOverMode(int count = 1);
75 void enterStepOutMode();
76 void enterContinueMode();
77 void enterInterruptMode();
78 void enterRunToLocationMode(const QString &fileName, int lineNumber);
79 void enterRunToLocationMode(qint64 scriptId, int lineNumber);
80 void enterReturnByForceMode(int contextIndex, const QScriptValue &value);
81
82 int setBreakpoint(const QScriptBreakpointData &data);
83 bool deleteBreakpoint(int id);
84 void deleteAllBreakpoints();
85 QScriptBreakpointData breakpointData(int id) const;
86 bool setBreakpointData(int id, const QScriptBreakpointData &data);
87 QScriptBreakpointMap breakpoints() const;
88
89 QScriptScriptMap scripts() const;
90 QScriptScriptData scriptData(qint64 id) const;
91 void scriptsCheckpoint();
92 QPair<QList<qint64>, QList<qint64> > scriptsDelta() const;
93 qint64 resolveScript(const QString &fileName) const;
94
95 QList<qint64> contextIds() const;
96 QPair<QList<qint64>, QList<qint64> > contextsCheckpoint();
97
98 void nullifyBackendPointer();
99
100 // reimplemented
101 void scriptLoad(qint64 id, const QString &program,
102 const QString &fileName, int baseLineNumber);
103 void scriptUnload(qint64 id);
104
105 void contextPush();
106 void contextPop();
107
108 void functionEntry(qint64 scriptId);
109 void functionExit(qint64 scriptId,
110 const QScriptValue &returnValue);
111
112 void positionChange(qint64 scriptId,
113 int lineNumber, int columnNumber);
114
115 void exceptionThrow(qint64 scriptId,
116 const QScriptValue &exception,
117 bool hasHandler);
118 void exceptionCatch(qint64 scriptId,
119 const QScriptValue &exception);
120
121 bool supportsExtension(Extension extension) const;
122 QVariant extension(Extension extension,
123 const QVariant &argument = QVariant());
124
125private:
126 QScriptDebuggerAgentPrivate *d_ptr;
127 Q_DECLARE_PRIVATE(QScriptDebuggerAgent)
128 Q_DISABLE_COPY(QScriptDebuggerAgent)
129};
130
131QT_END_NAMESPACE
132
133#endif
134

source code of qtscript/src/scripttools/debugging/qscriptdebuggeragent_p.h