CMakePM: Add "CMake Install" deployment step

This commit adds a "CMake Install" deployment step, which is using "cmake --install" command. "cmake --install" command has been added in CMake 3.15, this is why the minimum CMake version has been updated to 3.15. Note that CMakeBuildSystem::makeInstallCommand is still using cmake -- build --target install due to a CMake bug regarding "Ninja Multi-Config" generator, which doesn't intall all binaries via "cmake --install". Fixes: QTCREATORBUG-25880 Change-Id: I504674c380055d8ef136d344a78b80c17ecf9765 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-12-09 18:44:42 +01:00
parent 2eb2aa13ae
commit a0afd51f3f
12 changed files with 270 additions and 46 deletions
--- a/src/plugins/cmakeprojectmanager/cmakeinstallstep.cpp
+++ b/src/plugins/cmakeprojectmanager/cmakeinstallstep.cpp
@@ -0,0 +1,123 @@
+// Copyright (C) 2022 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
+
+#include "cmakeinstallstep.h"
+
+#include "cmakebuildsystem.h"
+#include "cmakekitinformation.h"
+#include "cmakeparser.h"
+#include "cmakeprojectconstants.h"
+#include "cmakeprojectmanagertr.h"
+#include "cmaketool.h"
+
+#include <projectexplorer/buildsteplist.h>
+#include <projectexplorer/processparameters.h>
+#include <projectexplorer/project.h>
+#include <projectexplorer/projectexplorer.h>
+#include <projectexplorer/projectexplorerconstants.h>
+#include <utils/layoutbuilder.h>
+
+using namespace Core;
+using namespace ProjectExplorer;
+using namespace Utils;
+
+namespace CMakeProjectManager::Internal {
+
+const char CMAKE_ARGUMENTS_KEY[] = "CMakeProjectManager.InstallStep.CMakeArguments";
+
+// CMakeInstallStep
+
+CMakeInstallStep::CMakeInstallStep(BuildStepList *bsl, Utils::Id id)
+    : CMakeAbstractProcessStep(bsl, id)
+{
+    m_cmakeArguments = addAspect<StringAspect>();
+    m_cmakeArguments->setSettingsKey(CMAKE_ARGUMENTS_KEY);
+    m_cmakeArguments->setLabelText(Tr::tr("CMake arguments:"));
+    m_cmakeArguments->setDisplayStyle(StringAspect::LineEditDisplay);
+
+    setCommandLineProvider([this] { return cmakeCommand(); });
+}
+
+void CMakeInstallStep::setupOutputFormatter(Utils::OutputFormatter *formatter)
+{
+    CMakeParser *cmakeParser = new CMakeParser;
+    cmakeParser->setSourceDirectory(project()->projectDirectory());
+    formatter->addLineParsers({cmakeParser});
+    formatter->addSearchDir(processParameters()->effectiveWorkingDirectory());
+    CMakeAbstractProcessStep::setupOutputFormatter(formatter);
+}
+
+CommandLine CMakeInstallStep::cmakeCommand() const
+{
+    CommandLine cmd;
+    if (CMakeTool *tool = CMakeKitAspect::cmakeTool(kit()))
+        cmd.setExecutable(tool->cmakeExecutable());
+
+    FilePath buildDirectory = ".";
+    if (buildConfiguration())
+        buildDirectory = buildConfiguration()->buildDirectory();
+
+    cmd.addArgs({"--install", buildDirectory.onDevice(cmd.executable()).path()});
+
+    auto bs = qobject_cast<CMakeBuildSystem *>(buildSystem());
+    if (bs && bs->isMultiConfigReader()) {
+        cmd.addArg("--config");
+        cmd.addArg(bs->cmakeBuildType());
+    }
+
+    if (!m_cmakeArguments->value().isEmpty())
+        cmd.addArgs(m_cmakeArguments->value(), CommandLine::Raw);
+
+    return cmd;
+}
+
+void CMakeInstallStep::processFinished(bool success)
+{
+    Q_UNUSED(success)
+    emit progress(100, {});
+}
+
+QWidget *CMakeInstallStep::createConfigWidget()
+{
+    auto updateDetails = [this] {
+        ProcessParameters param;
+        setupProcessParameters(&param);
+        param.setCommandLine(cmakeCommand());
+
+        setSummaryText(param.summary(displayName()));
+    };
+
+    setDisplayName(Tr::tr("Install", "ConfigWidget display name."));
+
+    Layouting::Form builder;
+    builder.addRow(m_cmakeArguments);
+
+    auto widget = builder.emerge(Layouting::WithoutMargins);
+
+    updateDetails();
+
+    connect(m_cmakeArguments, &StringAspect::changed, this, updateDetails);
+
+    connect(ProjectExplorerPlugin::instance(),
+            &ProjectExplorerPlugin::settingsChanged,
+            this,
+            updateDetails);
+    connect(buildConfiguration(), &BuildConfiguration::buildDirectoryChanged, this, updateDetails);
+    connect(buildConfiguration(), &BuildConfiguration::buildTypeChanged, this, updateDetails);
+
+    return widget;
+}
+
+// CMakeInstallStepFactory
+
+CMakeInstallStepFactory::CMakeInstallStepFactory()
+{
+    registerStep<CMakeInstallStep>(Constants::CMAKE_INSTALL_STEP_ID);
+    setDisplayName(
+        Tr::tr("CMake Install", "Display name for CMakeProjectManager::CMakeInstallStep id."));
+    setSupportedProjectType(Constants::CMAKE_PROJECT_ID);
+    setSupportedStepLists({ProjectExplorer::Constants::BUILDSTEPS_DEPLOY});
+}
+
+} // namespace CMakeProjectManager::Internal
+