Move UI stuff back into slv2.h (avoid breakage).

Deprecate slv2_ui_instance_get_descriptor and slv2_ui_instance_get_handle.


git-svn-id: http://svn.drobilla.net/lad/trunk/slv2@3020 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 151 insertions, 0 deletions

diff --git a/slv2/slv2.h b/slv2/slv2.h
index 8c198bd..e703689 100644
--- a/slv2/slv2.h
+++ b/slv2/slv2.h
@@ -23,6 +23,7 @@
 #include <stdbool.h>
 
 #include "lv2/lv2plug.in/ns/lv2core/lv2.h"
+#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -46,6 +47,16 @@ extern "C" {
 	#define SLV2_API
 #endif
 
+#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
+	#ifdef SLV2_INTERNAL  // Building SLV2 (not using it)
+		#define SLV2_DEPRECATED
+	#else
+		#define SLV2_DEPRECATED __attribute__((__deprecated__))
+	#endif
+#else
+	#define SLV2_DEPRECATED
+#endif
+
 #define SLV2_NAMESPACE_LV2      "http://lv2plug.in/ns/lv2core#"
 #define SLV2_PORT_CLASS_PORT    "http://lv2plug.in/ns/lv2core#Port"
 #define SLV2_PORT_CLASS_INPUT   "http://lv2plug.in/ns/lv2core#InputPort"
@@ -59,12 +70,14 @@ typedef struct _SLV2Plugin*       SLV2Plugin;       /**< LV2 Plugin. */
 typedef struct _SLV2PluginClass*  SLV2PluginClass;  /**< Plugin Class. */
 typedef struct _SLV2Port*         SLV2Port;         /**< Port. */
 typedef struct _SLV2ScalePoint*   SLV2ScalePoint;   /**< Scale Point (Notch). */
+typedef struct _SLV2UI*           SLV2UI;           /**< Plugin UI. */
 typedef struct _SLV2Value*        SLV2Value;        /**< Typed Value. */
 typedef struct _SLV2World*        SLV2World;        /**< SLV2 World. */
 
 typedef void* SLV2PluginClasses;  /**< set<PluginClass>. */
 typedef void* SLV2Plugins;        /**< set<Plugin>. */
 typedef void* SLV2ScalePoints;    /**< array<ScalePoint>. */
+typedef void* SLV2UIs;            /**< set<UI>. */
 typedef void* SLV2Values;         /**< array<Value>. */
 
 /** @defgroup slv2 SLV2
@@ -293,6 +306,7 @@ prefix ## _get_at(CollType collection, \
 
 SLV2_COLLECTION(SLV2PluginClasses, SLV2PluginClass, slv2_plugin_classes)
 SLV2_COLLECTION(SLV2ScalePoints, SLV2ScalePoint, slv2_scale_points)
+SLV2_COLLECTION(SLV2UIs, SLV2UI, slv2_uis)
 SLV2_COLLECTION(SLV2Values, SLV2Value, slv2_values)
 
 /** Free a plugin collection.
@@ -1057,6 +1071,143 @@ slv2_instance_get_handle(SLV2Instance instance)
 #endif /* SLV2_INTERNAL */
 
 /** @} */
+/** @name Plugin UI
+ * @{
+ */
+
+/** Get a UI from @a uis by URI.
+ * Return value is shared (stored in @a uis) and must not be freed or
+ * modified by the caller in any way.
+ * @return NULL if no UI with @a uri is found in @a list.
+ */
+SLV2_API
+SLV2UI
+slv2_uis_get_by_uri(SLV2UIs   uis,
+                    SLV2Value uri);
+
+/** Get a list of all UIs available for this plugin.
+ * Note this returns the URI of the UI, and not the path/URI to its shared
+ * library, use slv2_ui_get_library_uri with the values returned
+ * here for that.
+ *
+ * Returned value must be freed by caller using slv2_uis_free.
+ */
+SLV2_API
+SLV2UIs
+slv2_plugin_get_uis(SLV2Plugin plugin);
+
+/** @name Plugin UI
+ * @{
+ */
+
+/** Get the URI of a Plugin UI.
+ * @param ui The Plugin UI
+ * @return a shared value which must not be modified or freed.
+ */
+SLV2_API
+SLV2Value
+slv2_ui_get_uri(SLV2UI ui);
+
+/** Get the types (URIs of RDF classes) of a Plugin UI.
+ * @param ui The Plugin UI
+ * @return a shared value which must not be modified or freed.
+ */
+SLV2_API
+SLV2Values
+slv2_ui_get_classes(SLV2UI ui);
+
+/** Check whether a plugin UI is a given type.
+ * @param ui        The Plugin UI
+ * @param class_uri The URI of the LV2 UI type to check this UI against
+ */
+SLV2_API
+bool
+slv2_ui_is_a(SLV2UI ui, SLV2Value class_uri);
+
+/** Get the URI for a Plugin UI's bundle.
+ * @param ui The Plugin UI
+ * @return a shared value which must not be modified or freed.
+ */
+SLV2_API
+SLV2Value
+slv2_ui_get_bundle_uri(SLV2UI ui);
+
+/** Get the URI for a Plugin UI's shared library.
+ * @param ui The Plugin UI
+ * @return a shared value which must not be modified or freed.
+ */
+SLV2_API
+SLV2Value
+slv2_ui_get_binary_uri(SLV2UI ui);
+
+/** @} */
+/** @name Plugin UI Instance
+ * @{
+ */
+
+typedef struct _SLV2UIInstance* SLV2UIInstance;
+
+/** Instantiate a plugin UI.
+ * The returned object represents shared library objects loaded into memory,
+ * it must be cleaned up with slv2_ui_instance_free when no longer
+ * needed.
+ *
+ * @a plugin is not modified or directly referenced by the returned object
+ * (instances store only a copy of the plugin's URI).
+ *
+ * @a features NULL-terminated array of features the host supports.
+ * NULL may be passed if the host supports no additional features (unlike
+ * the LV2 specification - SLV2 takes care of it).
+ *
+ * @return NULL if instantiation failed.
+ */
+SLV2_API
+SLV2UIInstance
+slv2_ui_instantiate(SLV2Plugin                plugin,
+                    SLV2UI                    ui,
+                    LV2UI_Write_Function      write_function,
+                    LV2UI_Controller          controller,
+                    const LV2_Feature* const* features);
+
+/** Free a plugin UI instance.
+ * @a instance is invalid after this call.
+ * It is the caller's responsibility to ensure all references to the UI
+ * instance (including any returned widgets) are cut before calling
+ * this function.
+ */
+SLV2_API
+void
+slv2_ui_instance_free(SLV2UIInstance instance);
+
+/** Get the widget for the UI instance.
+ */
+SLV2_API
+LV2UI_Widget
+slv2_ui_instance_get_widget(SLV2UIInstance instance);
+
+/** DEPRECATED: Get the LV2UI_Descriptor of the plugin UI instance.
+ * Normally hosts should not need to access the LV2UI_Descriptor directly,
+ * use the slv2_ui_instance_* functions.
+ *
+ * The returned descriptor is shared and must not be deleted.
+ */
+SLV2_DEPRECATED
+SLV2_API
+const LV2UI_Descriptor*
+slv2_ui_instance_get_descriptor(SLV2UIInstance instance);
+
+/** DEPRECATED: Get the LV2UI_Handle of the plugin UI instance.
+ * Normally hosts should not need to access the LV2UI_Handle directly,
+ * use the slv2_ui_instance_* functions.
+ *
+ * The returned handle is shared and must not be deleted.
+ */
+SLV2_DEPRECATED
+SLV2_API
+LV2UI_Handle
+slv2_ui_instance_get_handle(SLV2UIInstance instance);
+
+/** @} */
 /** @} */
 
 #ifdef __cplusplus