Remove UI instance API from SLV2 (apps should implement UIs via Suil now).

Remove UI extension API and header from public APIs entirely.
Rework UI instance API to support multiple UIs and a more precise notion of embedding support.


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

3 files changed, 92 insertions, 24 deletions

diff --git a/src/host.c b/src/host.c
new file mode 100644
index 0000000..281142d
--- /dev/null
+++ b/src/host.c
@@ -0,0 +1,48 @@
+/*
+  Copyright 2011 David Robillard <http://drobilla.net>
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+  AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+  THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#include "suil_internal.h"
+
+SUIL_API
+SuilHost
+suil_host_new(SuilPortWriteFunc       write_func,
+              SuilPortIndexFunc       index_func,
+              SuilPortSubscribeFunc   subscribe_func,
+              SuilPortUnsubscribeFunc unsubscribe_func)
+{
+	SuilHost host = malloc(sizeof(struct _SuilHost));
+	host->write_func       = write_func;
+	host->index_func       = index_func;
+	host->subscribe_func   = subscribe_func;
+	host->unsubscribe_func = unsubscribe_func;
+	return host;
+}
+
+SUIL_API
+void
+suil_host_free(SuilHost host)
+{
+	free(host);
+}
diff --git a/src/instance.c b/src/instance.c
index 6458d51..42b87d3 100644
--- a/src/instance.c
+++ b/src/instance.c
@@ -39,14 +39,25 @@
 #define QT4_UI_URI  NS_UI "Qt4UI"
 
 SUIL_API
-bool
-suil_ui_type_supported(const char* host_type_uri,
-                       const char* ui_type_uri)
+unsigned
+suil_ui_supported(const char* container_type_uri,
+                  const char* ui_type_uri)
 {
-	return (!strcmp(host_type_uri, GTK2_UI_URI)
-	        || !strcmp(host_type_uri, QT4_UI_URI))
-		&& (!strcmp(ui_type_uri, GTK2_UI_URI)
-		    || !strcmp(ui_type_uri, QT4_UI_URI));
+	enum {
+		SUIL_WRAPPING_UNSUPPORTED = 0,
+		SUIL_WRAPPING_NATIVE      = 1,
+		SUIL_WRAPPING_EMBEDDED    = 2
+	};
+	if (!strcmp(container_type_uri, ui_type_uri)) {
+		return SUIL_WRAPPING_NATIVE;
+	} else if ((!strcmp(container_type_uri, GTK2_UI_URI)
+	            && !strcmp(ui_type_uri, QT4_UI_URI))
+	           || (!strcmp(container_type_uri, QT4_UI_URI)
+	               && !strcmp(ui_type_uri, GTK2_UI_URI))) {
+		return SUIL_WRAPPING_EMBEDDED;
+	} else {
+		return SUIL_WRAPPING_UNSUPPORTED;
+	}
 }
 
 struct _SuilModule {
@@ -57,25 +68,25 @@ struct _SuilModule {
 typedef struct _SuilModule* SuilModule;
 
 static SuilModule
-get_wrap_module(const char* host_type_uri,
+get_wrap_module(const char* container_type_uri,
                 const char* ui_type_uri)
 {
-	if (!strcmp(host_type_uri, ui_type_uri)) {
+	if (!strcmp(container_type_uri, ui_type_uri)) {
 		return NULL;
 	}
 
 	const char* module_name = NULL;
-	if (!strcmp(host_type_uri, QT4_UI_URI)
+	if (!strcmp(container_type_uri, QT4_UI_URI)
 	    && !strcmp(ui_type_uri, GTK2_UI_URI)) {
 		module_name = "libsuil_gtk2_in_qt4";
-	} else if (!strcmp(host_type_uri, GTK2_UI_URI)
+	} else if (!strcmp(container_type_uri, GTK2_UI_URI)
 	    && !strcmp(ui_type_uri, QT4_UI_URI)) {
 		module_name = "libsuil_qt4_in_gtk2";
 	}
 
 	if (!module_name) {
 		SUIL_ERRORF("Unable to wrap UI type <%s> as type <%s>\n",
-		            ui_type_uri, host_type_uri);
+		            ui_type_uri, container_type_uri);
 		return NULL;
 	}
 
@@ -114,14 +125,14 @@ get_wrap_module(const char* host_type_uri,
 
 SUIL_API
 SuilInstance
-suil_instance_new(const char*               plugin_uri,
+suil_instance_new(SuilHost                  host,
+                  SuilController            controller,
+                  const char*               container_type_uri,
+                  const char*               plugin_uri,
                   const char*               ui_uri,
+                  const char*               ui_type_uri,
                   const char*               ui_bundle_path,
                   const char*               ui_binary_path,
-                  const char*               ui_type_uri,
-                  const char*               host_type_uri,
-                  LV2UI_Write_Function      write_function,
-                  LV2UI_Controller          controller,
                   const LV2_Feature* const* features)
 {
 	// Open UI library
@@ -166,9 +177,9 @@ suil_instance_new(const char*               plugin_uri,
 		features = (const LV2_Feature* const*)&local_features;
 	}
 
-	SuilModule module = get_wrap_module(host_type_uri, ui_type_uri);
+	SuilModule module = get_wrap_module(container_type_uri, ui_type_uri);
 	if (module) {
-		module->init(host_type_uri, ui_type_uri, features);
+		module->init(container_type_uri, ui_type_uri, features);
 	}
 
 	// Instantiate UI
@@ -181,7 +192,7 @@ suil_instance_new(const char*               plugin_uri,
 		descriptor,
 		plugin_uri,
 		ui_bundle_path,
-		write_function,
+		host->write_func,
 		controller,
 		&instance->ui_widget,
 		features);
@@ -204,9 +215,9 @@ suil_instance_new(const char*               plugin_uri,
 	}
 
 	if (module) {
-		if (module->wrap(host_type_uri, ui_type_uri, instance)) {
+		if (module->wrap(container_type_uri, ui_type_uri, instance)) {
 			SUIL_ERRORF("Failed to wrap UI <%s> in type <%s>\n",
-			            ui_uri, host_type_uri);
+			            ui_uri, container_type_uri);
 			suil_instance_free(instance);
 			return NULL;
 		}
diff --git a/src/suil_internal.h b/src/suil_internal.h
index 12dee3e..b8e6f0b 100644
--- a/src/suil_internal.h
+++ b/src/suil_internal.h
@@ -29,6 +29,8 @@
 #include <assert.h>
 #include <stdlib.h>
 
+#include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
+
 #ifdef __WIN32__
 #include <windows.h>
 #define dlopen(path, flags) LoadLibrary(path)
@@ -44,12 +46,19 @@ static inline char* dlerror(void) { return "Unknown error"; }
 #define SUIL_ERRORF(fmt, ...) fprintf(stderr, "error: %s: " fmt, \
                                       __func__, __VA_ARGS__)
 
+struct _SuilHost {
+	SuilPortWriteFunc       write_func;
+	SuilPortIndexFunc       index_func;
+	SuilPortSubscribeFunc   subscribe_func;
+	SuilPortUnsubscribeFunc unsubscribe_func;
+};
+
 struct _SuilInstance {
 	void*                   lib_handle;
 	const LV2UI_Descriptor* descriptor;
 	LV2UI_Handle            handle;
-	LV2UI_Widget            ui_widget;
-	LV2UI_Widget            host_widget;
+	SuilWidget              ui_widget;
+	SuilWidget              host_widget;
 };
 
 /** Type of a module's suil_wrap_init function.