diff options
Diffstat (limited to 'src/plugins/cmakeprojectmanager/cmaketoolsettingsaccessor.cpp')
| -rw-r--r-- | src/plugins/cmakeprojectmanager/cmaketoolsettingsaccessor.cpp | 257 |
1 files changed, 257 insertions, 0 deletions
diff --git a/src/plugins/cmakeprojectmanager/cmaketoolsettingsaccessor.cpp b/src/plugins/cmakeprojectmanager/cmaketoolsettingsaccessor.cpp new file mode 100644 index 0000000000..2f2d40b91d --- /dev/null +++ b/src/plugins/cmakeprojectmanager/cmaketoolsettingsaccessor.cpp @@ -0,0 +1,257 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** 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. +** +****************************************************************************/ + +#include "cmaketoolsettingsaccessor.h" + +#include "cmaketool.h" +#include "cmaketoolmanager.h" + +#include <coreplugin/icore.h> + +#include <app/app_version.h> + +#include <utils/algorithm.h> +#include <utils/environment.h> + +#include <QDebug> +#include <QDir> +#include <QFileInfo> + +using namespace Utils; + +namespace CMakeProjectManager { +namespace Internal { + +// -------------------------------------------------------------------- +// CMakeToolSettingsUpgraders: +// -------------------------------------------------------------------- + +class CMakeToolSettingsUpgraderV0 : public Utils::VersionUpgrader +{ + // Necessary to make Version 1 supported. +public: + CMakeToolSettingsUpgraderV0() : Utils::VersionUpgrader(0, "4.6") { } + + // NOOP + QVariantMap upgrade(const QVariantMap &data) final { return data; } +}; + +// -------------------------------------------------------------------- +// Helpers: +// -------------------------------------------------------------------- + +static const char CMAKE_TOOL_COUNT_KEY[] = "CMakeTools.Count"; +static const char CMAKE_TOOL_DATA_KEY[] = "CMakeTools."; +static const char CMAKE_TOOL_DEFAULT_KEY[] = "CMakeTools.Default"; +static const char CMAKE_TOOL_FILENAME[] = "/cmaketools.xml"; + + +static std::vector<std::unique_ptr<CMakeTool>> autoDetectCMakeTools() +{ + Utils::Environment env = Environment::systemEnvironment(); + + Utils::FileNameList path = env.path(); + path = Utils::filteredUnique(path); + + if (HostOsInfo::isWindowsHost()) { + const QString progFiles = QLatin1String(qgetenv("ProgramFiles")); + path.append(Utils::FileName::fromString(progFiles + "/CMake")); + path.append(Utils::FileName::fromString(progFiles + "/CMake/bin")); + const QString progFilesX86 = QLatin1String(qgetenv("ProgramFiles(x86)")); + if (!progFilesX86.isEmpty()) { + path.append(Utils::FileName::fromString(progFilesX86 + "/CMake")); + path.append(Utils::FileName::fromString(progFilesX86 + "/CMake/bin")); + } + } + + if (HostOsInfo::isMacHost()) { + path.append(Utils::FileName::fromString("/Applications/CMake.app/Contents/bin")); + path.append(Utils::FileName::fromString("/usr/local/bin")); + path.append(Utils::FileName::fromString("/opt/local/bin")); + } + + const QStringList execs = env.appendExeExtensions(QLatin1String("cmake")); + + FileNameList suspects; + foreach (const Utils::FileName &base, path) { + if (base.isEmpty()) + continue; + + QFileInfo fi; + for (const QString &exec : execs) { + fi.setFile(QDir(base.toString()), exec); + if (fi.exists() && fi.isFile() && fi.isExecutable()) + suspects << FileName::fromString(fi.absoluteFilePath()); + } + } + + std::vector<std::unique_ptr<CMakeTool>> found; + foreach (const FileName &command, suspects) { + auto item = std::make_unique<CMakeTool>(CMakeTool::AutoDetection, CMakeTool::createId()); + item->setCMakeExecutable(command); + item->setDisplayName(CMakeToolManager::tr("System CMake at %1").arg(command.toUserOutput())); + + found.emplace_back(std::move(item)); + } + + return found; +} + + +static std::vector<std::unique_ptr<CMakeTool>> +mergeTools(std::vector<std::unique_ptr<CMakeTool>> &sdkTools, + std::vector<std::unique_ptr<CMakeTool>> &userTools, + std::vector<std::unique_ptr<CMakeTool>> &autoDetectedTools) +{ + std::vector<std::unique_ptr<CMakeTool>> result = std::move(sdkTools); + while (userTools.size() > 0) { + std::unique_ptr<CMakeTool> userTool = std::move(userTools[0]); + userTools.erase(std::begin(userTools)); + + if (!Utils::contains(result, Utils::equal(&CMakeTool::id, userTool->id()))) { + if (userTool->isAutoDetected() + && !Utils::contains(autoDetectedTools, Utils::equal(&CMakeTool::cmakeExecutable, + userTool->cmakeExecutable()))) { + + qWarning() << QString::fromLatin1("Previously SDK provided CMakeTool \"%1\" (%2) dropped.") + .arg(userTool->cmakeExecutable().toUserOutput(), userTool->id().toString()); + continue; + } + result.emplace_back(std::move(userTool)); + } + } + + // add all the autodetected tools that are not known yet + while (autoDetectedTools.size() > 0) { + std::unique_ptr<CMakeTool> autoDetectedTool = std::move(autoDetectedTools[0]); + autoDetectedTools.erase(std::begin(autoDetectedTools)); + + if (!Utils::contains(result, + Utils::equal(&CMakeTool::cmakeExecutable, autoDetectedTool->cmakeExecutable()))) + result.emplace_back(std::move(autoDetectedTool)); + } + + return result; +} + + +// -------------------------------------------------------------------- +// CMakeToolSettingsAccessor: +// -------------------------------------------------------------------- + +CMakeToolSettingsAccessor::CMakeToolSettingsAccessor() : + UpgradingSettingsAccessor("QtCreatorCMakeTools", + QCoreApplication::translate("CMakeProjectManager::CMakeToolManager", "CMake"), + Core::Constants::IDE_DISPLAY_NAME) +{ + setBaseFilePath(FileName::fromString(Core::ICore::userResourcePath() + CMAKE_TOOL_FILENAME)); + + addVersionUpgrader(std::make_unique<CMakeToolSettingsUpgraderV0>()); +} + +CMakeToolSettingsAccessor::CMakeTools CMakeToolSettingsAccessor::restoreCMakeTools(QWidget *parent) const +{ + CMakeTools result; + + const FileName sdkSettingsFile = FileName::fromString(Core::ICore::installerResourcePath() + + CMAKE_TOOL_FILENAME); + + CMakeTools sdkTools = cmakeTools(restoreSettings(sdkSettingsFile, parent), true); + + //read the tools from the user settings file + CMakeTools userTools = cmakeTools(restoreSettings(parent), false); + + //autodetect tools + std::vector<std::unique_ptr<CMakeTool>> autoDetectedTools = autoDetectCMakeTools(); + + //filter out the tools that were stored in SDK + std::vector<std::unique_ptr<CMakeTool>> toRegister = mergeTools(sdkTools.cmakeTools, + userTools.cmakeTools, + autoDetectedTools); + + // Store all tools + for (auto it = std::begin(toRegister); it != std::end(toRegister); ++it) + result.cmakeTools.emplace_back(std::move(*it)); + + result.defaultToolId = userTools.defaultToolId.isValid() ? userTools.defaultToolId : sdkTools.defaultToolId; + + // Set default TC... + return result; +} + +void CMakeToolSettingsAccessor::saveCMakeTools(const QList<CMakeTool *> &cmakeTools, + const Core::Id &defaultId, + QWidget *parent) +{ + QVariantMap data; + data.insert(QLatin1String(CMAKE_TOOL_DEFAULT_KEY), defaultId.toSetting()); + + int count = 0; + for (const CMakeTool *item : cmakeTools) { + QFileInfo fi = item->cmakeExecutable().toFileInfo(); + + if (fi.isExecutable()) { + QVariantMap tmp = item->toMap(); + if (tmp.isEmpty()) + continue; + data.insert(QString::fromLatin1(CMAKE_TOOL_DATA_KEY) + QString::number(count), tmp); + ++count; + } + } + data.insert(QLatin1String(CMAKE_TOOL_COUNT_KEY), count); + + saveSettings(data, parent); +} + +CMakeToolSettingsAccessor::CMakeTools +CMakeToolSettingsAccessor::cmakeTools(const QVariantMap &data, bool fromSdk) const +{ + CMakeTools result; + + int count = data.value(QLatin1String(CMAKE_TOOL_COUNT_KEY), 0).toInt(); + for (int i = 0; i < count; ++i) { + const QString key = QString::fromLatin1(CMAKE_TOOL_DATA_KEY) + QString::number(i); + if (!data.contains(key)) + continue; + + const QVariantMap dbMap = data.value(key).toMap(); + auto item = std::make_unique<CMakeTool>(dbMap, fromSdk); + if (item->isAutoDetected() && !item->cmakeExecutable().toFileInfo().isExecutable()) { + qWarning() << QString::fromLatin1("CMakeTool \"%1\" (%2) dropped since the command is not executable.") + .arg(item->cmakeExecutable().toUserOutput(), item->id().toString()); + continue; + } + + result.cmakeTools.emplace_back(std::move(item)); + } + + result.defaultToolId = Core::Id::fromSetting(data.value(CMAKE_TOOL_DEFAULT_KEY, + Core::Id().toSetting())); + + return result; +} + +} // namespace Internal +} // namespace CMakeProjectManager |