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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** 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.
**
****************************************************************************/
#pragma once
#include "utils_global.h"
#include "environment.h"
#include "commandline.h"
#include "processutils.h"
#include <QProcess>
#include <QTextCodec>
#include <functional>
QT_FORWARD_DECLARE_CLASS(QDebug)
class tst_QtcProcess;
namespace Utils {
class CommandLine;
class Environment;
class QtcProcess;
namespace Internal { class QtcProcessPrivate; }
class DeviceProcessHooks
{
public:
std::function<void(QtcProcess &)> startProcessHook;
std::function<Environment(const FilePath &)> systemEnvironmentForBinary;
};
class QTCREATOR_UTILS_EXPORT QtcProcess : public QObject
{
Q_OBJECT
public:
enum ProcessImpl {
QProcessImpl,
ProcessLauncherImpl
};
QtcProcess(ProcessImpl processImpl, ProcessMode processMode, QObject *parent = nullptr);
QtcProcess(ProcessImpl processImpl, QObject *parent = nullptr);
QtcProcess(ProcessMode processMode, QObject *parent = nullptr);
QtcProcess(QObject *parent = nullptr);
~QtcProcess();
ProcessMode processMode() const;
enum Result {
// Finished successfully. Unless an ExitCodeInterpreter is set
// this corresponds to a return code 0.
FinishedWithSuccess,
Finished = FinishedWithSuccess, // FIXME: Kept to ease downstream transition
// Finished unsuccessfully. Unless an ExitCodeInterpreter is set
// this corresponds to a return code different from 0.
FinishedWithError,
FinishedError = FinishedWithError, // FIXME: Kept to ease downstream transition
// Process terminated abnormally (kill)
TerminatedAbnormally,
// Executable could not be started
StartFailed,
// Hang, no output after time out
Hang
};
void setEnvironment(const Environment &env);
void unsetEnvironment();
const Environment &environment() const;
void setCommand(const CommandLine &cmdLine);
const CommandLine &commandLine() const;
FilePath workingDirectory() const;
void setWorkingDirectory(const FilePath &dir);
void setWorkingDirectory(const QString &dir); // FIXME: Kept to ease downstream transition
void setUseCtrlCStub(bool enabled);
void setLowPriority();
void setDisableUnixTerminal();
void setRunAsRoot(bool on);
void setUseTerminal(bool on);
bool useTerminal() const;
void start();
void terminate();
void interrupt();
static bool startDetached(const CommandLine &cmd, const FilePath &workingDirectory = {},
qint64 *pid = nullptr);
// Starts the command and waits for finish. User input processing depends
// on whether setProcessUserEventWhileRunning was called.
void runBlocking();
// This starts a nested event loop when running the command.
void setProcessUserEventWhileRunning(); // Avoid.
/* Timeout for hanging processes (triggers after no more output
* occurs on stderr/stdout). */
void setTimeoutS(int timeoutS);
void setCodec(QTextCodec *c);
void setTimeOutMessageBoxEnabled(bool);
void setExitCodeInterpreter(const std::function<QtcProcess::Result(int)> &interpreter);
// FIXME: This is currently only used in run(), not in start()
void setWriteData(const QByteArray &writeData);
void setStdOutCallback(const std::function<void(const QString &)> &callback);
void setStdOutLineCallback(const std::function<void(const QString &)> &callback);
void setStdErrCallback(const std::function<void(const QString &)> &callback);
void setStdErrLineCallback(const std::function<void(const QString &)> &callback);
static void setRemoteProcessHooks(const DeviceProcessHooks &hooks);
bool stopProcess();
bool readDataFromProcess(int timeoutS, QByteArray *stdOut, QByteArray *stdErr,
bool showTimeOutMessageBox);
static QString normalizeNewlines(const QString &text);
Result result() const;
void setResult(Result result);
QByteArray allRawOutput() const;
QString allOutput() const;
QString stdOut() const;
QString stdErr() const;
QByteArray rawStdOut() const;
int exitCode() const;
QString exitMessage();
// Helpers to find binaries. Do not use it for other path variables
// and file types.
static QString locateBinary(const QString &binary);
static QString locateBinary(const QString &path, const QString &binary);
static Environment systemEnvironmentForBinary(const FilePath &filePath);
// FIXME: Cut down the following bits inherited from QProcess and QIODevice.
void setProcessChannelMode(QProcess::ProcessChannelMode mode);
QProcess::ProcessError error() const;
QProcess::ProcessState state() const;
bool isRunning() const; // Short for state() == QProcess::Running.
QString errorString() const;
void setErrorString(const QString &str);
qint64 processId() const;
bool waitForStarted(int msecs = 30000);
bool waitForReadyRead(int msecs = 30000);
bool waitForFinished(int msecs = 30000);
QByteArray readAllStandardOutput();
QByteArray readAllStandardError();
QProcess::ExitStatus exitStatus() const;
void kill();
qint64 write(const QByteArray &input);
void close();
void setStandardInputFile(const QString &inputFile);
QString toStandaloneCommandLine() const;
signals:
void started();
void finished();
void errorOccurred(QProcess::ProcessError error);
void readyReadStandardOutput();
void readyReadStandardError();
private:
friend QTCREATOR_UTILS_EXPORT QDebug operator<<(QDebug str, const QtcProcess &r);
Internal::QtcProcessPrivate *d = nullptr;
friend tst_QtcProcess;
void beginFeed();
void feedStdOut(const QByteArray &data);
void endFeed();
};
using ExitCodeInterpreter = std::function<QtcProcess::Result(int /*exitCode*/)>;
QTCREATOR_UTILS_EXPORT QDebug operator<<(QDebug str, const QtcProcess &);
} // namespace Utils
|
