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 QSCRIPTDEBUGGERBACKEND_P_H
41#define QSCRIPTDEBUGGERBACKEND_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 <QtCore/qobjectdefs.h>
55
56#include <QtCore/qpair.h>
57
58#include "qscriptbreakpointdata_p.h"
59#include "qscriptscriptdata_p.h"
60
61QT_BEGIN_NAMESPACE
62
63class QScriptContext;
64class QScriptEngine;
65class QScriptDebuggerCommandExecutor;
66class QScriptDebuggerEvent;
67class QScriptValue;
68class QScriptValueIterator;
69class QScriptObjectSnapshot;
70class QStringList;
71
72typedef QPair<QList<qint64>, QList<qint64> > QScriptScriptsDelta;
73typedef QPair<QList<qint64>, QList<qint64> > QScriptContextsDelta;
74
75class QScriptDebuggerBackendPrivate;
76class Q_AUTOTEST_EXPORT QScriptDebuggerBackend
77{
78public:
79 QScriptDebuggerBackend();
80 virtual ~QScriptDebuggerBackend();
81
82 void attachTo(QScriptEngine *engine);
83 void detach();
84
85 QScriptEngine *engine() const;
86
87 void stepInto(int count = 1);
88 void stepOver(int count = 1);
89 void stepOut();
90 void continueEvalution();
91 void interruptEvaluation();
92 void runToLocation(const QString &fileName, int lineNumber);
93 void runToLocation(qint64 scriptId, int lineNumber);
94 void returnToCaller(int contextIndex, const QScriptValue &value);
95 void evaluate(int contextIndex, const QString &program,
96 const QString &fileName, int lineNumber);
97
98 int setBreakpoint(const QScriptBreakpointData &data);
99 bool deleteBreakpoint(int id);
100 void deleteAllBreakpoints();
101 QScriptBreakpointData breakpointData(int id) const;
102 bool setBreakpointData(int id, const QScriptBreakpointData &data);
103 QScriptBreakpointMap breakpoints() const;
104
105 QScriptScriptMap scripts() const;
106 QScriptScriptData scriptData(qint64 id) const;
107 void scriptsCheckpoint();
108 QScriptScriptsDelta scriptsDelta() const;
109 qint64 resolveScript(const QString &fileName) const;
110
111 int contextCount() const;
112 QScriptContext *context(int index) const;
113 QStringList backtrace() const;
114 QList<qint64> contextIds() const;
115 QScriptContextsDelta contextsCheckpoint();
116
117 int newScriptObjectSnapshot();
118 QScriptObjectSnapshot *scriptObjectSnapshot(int id) const;
119 void deleteScriptObjectSnapshot(int id);
120
121 int newScriptValueIterator(const QScriptValue &object);
122 QScriptValueIterator *scriptValueIterator(int id) const;
123 void deleteScriptValueIterator(int id);
124
125 QScriptValue traceFunction() const;
126 QScriptValue assertFunction() const;
127 QScriptValue fileNameFunction() const;
128 QScriptValue lineNumberFunction() const;
129
130 void doPendingEvaluate(bool postEvent);
131
132 bool ignoreExceptions() const;
133 void setIgnoreExceptions(bool ignore);
134
135 QScriptDebuggerCommandExecutor *commandExecutor() const;
136 void setCommandExecutor(QScriptDebuggerCommandExecutor *executor);
137
138 virtual void resume() = 0;
139
140protected:
141 virtual void event(const QScriptDebuggerEvent &event) = 0;
142
143protected:
144 QScriptDebuggerBackend(QScriptDebuggerBackendPrivate &dd);
145 QScopedPointer<QScriptDebuggerBackendPrivate> d_ptr;
146
147private:
148 Q_DECLARE_PRIVATE(QScriptDebuggerBackend)
149 Q_DISABLE_COPY(QScriptDebuggerBackend)
150};
151
152QT_END_NAMESPACE
153
154#endif
155

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