ivi-shell: rework remove_surface notification

The add_notification_remove_surface API accepts a simple
wl_listener instead of a ivi-shell specific notification
function. Therefore, the API is renamed to add_listener_remove_surface.

This change has several advantages:
1. Code cleanup
2. No dynamic memory allocation. Listeners are allocated
   by controller plugins
3. Remove API is not needed. Controller plugins can easily
   remove the listener link.

The remove API is removed too:
- ivi_layout_remove_notification_remove_surface

Signed-off-by: Emre Ucan <eucan@de.adit-jv.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>

ivi-shell/hmi-controller.c

@@ -128,6 +128,7 @@ struct hmi_controller {
 	struct wl_listener                  destroy_listener;
 
 	struct wl_listener                  surface_created;
+	struct wl_listener                  surface_removed;
 
 	struct wl_client                   *user_interface;
 	struct ui_setting                   ui_setting;
@@ -600,10 +601,12 @@ set_notification_create_surface(struct wl_listener *listener, void *data)
 }
 
 static void
-set_notification_remove_surface(struct ivi_layout_surface *ivisurf,
+set_notification_remove_surface(struct wl_listener *listener, void *data)
-				void *userdata)
 {
-	struct hmi_controller *hmi_ctrl = userdata;
+	struct hmi_controller *hmi_ctrl =
+			wl_container_of(listener, hmi_ctrl,
+					surface_removed);
+	(void)data;
 
 	switch_mode(hmi_ctrl, hmi_ctrl->layout_mode);
 }
@@ -840,8 +843,9 @@ hmi_controller_create(struct weston_compositor *ec)
 
 	hmi_ctrl->surface_created.notify = set_notification_create_surface;
 	ivi_layout_interface->add_listener_create_surface(&hmi_ctrl->surface_created);
-	ivi_layout_interface->add_notification_remove_surface(
+
-		set_notification_remove_surface, hmi_ctrl);
+	hmi_ctrl->surface_removed.notify = set_notification_remove_surface;
+	ivi_layout_interface->add_listener_remove_surface(&hmi_ctrl->surface_removed);
 	ivi_layout_interface->add_notification_configure_surface(
 		set_notification_configure_surface, hmi_ctrl);
 

ivi-shell/ivi-layout-export.h

@@ -138,10 +138,6 @@ enum ivi_layout_transition_type{
 	IVI_LAYOUT_TRANSITION_MAX,
 };
 
-typedef void (*surface_remove_notification_func)(
-			struct ivi_layout_surface *ivisurf,
-			void *userdata);
-
 typedef void (*surface_configure_notification_func)(
 			struct ivi_layout_surface *ivisurf,
 			void *userdata);
@@ -172,15 +168,14 @@ struct ivi_layout_interface {
 	int32_t (*add_listener_create_surface)(struct wl_listener *listener);
 
 	/**
-	 * \brief register/unregister for notification when ivi_surface is removed
+	 * \brief add a listener for notification when ivi_surface is removed
+	 *
+	 * When an ivi_surface is removed, a signal is emitted
+	 * to the listening controller plugins.
+	 * The pointer of the removed ivi_surface is sent as the void *data argument
+	 * to the wl_listener::notify callback function of the listener.
 	 */
-	int32_t (*add_notification_remove_surface)(
+	int32_t (*add_listener_remove_surface)(struct wl_listener *listener);
-				surface_remove_notification_func callback,
-				void *userdata);
-
-	void (*remove_notification_remove_surface)(
-				surface_remove_notification_func callback,
-				void *userdata);
 
 	/**
 	 * \brief register/unregister for notification when ivi_surface is configured

ivi-shell/ivi-layout.c

@@ -930,23 +930,6 @@ clear_surface_order_list(struct ivi_layout_layer *ivilayer)
 	}
 }
 
-static void
-surface_removed(struct wl_listener *listener, void *data)
-{
-	struct ivi_layout_surface *ivisurface = data;
-
-	struct listener_layout_notification *notification =
-		container_of(listener,
-			     struct listener_layout_notification,
-			     listener);
-
-	struct ivi_layout_notification_callback *removed_callback =
-		notification->userdata;
-
-	((surface_remove_notification_func)removed_callback->callback)
-		(ivisurface, removed_callback->data);
-}
-
 static void
 surface_configure_changed(struct wl_listener *listener,
 			  void *data)
@@ -1064,37 +1047,18 @@ ivi_layout_add_listener_create_surface(struct wl_listener *listener)
 }
 
 static int32_t
-ivi_layout_add_notification_remove_surface(surface_remove_notification_func callback,
+ivi_layout_add_listener_remove_surface(struct wl_listener *listener)
-					   void *userdata)
 {
 	struct ivi_layout *layout = get_instance();
-	struct ivi_layout_notification_callback *removed_callback = NULL;
 
-	if (callback == NULL) {
+	if (listener == NULL) {
-		weston_log("ivi_layout_add_notification_remove_surface: invalid argument\n");
+		weston_log("ivi_layout_add_listener_remove_surface: invalid argument\n");
-		return IVI_FAILED;
-	}
-
-	removed_callback = malloc(sizeof *removed_callback);
-	if (removed_callback == NULL) {
-		weston_log("fails to allocate memory\n");
 		return IVI_FAILED;
 	}
 
-	removed_callback->callback = callback;
+	wl_signal_add(&layout->surface_notification.removed, listener);
-	removed_callback->data = userdata;
 
-	return add_notification(&layout->surface_notification.removed,
+	return IVI_SUCCEEDED;
-				surface_removed,
-				removed_callback);
-}
-
-static void
-ivi_layout_remove_notification_remove_surface(surface_remove_notification_func callback,
-					      void *userdata)
-{
-	struct ivi_layout *layout = get_instance();
-	remove_notification(&layout->surface_notification.removed.listener_list, callback, userdata);
 }
 
 static int32_t
@@ -2123,8 +2087,7 @@ static struct ivi_layout_interface ivi_layout_interface = {
 	 * surface controller interfaces
 	 */
 	.add_listener_create_surface	= ivi_layout_add_listener_create_surface,
-	.add_notification_remove_surface	= ivi_layout_add_notification_remove_surface,
+	.add_listener_remove_surface	= ivi_layout_add_listener_remove_surface,
-	.remove_notification_remove_surface	= ivi_layout_remove_notification_remove_surface,
 	.add_notification_configure_surface	= ivi_layout_add_notification_configure_surface,
 	.remove_notification_configure_surface	= ivi_layout_remove_notification_configure_surface,
 	.get_surfaces				= ivi_layout_get_surfaces,

tests/ivi_layout-internal-test.c

@@ -873,7 +873,7 @@ test_surface_bad_remove_notification(struct test_context *ctx)
 {
 	const struct ivi_layout_interface *lyt = ctx->layout_interface;
 
-	iassert(lyt->add_notification_remove_surface(NULL, NULL) == IVI_FAILED);
+	iassert(lyt->add_listener_remove_surface(NULL) == IVI_FAILED);
 }
 
 /************************ tests end ********************************/

tests/ivi_layout-test-plugin.c

@@ -86,6 +86,7 @@ struct test_context {
 
 	struct wl_listener surface_property_changed;
 	struct wl_listener surface_created;
+	struct wl_listener surface_removed;
 };
 
 static struct test_context static_context;
@@ -952,11 +953,13 @@ RUNNER_TEST(surface_create_notification_p3)
 }
 
 static void
-test_surface_remove_notification_callback(struct ivi_layout_surface *ivisurf,
+test_surface_remove_notification_callback(struct wl_listener *listener, void *data)
-					  void *userdata)
 {
-	struct test_context *ctx = userdata;
+	struct test_context *ctx =
+			container_of(listener, struct test_context,
+					surface_removed);
 	const struct ivi_layout_interface *lyt = ctx->layout_interface;
+	struct ivi_layout_surface *ivisurf = data;
 
 	runner_assert_or_return(lyt->get_id_of_surface(ivisurf) == IVI_TEST_SURFACE_ID(0));
 
@@ -967,19 +970,19 @@ RUNNER_TEST(surface_remove_notification_p1)
 {
 	const struct ivi_layout_interface *lyt = ctx->layout_interface;
 
-	runner_assert(lyt->add_notification_remove_surface(
+	ctx->surface_removed.notify = test_surface_remove_notification_callback;
-		      test_surface_remove_notification_callback, ctx) == IVI_SUCCEEDED);
+	runner_assert(lyt->add_listener_remove_surface(&ctx->surface_removed)
+			== IVI_SUCCEEDED);
 
 	ctx->user_flags = 0;
 }
 
 RUNNER_TEST(surface_remove_notification_p2)
 {
-	const struct ivi_layout_interface *lyt = ctx->layout_interface;
-
 	runner_assert(ctx->user_flags == 1);
 
-	lyt->remove_notification_remove_surface(test_surface_remove_notification_callback, ctx);
+	// remove surface removed listener.
+	wl_list_remove(&ctx->surface_removed.link);
 	ctx->user_flags = 0;
 }