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
|
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "utils_global.h"
#include "environment.h"
#include "commandline.h"
#include "processenums.h"
#include <QDeadlineTimer>
#include <QProcess>
#include <QSize>
namespace Utils {
namespace Internal { class ProcessPrivate; }
namespace Pty {
enum PtyInputFlag {
None = 0x0,
InputModeHidden = 0x1,
};
using ResizeHandler = std::function<void(const QSize &)>;
using PtyInputFlagsChangeHandler = std::function<void(PtyInputFlag)>;
class QTCREATOR_UTILS_EXPORT SharedData
{
public:
ResizeHandler m_handler;
PtyInputFlagsChangeHandler m_inputFlagsChangedHandler;
};
class QTCREATOR_UTILS_EXPORT Data
{
public:
Data() : m_data(new SharedData) {}
void setResizeHandler(const ResizeHandler &handler) { m_data->m_handler = handler; }
void setPtyInputFlagsChangedHandler(const PtyInputFlagsChangeHandler &handler)
{
m_data->m_inputFlagsChangedHandler = handler;
}
PtyInputFlagsChangeHandler ptyInputFlagsChangedHandler() const
{
return m_data->m_inputFlagsChangedHandler;
}
QSize size() const { return m_size; }
void resize(const QSize &size);
private:
QSize m_size{80, 60};
std::shared_ptr<SharedData> m_data;
};
} // namespace Pty
class QTCREATOR_UTILS_EXPORT ProcessRunData
{
public:
Utils::CommandLine command;
Utils::FilePath workingDirectory;
Utils::Environment environment;
};
class QTCREATOR_UTILS_EXPORT ProcessSetupData
{
public:
ProcessImpl m_processImpl = ProcessImpl::Default;
ProcessMode m_processMode = ProcessMode::Reader;
TerminalMode m_terminalMode = TerminalMode::Off;
std::optional<Pty::Data> m_ptyData;
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
std::chrono::milliseconds m_reaperTimeout{500};
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
bool m_createConsoleOnWindows = false;
};
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;
};
enum class ControlSignal {
Terminate,
Kill,
Interrupt,
KickOff,
CloseWriteChannel
};
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, QDeadlineTimer timeout) = 0;
friend class Internal::ProcessPrivate;
};
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 Process;
friend class Internal::ProcessPrivate;
};
} // namespace Utils
|
