1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25
26 #include "qbsbuildconfiguration.h"
27
28 #include "qbsbuildstep.h"
29 #include "qbscleanstep.h"
30 #include "qbsinstallstep.h"
31 #include "qbsproject.h"
32 #include "qbsprojectmanagerconstants.h"
33 #include "qbssettings.h"
34
35 #include <coreplugin/documentmanager.h>
36
37 #include <projectexplorer/buildinfo.h>
38 #include <projectexplorer/buildsteplist.h>
39 #include <projectexplorer/deployconfiguration.h>
40 #include <projectexplorer/kit.h>
41 #include <projectexplorer/kitinformation.h>
42 #include <projectexplorer/projectexplorer.h>
43 #include <projectexplorer/projectexplorerconstants.h>
44 #include <projectexplorer/projectmacroexpander.h>
45 #include <projectexplorer/target.h>
46 #include <projectexplorer/toolchain.h>
47
48 #include <qtsupport/qtkitinformation.h>
49
50 #include <utils/mimetypes/mimedatabase.h>
51 #include <utils/qtcassert.h>
52 #include <utils/qtcprocess.h>
53
54 #include <QCoreApplication>
55 #include <QCryptographicHash>
56
57 using namespace ProjectExplorer;
58 using namespace Utils;
59
60 namespace QbsProjectManager {
61 namespace Internal {
62
defaultBuildDirectory(const FilePath & projectFilePath,const Kit * k,const QString & bcName,BuildConfiguration::BuildType buildType)63 static FilePath defaultBuildDirectory(const FilePath &projectFilePath, const Kit *k,
64 const QString &bcName,
65 BuildConfiguration::BuildType buildType)
66 {
67 const QString projectName = projectFilePath.completeBaseName();
68 ProjectMacroExpander expander(projectFilePath, projectName, k, bcName, buildType);
69 FilePath projectDir = Project::projectDirectory(projectFilePath);
70 QString buildPath = expander.expand(ProjectExplorerPlugin::buildDirectoryTemplate());
71 return projectDir.resolvePath(buildPath);
72 }
73
74 // ---------------------------------------------------------------------------
75 // QbsBuildConfiguration:
76 // ---------------------------------------------------------------------------
77
QbsBuildConfiguration(Target * target,Utils::Id id)78 QbsBuildConfiguration::QbsBuildConfiguration(Target *target, Utils::Id id)
79 : BuildConfiguration(target, id)
80 {
81 setConfigWidgetHasFrame(true);
82
83 appendInitialBuildStep(Constants::QBS_BUILDSTEP_ID);
84 appendInitialCleanStep(Constants::QBS_CLEANSTEP_ID);
85
86 setInitializer([this, target](const BuildInfo &info) {
87 const Kit *kit = target->kit();
88 QVariantMap configData = info.extraInfo.value<QVariantMap>();
89 configData.insert(QLatin1String(Constants::QBS_CONFIG_VARIANT_KEY),
90 (info.buildType == BuildConfiguration::Debug)
91 ? QLatin1String(Constants::QBS_VARIANT_DEBUG)
92 : QLatin1String(Constants::QBS_VARIANT_RELEASE));
93
94 FilePath buildDir = info.buildDirectory;
95 if (buildDir.isEmpty())
96 buildDir = defaultBuildDirectory(target->project()->projectFilePath(),
97 kit, info.displayName,
98 buildType());
99 setBuildDirectory(buildDir);
100
101 // Add the build configuration.
102 QVariantMap bd = configData;
103 QString configName = bd.take("configName").toString();
104 if (configName.isEmpty()) {
105 configName = "qtc_" + kit->fileSystemFriendlyName() + '_'
106 + FileUtils::fileSystemFriendlyName(info.displayName);
107 }
108
109 const QString kitName = kit->displayName();
110 const QByteArray hash = QCryptographicHash::hash((kitName + info.displayName).toUtf8(),
111 QCryptographicHash::Sha1);
112
113 const QString uniqueConfigName = configName
114 + '_' + kit->fileSystemFriendlyName().left(8)
115 + '_' + hash.toHex().left(16);
116
117 m_configurationName->setValue(uniqueConfigName);
118
119 auto bs = buildSteps()->firstOfType<QbsBuildStep>();
120 QTC_ASSERT(bs, return);
121 bs->setQbsConfiguration(bd);
122
123 emit qbsConfigurationChanged();
124 });
125
126 m_configurationName = addAspect<StringAspect>();
127 m_configurationName->setLabelText(tr("Configuration name:"));
128 m_configurationName->setSettingsKey("Qbs.configName");
129 m_configurationName->setDisplayStyle(StringAspect::LineEditDisplay);
130 connect(m_configurationName, &StringAspect::changed,
131 this, &BuildConfiguration::buildDirectoryChanged);
132
133 const auto separateDebugInfoAspect = addAspect<SeparateDebugInfoAspect>();
134 connect(separateDebugInfoAspect, &SeparateDebugInfoAspect::changed,
135 this, &QbsBuildConfiguration::qbsConfigurationChanged);
136
137 const auto qmlDebuggingAspect = addAspect<QtSupport::QmlDebuggingAspect>();
138 qmlDebuggingAspect->setKit(target->kit());
139 connect(qmlDebuggingAspect, &QtSupport::QmlDebuggingAspect::changed,
140 this, &QbsBuildConfiguration::qbsConfigurationChanged);
141
142 const auto qtQuickCompilerAspect = addAspect<QtSupport::QtQuickCompilerAspect>();
143 qtQuickCompilerAspect->setKit(target->kit());
144 connect(qtQuickCompilerAspect, &QtSupport::QtQuickCompilerAspect::changed,
145 this, &QbsBuildConfiguration::qbsConfigurationChanged);
146
147 connect(this, &BuildConfiguration::environmentChanged,
148 this, &QbsBuildConfiguration::triggerReparseIfActive);
149 connect(this, &BuildConfiguration::buildDirectoryChanged,
150 this, &QbsBuildConfiguration::triggerReparseIfActive);
151 connect(this, &QbsBuildConfiguration::qbsConfigurationChanged,
152 this, &QbsBuildConfiguration::triggerReparseIfActive);
153
154 macroExpander()->registerVariable("CurrentBuild:QbsBuildRoot", tr("The qbs project build root"),
155 [this] { return buildDirectory().pathAppended(configurationName()).toUserOutput(); });
156
157 m_buildSystem = new QbsBuildSystem(this);
158 }
159
~QbsBuildConfiguration()160 QbsBuildConfiguration::~QbsBuildConfiguration()
161 {
162 for (BuildStep * const bs : buildSteps()->steps()) {
163 if (const auto qbs = qobject_cast<QbsBuildStep *>(bs))
164 qbs->dropSession();
165 }
166 for (BuildStep * const cs : cleanSteps()->steps()) {
167 if (const auto qcs = qobject_cast<QbsCleanStep *>(cs))
168 qcs->dropSession();
169 }
170 delete m_buildSystem;
171 }
172
buildSystem() const173 BuildSystem *QbsBuildConfiguration::buildSystem() const
174 {
175 return m_buildSystem;
176 }
177
triggerReparseIfActive()178 void QbsBuildConfiguration::triggerReparseIfActive()
179 {
180 if (isActive())
181 m_buildSystem->delayParsing();
182 }
183
fromMap(const QVariantMap & map)184 bool QbsBuildConfiguration::fromMap(const QVariantMap &map)
185 {
186 if (!BuildConfiguration::fromMap(map))
187 return false;
188
189 if (m_configurationName->value().isEmpty()) { // pre-4.4 backwards compatibility
190 const QString profileName = QbsProfileManager::profileNameForKit(target()->kit());
191 const QString buildVariant = qbsConfiguration()
192 .value(QLatin1String(Constants::QBS_CONFIG_VARIANT_KEY)).toString();
193 m_configurationName->setValue(profileName + '-' + buildVariant);
194 }
195
196 return true;
197 }
198
restrictNextBuild(const RunConfiguration * rc)199 void QbsBuildConfiguration::restrictNextBuild(const RunConfiguration *rc)
200 {
201 if (!rc) {
202 setProducts({});
203 return;
204 }
205 const auto productNode = dynamic_cast<QbsProductNode *>(rc->productNode());
206 QTC_ASSERT(productNode, return);
207 setProducts({productNode->fullDisplayName()});
208 }
209
qbsStep() const210 QbsBuildStep *QbsBuildConfiguration::qbsStep() const
211 {
212 return buildSteps()->firstOfType<QbsBuildStep>();
213 }
214
qbsConfiguration() const215 QVariantMap QbsBuildConfiguration::qbsConfiguration() const
216 {
217 QVariantMap config;
218 QbsBuildStep *qbsBs = qbsStep();
219 if (qbsBs)
220 config = qbsBs->qbsConfiguration(QbsBuildStep::ExpandVariables);
221 return config;
222 }
223
buildType() const224 BuildConfiguration::BuildType QbsBuildConfiguration::buildType() const
225 {
226 QString variant;
227 if (qbsStep())
228 variant = qbsStep()->buildVariant();
229
230 if (variant == QLatin1String(Constants::QBS_VARIANT_DEBUG))
231 return Debug;
232 if (variant == QLatin1String(Constants::QBS_VARIANT_RELEASE))
233 return Release;
234 return Unknown;
235 }
236
setChangedFiles(const QStringList & files)237 void QbsBuildConfiguration::setChangedFiles(const QStringList &files)
238 {
239 m_changedFiles = files;
240 }
241
changedFiles() const242 QStringList QbsBuildConfiguration::changedFiles() const
243 {
244 return m_changedFiles;
245 }
246
setActiveFileTags(const QStringList & fileTags)247 void QbsBuildConfiguration::setActiveFileTags(const QStringList &fileTags)
248 {
249 m_activeFileTags = fileTags;
250 }
251
activeFileTags() const252 QStringList QbsBuildConfiguration::activeFileTags() const
253 {
254 return m_activeFileTags;
255 }
256
setProducts(const QStringList & products)257 void QbsBuildConfiguration::setProducts(const QStringList &products)
258 {
259 m_products = products;
260 }
261
products() const262 QStringList QbsBuildConfiguration::products() const
263 {
264 return m_products;
265 }
266
configurationName() const267 QString QbsBuildConfiguration::configurationName() const
268 {
269 return m_configurationName->value();
270 }
271
equivalentCommandLine(const QbsBuildStepData & stepData) const272 QString QbsBuildConfiguration::equivalentCommandLine(const QbsBuildStepData &stepData) const
273 {
274 CommandLine commandLine;
275 commandLine.addArg(QDir::toNativeSeparators(QbsSettings::qbsExecutableFilePath().toString()));
276 commandLine.addArg(stepData.command);
277 const QString buildDir = buildDirectory().toUserOutput();
278 commandLine.addArgs({"-d", buildDir});
279 commandLine.addArgs({"-f", project()->projectFilePath().toUserOutput()});
280 if (QbsSettings::useCreatorSettingsDirForQbs()) {
281 commandLine.addArgs({"--settings-dir",
282 QDir::toNativeSeparators(QbsSettings::qbsSettingsBaseDir())});
283 }
284 if (stepData.dryRun)
285 commandLine.addArg("--dry-run");
286 if (stepData.keepGoing)
287 commandLine.addArg("--keep-going");
288 if (stepData.forceProbeExecution)
289 commandLine.addArg("--force-probe-execution");
290 if (stepData.showCommandLines)
291 commandLine.addArgs({"--command-echo-mode", "command-line"});
292 if (stepData.noInstall)
293 commandLine.addArg("--no-install");
294 if (stepData.noBuild)
295 commandLine.addArg("--no-build");
296 if (stepData.cleanInstallRoot)
297 commandLine.addArg("--clean-install-root");
298 const int jobCount = stepData.jobCount;
299 if (jobCount > 0)
300 commandLine.addArgs({"--jobs", QString::number(jobCount)});
301
302 const QString profileName = QbsProfileManager::profileNameForKit(target()->kit());
303 const QString buildVariant = qbsConfiguration()
304 .value(QLatin1String(Constants::QBS_CONFIG_VARIANT_KEY)).toString();
305 commandLine.addArg("config:" + configurationName());
306 commandLine.addArg(QString(Constants::QBS_CONFIG_VARIANT_KEY) + ':' + buildVariant);
307 const FilePath installRoot = stepData.installRoot;
308 if (!installRoot.isEmpty()) {
309 commandLine.addArg(QString(Constants::QBS_INSTALL_ROOT_KEY) + ':' + installRoot.toUserOutput());
310 if (stepData.isInstallStep)
311 commandLine.addArgs({"--installRoot", installRoot.toUserOutput()});
312 }
313 commandLine.addArg("profile:" + profileName);
314
315 return commandLine.arguments();
316 }
317
qmlDebuggingSetting() const318 TriState QbsBuildConfiguration::qmlDebuggingSetting() const
319 {
320 return aspect<QtSupport::QmlDebuggingAspect>()->value();
321 }
322
qtQuickCompilerSetting() const323 TriState QbsBuildConfiguration::qtQuickCompilerSetting() const
324 {
325 return aspect<QtSupport::QtQuickCompilerAspect>()->value();
326 }
327
separateDebugInfoSetting() const328 TriState QbsBuildConfiguration::separateDebugInfoSetting() const
329 {
330 return aspect<SeparateDebugInfoAspect>()->value();
331 }
332
333 // ---------------------------------------------------------------------------
334 // QbsBuildConfigurationFactory:
335 // ---------------------------------------------------------------------------
336
QbsBuildConfigurationFactory()337 QbsBuildConfigurationFactory::QbsBuildConfigurationFactory()
338 {
339 registerBuildConfiguration<QbsBuildConfiguration>(Constants::QBS_BC_ID);
340 setSupportedProjectType(Constants::PROJECT_ID);
341 setSupportedProjectMimeTypeName(Constants::MIME_TYPE);
342 setIssueReporter([](Kit *k, const QString &projectPath, const QString &buildDir) -> Tasks {
343 const QtSupport::BaseQtVersion * const version = QtSupport::QtKitAspect::qtVersion(k);
344 return version ? version->reportIssues(projectPath, buildDir)
345 : Tasks();
346 });
347
348 setBuildGenerator([this](const Kit *k, const FilePath &projectPath, bool forSetup) {
349 QList<BuildInfo> result;
350
351 if (forSetup) {
352 BuildInfo info = createBuildInfo(BuildConfiguration::Debug);
353 //: The name of the debug build configuration created by default for a qbs project.
354 info.displayName = BuildConfiguration::tr("Debug");
355 //: Non-ASCII characters in directory suffix may cause build issues.
356 const QString dbg = QbsBuildConfiguration::tr("Debug", "Shadow build directory suffix");
357 info.buildDirectory = defaultBuildDirectory(projectPath, k, dbg, info.buildType);
358 result << info;
359
360 info = createBuildInfo(BuildConfiguration::Release);
361 //: The name of the release build configuration created by default for a qbs project.
362 info.displayName = BuildConfiguration::tr("Release");
363 //: Non-ASCII characters in directory suffix may cause build issues.
364 const QString rel = QbsBuildConfiguration::tr("Release", "Shadow build directory suffix");
365 info.buildDirectory = defaultBuildDirectory(projectPath, k, rel, info.buildType);
366 result << info;
367 } else {
368 result << createBuildInfo(BuildConfiguration::Debug);
369 result << createBuildInfo(BuildConfiguration::Release);
370 }
371
372 return result;
373 });
374 }
375
createBuildInfo(BuildConfiguration::BuildType type) const376 BuildInfo QbsBuildConfigurationFactory::createBuildInfo(BuildConfiguration::BuildType type) const
377 {
378 BuildInfo info;
379 info.buildType = type;
380 info.typeName = type == BuildConfiguration::Debug
381 ? BuildConfiguration::tr("Debug") : BuildConfiguration::tr("Release");
382 QVariantMap config;
383 config.insert("configName", type == BuildConfiguration::Debug ? "Debug" : "Release");
384 info.extraInfo = config;
385 return info;
386 }
387
388 } // namespace Internal
389 } // namespace QbsProjectManager
390