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 QSCRIPTDEBUGGERCONSOLEGLOBALOBJECT_P_H 41 #define QSCRIPTDEBUGGERCONSOLEGLOBALOBJECT_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/qobject.h> 55 56 #include <QtCore/qstringlist.h> 57 58 #include "qscriptdebuggerconsolecommandgroupdata_p.h" 59 #include "qscriptdebuggerconsolecommand_p.h" 60 61 QT_BEGIN_NAMESPACE 62 63 class QScriptDebuggerCommandSchedulerInterface; 64 class QScriptMessageHandlerInterface; 65 class QScriptDebuggerResponseHandlerInterface; 66 class QScriptDebuggerConsole; 67 class QScriptDebuggerValue; 68 class QScriptDebuggerCommand; 69 class QScriptBreakpointData; 70 71 class QScriptDebuggerConsoleGlobalObjectPrivate; 72 class Q_AUTOTEST_EXPORT QScriptDebuggerConsoleGlobalObject 73 : public QObject 74 { 75 Q_OBJECT 76 public: 77 QScriptDebuggerConsoleGlobalObject(QObject *parent = 0); 78 ~QScriptDebuggerConsoleGlobalObject(); 79 80 QScriptDebuggerCommandSchedulerInterface *scheduler() const; 81 void setScheduler(QScriptDebuggerCommandSchedulerInterface *scheduler); 82 83 QScriptDebuggerResponseHandlerInterface *responseHandler() const; 84 void setResponseHandler(QScriptDebuggerResponseHandlerInterface *responseHandler); 85 86 QScriptMessageHandlerInterface *messageHandler() const; 87 void setMessageHandler(QScriptMessageHandlerInterface *messageHandler); 88 89 QScriptDebuggerConsole *console() const; 90 void setConsole(QScriptDebuggerConsole *console); 91 92 public Q_SLOTS: 93 // frontend 94 int scheduleInterrupt(); 95 int scheduleContinue(); 96 int scheduleStepInto(int count = 1); 97 int scheduleStepOver(int count = 1); 98 int scheduleStepOut(); 99 int scheduleRunToLocation(const QString &fileName, int lineNumber); 100 int scheduleRunToLocation(qint64 scriptId, int lineNumber); 101 int scheduleForceReturn(int contextIndex, const QScriptDebuggerValue &value); 102 103 int scheduleSetBreakpoint(const QScriptBreakpointData &data); 104 int scheduleDeleteBreakpoint(int id); 105 int scheduleDeleteAllBreakpoints(); 106 int scheduleGetBreakpoints(); 107 int scheduleGetBreakpointData(int id); 108 int scheduleSetBreakpointData(int id, const QScriptBreakpointData &data); 109 110 int scheduleGetScripts(); 111 int scheduleGetScriptData(qint64 id); 112 int scheduleScriptsCheckpoint(); 113 int scheduleGetScriptsDelta(); 114 int scheduleResolveScript(const QString &fileName); 115 116 int scheduleGetBacktrace(); 117 int scheduleGetThisObject(int contextIndex); 118 int scheduleGetActivationObject(int contextIndex); 119 int scheduleGetContextCount(); 120 int scheduleGetContextInfo(int contextIndex); 121 122 int scheduleNewScriptValueIterator(const QScriptDebuggerValue &object); 123 int scheduleGetPropertiesByIterator(int id, int count); 124 int scheduleDeleteScriptValueIterator(int id); 125 126 int scheduleEvaluate(int contextIndex, const QString &program, 127 const QString &fileName = QString(), 128 int lineNumber = 1); 129 130 int scheduleScriptValueToString(const QScriptDebuggerValue &value); 131 132 int scheduleClearExceptions(); 133 134 int scheduleCommand(const QScriptDebuggerCommand &command); 135 136 // message handler 137 void message(const QString &text, const QString &fileName = QString(), 138 int lineNumber = -1, int columnNumber = -1); 139 void warning(const QString &text, const QString &fileName = QString(), 140 int lineNumber = -1, int columnNumber = -1); 141 void error(const QString &text, const QString &fileName = QString(), 142 int lineNumber = -1, int columnNumber = -1); 143 144 // console state 145 int getCurrentFrameIndex() const; 146 void setCurrentFrameIndex(int index); 147 qint64 getCurrentScriptId() const; 148 void setCurrentScriptId(qint64 id); 149 qint64 getSessionId() const; 150 int getCurrentLineNumber() const; 151 void setCurrentLineNumber(int lineNumber); 152 153 // command introspection 154 QScriptDebuggerConsoleCommandGroupMap getCommandGroups() const; 155 QScriptDebuggerConsoleCommand *findCommand(const QString &command) const; 156 QScriptDebuggerConsoleCommandList getCommandsInGroup(const QString &name) const; 157 QStringList getCommandCompletions(const QString &prefix) const; 158 159 bool checkSyntax(const QString &program); 160 161 void setEvaluateAction(int action); 162 163 private: 164 Q_DECLARE_PRIVATE(QScriptDebuggerConsoleGlobalObject) 165 Q_DISABLE_COPY(QScriptDebuggerConsoleGlobalObject) 166 }; 167 168 QT_END_NAMESPACE 169 170 #endif 171