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
|
/****************************************************************************
**
** 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 <QProcess>
#include <QVector>
QT_BEGIN_NAMESPACE
class QSettings;
QT_END_NAMESPACE
namespace Utils {
class Environment;
struct ConsoleProcessPrivate;
class QTCREATOR_UTILS_EXPORT TerminalCommand
{
public:
TerminalCommand() = default;
TerminalCommand(const QString &command, const QString &openArgs, const QString &executeArgs);
bool operator==(const TerminalCommand &other) const;
bool operator<(const TerminalCommand &other) const;
QString command;
QString openArgs;
QString executeArgs;
};
class QTCREATOR_UTILS_EXPORT ConsoleProcess : public QObject
{
Q_OBJECT
public:
enum Mode { Run, Debug, Suspend };
ConsoleProcess(QObject *parent = nullptr);
~ConsoleProcess() override;
void setWorkingDirectory(const QString &dir);
QString workingDirectory() const;
void setEnvironment(const Environment &env);
Environment environment() const;
QProcess::ProcessError error() const;
QString errorString() const;
enum class MetaCharMode { Abort, Ignore };
bool start(const QString &program, const QString &args,
MetaCharMode metaCharMode = MetaCharMode::Abort);
public slots:
void stop();
public:
void setMode(Mode m);
Mode mode() const;
bool isRunning() const; // This reflects the state of the console+stub
qint64 applicationPID() const;
void killProcess();
void killStub();
qint64 applicationMainThreadID() const;
#ifndef Q_OS_WIN
void detachStub();
#endif
int exitCode() const;
QProcess::ExitStatus exitStatus() const;
#ifdef Q_OS_WIN
// Add PATH and SystemRoot environment variables in case they are missing
static QStringList fixWinEnvironment(const QStringList &env);
// Quote a Windows command line correctly for the "CreateProcess" API
static QString createWinCommandline(const QString &program, const QStringList &args);
static QString createWinCommandline(const QString &program, const QString &args);
#endif
#ifndef Q_OS_WIN
void setSettings(QSettings *settings);
static TerminalCommand defaultTerminalEmulator();
static QVector<TerminalCommand> availableTerminalEmulators();
static TerminalCommand terminalEmulator(const QSettings *settings);
static void setTerminalEmulator(QSettings *settings, const TerminalCommand &term);
#else
void setSettings(QSettings *) {}
static TerminalCommand defaultTerminalEmulator() { return TerminalCommand(); }
static QVector<TerminalCommand> availableTerminalEmulators() { return {}; }
static TerminalCommand terminalEmulator(const QSettings *) { return TerminalCommand(); }
static void setTerminalEmulator(QSettings *, const TerminalCommand &) {}
#endif
static bool startTerminalEmulator(QSettings *settings, const QString &workingDir,
const Utils::Environment &env);
signals:
void error(QProcess::ProcessError error);
void processError(const QString &errorString);
// These reflect the state of the actual client process
void processStarted();
void processStopped(int, QProcess::ExitStatus);
// These reflect the state of the console+stub
void stubStarted();
void stubStopped();
private:
void stubConnectionAvailable();
void readStubOutput();
void stubExited();
#ifdef Q_OS_WIN
void inferiorExited();
#endif
static QString modeOption(Mode m);
static QString msgCommChannelFailed(const QString &error);
static QString msgPromptToClose();
static QString msgCannotCreateTempFile(const QString &why);
static QString msgCannotWriteTempFile();
static QString msgCannotCreateTempDir(const QString & dir, const QString &why);
static QString msgUnexpectedOutput(const QByteArray &what);
static QString msgCannotChangeToWorkDir(const QString & dir, const QString &why);
static QString msgCannotExecute(const QString & p, const QString &why);
void emitError(QProcess::ProcessError err, const QString &errorString);
QString stubServerListen();
void stubServerShutdown();
#ifdef Q_OS_WIN
void cleanupStub();
void cleanupInferior();
#endif
ConsoleProcessPrivate *d;
};
} //namespace Utils
Q_DECLARE_METATYPE(Utils::TerminalCommand)
|
