Add EnvironmentAspect to ProjectExplorer

This is meant to hold environment data for RunConfigurations that
require one.

Change-Id: Icfc6a499dec6dfc303a96de66f51c44592318f21
Reviewed-by: Daniel Teske <daniel.teske@digia.com>

src/plugins/projectexplorer/environmentaspect.cpp

+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "environmentaspect.h"
+
+#include "target.h"
+
+#include <utils/qtcassert.h>
+
+static const char BASE_KEY[] = "PE.EnvironmentAspect.Base";
+static const char CHANGES_KEY[] = "PE.EnvironmentAspect.Changes";
+
+namespace ProjectExplorer {
+
+// --------------------------------------------------------------------
+// EnvironmentAspect:
+// --------------------------------------------------------------------
+
+EnvironmentAspect::EnvironmentAspect(RunConfiguration *rc) :
+    m_base(-1),
+    m_runConfiguration(rc)
+{
+    QTC_CHECK(m_runConfiguration);
+}
+
+EnvironmentAspect::EnvironmentAspect(const EnvironmentAspect *other, RunConfiguration *parent) :
+    m_base(other->m_base),
+    m_changes(other->m_changes),
+    m_runConfiguration(parent)
+{ }
+
+QVariantMap EnvironmentAspect::toMap() const
+{
+    QVariantMap data;
+    data.insert(QLatin1String(BASE_KEY), m_base);
+    data.insert(QLatin1String(CHANGES_KEY), Utils::EnvironmentItem::toStringList(m_changes));
+    return data;
+}
+
+QString EnvironmentAspect::displayName() const
+{
+    return tr("Run Environment");
+}
+
+int EnvironmentAspect::baseEnvironmentBase() const
+{
+    if (m_base == -1) {
+        QList<int> bases = possibleBaseEnvironments();
+        QTC_ASSERT(!bases.isEmpty(), return -1);
+        foreach (int i, bases)
+            QTC_CHECK(i >= 0);
+        m_base = bases.at(0);
+    }
+    return m_base;
+}
+
+void EnvironmentAspect::setBaseEnvironmentBase(int base)
+{
+    QTC_ASSERT(base >= 0, return);
+    QTC_ASSERT(possibleBaseEnvironments().contains(base), return);
+
+    if (m_base != base) {
+        m_base = base;
+        emit baseEnvironmentChanged();
+    }
+}
+
+void EnvironmentAspect::setUserEnvironmentChanges(const QList<Utils::EnvironmentItem> &diff)
+{
+    if (m_changes != diff) {
+        m_changes = diff;
+        emit userEnvironmentChangesChanged(m_changes);
+        emit environmentChanged();
+    }
+}
+
+Utils::Environment EnvironmentAspect::environment() const
+{
+    Utils::Environment env = baseEnvironment();
+    env.modify(m_changes);
+    return env;
+}
+
+void EnvironmentAspect::fromMap(const QVariantMap &map)
+{
+    m_base = map.value(QLatin1String(BASE_KEY), -1).toInt();
+    m_changes = Utils::EnvironmentItem::fromStringList(map.value(QLatin1String(CHANGES_KEY)).toStringList());
+}
+
+} // namespace ProjectExplorer

src/plugins/projectexplorer/environmentaspect.h

+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef ENVIRONMENTASPECT_H
+#define ENVIRONMENTASPECT_H
+
+#include "projectexplorer_export.h"
+
+#include "runconfiguration.h"
+
+#include <utils/environment.h>
+
+#include <QList>
+#include <QVariantMap>
+
+namespace ProjectExplorer {
+
+class PROJECTEXPLORER_EXPORT EnvironmentAspect : public QObject, public IRunConfigurationAspect
+{
+    Q_OBJECT
+
+public:
+    // from IRunConfigurationAspect:
+    QVariantMap toMap() const;
+    QString displayName() const;
+
+    virtual RunConfiguration *runConfiguration() const { return m_runConfiguration; }
+
+    virtual QList<int> possibleBaseEnvironments() const = 0;
+    virtual QString baseEnvironmentDisplayName(int base) const = 0;
+
+    int baseEnvironmentBase() const;
+    void setBaseEnvironmentBase(int base);
+
+    QList<Utils::EnvironmentItem> userEnvironmentChanges() const { return m_changes; }
+    void setUserEnvironmentChanges(const QList<Utils::EnvironmentItem> &diff);
+
+    virtual Utils::Environment baseEnvironment() const = 0;
+    virtual Utils::Environment environment() const;
+
+signals:
+    void baseEnvironmentChanged();
+    void userEnvironmentChangesChanged(const QList<Utils::EnvironmentItem> &diff);
+    void environmentChanged();
+
+protected:
+    EnvironmentAspect(const EnvironmentAspect *other, RunConfiguration *parent);
+    EnvironmentAspect(RunConfiguration *rc);
+    void fromMap(const QVariantMap &map);
+
+private:
+    mutable int m_base;
+    QList<Utils::EnvironmentItem> m_changes;
+    RunConfiguration *m_runConfiguration;
+};
+
+} // namespace ProjectExplorer
+
+#endif // ENVIRONMENTASPECT_H

src/plugins/projectexplorer/projectexplorer.pro

@@ -7,6 +7,7 @@ HEADERS += projectexplorer.h \
     abiwidget.h \
     ansifilterparser.h \
     clangparser.h \
+    environmentaspect.h \
     gcctoolchain.h \
     localapplicationrunconfiguration.h \
     projectexplorer_export.h \
@@ -132,6 +133,7 @@ SOURCES += projectexplorer.cpp \
     abiwidget.cpp \
     ansifilterparser.cpp \
     clangparser.cpp \
+    environmentaspect.cpp \
     gcctoolchain.cpp \
     localapplicationrunconfiguration.cpp \
     projectwindow.cpp \

src/plugins/projectexplorer/projectexplorer.qbs

@@ -94,6 +94,8 @@ QtcPlugin {
         "editorsettingspropertiespage.cpp",
         "editorsettingspropertiespage.h",
         "editorsettingspropertiespage.ui",
+        "environmentaspect.cpp",
+        "environmentaspect.h",
         "environmentitemswidget.cpp",
         "environmentitemswidget.h",
         "environmentwidget.cpp",