1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qqmldebugprocess_p.h"
#include <QtCore/qdebug.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qdir.h>
QQmlDebugProcess::QQmlDebugProcess(const QString &executable, QObject *parent)
: QObject(parent)
, m_executable(executable)
, m_state(SessionUnknown)
, m_port(0)
, m_maximumBindErrors(0)
, m_receivedBindErrors(0)
{
m_process.setProcessChannelMode(QProcess::MergedChannels);
m_timer.setInterval(15000);
connect(&m_process, &QProcess::readyReadStandardOutput,
this, &QQmlDebugProcess::processAppOutput);
connect(&m_process, &QProcess::errorOccurred,
this, &QQmlDebugProcess::processError);
connect(&m_process, QOverload<int, QProcess::ExitStatus>::of(&QProcess::finished),
this, [this]() {
m_timer.stop();
m_eventLoop.quit();
emit finished();
});
connect(&m_timer, &QTimer::timeout,
this, &QQmlDebugProcess::timeout);
}
QQmlDebugProcess::~QQmlDebugProcess()
{
stop();
}
QString QQmlDebugProcess::stateString() const
{
QString stateStr;
switch (m_process.state()) {
case QProcess::NotRunning: {
stateStr = "not running";
if (m_process.exitStatus() == QProcess::CrashExit)
stateStr += " (crashed!)";
else
stateStr += ", return value " + QString::number(m_process.exitCode());
break;
}
case QProcess::Starting:
stateStr = "starting";
break;
case QProcess::Running:
stateStr = "running";
break;
}
return stateStr;
}
void QQmlDebugProcess::start(const QStringList &arguments)
{
#ifdef Q_OS_MAC
// make sure m_executable points to the actual binary even if it's inside an app bundle
QFileInfo binFile(m_executable);
if (!binFile.isExecutable()) {
QDir bundleDir(m_executable + ".app");
if (bundleDir.exists()) {
m_executable = bundleDir.absoluteFilePath("Contents/MacOS/" + binFile.baseName());
//qDebug() << Q_FUNC_INFO << "found bundled binary" << m_executable;
}
}
#endif
m_mutex.lock();
m_port = 0;
m_process.setEnvironment(QProcess::systemEnvironment() + m_environment);
m_process.start(m_executable, arguments);
if (!m_process.waitForStarted()) {
qWarning() << "QML Debug Client: Could not launch app " << m_executable
<< ": " << m_process.errorString();
m_eventLoop.quit();
}
m_mutex.unlock();
}
void QQmlDebugProcess::stop()
{
if (m_process.state() != QProcess::NotRunning) {
disconnect(&m_process, &QProcess::errorOccurred, this, &QQmlDebugProcess::processError);
m_process.kill();
m_process.waitForFinished(5000);
}
}
void QQmlDebugProcess::setMaximumBindErrors(int ignore)
{
m_maximumBindErrors = ignore;
}
void QQmlDebugProcess::timeout()
{
qWarning() << "Timeout while waiting for QML debugging messages "
"in application output. Process is in state" << m_process.state()
<< ", Output:" << m_output << ".";
}
bool QQmlDebugProcess::waitForSessionStart()
{
if (m_process.state() != QProcess::Running) {
qWarning() << "Could not start up " << m_executable;
return false;
} else if (m_state == SessionStarted) {
return true;
} else if (m_state == SessionFailed) {
return false;
}
m_timer.start();
m_eventLoop.exec();
return m_state == SessionStarted;
}
int QQmlDebugProcess::debugPort() const
{
return m_port;
}
bool QQmlDebugProcess::waitForFinished()
{
return m_process.waitForFinished();
}
QProcess::ProcessState QQmlDebugProcess::state() const
{
return m_process.state();
}
QProcess::ExitStatus QQmlDebugProcess::exitStatus() const
{
return m_process.exitStatus();
}
void QQmlDebugProcess::addEnvironment(const QString &environment)
{
m_environment.append(environment);
}
QString QQmlDebugProcess::output() const
{
return m_output;
}
void QQmlDebugProcess::processAppOutput()
{
m_mutex.lock();
bool outputFromAppItself = false;
QString newOutput = m_process.readAll();
m_output.append(newOutput);
m_outputBuffer.append(newOutput);
while (true) {
const int nlIndex = m_outputBuffer.indexOf(QLatin1Char('\n'));
if (nlIndex < 0) // no further complete lines
break;
const QString line = m_outputBuffer.left(nlIndex);
m_outputBuffer = m_outputBuffer.right(m_outputBuffer.size() - nlIndex - 1);
if (line.contains("QML Debugger:")) {
const QRegExp portRx("Waiting for connection on port (\\d+)");
if (portRx.indexIn(line) != -1) {
m_port = portRx.cap(1).toInt();
m_timer.stop();
m_state = SessionStarted;
m_eventLoop.quit();
continue;
}
if (line.contains("Unable to listen")) {
if (++m_receivedBindErrors >= m_maximumBindErrors) {
if (m_maximumBindErrors == 0)
qWarning() << "App was unable to bind to port!";
m_timer.stop();
m_state = SessionFailed;
m_eventLoop.quit();
}
continue;
}
}
// set to true if there is output not coming from the debugger or we don't understand it
outputFromAppItself = true;
}
m_mutex.unlock();
if (outputFromAppItself)
emit readyReadStandardOutput();
}
void QQmlDebugProcess::processError(QProcess::ProcessError error)
{
qDebug() << "An error occurred while waiting for debug process to become available:";
switch (error) {
case QProcess::FailedToStart:
qDebug() << "Process failed to start.";
break;
case QProcess::Crashed:
qDebug() << "Process crashed.";
break;
case QProcess::Timedout:
qDebug() << "Process timed out.";
break;
case QProcess::WriteError:
qDebug() << "Error while writing to process.";
break;
case QProcess::ReadError:
qDebug() << "Error while reading from process.";
break;
case QProcess::UnknownError:
qDebug() << "Unknown process error.";
break;
}
}
|
