ProjectExplorer: Let users provide project-specific environment

Add a new project panel where users can set environment variables for
the current project in all configurations.

Fixes: QTCREATORBUG-21862
Change-Id: Id98c7f1cf579927a8004a63172f193f943556f44
Reviewed-by: hjk <hjk@qt.io>

src/plugins/projectexplorer/buildconfiguration.cpp

@@ -116,6 +116,8 @@ BuildConfiguration::BuildConfiguration(Target *target, Core::Id id)
             this, &BuildConfiguration::updateCacheAndEmitEnvironmentChanged);
     connect(this, &BuildConfiguration::environmentChanged,
             this, &BuildConfiguration::emitBuildDirectoryChanged);
+    connect(target->project(), &Project::environmentChanged,
+            this, &BuildConfiguration::environmentChanged);
     // Many macroexpanders are based on the current project, so they may change the environment:
     connect(ProjectTree::instance(), &ProjectTree::currentProjectChanged,
             this, &BuildConfiguration::updateCacheAndEmitEnvironmentChanged);
@@ -343,6 +345,7 @@ Utils::Environment BuildConfiguration::baseEnvironment() const
         result = Utils::Environment::systemEnvironment();
     addToEnvironment(result);
     target()->kit()->addToEnvironment(result);
+    result.modify(project()->additionalEnvironment());
     return result;
 }
 

src/plugins/projectexplorer/environmentwidget.cpp

@@ -283,7 +283,12 @@ void EnvironmentWidget::setUserChanges(const Utils::EnvironmentItems &list)
 void EnvironmentWidget::setOpenTerminalFunc(const EnvironmentWidget::OpenTerminalFunc &func)
 {
     d->m_openTerminalFunc = func;
-    d->m_terminalButton->setEnabled(bool(func));
+    d->m_terminalButton->setVisible(bool(func));
+}
+
+void EnvironmentWidget::expand()
+{
+    d->m_detailsContainer->setState(Utils::DetailsWidget::Expanded);
 }
 
 void EnvironmentWidget::updateSummaryText()
@@ -294,7 +299,8 @@ void EnvironmentWidget::updateSummaryText()
     QString text;
     foreach (const Utils::EnvironmentItem &item, list) {
         if (item.name != Utils::EnvironmentModel::tr("<VARIABLE>")) {
-            text.append(QLatin1String("<br>"));
+            if (!d->m_baseEnvironmentText.isEmpty() || !text.isEmpty())
+                text.append(QLatin1String("<br>"));
             switch (item.operation) {
             case Utils::EnvironmentItem::Unset:
                 text.append(tr("Unset <a href=\"%1\"><b>%1</b></a>").arg(item.name.toHtmlEscaped()));
@@ -313,11 +319,15 @@ void EnvironmentWidget::updateSummaryText()
 
     if (text.isEmpty()) {
         //: %1 is "System Environment" or some such.
-        text.prepend(tr("Use <b>%1</b>").arg(d->m_baseEnvironmentText));
+        if (!d->m_baseEnvironmentText.isEmpty())
+            text.prepend(tr("Use <b>%1</b>").arg(d->m_baseEnvironmentText));
+        else
+            text.prepend(tr("<b>No environment changes</b>"));
     } else {
         //: Yup, word puzzle. The Set/Unset phrases above are appended to this.
         //: %1 is "System Environment" or some such.
-        text.prepend(tr("Use <b>%1</b> and").arg(d->m_baseEnvironmentText));
+        if (!d->m_baseEnvironmentText.isEmpty())
+            text.prepend(tr("Use <b>%1</b> and").arg(d->m_baseEnvironmentText));
     }
 
     d->m_detailsContainer->setSummaryText(text);

src/plugins/projectexplorer/environmentwidget.h

@@ -59,6 +59,8 @@ public:
     using OpenTerminalFunc = std::function<void(const Utils::Environment &env)>;
     void setOpenTerminalFunc(const OpenTerminalFunc &func);
 
+    void expand();
+
 signals:
     void userChangesChanged();
     void detailsVisibleChanged(bool visible);

src/plugins/projectexplorer/project.cpp

@@ -90,6 +90,8 @@ const char TARGET_KEY_PREFIX[] = "ProjectExplorer.Project.Target.";
 const char TARGET_COUNT_KEY[] = "ProjectExplorer.Project.TargetCount";
 const char EDITOR_SETTINGS_KEY[] = "ProjectExplorer.Project.EditorSettings";
 const char PLUGIN_SETTINGS_KEY[] = "ProjectExplorer.Project.PluginSettings";
+
+const char PROJECT_ENV_KEY[] = "ProjectExplorer.Project.Environment";
 } // namespace
 
 namespace ProjectExplorer {
@@ -867,6 +869,17 @@ void Project::setNamedSettings(const QString &name, const QVariant &value)
         d->m_pluginSettings.insert(name, value);
 }
 
+void Project::setAdditionalEnvironment(const Utils::EnvironmentItems &envItems)
+{
+    setNamedSettings(PROJECT_ENV_KEY, Utils::NameValueItem::toStringList(envItems));
+    emit environmentChanged();
+}
+
+Utils::EnvironmentItems Project::additionalEnvironment() const
+{
+    return Utils::NameValueItem::fromStringList(namedSettings(PROJECT_ENV_KEY).toStringList());
+}
+
 bool Project::needsConfiguration() const
 {
     return d->m_targets.size() == 0;

src/plugins/projectexplorer/project.h

@@ -33,6 +33,7 @@
 #include <coreplugin/id.h>
 #include <coreplugin/idocument.h>
 
+#include <utils/environmentfwd.h>
 #include <utils/fileutils.h>
 
 #include <QObject>
@@ -134,6 +135,9 @@ public:
     QVariant namedSettings(const QString &name) const;
     void setNamedSettings(const QString &name, const QVariant &value);
 
+    void setAdditionalEnvironment(const Utils::EnvironmentItems &envItems);
+    Utils::EnvironmentItems additionalEnvironment() const;
+
     virtual bool needsConfiguration() const;
     bool needsBuildConfigurations() const;
     virtual void configureAsExampleProject();
@@ -174,6 +178,7 @@ signals:
 
     void displayNameChanged();
     void fileListChanged();
+    void environmentChanged();
 
     // Note: activeTarget can be 0 (if no targets are defined).
     void activeTargetChanged(ProjectExplorer::Target *target);

src/plugins/projectexplorer/projectexplorer.cpp

@@ -37,6 +37,7 @@
 #include "deployablefile.h"
 #include "deployconfiguration.h"
 #include "desktoprunconfiguration.h"
+#include "environmentwidget.h"
 #include "extraabi.h"
 #include "gcctoolchainfactories.h"
 #ifdef WITH_JOURNALD
@@ -45,6 +46,7 @@
 #include "jsonwizard/jsonwizardfactory.h"
 #include "jsonwizard/jsonwizardgeneratorfactory.h"
 #include "jsonwizard/jsonwizardpagefactory_p.h"
+#include "namedwidget.h"
 #include "project.h"
 #include "projectexplorersettings.h"
 #include "projectexplorersettingspage.h"
@@ -351,6 +353,29 @@ public:
     }
 };
 
+
+class ProjectEnvironmentWidget : public NamedWidget
+{
+    Q_DECLARE_TR_FUNCTIONS(ProjectEnvironmentWidget)
+
+public:
+    explicit ProjectEnvironmentWidget(Project *project) : NamedWidget(tr("Project Environment"))
+    {
+        const auto vbox = new QVBoxLayout(this);
+        vbox->setContentsMargins(0, 0, 0, 0);
+        const auto envWidget = new EnvironmentWidget(this, EnvironmentWidget::TypeLocal);
+        envWidget->setOpenTerminalFunc({});
+        envWidget->expand();
+        vbox->addWidget(envWidget);
+        connect(envWidget, &EnvironmentWidget::userChangesChanged,
+                this, [project, envWidget] {
+            project->setAdditionalEnvironment(envWidget->userChanges());
+        });
+        envWidget->setUserChanges(project->additionalEnvironment());
+    }
+};
+
+
 class ProjectExplorerPluginPrivate : public QObject
 {
     Q_DECLARE_TR_FUNCTIONS(ProjectExplorer::ProjectExplorerPlugin)
@@ -775,6 +800,14 @@ bool ProjectExplorerPlugin::initialize(const QStringList &arguments, QString *er
     panelFactory->setCreateWidgetFunction([](Project *project) { return new DependenciesWidget(project); });
     ProjectPanelFactory::registerFactory(panelFactory);
 
+    panelFactory = new ProjectPanelFactory;
+    panelFactory->setPriority(60);
+    panelFactory->setDisplayName(QCoreApplication::translate("EnvironmentPanelFactory", "Environment"));
+    panelFactory->setCreateWidgetFunction([](Project *project) {
+        return new ProjectEnvironmentWidget(project);
+    });
+    ProjectPanelFactory::registerFactory(panelFactory);
+
     // context menus
     ActionContainer *msessionContextMenu =
         ActionManager::createMenu(Constants::M_SESSIONCONTEXT);