Docker: New empty shell

The usual boiler plate for plugins, including an option page that
knows how to run "docker search" for demonstration purposes.

Change-Id: I2df91f18f4869cbb2ee8f65ccb8b41969f8c90ae
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>

src/plugins/CMakeLists.txt

@@ -27,6 +27,7 @@ add_subdirectory(resourceeditor)
 add_subdirectory(tasklist)
 add_subdirectory(nim)
 add_subdirectory(conan)
+add_subdirectory(docker)
 
 # Level 4: (only depends on Level 3 and below)
 add_subdirectory(clangpchmanager)

src/plugins/docker/CMakeLists.txt

@@ -0,0 +1,10 @@
+add_qtc_plugin(Docker
+  PLUGIN_DEPENDS Core
+  SOURCES
+    dockerplugin.cpp
+    dockerplugin.h
+    dockersettings.cpp
+    dockersettings.h
+    docker_global.h
+    dockerconstants.h
+)

src/plugins/docker/Docker.json.in

@@ -0,0 +1,20 @@
+{
+    \"Name\" : \"Docker\",
+    \"Version\" : \"$$QTCREATOR_VERSION\",
+    \"CompatVersion\" : \"$$QTCREATOR_COMPAT_VERSION\",
+    \"Vendor\" : \"The Qt Company Ltd\",
+    \"Copyright\" : \"(C) $$QTCREATOR_COPYRIGHT_YEAR The Qt Company Ltd\",
+    \"License\" : [ \"Commercial Usage\",
+                  \"\",
+                  \"Licensees holding valid Qt Commercial licenses may use this plugin in accordance with the Qt 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.\",
+                  \"\",
+                  \"GNU General Public License Usage\",
+                  \"\",
+                  \"Alternatively, this plugin 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 plugin. 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.\"
+    ],
+    \"Category\" : \"Utilities\",
+    \"Experimental\" : true,
+    \"Description\" : \"Basic support for Docker\",
+    \"Url\" : \"http://www.qt.io\",
+    $$dependencyList
+}

src/plugins/docker/docker.pro

@@ -0,0 +1,12 @@
+include(../../qtcreatorplugin.pri)
+
+DEFINES += QT_RESTRICTED_CAST_FROM_ASCII
+
+SOURCES += \
+    dockerplugin.cpp \
+    dockersettings.cpp
+HEADERS += \
+    dockerconstants.h \
+    dockerplugin.h \
+    docker_global.h \
+    dockersettings.h

src/plugins/docker/docker.qbs

@@ -0,0 +1,21 @@
+import qbs 1.0
+
+QtcPlugin {
+    name: "Docker"
+
+    Depends { name: "Qt.widgets" }
+    Depends { name: "Utils" }
+
+    Depends { name: "Core" }
+    Depends { name: "ProjectExplorer" }
+
+    files: [
+        "docker_global.h",
+        "dockerconstants.h",
+        "dockerplugin.h",
+        "dockerplugin.cpp",
+        "dockersettings.h",
+        "dockersettings.cpp"
+    ]
+}
+

src/plugins/docker/docker_dependencies.pri

@@ -0,0 +1,6 @@
+QTC_PLUGIN_NAME = Docker
+QTC_LIB_DEPENDS += \
+    utils
+QTC_PLUGIN_DEPENDS += \
+    coreplugin \
+    projectexplorer

src/plugins/docker/docker_global.h

@@ -0,0 +1,10 @@
+#ifndef DOCKER_GLOBAL_H
+#define DOCKER_GLOBAL_H
+
+#if defined(DOCKER_LIBRARY)
+#  define DOCKER_EXPORT Q_DECL_EXPORT
+#else
+#  define DOCKER_EXPORT Q_DECL_IMPORT
+#endif
+
+#endif // DOCKER_GLOBAL_H

src/plugins/docker/dockerconstants.h

@@ -0,0 +1,39 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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.
+**
+****************************************************************************/
+
+#ifndef DOCKERCONSTANTS_H
+#define DOCKERCONSTANTS_H
+
+namespace Docker {
+namespace Constants {
+
+const char DOCKER_SETTINGS_ID[] = "Docker.Settings";
+const char ACTION_ID[] = "Docker.Action";
+const char MENU_ID[] = "Docker.Menu";
+
+} // namespace Constants
+} // namespace Docker
+
+#endif // DOCKERCONSTANTS_H

src/plugins/docker/dockerplugin.cpp

@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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 "dockerplugin.h"
+
+#include "dockerconstants.h"
+#include "dockersettings.h"
+
+using namespace Core;
+using namespace Utils;
+
+namespace Docker {
+namespace Internal {
+
+class DockerPluginPrivate
+{
+public:
+    DockerSettings settings;
+    DockerOptionsPage optionsPage{&settings};
+};
+
+DockerPlugin::~DockerPlugin()
+{
+    delete d;
+}
+
+bool DockerPlugin::initialize(const QStringList &arguments, QString *errorString)
+{
+    Q_UNUSED(arguments)
+    Q_UNUSED(errorString)
+
+    d = new DockerPluginPrivate;
+
+    return true;
+}
+
+} // namespace Internal
+} // namespace Docker

src/plugins/docker/dockerplugin.h

@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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.
+**
+****************************************************************************/
+
+#pragma once
+
+#include <extensionsystem/iplugin.h>
+
+namespace Docker {
+namespace Internal {
+
+class DockerPlugin final : public ExtensionSystem::IPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Docker.json")
+
+private:
+    ~DockerPlugin() final;
+
+    bool initialize(const QStringList &arguments, QString *errorString) final;
+
+    class DockerPluginPrivate *d = nullptr;
+};
+
+} // namespace Internal
+} // namespace Docker

src/plugins/docker/dockersettings.cpp

@@ -0,0 +1,161 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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 "dockerconstants.h"
+#include "dockersettings.h"
+
+#include <coreplugin/icore.h>
+
+#include <projectexplorer/projectexplorerconstants.h>
+
+#include <utils/layoutbuilder.h>
+#include <utils/qtcprocess.h>
+#include <utils/qtcsettings.h>
+
+using namespace Utils;
+
+namespace Docker {
+namespace Internal {
+
+// DockerSettings
+
+const char SETTINGS_KEY[] = "Docker";
+
+static DockerSettings *theSettings = nullptr;
+
+DockerSettings::DockerSettings()
+{
+    theSettings = this;
+    setAutoApply(false);
+    readSettings(Core::ICore::settings());
+
+    imageListFilter.setSettingsKey("DockerListFilter");
+    imageListFilter.setPlaceHolderText(tr("<filter>"));
+    imageListFilter.setDisplayStyle(StringAspect::LineEditDisplay);
+    imageListFilter.setLabelText(tr("Filter:"));
+
+    imageList.setDisplayStyle(StringAspect::TextEditDisplay);
+    imageList.setLabelText(tr("Images:"));
+
+    connect(&imageListFilter, &BaseAspect::changed, this, &DockerSettings::updateImageList);
+}
+
+DockerSettings *DockerSettings::instance()
+{
+    return theSettings;
+}
+
+void DockerSettings::writeSettings(QSettings *settings) const
+{
+    settings->remove(SETTINGS_KEY);
+    settings->beginGroup(SETTINGS_KEY);
+    forEachAspect([settings](BaseAspect *aspect) {
+        QtcSettings::setValueWithDefault(settings, aspect->settingsKey(),
+                                         aspect->value(), aspect->defaultValue());
+    });
+    settings->endGroup();
+}
+
+void DockerSettings::updateImageList()
+{
+    QtcProcess process;
+    process.setCommand({"docker", {"search", imageListFilter.value()}});
+
+    const auto finished = QOverload<int, QProcess::ExitStatus>::of(&QProcess::finished);
+    connect(&process, finished, this, [&process, this] {
+        const QString data = QString::fromUtf8(process.readAll());
+        imageList.setValue(data);
+    });
+
+    process.start();
+    process.waitForFinished();
+}
+
+void DockerSettings::readSettings(const QSettings *settings)
+{
+    const QString keyRoot = QString(SETTINGS_KEY) + '/';
+    forEachAspect([settings, keyRoot](BaseAspect *aspect) {
+        QString key = aspect->settingsKey();
+        const QVariant value = settings->value(keyRoot + key, aspect->defaultValue());
+        aspect->setValue(value);
+    });
+}
+
+// DockerOptionsPage
+
+class DockerConfigWidget : public Core::IOptionsPageWidget
+{
+    Q_DECLARE_TR_FUNCTIONS(Docker::Internal::DockerConfigWidget)
+
+public:
+    explicit DockerConfigWidget(DockerSettings *settings);
+
+    void apply() final
+    {
+        m_settings->apply();
+        m_settings->writeSettings(Core::ICore::settings());
+    }
+
+    void finish() final
+    {
+        m_settings->finish();
+    }
+
+private:
+    DockerSettings *m_settings;
+};
+
+DockerConfigWidget::DockerConfigWidget(DockerSettings *settings)
+    : m_settings(settings)
+{
+    using namespace Layouting;
+    DockerSettings &s = *settings;
+
+    Column {
+        Group {
+            Title(tr("Search images on Docker Hub")),
+            Form {
+                s.imageListFilter, Break(),
+                s.imageList
+            },
+        },
+        Stretch()
+    }.attachTo(this);
+}
+
+// DockerOptionsPage
+
+DockerOptionsPage::DockerOptionsPage(DockerSettings *settings)
+{
+    setId(Constants::DOCKER_SETTINGS_ID);
+    setDisplayName(DockerConfigWidget::tr("Docker"));
+    setCategory(ProjectExplorer::Constants::DEVICE_SETTINGS_CATEGORY);
+    setDisplayCategory(QCoreApplication::translate("ProjectExplorer", "Devices"));
+    setCategoryIconPath(":/projectexplorer/images/settingscategory_devices.png");
+    setWidgetCreator([settings] { return new DockerConfigWidget(settings); });
+}
+
+} // Internal
+} // Docker

src/plugins/docker/dockersettings.h

@@ -0,0 +1,58 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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.
+**
+****************************************************************************/
+
+#pragma once
+
+#include <utils/aspects.h>
+#include <utils/fileutils.h>
+
+#include <coreplugin/dialogs/ioptionspage.h>
+
+namespace Docker {
+namespace Internal {
+
+class DockerSettings : public QObject, public Utils::AspectContainer
+{
+public:
+    DockerSettings();
+    static DockerSettings *instance();
+
+    void readSettings(const QSettings *settings);
+    void writeSettings(QSettings *settings) const;
+
+    void updateImageList();
+
+    Utils::StringAspect imageListFilter;
+    Utils::StringAspect imageList;
+};
+
+class DockerOptionsPage final : public Core::IOptionsPage
+{
+public:
+    explicit DockerOptionsPage(DockerSettings *settings);
+};
+
+} // Internal
+} // Docker

src/plugins/plugins.pro

@@ -67,7 +67,8 @@ SUBDIRS   = \
     mcusupport \
     marketplace \
     incredibuild \
-    conan
+    conan \
+    docker
 
 qtHaveModule(serialport) {
     SUBDIRS += serialterminal

src/plugins/plugins.qbs

@@ -37,6 +37,7 @@ Project {
         "debugger/ptracepreload.qbs",
         "designer/designer.qbs",
         "diffeditor/diffeditor.qbs",
+        "docker/docker.qbs",
         "fakevim/fakevim.qbs",
         "emacskeys/emacskeys.qbs",
         "genericprojectmanager/genericprojectmanager.qbs",