Make CMakeTool known to the Kits

This patch adds support for binding a specific CMakeTool to a Kit.
When creating a new Kit or loading a existing one without a valid
CMakeTool, the default CMakeTool will be set.

Change-Id: I28d0843a01c583c4b31fc680a0ec556b40cd9c0d
Reviewed-by: Daniel Teske <daniel.teske@theqtcompany.com>

src/plugins/cmakeprojectmanager/cmakekitconfigwidget.cpp

@@ -0,0 +1,195 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Canonical Ltd.
+** Contact: http://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 http://www.qt.io/terms-conditions.  For further information
+** use the contact form at http://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 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "cmakeprojectconstants.h"
+#include "cmakekitconfigwidget.h"
+#include "cmakekitinformation.h"
+#include "cmaketoolmanager.h"
+#include "cmaketool.h"
+
+#include <utils/qtcassert.h>
+#include <coreplugin/icore.h>
+#include <projectexplorer/kit.h>
+#include <projectexplorer/projectexplorerconstants.h>
+
+#include <QComboBox>
+#include <QPushButton>
+
+namespace CMakeProjectManager {
+namespace Internal {
+
+CMakeKitConfigWidget::CMakeKitConfigWidget(ProjectExplorer::Kit *kit,
+                                           const ProjectExplorer::KitInformation *ki) :
+    ProjectExplorer::KitConfigWidget(kit, ki),
+    m_removingItem(false)
+{
+    m_comboBox = new QComboBox;
+    m_comboBox->setEnabled(false);
+    m_comboBox->setToolTip(toolTip());
+
+    foreach (CMakeTool *tool, CMakeToolManager::cmakeTools())
+        cmakeToolAdded(tool->id());
+
+    updateComboBox();
+
+    refresh();
+    connect(m_comboBox, static_cast<void(QComboBox::*)(int)>(&QComboBox::currentIndexChanged),
+            this, &CMakeKitConfigWidget::currentCMakeToolChanged);
+
+    m_manageButton = new QPushButton(KitConfigWidget::msgManage());
+    m_manageButton->setContentsMargins(0, 0, 0, 0);
+    connect(m_manageButton, &QPushButton::clicked,
+            this, &CMakeKitConfigWidget::manageCMakeTools);
+
+    CMakeToolManager *cmakeMgr = CMakeToolManager::instance();
+    connect(cmakeMgr, &CMakeToolManager::cmakeAdded,
+            this, &CMakeKitConfigWidget::cmakeToolAdded);
+    connect(cmakeMgr, &CMakeToolManager::cmakeRemoved,
+            this, &CMakeKitConfigWidget::cmakeToolRemoved);
+    connect(cmakeMgr, &CMakeToolManager::cmakeUpdated,
+            this, &CMakeKitConfigWidget::cmakeToolUpdated);
+}
+
+CMakeKitConfigWidget::~CMakeKitConfigWidget()
+{
+    delete m_comboBox;
+    delete m_manageButton;
+}
+
+QString CMakeKitConfigWidget::displayName() const
+{
+    return tr("CMake Tool:");
+}
+
+void CMakeKitConfigWidget::makeReadOnly()
+{
+    m_comboBox->setEnabled(false);
+}
+
+void CMakeKitConfigWidget::refresh()
+{
+    CMakeTool *tool = CMakeKitInformation::cmakeTool(m_kit);
+    m_comboBox->setCurrentIndex(tool == 0 ? -1 : indexOf(tool->id()));
+}
+
+QWidget *CMakeKitConfigWidget::mainWidget() const
+{
+    return m_comboBox;
+}
+
+QWidget *CMakeKitConfigWidget::buttonWidget() const
+{
+    return m_manageButton;
+}
+
+QString CMakeKitConfigWidget::toolTip() const
+{
+    return tr("The CMake Tool to use when building a project with CMake.<br>"
+              "This setting is ignored when using other build systems.");
+}
+
+int CMakeKitConfigWidget::indexOf(const Core::Id &id)
+{
+    for (int i = 0; i < m_comboBox->count(); ++i) {
+        if (id == Core::Id::fromSetting(m_comboBox->itemData(i)))
+            return i;
+    }
+    return -1;
+}
+
+void CMakeKitConfigWidget::cmakeToolAdded(const Core::Id &id)
+{
+    const CMakeTool *tool = CMakeToolManager::findById(id);
+    QTC_ASSERT(tool, return);
+
+    m_comboBox->addItem(tool->displayName(), tool->id().toSetting());
+    updateComboBox();
+    refresh();
+}
+
+void CMakeKitConfigWidget::cmakeToolUpdated(const Core::Id &id)
+{
+    const int pos = indexOf(id);
+    QTC_ASSERT(pos >= 0, return);
+
+    const CMakeTool *tool = CMakeToolManager::findById(id);
+    QTC_ASSERT(tool, return);
+
+    m_comboBox->setItemText(pos, tool->displayName());
+}
+
+void CMakeKitConfigWidget::cmakeToolRemoved(const Core::Id &id)
+{
+    const int pos = indexOf(id);
+    QTC_ASSERT(pos >= 0, return);
+
+    // do not handle the current index changed signal
+    m_removingItem = true;
+    m_comboBox->removeItem(pos);
+    m_removingItem = false;
+
+    // update the checkbox and set the current index
+    updateComboBox();
+    refresh();
+}
+
+void CMakeKitConfigWidget::updateComboBox()
+{
+    // remove unavailable cmake tool:
+    int pos = indexOf(Core::Id());
+    if (pos >= 0)
+        m_comboBox->removeItem(pos);
+
+    if (m_comboBox->count() == 0) {
+        m_comboBox->addItem(tr("<No CMake Tool available>"),
+                            Core::Id().toSetting());
+        m_comboBox->setEnabled(false);
+    } else {
+        m_comboBox->setEnabled(true);
+    }
+}
+
+void CMakeKitConfigWidget::currentCMakeToolChanged(int index)
+{
+    if (m_removingItem)
+        return;
+
+    const Core::Id id = Core::Id::fromSetting(m_comboBox->itemData(index));
+    CMakeKitInformation::setCMakeTool(m_kit, id);
+}
+
+void CMakeKitConfigWidget::manageCMakeTools()
+{
+    Core::ICore::showOptionsDialog(Constants::CMAKE_SETTINGSPAGE_ID,
+                                   buttonWidget());
+}
+
+} // namespace Internal
+} // namespace CMakeProjectManager