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
|
/****************************************************************************
**
** Copyright (C) 2016 Brian McGillion and Hugues Delorme
** 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 "filepath.h"
#include "processenums.h"
#include <QObject>
QT_BEGIN_NAMESPACE
class QMutex;
class QVariant;
template <typename T>
class QFutureInterface;
template <typename T>
class QFuture;
class QTextCodec;
QT_END_NAMESPACE
namespace Utils {
class CommandLine;
class Environment;
class QtcProcess;
namespace Internal { class ShellCommandPrivate; }
class QTCREATOR_UTILS_EXPORT ProgressParser
{
public:
ProgressParser();
virtual ~ProgressParser();
protected:
virtual void parseProgress(const QString &text) = 0;
void setProgressAndMaximum(int value, int maximum);
private:
void setFuture(QFutureInterface<void> *future);
QFutureInterface<void> *m_future;
QMutex *m_futureMutex = nullptr;
friend class ShellCommand;
};
class QTCREATOR_UTILS_EXPORT ShellCommand : public QObject
{
Q_OBJECT
public:
// Convenience to synchronously run commands
enum RunFlags {
ShowStdOut = 0x1, // Show standard output.
MergeOutputChannels = 0x2, // see QProcess: Merge stderr/stdout.
SuppressStdErr = 0x4, // Suppress standard error output.
SuppressFailMessage = 0x8, // No message about command failure.
SuppressCommandLogging = 0x10, // No command log entry.
ShowSuccessMessage = 0x20, // Show message about successful completion of command.
ForceCLocale = 0x40, // Force C-locale for commands whose output is parsed.
FullySynchronously = 0x80, // Suppress local event loop (in case UI actions are
// triggered by file watchers).
SilentOutput = 0x100, // Suppress user notifications about the output happening.
NoFullySync = 0x200, // Avoid fully synchronous execution even in UI thread.
NoOutput = SuppressStdErr | SuppressFailMessage | SuppressCommandLogging
};
ShellCommand(const FilePath &workingDirectory, const Environment &environment);
~ShellCommand() override;
QString displayName() const;
void setDisplayName(const QString &name);
void addJob(const CommandLine &command,
const FilePath &workingDirectory = {},
const ExitCodeInterpreter &interpreter = {});
void addJob(const CommandLine &command, int timeoutS,
const FilePath &workingDirectory = {},
const ExitCodeInterpreter &interpreter = {});
void execute(); // Execute tasks asynchronously!
void abort();
bool lastExecutionSuccess() const;
int lastExecutionExitCode() const;
const FilePath &defaultWorkingDirectory() const;
virtual const Environment processEnvironment() const;
int defaultTimeoutS() const;
void setDefaultTimeoutS(int timeout);
unsigned flags() const;
void addFlags(unsigned f);
const QVariant &cookie() const;
void setCookie(const QVariant &cookie);
QTextCodec *codec() const;
void setCodec(QTextCodec *codec);
void setProgressParser(ProgressParser *parser);
bool hasProgressParser() const;
void setProgressiveOutput(bool progressive);
void setDisableUnixTerminal();
// This is called once per job in a thread.
// When called from the UI thread it will execute fully synchronously, so no signals will
// be triggered!
virtual void runCommand(QtcProcess &process,
const CommandLine &command,
const FilePath &workingDirectory = {});
void cancel();
signals:
void stdOutText(const QString &);
void stdErrText(const QString &);
void started();
void finished(bool ok, int exitCode, const QVariant &cookie);
void success(const QVariant &cookie);
void terminate(); // Internal
void append(const QString &text);
void appendSilently(const QString &text);
void appendError(const QString &text);
void appendCommand(const Utils::FilePath &workingDirectory, const Utils::CommandLine &command);
void appendMessage(const QString &text);
protected:
virtual void addTask(QFuture<void> &future);
int timeoutS() const;
FilePath workDirectory(const FilePath &wd) const;
private:
void run(QFutureInterface<void> &future);
// Run without a event loop in fully blocking mode. No signals will be delivered.
void runFullySynchronous(QtcProcess &proc, const FilePath &workingDirectory);
// Run with an event loop. Signals will be delivered.
void runSynchronous(QtcProcess &proc, const FilePath &workingDirectory);
class Internal::ShellCommandPrivate *const d;
};
} // namespace Utils
|
