src/plugins/debugger/script/scriptengine.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef DEBUGGER_SCRIPTENGINE_H
  34 #define DEBUGGER_SCRIPTENGINE_H
  35
  36 #include "debuggerengine.h"
  37
  38 #include <QtCore/QSharedPointer>
  39 #include <QtCore/QScopedPointer>
  40 #include <QtCore/QHash>
  41
  42 QT_BEGIN_NAMESPACE
  43 class QScriptEngine;
  44 class QScriptValue;
  45 QT_END_NAMESPACE
  46
  47 namespace Debugger {
  48 namespace Internal {
  49
  50 class ScriptAgent;
  51 class WatchData;
  52
  53 /* A debugger engine for a QScriptEngine implemented using a QScriptEngineAgent.
  54  * listening on script events. The engine has a special execution model:
  55  * The script is executed in the foreground, while the debugger runs in
  56  * processEvents() triggered by QScriptEngine::setProcessEventsInterval().
  57  * Stopping is emulated by manually calling processEvents() from the debugger engine. */
  58
  59 class ScriptEngine : public Debugger::DebuggerEngine
  60 {
  61     Q_OBJECT
  62
  63 public:
  64     explicit ScriptEngine(const DebuggerStartParameters &startParameters);
  65     virtual ~ScriptEngine();
  66
  67 private:
  68     // DebuggerEngine implementation
  69     void executeStep();
  70     void executeStepOut();
  71     void executeNext();
  72     void executeStepI();
  73     void executeNextI();
  74
  75     bool setToolTipExpression(const QPoint &mousePos,
  76         TextEditor::ITextEditor *editor, const DebuggerToolTipContext &);
  77     void setupEngine();
  78     void setupInferior();
  79     void runEngine();
  80     void shutdownInferior();
  81     void shutdownEngine();
  82
  83     void continueInferior();
  84     void interruptInferior();
  85
  86     void executeRunToLine(const ContextData &data);
  87     void executeRunToFunction(const QString &functionName);
  88     void executeJumpToLine(const ContextData &data);
  89
  90     void activateFrame(int index);
  91     void selectThread(int index);
  92
  93     bool acceptsBreakpoint(BreakpointId id) const;
  94     void attemptBreakpointSynchronization();
  95
  96     void assignValueInDebugger(const WatchData *w,
  97         const QString &expr, const QVariant &value);
  98     void executeDebuggerCommand(const QString &command);
  99
 100     void loadSymbols(const QString &moduleName);
 101     void loadAllSymbols();
 102     void requestModuleSymbols(const QString &moduleName);
 103     void reloadModules();
 104     void reloadRegisters() {}
 105     void reloadSourceFiles() {}
 106     void reloadFullStack() {}
 107
 108     bool supportsThreads() const { return true; }
 109     bool checkForBreakCondition(bool byFunction);
 110     void updateWatchData(const WatchData &data, const WatchUpdateFlags &flags);
 111     void updateLocals();
 112     void updateSubItem(const WatchData &data);
 113
 114 private:
 115     friend class ScriptAgent;
 116
 117     void importExtensions();
 118
 119     QSharedPointer<QScriptEngine> m_scriptEngine;
 120     QString m_scriptContents;
 121     QString m_scriptFileName;
 122     QScopedPointer<ScriptAgent> m_scriptAgent;
 123     QHash<quint64,QScriptValue> m_watchIdToScriptValue;
 124     quint64 m_watchIdCounter;
 125
 126     bool m_stopped;
 127     bool m_stopOnNextLine;
 128 };
 129
 130 } // namespace Internal
 131 } // namespace Debugger
 132
 133 #endif // DEBUGGER_SCRIPTENGINE_H