Add proxy classes for IContextMenu

So we can proxy objects returned by the host during `IComponentHandler3::createContextMenu`.
2026-05-14 20:40:03 +02:00 · 2021-01-06 15:50:58 +01:00
parent 5b70e0eea6
commit fbbd2f0671
6 changed files with 286 additions and 0 deletions
@@ -0,0 +1,82 @@
+// 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/ivstcontextmenu.h>
+
+#include "../../common.h"
+#include "../base.h"
+
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
+
+/**
+ * Wraps around `IContextMenu` for serialization purposes. This is instantiated
+ * as part of `Vst3ContextMenuProxy`.
+ */
+class YaContextMenu : public Steinberg::Vst::IContextMenu {
+   public:
+    /**
+     * These are the arguments for creating a `YaContextMenu`.
+     */
+    struct ConstructArgs {
+        ConstructArgs();
+
+        /**
+         * Check whether an existing implementation implements `IContextMenu`
+         * 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.
+     */
+    YaContextMenu(const ConstructArgs&& args);
+
+    inline bool supported() const { return arguments.supported; }
+
+    virtual int32 PLUGIN_API getItemCount() override = 0;
+    virtual tresult PLUGIN_API
+    getItem(int32 index,
+            Steinberg::Vst::IContextMenuItem& item /*out*/,
+            Steinberg::Vst::IContextMenuTarget** target /*out*/) override = 0;
+    virtual tresult PLUGIN_API
+    addItem(const Steinberg::Vst::IContextMenuItem& item,
+            Steinberg::Vst::IContextMenuTarget* target) override = 0;
+    virtual tresult PLUGIN_API
+    removeItem(const Item& item,
+               Steinberg::Vst::IContextMenuTarget* target) override = 0;
+    virtual tresult PLUGIN_API popup(Steinberg::UCoord x,
+                                     Steinberg::UCoord y) override = 0;
+
+   protected:
+    ConstructArgs arguments;
+};
+
+#pragma GCC diagnostic pop