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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QBS_BUILDGRAPH_COMMAND_H
#define QBS_BUILDGRAPH_COMMAND_H
#include "forward_decls.h"
#include <tools/codelocation.h>
#include <tools/persistence.h>
#include <tools/set.h>
#include <QtCore/qprocess.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qvariant.h>
#include <QtScript/qscriptvalue.h>
namespace qbs {
namespace Internal {
class AbstractCommand
{
public:
virtual ~AbstractCommand();
enum CommandType {
ProcessCommandType,
JavaScriptCommandType
};
static QString defaultDescription() { return {}; }
static QString defaultExtendedDescription() { return {}; }
static QString defaultHighLight() { return {}; }
static bool defaultIgnoreDryRun() { return false; }
static bool defaultIsSilent() { return false; }
virtual CommandType type() const = 0;
virtual bool equals(const AbstractCommand *other) const;
virtual void fillFromScriptValue(const QScriptValue *scriptValue, const CodeLocation &codeLocation);
QString fullDescription(const QString &productName) const;
const QString description() const { return m_description; }
const QString extendedDescription() const { return m_extendedDescription; }
const QString highlight() const { return m_highlight; }
bool ignoreDryRun() const { return m_ignoreDryRun; }
bool isSilent() const { return m_silent; }
QString jobPool() const { return m_jobPool; }
CodeLocation codeLocation() const { return m_codeLocation; }
const QVariantMap &properties() const { return m_properties; }
virtual void load(PersistentPool &pool);
virtual void store(PersistentPool &pool);
protected:
AbstractCommand();
void applyCommandProperties(const QScriptValue *scriptValue);
Set<QString> m_predefinedProperties;
private:
template<PersistentPool::OpType opType> void serializationOp(PersistentPool &pool)
{
pool.serializationOp<opType>(m_description, m_extendedDescription, m_highlight,
m_ignoreDryRun, m_silent, m_codeLocation, m_jobPool,
m_properties);
}
QString m_description;
QString m_extendedDescription;
QString m_highlight;
bool m_ignoreDryRun;
bool m_silent;
CodeLocation m_codeLocation;
QString m_jobPool;
QVariantMap m_properties;
};
class ProcessCommand : public AbstractCommand
{
public:
static ProcessCommandPtr create() { return ProcessCommandPtr(new ProcessCommand); }
static void setupForJavaScript(QScriptValue targetObject);
CommandType type() const override { return ProcessCommandType; }
bool equals(const AbstractCommand *otherAbstractCommand) const override;
void fillFromScriptValue(const QScriptValue *scriptValue,
const CodeLocation &codeLocation) override;
const QString program() const { return m_program; }
const QStringList arguments() const { return m_arguments; }
const QString workingDir() const { return m_workingDir; }
int maxExitCode() const { return m_maxExitCode; }
QString stdoutFilterFunction() const { return m_stdoutFilterFunction; }
QString stderrFilterFunction() const { return m_stderrFilterFunction; }
int responseFileThreshold() const { return m_responseFileThreshold; }
int responseFileArgumentIndex() const { return m_responseFileArgumentIndex; }
QString responseFileUsagePrefix() const { return m_responseFileUsagePrefix; }
QProcessEnvironment environment() const { return m_environment; }
QStringList relevantEnvVars() const;
void clearRelevantEnvValues() { m_relevantEnvValues.clear(); }
void addRelevantEnvValue(const QString &key, const QString &value);
QString relevantEnvValue(const QString &key) const { return m_relevantEnvValues.value(key); }
QString stdoutFilePath() const { return m_stdoutFilePath; }
QString stderrFilePath() const { return m_stderrFilePath; }
void load(PersistentPool &pool) override;
void store(PersistentPool &pool) override;
private:
ProcessCommand();
int defaultResponseFileThreshold() const;
void getEnvironmentFromList(const QStringList &envList);
template<PersistentPool::OpType opType> void serializationOp(PersistentPool &pool)
{
pool.serializationOp<opType>(m_program, m_arguments, m_environment, m_workingDir,
m_stdoutFilterFunction, m_stderrFilterFunction,
m_responseFileUsagePrefix, m_maxExitCode,
m_responseFileThreshold, m_responseFileArgumentIndex,
m_relevantEnvVars, m_relevantEnvValues, m_stdoutFilePath,
m_stderrFilePath);
}
QString m_program;
QStringList m_arguments;
QString m_workingDir;
int m_maxExitCode;
QString m_stdoutFilterFunction;
QString m_stderrFilterFunction;
int m_responseFileThreshold; // When to use response files? In bytes of (program name + arguments).
int m_responseFileArgumentIndex;
QString m_responseFileUsagePrefix;
QProcessEnvironment m_environment;
QStringList m_relevantEnvVars;
QProcessEnvironment m_relevantEnvValues;
QString m_stdoutFilePath;
QString m_stderrFilePath;
};
class JavaScriptCommand : public AbstractCommand
{
public:
static JavaScriptCommandPtr create() { return JavaScriptCommandPtr(new JavaScriptCommand); }
static void setupForJavaScript(QScriptValue targetObject);
CommandType type() const override { return JavaScriptCommandType; }
bool equals(const AbstractCommand *otherAbstractCommand) const override;
void fillFromScriptValue(const QScriptValue *scriptValue,
const CodeLocation &codeLocation) override;
const QString &scopeName() const { return m_scopeName; }
const QString &sourceCode() const { return m_sourceCode; }
void setSourceCode(const QString &str) { m_sourceCode = str; }
void load(PersistentPool &pool) override;
void store(PersistentPool &pool) override;
private:
JavaScriptCommand();
template<PersistentPool::OpType opType> void serializationOp(PersistentPool &pool)
{
pool.serializationOp<opType>(m_scopeName, m_sourceCode);
}
QString m_scopeName;
QString m_sourceCode;
};
class CommandList
{
public:
bool empty() const { return m_commands.empty(); }
int size() const { return m_commands.size(); }
AbstractCommandPtr commandAt(int i) const { return m_commands.at(i); }
const QList<AbstractCommandPtr> &commands() const { return m_commands; }
void clear() { m_commands.clear(); }
void addCommand(const AbstractCommandPtr &cmd) { m_commands.push_back(cmd); }
void load(PersistentPool &pool);
void store(PersistentPool &pool) const;
private:
QList<AbstractCommandPtr> m_commands;
};
bool operator==(const CommandList &cl1, const CommandList &cl2);
inline bool operator!=(const CommandList &cl1, const CommandList &cl2) { return !(cl1 == cl2); }
} // namespace Internal
} // namespace qbs
#endif // QBS_BUILDGRAPH_COMMAND_H
|
