Add a proxy class for IComponentHandler2

meson.build

@@ -112,6 +112,7 @@ vst3_plugin_sources = [
   'src/common/serialization/vst3/plugin/unit-data.cpp',
   'src/common/serialization/vst3/plugin/unit-info.cpp',
   'src/common/serialization/vst3/component-handler/component-handler.cpp',
+  'src/common/serialization/vst3/component-handler/component-handler-2.cpp',
   'src/common/serialization/vst3/component-handler/unit-handler.cpp',
   'src/common/serialization/vst3/host-context/host-application.cpp',
   'src/common/serialization/vst3/attribute-list.cpp',
@@ -175,6 +176,7 @@ if with_vst3
     'src/common/serialization/vst3/plugin/unit-data.cpp',
     'src/common/serialization/vst3/plugin/unit-info.cpp',
     'src/common/serialization/vst3/component-handler/component-handler.cpp',
+    'src/common/serialization/vst3/component-handler/component-handler-2.cpp',
     'src/common/serialization/vst3/component-handler/unit-handler.cpp',
     'src/common/serialization/vst3/host-context/host-application.cpp',
     'src/common/serialization/vst3/attribute-list.cpp',

src/common/serialization/vst3/README.md

@@ -36,15 +36,16 @@ VST3 plugin interfaces are implemented as follows:
 
 VST3 host interfaces are implemented as follows:
 
-| yabridge class              | Included in                 | Interfaces          |
+| yabridge class              | Included in                 | Interfaces           |
-| --------------------------- | --------------------------- | ------------------- |
+| --------------------------- | --------------------------- | -------------------- |
-| `Vst3HostContextProxy`      |                             | All of the below:   |
+| `Vst3HostContextProxy`      |                             | All of the below:    |
-| `YaHostApplication`         | `Vst3HostContextProxy`      | `IHostApplication`  |
+| `YaHostApplication`         | `Vst3HostContextProxy`      | `IHostApplication`   |
-| `Vst3ComponentHandlerProxy` |                             | All of the below:   |
+| `Vst3ComponentHandlerProxy` |                             | All of the below:    |
-| `YaComponentHandler`        | `Vst3ComponentHandlerProxy` | `IComponentHandler` |
+| `YaComponentHandler`        | `Vst3ComponentHandlerProxy` | `IComponentHandler`  |
-| `YaUnitHandler`             | `Vst3ComponentHandlerProxy` | `IUnitHandler`      |
+| `YaComponentHandler2`       | `Vst3ComponentHandlerProxy` | `IComponentHandler2` |
-| `Vst3PlugFrameProxy`        |                             | All of the below:   |
+| `YaUnitHandler`             | `Vst3ComponentHandlerProxy` | `IUnitHandler`       |
-| `YaPlugFrame`               | `Vst3PlugFrameProxy`        | `IPlugFrame`        |
+| `Vst3PlugFrameProxy`        |                             | All of the below:    |
+| `YaPlugFrame`               | `Vst3PlugFrameProxy`        | `IPlugFrame`         |
 
 The following host interfaces are passed as function arguments and are thus also
 implemented for serialization purposes:

src/common/serialization/vst3/component-handler/component-handler-2.cpp

@@ -0,0 +1,27 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020-2021 Robbert van der Helm
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#include "component-handler-2.h"
+
+YaComponentHandler2::ConstructArgs::ConstructArgs() {}
+
+YaComponentHandler2::ConstructArgs::ConstructArgs(
+    Steinberg::IPtr<Steinberg::FUnknown> object)
+    : supported(
+          Steinberg::FUnknownPtr<Steinberg::Vst::IComponentHandler2>(object)) {}
+
+YaComponentHandler2::YaComponentHandler2(const ConstructArgs&& args)
+    : arguments(std::move(args)) {}

src/common/serialization/vst3/component-handler/component-handler-2.h

@@ -0,0 +1,74 @@
+// yabridge: a Wine VST bridge
+// Copyright (C) 2020-2021 Robbert van der Helm
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#pragma once
+
+#include <pluginterfaces/vst/ivsteditcontroller.h>
+
+#include "../../common.h"
+#include "../base.h"
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
+
+/**
+ * Wraps around `IComponentHandler2` for serialization purposes. This is
+ * instantiated as part of `Vst3ComponentHandler2Proxy`.
+ */
+class YaComponentHandler2 : public Steinberg::Vst::IComponentHandler2 {
+   public:
+    /**
+     * These are the arguments for creating a `YaComponentHandler2`.
+     */
+    struct ConstructArgs {
+        ConstructArgs();
+
+        /**
+         * Check whether an existing implementation implements
+         * `IComponentHandler2` and read arguments from it.
+         */
+        ConstructArgs(Steinberg::IPtr<Steinberg::FUnknown> object);
+
+        /**
+         * Whether the object supported this interface.
+         */
+        bool supported;
+
+        template <typename S>
+        void serialize(S& s) {
+            s.value1b(supported);
+        }
+    };
+
+    /**
+     * Instantiate this instance with arguments read from another interface
+     * implementation.
+     */
+    YaComponentHandler2(const ConstructArgs&& args);
+
+    inline bool supported() const { return arguments.supported; }
+
+    virtual tresult PLUGIN_API setDirty(TBool state) override = 0;
+    virtual tresult PLUGIN_API
+    requestOpenEditor(Steinberg::FIDString name) override = 0;
+    virtual tresult PLUGIN_API startGroupEdit() override = 0;
+    virtual tresult PLUGIN_API finishGroupEdit() override = 0;
+
+   protected:
+    ConstructArgs arguments;
+};
+
+#pragma GCC diagnostic pop