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
|
// Copyright (C) 2022 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 "environment.h"
#include "commandline.h"
#include "processenums.h"
#include <QProcess>
namespace Utils {
namespace Internal { class QtcProcessPrivate; }
class QTCREATOR_UTILS_EXPORT ProcessSetupData
{
public:
ProcessImpl m_processImpl = ProcessImpl::Default;
ProcessMode m_processMode = ProcessMode::Reader;
TerminalMode m_terminalMode = TerminalMode::Off;
CommandLine m_commandLine;
FilePath m_workingDirectory;
Environment m_environment;
Environment m_controlEnvironment;
QByteArray m_writeData;
QProcess::ProcessChannelMode m_processChannelMode = QProcess::SeparateChannels;
QVariantHash m_extraData;
QString m_standardInputFile;
QString m_nativeArguments; // internal, dependent on specific code path
int m_reaperTimeout = 500; // in ms
bool m_abortOnMetaChars = true;
bool m_runAsRoot = false;
bool m_lowPriority = false;
bool m_unixTerminalDisabled = false;
bool m_useCtrlCStub = false;
bool m_belowNormalPriority = false; // internal, dependent on other fields and specific code path
};
class QTCREATOR_UTILS_EXPORT ProcessResultData
{
public:
int m_exitCode = 0;
QProcess::ExitStatus m_exitStatus = QProcess::NormalExit;
QProcess::ProcessError m_error = QProcess::UnknownError;
QString m_errorString;
bool m_canceledByUser = false;
};
enum class ControlSignal {
Terminate,
Kill,
Interrupt,
KickOff
};
enum class ProcessSignalType {
Started,
ReadyRead,
Done
};
class QTCREATOR_UTILS_EXPORT ProcessBlockingInterface : public QObject
{
private:
// Wait for:
// - Started is being called only in Starting state.
// - ReadyRead is being called in Starting or Running state.
// - Done is being called in Starting or Running state.
virtual bool waitForSignal(ProcessSignalType signalType, int msecs) = 0;
friend class Internal::QtcProcessPrivate;
};
class QTCREATOR_UTILS_EXPORT ProcessInterface : public QObject
{
Q_OBJECT
signals:
// This should be emitted when being in Starting state only.
// After emitting this signal the process enters Running state.
void started(qint64 processId, qint64 applicationMainThreadId = 0);
// This should be emitted when being in Running state only.
void readyRead(const QByteArray &outputData, const QByteArray &errorData);
// This should be emitted when being in Starting or Running state.
// When being in Starting state, the resultData should set error to FailedToStart.
// After emitting this signal the process enters NotRunning state.
void done(const ProcessResultData &resultData);
protected:
static int controlSignalToInt(ControlSignal controlSignal);
ProcessSetupData m_setup;
private:
// It's being called only in Starting state. Just before this method is being called,
// the process transitions from NotRunning into Starting state.
virtual void start() = 0;
// It's being called only in Running state.
virtual qint64 write(const QByteArray &data) = 0;
// It's being called in Starting or Running state.
virtual void sendControlSignal(ControlSignal controlSignal) = 0;
virtual ProcessBlockingInterface *processBlockingInterface() const { return nullptr; }
friend class QtcProcess;
friend class Internal::QtcProcessPrivate;
};
} // namespace Utils
|
