| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 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:LGPL$ |
| ** 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 Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** 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-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef QV4DEBUGGER_H |
| #define QV4DEBUGGER_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 "qv4datacollector.h" |
| #include <private/qv4debugging_p.h> |
| #include <private/qv4function_p.h> |
| #include <private/qv4context_p.h> |
| #include <private/qv4persistent_p.h> |
| |
| #include <QtCore/qmutex.h> |
| #include <QtCore/qwaitcondition.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| class QV4DebugJob; |
| class QV4DataCollector; |
| class QV4Debugger : public QV4::Debugging::Debugger |
| { |
| Q_OBJECT |
| public: |
| struct BreakPoint { |
| BreakPoint(const QString &fileName, int line); |
| QString fileName; |
| int lineNumber; |
| }; |
| |
| enum State { |
| Running, |
| Paused |
| }; |
| |
| enum Speed { |
| FullThrottle = 0, |
| StepOut, |
| StepOver, |
| StepIn, |
| |
| NotStepping = FullThrottle |
| }; |
| |
| enum PauseReason { |
| PauseRequest, |
| BreakPointHit, |
| Throwing, |
| Step |
| }; |
| |
| QV4Debugger(QV4::ExecutionEngine *engine); |
| |
| QV4::ExecutionEngine *engine() const; |
| const QV4DataCollector *collector() const; |
| QV4DataCollector *collector(); |
| |
| void pause(); |
| void resume(Speed speed); |
| |
| State state() const; |
| |
| void addBreakPoint(const QString &fileName, int lineNumber, |
| const QString &condition = QString()); |
| void removeBreakPoint(const QString &fileName, int lineNumber); |
| |
| void setBreakOnThrow(bool onoff); |
| |
| void clearPauseRequest(); |
| |
| // used for testing |
| struct ExecutionState |
| { |
| QString fileName; |
| int lineNumber; |
| }; |
| ExecutionState currentExecutionState() const; |
| |
| QVector<QV4::StackFrame> stackTrace(int frameLimit = -1) const; |
| QVector<QV4::Heap::ExecutionContext::ContextType> getScopeTypes(int frame = 0) const; |
| |
| QV4::Function *getFunction() const; |
| void runInEngine(QV4DebugJob *job); |
| |
| // compile-time interface |
| void maybeBreakAtInstruction() override; |
| |
| // execution hooks |
| void enteringFunction() override; |
| void leavingFunction(const QV4::ReturnedValue &retVal) override; |
| void aboutToThrow() override; |
| |
| bool pauseAtNextOpportunity() const override; |
| |
| signals: |
| void debuggerPaused(QV4Debugger *self, QV4Debugger::PauseReason reason); |
| void scheduleJob(); |
| |
| private: |
| // requires lock to be held |
| void pauseAndWait(PauseReason reason); |
| bool reallyHitTheBreakPoint(const QString &filename, int linenr); |
| void runInEngine_havingLock(QV4DebugJob *job); |
| void runJobUnpaused(); |
| |
| QV4::ExecutionEngine *m_engine; |
| QV4::CppStackFrame *m_currentFrame = 0; |
| QMutex m_lock; |
| QWaitCondition m_runningCondition; |
| State m_state; |
| Speed m_stepping; |
| bool m_pauseRequested; |
| bool m_haveBreakPoints; |
| bool m_breakOnThrow; |
| |
| QHash<BreakPoint, QString> m_breakPoints; |
| QV4::PersistentValue m_returnedValue; |
| |
| QV4DebugJob *m_gatherSources; |
| QV4DebugJob *m_runningJob; |
| QV4DataCollector m_collector; |
| QWaitCondition m_jobIsRunning; |
| }; |
| |
| QT_END_NAMESPACE |
| |
| Q_DECLARE_METATYPE(QV4Debugger::PauseReason) |
| Q_DECLARE_METATYPE(QV4Debugger*) |
| |
| #endif // QV4DEBUGGER_H |