Start to make text editor plugin usable

Signed-off-by: falkTX <[email protected]>

Author: falkTX

dpf

@@ -40,7 +40,7 @@ class ImGuiDemoPlugin : public Plugin
     */
     const char* getMaker() const noexcept override
     {
-        return "falkTX";
+        return "DISTRHO";
     }
 
    /**

dpf-widgets

@@ -1,6 +1,6 @@
 /*
  * Text Editor example
- * Copyright (C) 2023 Filipe Coelho <[email protected]>
+ * Copyright (C) 2023-2025 Filipe Coelho <[email protected]>
  * SPDX-License-Identifier: ISC
  */
 
@@ -95,7 +95,7 @@
    @see Plugin::initState(uint32_t, String&, String&)
    @see Plugin::setState(const char*, const char*)
  */
-#define DISTRHO_PLUGIN_WANT_STATE 0
+#define DISTRHO_PLUGIN_WANT_STATE 1
 
 /**
    Whether the plugin implements the full state API.
@@ -172,10 +172,26 @@
 #define DISTRHO_UI_USER_RESIZABLE 1
 
 /**
-   The %UI URI when exporting in LV2 format.@n
-   By default this is set to @ref DISTRHO_PLUGIN_URI with "#UI" as suffix.
+   Whether to %UI is going to use file browser dialogs.@n
+   By default this is false, with the file browser APIs not available for use.
  */
-#define DISTRHO_UI_URI DISTRHO_PLUGIN_URI "#UI"
+#define DISTRHO_UI_FILE_BROWSER 1
+
+/**
+   A 4-character symbol that identifies a brand or manufacturer, with at least one non-lower case character.@n
+   Plugins from the same brand should use the same symbol.
+   @note This macro is required when building AU plugins, and used for VST3 if present
+   @note Setting this macro will change the uid of a VST3 plugin.
+         If you already released a DPF-based VST3 plugin make sure to also enable DPF_VST3_DONT_USE_BRAND_ID
+ */
+#define DISTRHO_PLUGIN_BRAND_ID Dstr
+
+/**
+   A 4-character symbol which identifies a plugin.@n
+   It must be unique within at least a set of plugins from the brand.
+   @note This macro is required when building AU plugins
+ */
+#define DISTRHO_PLUGIN_UNIQUE_ID dTxt
 
 /**
    Custom LV2 category for the plugin.@n

plugins/ImGuiDemo/PluginDSP.cpp

@@ -28,6 +28,6 @@ BUILD_CXX_FLAGS += -I../../dpf-widgets/opengl
 # --------------------------------------------------------------
 # Enable all possible plugin types
 
-all: clap dssi jack lv2_sep vst2 vst3
+all: au clap dssi jack lv2_sep vst2 vst3
 
 # --------------------------------------------------------------

plugins/TextEditor/DistrhoPluginInfo.h

@@ -1,6 +1,6 @@
 /*
  * Text Editor example
- * Copyright (C) 2023 Filipe Coelho <[email protected]>
+ * Copyright (C) 2023-2025 Filipe Coelho <[email protected]>
  * SPDX-License-Identifier: ISC
  */
 
@@ -18,7 +18,7 @@ class TextEditorPlugin : public Plugin
       You must set all parameter values to their defaults, matching ParameterRanges::def.
     */
     TextEditorPlugin()
-        : Plugin(0, 0, 0) // parameters, programs, states
+        : Plugin(0, 0, 1) // parameters, programs, states
     {
     }
 
@@ -40,7 +40,7 @@ class TextEditorPlugin : public Plugin
     */
     const char* getMaker() const noexcept override
     {
-        return "falkTX";
+        return "DISTRHO";
     }
 
    /**
@@ -61,14 +61,22 @@ class TextEditorPlugin : public Plugin
         return d_version(1, 0, 0);
     }
 
+    // ----------------------------------------------------------------------------------------------------------------
+    // Init
+
    /**
-      Get the plugin unique Id.@n
-      This value is used by LADSPA, DSSI and VST plugin formats.
-      @see d_cconst()
+      Initialize the state @a index.@n
+      This function will be called once, shortly after the plugin is created.@n
+      Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.
     */
-    int64_t getUniqueId() const noexcept override
+    void initState(uint32_t index, State& state) override
     {
-        return d_cconst('d', 'T', 'x', 't');
+        if (index != 0)
+            return;
+
+        state.hints = kStateIsHostWritable | kStateIsOnlyForUI;
+        state.key = "text";
+        state.label = "Text";
     }
 
     // ----------------------------------------------------------------------------------------------------------------

plugins/TextEditor/Makefile

@@ -1,17 +1,21 @@
 /*
  * Text Editor example
- * Copyright (C) 2023 Filipe Coelho <[email protected]>
+ * Copyright (C) 2023-2025 Filipe Coelho <[email protected]>
  * SPDX-License-Identifier: ISC
  */
 
 #include "DistrhoUI.hpp"
 
+#include <fstream>
+
 START_NAMESPACE_DISTRHO
 
 // --------------------------------------------------------------------------------------------------------------------
 
 class TextEditorUI : public UI
 {
+    bool textChanged = false;
+
 public:
    /**
       UI class constructor.
@@ -33,6 +37,8 @@ class TextEditorUI : public UI
             setGeometryConstraints(width, height);
             setSize(width, height);
         }
+
+        showMenu();
     }
 
 protected:
@@ -45,6 +51,67 @@ class TextEditorUI : public UI
     */
     void parameterChanged(uint32_t, float) override {}
 
+   /**
+      A state has changed on the plugin side.@n
+      This is called by the host to inform the UI about state changes.
+    */
+    void stateChanged(const char* key, const char* value) override
+    {
+        if (std::strcmp(key, "text") != 0)
+            return;
+
+        setText(value);
+    }
+
+    // ----------------------------------------------------------------------------------------------------------------
+    // UI Callbacks
+
+   /**
+      UI idle function, called to give idle time to the plugin UI directly from the host.
+      This is called right after OS event handling and Window idle events (within the same cycle).
+      There are no guarantees in terms of timing.
+    */
+    void uiIdle() override
+    {
+        if (hasTextChangedSinceLastTime())
+        {
+            textChanged = true;
+            return;
+        }
+
+        // wait for first idle with no more text changes
+        if (textChanged)
+        {
+            textChanged = false;
+            setState("text", getText().c_str());
+        }
+    }
+
+   /**
+      Window file selected function, called when a path is selected by the user, as triggered by openFileBrowser().
+      This function is for plugin UIs to be able to override Window::onFileSelected(const char*).
+
+      This action happens after the user confirms the action, so the file browser dialog will be closed at this point.
+      The default implementation does nothing.
+
+      If you need to use files as plugin state, please setup and use states with kStateIsFilenamePath instead.
+    */
+    void uiFileBrowserSelected(const char* const filename) override
+    {
+        // TODO check if this can be null, add to docs if that can happen
+        if (filename == nullptr)
+            return;
+
+        std::ifstream filestream(filename);
+
+        if (filestream.good())
+        {
+            const std::string text((std::istreambuf_iterator<char>(filestream)), std::istreambuf_iterator<char>());
+            setText(text);
+            setState("text", text.c_str());
+        }
+    }
+
     // ----------------------------------------------------------------------------------------------------------------
 
     DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(TextEditorUI)