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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#pragma once
#include "utils_global.h"
#include "commandline.h"
#include "processenums.h"
#include "tasktree.h"
#include <QProcess>
QT_BEGIN_NAMESPACE
class QDebug;
class QTextCodec;
QT_END_NAMESPACE
class tst_QtcProcess;
namespace Utils {
namespace Internal { class QtcProcessPrivate; }
class Environment;
class DeviceProcessHooks;
class ProcessInterface;
class ProcessResultData;
class QTCREATOR_UTILS_EXPORT QtcProcess final : public QObject
{
Q_OBJECT
public:
QtcProcess(QObject *parent = nullptr);
~QtcProcess();
// ProcessInterface related
void start();
void terminate();
void kill();
void interrupt();
void kickoffProcess();
void close();
void stop();
QByteArray readAllStandardOutput();
QByteArray readAllStandardError();
qint64 write(const QString &input);
qint64 writeRaw(const QByteArray &input);
qint64 processId() const;
qint64 applicationMainThreadId() const;
QProcess::ProcessState state() const;
ProcessResultData resultData() const;
int exitCode() const;
QProcess::ExitStatus exitStatus() const;
QProcess::ProcessError error() const;
QString errorString() const;
bool waitForStarted(int msecs = 30000);
bool waitForReadyRead(int msecs = 30000);
bool waitForFinished(int msecs = 30000);
// ProcessSetupData related
void setProcessImpl(ProcessImpl processImpl);
void setTerminalMode(TerminalMode mode);
TerminalMode terminalMode() const;
bool usesTerminal() const { return terminalMode() != TerminalMode::Off; }
void setProcessMode(ProcessMode processMode);
ProcessMode processMode() const;
void setEnvironment(const Environment &env); // Main process
const Environment &environment() const;
void setControlEnvironment(const Environment &env); // Possible helper process (ssh on host etc)
const Environment &controlEnvironment() const;
void setCommand(const CommandLine &cmdLine);
const CommandLine &commandLine() const;
void setWorkingDirectory(const FilePath &dir);
FilePath workingDirectory() const;
void setWriteData(const QByteArray &writeData);
void setUseCtrlCStub(bool enabled); // release only
void setLowPriority();
void setDisableUnixTerminal();
void setRunAsRoot(bool on);
bool isRunAsRoot() const;
void setAbortOnMetaChars(bool abort);
QProcess::ProcessChannelMode processChannelMode() const;
void setProcessChannelMode(QProcess::ProcessChannelMode mode);
void setStandardInputFile(const QString &inputFile);
void setExtraData(const QString &key, const QVariant &value);
QVariant extraData(const QString &key) const;
void setExtraData(const QVariantHash &extraData);
QVariantHash extraData() const;
void setReaperTimeout(int msecs);
int reaperTimeout() const;
static void setRemoteProcessHooks(const DeviceProcessHooks &hooks);
// TODO: Some usages of this method assume that Starting phase is also a running state
// i.e. if isRunning() returns false, they assume NotRunning state, what may be an error.
bool isRunning() const; // Short for state() == QProcess::Running.
// Other enhancements.
// These (or some of them) may be potentially moved outside of the class.
// For some we may aggregate in another public utils class (or subclass of QtcProcess)?
// TODO: How below 2 methods relate to QtcProcess?
// Action: move/merge them somewhere else, FilePath::searchInPath() ?
// Helpers to find binaries. Do not use it for other path variables
// and file types.
static QString locateBinary(const QString &path, const QString &binary);
static QString normalizeNewlines(const QString &text);
// TODO: Unused currently? Should it serve as a compartment for contrary of remoteEnvironment?
static Environment systemEnvironmentForBinary(const FilePath &filePath);
static bool startDetached(const CommandLine &cmd, const FilePath &workingDirectory = {},
qint64 *pid = nullptr);
// Starts the command and waits for finish.
// User input processing is enabled when EventLoopMode::On was passed.
void runBlocking(EventLoopMode eventLoopMode = EventLoopMode::Off);
/* Timeout for hanging processes (triggers after no more output
* occurs on stderr/stdout). */
void setTimeoutS(int timeoutS);
int timeoutS() const;
// TODO: We should specify the purpose of the codec, e.g. setCodecForStandardChannel()
void setCodec(QTextCodec *c);
void setTimeOutMessageBoxEnabled(bool);
void setExitCodeInterpreter(const ExitCodeInterpreter &interpreter);
void setStdOutCallback(const TextChannelCallback &callback);
void setStdOutLineCallback(const TextChannelCallback &callback);
void setStdErrCallback(const TextChannelCallback &callback);
void setStdErrLineCallback(const TextChannelCallback &callback);
void setTextChannelMode(Channel channel, TextChannelMode mode);
TextChannelMode textChannelMode(Channel channel) const;
bool readDataFromProcess(QByteArray *stdOut, QByteArray *stdErr, int timeoutS = 30);
ProcessResult result() const;
QByteArray allRawOutput() const;
QString allOutput() const;
QByteArray rawStdOut() const;
QString stdOut() const; // possibly with CR
QString stdErr() const; // possibly with CR
QString cleanedStdOut() const; // with sequences of CR squashed and CR LF replaced by LF
QString cleanedStdErr() const; // with sequences of CR squashed and CR LF replaced by LF
const QStringList stdOutLines() const; // split, CR removed
const QStringList stdErrLines() const; // split, CR removed
QString exitMessage() const;
QString toStandaloneCommandLine() const;
signals:
void starting(); // On NotRunning -> Starting state transition
void started(); // On Starting -> Running state transition
void done(); // On Starting | Running -> NotRunning state transition
void readyReadStandardOutput();
void readyReadStandardError();
void textOnStandardOutput(const QString &text);
void textOnStandardError(const QString &text);
private:
friend QTCREATOR_UTILS_EXPORT QDebug operator<<(QDebug str, const QtcProcess &r);
friend class Internal::QtcProcessPrivate;
Internal::QtcProcessPrivate *d = nullptr;
};
class DeviceProcessHooks
{
public:
std::function<ProcessInterface *(const FilePath &)> processImplHook;
std::function<Environment(const FilePath &)> systemEnvironmentForBinary;
};
class QTCREATOR_UTILS_EXPORT QtcProcessAdapter : public Tasking::TaskAdapter<QtcProcess>
{
public:
QtcProcessAdapter();
void start() final;
};
} // namespace Utils
QTC_DECLARE_CUSTOM_TASK(Process, Utils::QtcProcessAdapter);
|
