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_P_H
41 #define QSCRIPTDEBUGGERBACKEND_P_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/qhash.h>
57 #include <QtCore/qlist.h>
58 #include <QtScript/qscriptvalue.h>
59 
60 #include "qscriptdebuggerbackend_p.h"
61 
62 QT_BEGIN_NAMESPACE
63 
64 class QEvent;
65 class QString;
66 class QScriptContext;
67 class QScriptEngine;
68 class QScriptValueIterator;
69 class QScriptObjectSnapshot;
70 class QScriptDebuggerAgent;
71 class QScriptDebuggerCommandExecutor;
72 
73 class QScriptDebuggerBackend;
74 class Q_AUTOTEST_EXPORT QScriptDebuggerBackendPrivate
75 {
76     Q_DECLARE_PUBLIC(QScriptDebuggerBackend)
77 public:
78     QScriptDebuggerBackendPrivate();
79     virtual ~QScriptDebuggerBackendPrivate();
80 
81     void postEvent(QEvent *e);
82     virtual bool event(QEvent *e);
83 
84     // events reported by agent
85     virtual void stepped(qint64 scriptId, int lineNumber, int columnNumber,
86                          const QScriptValue &result);
87     virtual void locationReached(qint64 scriptId, int lineNumber, int columnNumber);
88     virtual void interrupted(qint64 scriptId, int lineNumber, int columnNumber);
89     virtual void breakpoint(qint64 scriptId, int lineNumber, int columnNumber,
90                             int breakpointId);
91     virtual void exception(qint64 scriptId, const QScriptValue &exception,
92                            bool hasHandler);
93     virtual void debuggerInvocationRequest(qint64 scriptId, int lineNumber,
94                                            int columnNumber);
95     virtual void forcedReturn(qint64 scriptId, int lineNumber, int columnNumber,
96                               const QScriptValue &value);
97 
98     static QScriptValue trace(QScriptContext *context,
99                               QScriptEngine *engine);
100     static QScriptValue qsassert(QScriptContext *context,
101                                  QScriptEngine *engine);
102     static QScriptValue fileName(QScriptContext *context,
103                                  QScriptEngine *engine);
104     static QScriptValue lineNumber(QScriptContext *context,
105                                    QScriptEngine *engine);
106 
107     void agentDestroyed(QScriptDebuggerAgent *);
108 
109     QScriptDebuggerAgent *agent;
110     QScriptDebuggerCommandExecutor *commandExecutor;
111 
112     int pendingEvaluateContextIndex;
113     QString pendingEvaluateProgram;
114     QString pendingEvaluateFileName;
115     int pendingEvaluateLineNumber;
116     bool ignoreExceptions;
117 
118     int nextScriptValueIteratorId;
119     QMap<int, QScriptValueIterator*> scriptValueIterators;
120 
121     int nextScriptObjectSnapshotId;
122     QMap<int, QScriptObjectSnapshot*> scriptObjectSnapshots;
123 
124     QObject *eventReceiver;
125 
126     QScriptDebuggerBackend *q_ptr;
127 
128     QScriptValue origTraceFunction;
129     QScriptValue origFileNameFunction;
130     QScriptValue origLineNumberFunction;
131 };
132 
133 QT_END_NAMESPACE
134 
135 #endif
136