qmlengine.h 6.85 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
30

Kai Koehne's avatar
Kai Koehne committed
31 32
#ifndef QMLENGINE_H
#define QMLENGINE_H
33

Kai Koehne's avatar
Kai Koehne committed
34 35 36
#include "interactiveinterpreter.h"
#include "qmladapter.h"
#include "qmlinspectoradapter.h"
37
#include <debugger/debuggerengine.h>
Kai Koehne's avatar
Kai Koehne committed
38 39

#include <projectexplorer/applicationlauncher.h>
40
#include <qmldebug/qdebugmessageclient.h>
Kai Koehne's avatar
Kai Koehne committed
41
#include <qmldebug/qmloutputparser.h>
42
#include <qmljs/iscriptevaluator.h>
43
#include <qmljs/qmljsdocument.h>
hjk's avatar
hjk committed
44

45
QT_FORWARD_DECLARE_CLASS(QTextDocument)
46

47
namespace Core { class IDocument; }
48

49 50
namespace TextEditor { class BaseTextEditor; }

51
namespace Debugger {
52
namespace Internal {
53

54
class QmlAdapter;
55
class WatchTreeView;
56

57
class QmlEngine : public DebuggerEngine, QmlJS::IScriptEvaluator
58 59 60 61
{
    Q_OBJECT

public:
Aurindam Jana's avatar
Aurindam Jana committed
62 63
    explicit QmlEngine(const DebuggerStartParameters &startParameters,
                       DebuggerEngine *masterEngine = 0);
64
    ~QmlEngine();
65

Aurindam Jana's avatar
Aurindam Jana committed
66
    void notifyEngineRemoteServerRunning(const QByteArray &, int pid);
67
    void notifyEngineRemoteSetupFinished(const RemoteSetupResult &result);
68

69
    bool canDisplayTooltip() const;
70

71 72
    void showMessage(const QString &msg, int channel = LogDebug,
                     int timeout = -1) const;
73 74
    void gotoLocation(const Internal::Location &location);

75
    void filterApplicationMessage(const QString &msg, int channel);
76 77
    void inferiorSpontaneousStop();

Kai Koehne's avatar
Kai Koehne committed
78 79 80 81 82 83 84
    enum LogDirection {
        LogSend,
        LogReceive
    };

    void logMessage(const QString &service, LogDirection direction,
                    const QString &str);
85

86
    void setSourceFiles(const QStringList &fileNames);
Kai Koehne's avatar
Kai Koehne committed
87 88
    void updateScriptSource(const QString &fileName, int lineOffset,
                            int columnOffset, const QString &source);
89

90
    void insertBreakpoint(Breakpoint bp);
91

Kai Koehne's avatar
Kai Koehne committed
92
signals:
93
    void tooltipRequested(const DebuggerToolTipContext &context);
Kai Koehne's avatar
Kai Koehne committed
94 95

private slots:
96
    void disconnected();
97
    void documentUpdated(QmlJS::Document::Ptr doc);
98
    void expressionEvaluated(quint32 queryId, const QVariant &result);
99

100
    void errorMessageBoxFinished(int result);
101
    void updateCurrentContext();
102
    void appendDebugOutput(QtMsgType type, const QString &message,
103
                           const QmlDebug::QDebugContextInfo &info);
104

Kai Koehne's avatar
Kai Koehne committed
105 106 107 108 109
    void tryToConnect(quint16 port = 0);
    void beginConnection(quint16 port = 0);
    void connectionEstablished();
    void connectionStartupFailed();
    void appStartupFailed(const QString &errorMessage);
110
    void connectionError(QDebugSupport::Error error);
Kai Koehne's avatar
Kai Koehne committed
111 112 113 114 115
    void serviceConnectionError(const QString &service);
    void appendMessage(const QString &msg, Utils::OutputFormat);

    void synchronizeWatchers();

116
private:
117
    // DebuggerEngine implementation.
hjk's avatar
hjk committed
118
    bool isSynchronous() const { return false; }
119 120 121 122 123 124
    void executeStep();
    void executeStepOut();
    void executeNext();
    void executeStepI();
    void executeNextI();

hjk's avatar
hjk committed
125
    void setupEngine();
hjk's avatar
hjk committed
126 127 128 129 130
    void setupInferior();
    void runEngine();
    void shutdownInferior();
    void shutdownEngine();

131
    bool setToolTipExpression(const DebuggerToolTipContext &);
132 133 134 135

    void continueInferior();
    void interruptInferior();

136
    void executeRunToLine(const ContextData &data);
137
    void executeRunToFunction(const QString &functionName);
138
    void executeJumpToLine(const ContextData &data);
139 140

    void activateFrame(int index);
hjk's avatar
hjk committed
141
    void selectThread(ThreadId threadId);
142 143

    void attemptBreakpointSynchronization();
144 145 146
    void removeBreakpoint(Breakpoint bp);
    void changeBreakpoint(Breakpoint bp);
    bool acceptsBreakpoint(Breakpoint bp) const;
147

148
    void assignValueInDebugger(const WatchData *data,
hjk's avatar
hjk committed
149
        const QString &expr, const QVariant &value);
150 151


152 153 154 155 156
    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();
    void requestModuleSymbols(const QString &moduleName);
    void reloadModules();
    void reloadRegisters() {}
157
    void reloadSourceFiles();
158 159
    void reloadFullStack() {}

Olivier Goffart's avatar
Olivier Goffart committed
160
    bool supportsThreads() const { return false; }
hjk's avatar
hjk committed
161
    void updateWatchData(const WatchData &data);
162
    void watchDataSelected(const QByteArray &iname);
163
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
164
    bool evaluateScript(const QString &expression);
165

166
    bool hasCapability(unsigned) const;
167
    void quitDebugger();
168

169
private:
170 171 172 173
    void closeConnection();
    void startApplicationLauncher();
    void stopApplicationLauncher();

174 175
    bool isShadowBuildProject() const;
    QString fromShadowBuildFilename(const QString &filename) const;
hjk's avatar
hjk committed
176 177
    QString mangleFilenamePaths(const QString &filename,
        const QString &oldBasePath, const QString &newBasePath) const;
178 179
    QString qmlImportPath() const;

180
    void updateDocument(Core::IDocument *document, const QTextDocument *textDocument);
181
    bool canEvaluateScript(const QString &script);
182 183
    bool adjustBreakpointLineAndColumn(const QString &filePath, quint32 *line,
                                       quint32 *column, bool *valid);
184

Kai Koehne's avatar
Kai Koehne committed
185 186 187 188
    QmlAdapter m_adapter;
    QmlInspectorAdapter m_inspectorAdapter;
    ProjectExplorer::ApplicationLauncher m_applicationLauncher;
    QTimer m_noDebugOutputTimer;
Kai Koehne's avatar
Kai Koehne committed
189
    QmlDebug::QmlOutputParser m_outputParser;
Kai Koehne's avatar
Kai Koehne committed
190
    QHash<QString, QTextDocument*> m_sourceDocuments;
191
    QHash<QString, QWeakPointer<TextEditor::BaseTextEditor> > m_sourceEditors;
Kai Koehne's avatar
Kai Koehne committed
192
    InteractiveInterpreter m_interpreter;
193
    QHash<QString,Breakpoint> pendingBreakpoints;
Kai Koehne's avatar
Kai Koehne committed
194 195 196 197
    QList<quint32> queryIds;
    bool m_retryOnConnectFail;
    bool m_automaticConnect;

198
    friend class QmlCppEngine;
199 200
};

201
} // namespace Internal
202 203
} // namespace Debugger

Kai Koehne's avatar
Kai Koehne committed
204
#endif // QMLENGINE_H