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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "customwizardscriptgenerator.h"
#include "customwizard.h"
#include "customwizardparameters.h"
#include <utils/environment.h>
#include <utils/fileutils.h>
#include <utils/hostosinfo.h>
#include <utils/qtcprocess.h>
#include <utils/temporarydirectory.h>
#include <QFileInfo>
#include <QDebug>
using namespace Utils;
namespace ProjectExplorer {
namespace Internal {
// Parse helper: Determine the correct binary to run:
// Expand to full wizard path if it is relative and located
// in the wizard directory, else assume it can be found in path.
// On Windows, run non-exe files with 'cmd /c'.
QStringList fixGeneratorScript(const QString &configFile, QString binary)
{
if (binary.isEmpty())
return {};
// Expand to full path if it is relative and in the wizard
// directory, else assume it can be found in path.
QFileInfo binaryInfo(binary);
if (!binaryInfo.isAbsolute()) {
QString fullPath = QFileInfo(configFile).absolutePath();
fullPath += QLatin1Char('/');
fullPath += binary;
const QFileInfo fullPathInfo(fullPath);
if (fullPathInfo.isFile()) {
binary = fullPathInfo.absoluteFilePath();
binaryInfo = fullPathInfo;
}
} // not absolute
QStringList rc(binary);
if (Utils::HostOsInfo::isWindowsHost()) { // Windows: Cannot run scripts by QProcess, do 'cmd /c'
const QString extension = binaryInfo.suffix();
if (!extension.isEmpty() && extension.compare(QLatin1String("exe"),
Qt::CaseInsensitive) != 0) {
rc.push_front(QLatin1String("/C"));
rc.push_front(qtcEnvironmentVariable("COMSPEC"));
if (rc.front().isEmpty())
rc.front() = QLatin1String("cmd.exe");
}
}
return rc;
}
// Helper for running the optional generation script.
static bool
runGenerationScriptHelper(const FilePath &workingDirectory,
const QStringList &script,
const QList<GeneratorScriptArgument> &argumentsIn,
bool dryRun,
const QMap<QString, QString> &fieldMap,
QString *stdOut /* = 0 */, QString *errorMessage)
{
Utils::Process process;
const QString binary = script.front();
QStringList arguments;
const int binarySize = script.size();
for (int i = 1; i < binarySize; i++)
arguments.push_back(script.at(i));
// Arguments: Prepend 'dryrun' and do field replacement
if (dryRun)
arguments.push_back(QLatin1String("--dry-run"));
// Arguments: Prepend 'dryrun'. Do field replacement to actual
// argument value to expand via temporary file if specified
CustomWizardContext::TemporaryFilePtrList temporaryFiles;
for (const GeneratorScriptArgument &argument : argumentsIn) {
QString value = argument.value;
const bool nonEmptyReplacements
= argument.flags & GeneratorScriptArgument::WriteFile ?
CustomWizardContext::replaceFields(fieldMap, &value, &temporaryFiles) :
CustomWizardContext::replaceFields(fieldMap, &value);
if (nonEmptyReplacements || !(argument.flags & GeneratorScriptArgument::OmitEmpty))
arguments.push_back(value);
}
process.setWorkingDirectory(workingDirectory);
const Utils::CommandLine cmd(FilePath::fromString(binary), arguments);
if (CustomWizard::verbose())
qDebug("In %s, running:\n%s\n", qPrintable(workingDirectory.toUserOutput()),
qPrintable(cmd.toUserOutput()));
process.setCommand(cmd);
using namespace std::chrono_literals;
process.runBlocking(30s, EventLoopMode::On);
if (process.result() != Utils::ProcessResult::FinishedWithSuccess) {
*errorMessage = QString("Generator script failed: %1").arg(process.exitMessage());
const QString stdErr = process.cleanedStdErr();
if (!stdErr.isEmpty()) {
errorMessage->append(QLatin1Char('\n'));
errorMessage->append(stdErr);
}
return false;
}
if (stdOut) {
*stdOut = process.cleanedStdOut();
if (CustomWizard::verbose())
qDebug("Output: '%s'\n", qPrintable(*stdOut));
}
return true;
}
/*!
Performs the first step in custom wizard script generation.
Does a dry run of the generation script to get a list of files.
\sa runCustomWizardGeneratorScript, ProjectExplorer::CustomWizard
*/
Core::GeneratedFiles
dryRunCustomWizardGeneratorScript(const QString &targetPath,
const QStringList &script,
const QList<GeneratorScriptArgument> &arguments,
const QMap<QString, QString> &fieldMap,
QString *errorMessage)
{
// Run in temporary directory as the target path may not exist yet.
QString stdOut;
if (!runGenerationScriptHelper(Utils::TemporaryDirectory::masterDirectoryFilePath(),
script, arguments, true, fieldMap, &stdOut, errorMessage))
return Core::GeneratedFiles();
Core::GeneratedFiles files;
// Parse the output consisting of lines with ',' separated tokens.
// (file name + attributes matching those of the <file> element)
const QStringList lines = stdOut.split(QLatin1Char('\n'));
for (const QString &line : lines) {
const QString trimmed = line.trimmed();
if (!trimmed.isEmpty()) {
Core::GeneratedFile file;
Core::GeneratedFile::Attributes attributes = Core::GeneratedFile::CustomGeneratorAttribute;
const QStringList tokens = line.split(QLatin1Char(','));
const int count = tokens.count();
for (int i = 0; i < count; i++) {
const QString &token = tokens.at(i);
if (i) {
if (token == QLatin1String(customWizardFileOpenEditorAttributeC))
attributes |= Core::GeneratedFile::OpenEditorAttribute;
else if (token == QLatin1String(customWizardFileOpenProjectAttributeC))
attributes |= Core::GeneratedFile::OpenProjectAttribute;
} else {
// Token 0 is file name. Wizard wants native names.
// Expand to full path if relative
const QFileInfo fileInfo(token);
const QString fullPath =
fileInfo.isAbsolute() ?
token :
(targetPath + QLatin1Char('/') + token);
file.setFilePath(FilePath::fromString(fullPath).cleanPath());
}
}
file.setAttributes(attributes);
files.push_back(file);
}
}
if (CustomWizard::verbose()) {
QDebug nospace = qDebug().nospace();
nospace << script << " generated:\n";
for (const Core::GeneratedFile &f : std::as_const(files))
nospace << ' ' << f.filePath() << f.attributes() << '\n';
}
return files;
}
/*!
Performs the second step in custom wizard script generation by actually
creating the files.
In addition to the <file> elements
that define template files in which macros are replaced, it is possible to have
a custom wizard call a generation script (specified in the \a generatorscript
attribute of the <files> element) which actually creates files.
The command line of the script must follow the convention
\code
script [--dry-run] [options]
\endcode
Options containing field placeholders are configured in the XML files
and will be passed with them replaced by their values.
As \QC needs to know the file names before it actually creates the files to
do overwrite checking etc., this is 2-step process:
\list
\li Determine file names and attributes: The script is called with the
\c --dry-run option and the field values. It then prints the relative path
names it intends to create followed by comma-separated attributes
matching those of the \c <file> element, for example:
\c myclass.cpp,openeditor
\li The script is called with the parameters only in the working directory
and then actually creates the files. If that involves directories, the script
should create those, too.
\endlist
\sa dryRunCustomWizardGeneratorScript, ProjectExplorer::CustomWizard
*/
bool runCustomWizardGeneratorScript(const QString &targetPath,
const QStringList &script,
const QList<GeneratorScriptArgument> &arguments,
const QMap<QString, QString> &fieldMap,
QString *errorMessage)
{
return runGenerationScriptHelper(FilePath::fromString(targetPath), script, arguments,
false, fieldMap,
nullptr, errorMessage);
}
} // namespace Internal
} // namespace ProjectExplorer
|
