agl-shell: Add bound_ok and bound_fail events and a default destructor

As we're increasing the amount of combinations we could have in the AGL
platforms, in which we're mixing various platforms, we require a way
to tell clients that there's already a shell client which in charge.

We can't really have multiple shell clients managing the windows and
surfaces, but in the same time we don't want to sever the wayland
connection the way it happens currently. Racy alternatives might exist,
which  avoid advertising the interface altogether once a
client did bind to the interface but that's not really a
viable solution.

So instead of doing that, this patch introduces two new events which
tells the client that it was either successful, and it can continue
issue requests and receive events or a that it the bind failed. The
client can chose to wait and try later and abandon to bind to the
agl_shell intefface, and behave like a regular client.

While doing an update to protocol to add those two events this patch add
also a default destructor for the protocol.

Bug-AGL: SPEC-4502
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Iacb86a668d1c4630724eecdb18e4b4c2d4e8e34a

1 files changed, 69 insertions, 6 deletions

diff --git a/src/shell.c b/src/shell.c
index dc07c26..28c1117 100644
--- a/src/shell.c
+++ b/src/shell.c
@@ -1017,10 +1017,20 @@ shell_ready(struct wl_client *client, struct wl_resource *shell_res)
 	struct ivi_output *output;
 	struct ivi_surface *surface, *tmp;
 
+	if (ivi->shell_client.resource &&
+	    ivi->shell_client.status == BOUND_FAILED) {
+		wl_resource_post_error(shell_res,
+				       WL_DISPLAY_ERROR_INVALID_OBJECT,
+				       "agl_shell has already been bound. "
+				       "Check out bound_fail event");
+		return;
+	}
+
 	/* Init already finished. Do nothing */
 	if (ivi->shell_client.ready)
 		return;
 
+
 	ivi->shell_client.ready = true;
 
 	wl_list_for_each(output, &ivi->outputs, link) {
@@ -1047,9 +1057,19 @@ shell_set_background(struct wl_client *client,
 	struct weston_output *woutput = weston_head_get_output(head);
 	struct ivi_output *output = to_ivi_output(woutput);
 	struct weston_surface *wsurface = wl_resource_get_user_data(surface_res);
+	struct ivi_compositor *ivi = wl_resource_get_user_data(shell_res);
 	struct weston_desktop_surface *dsurface;
 	struct ivi_surface *surface;
 
+	if (ivi->shell_client.resource &&
+	    ivi->shell_client.status == BOUND_FAILED) {
+		wl_resource_post_error(shell_res,
+				       WL_DISPLAY_ERROR_INVALID_OBJECT,
+				       "agl_shell has already been bound. "
+				       "Check out bound_fail event");
+		return;
+	}
+
 	dsurface = weston_surface_get_desktop_surface(wsurface);
 	if (!dsurface) {
 		wl_resource_post_error(shell_res,
@@ -1098,11 +1118,21 @@ shell_set_panel(struct wl_client *client,
 	struct weston_output *woutput = weston_head_get_output(head);
 	struct ivi_output *output = to_ivi_output(woutput);
 	struct weston_surface *wsurface = wl_resource_get_user_data(surface_res);
+	struct ivi_compositor *ivi = wl_resource_get_user_data(shell_res);
 	struct weston_desktop_surface *dsurface;
 	struct ivi_surface *surface;
 	struct ivi_surface **member;
 	int32_t width = 0, height = 0;
 
+	if (ivi->shell_client.resource &&
+	    ivi->shell_client.status == BOUND_FAILED) {
+		wl_resource_post_error(shell_res,
+				       WL_DISPLAY_ERROR_INVALID_OBJECT,
+				       "agl_shell has already been bound. "
+				       "Check out bound_fail event");
+		return;
+	}
+
 	dsurface = weston_surface_get_desktop_surface(wsurface);
 	if (!dsurface) {
 		wl_resource_post_error(shell_res,
@@ -1208,8 +1238,18 @@ shell_activate_app(struct wl_client *client,
 {
 	struct weston_head *head = weston_head_from_resource(output_res);
 	struct weston_output *woutput = weston_head_get_output(head);
+	struct ivi_compositor *ivi = wl_resource_get_user_data(shell_res);
 	struct ivi_output *output = to_ivi_output(woutput);
 
+	if (ivi->shell_client.resource &&
+	    ivi->shell_client.status == BOUND_FAILED) {
+		wl_resource_post_error(shell_res,
+				       WL_DISPLAY_ERROR_INVALID_OBJECT,
+				       "agl_shell has already been bound. "
+				       "Check out bound_fail event");
+		return;
+	}
+
 	ivi_layout_activate(output, app_id);
 }
 
@@ -1241,7 +1281,14 @@ shell_deactivate_app(struct wl_client *client,
 				  NULL, AGL_SHELL_DESKTOP_APP_STATE_DEACTIVATED);
 }
 
+/* stub, no usage for the time being */
+static void
+shell_destroy(struct wl_client *client, struct wl_resource *res)
+{
+}
+
 static const struct agl_shell_interface agl_shell_implementation = {
+	.destroy = shell_destroy,
 	.ready = shell_ready,
 	.set_background = shell_set_background,
 	.set_panel = shell_set_panel,
@@ -1334,6 +1381,14 @@ unbind_agl_shell(struct wl_resource *resource)
 	struct ivi_surface *surf, *surf_tmp;
 
 	ivi = wl_resource_get_user_data(resource);
+
+	/* reset status to allow other clients issue legit requests */
+	if (ivi->shell_client.resource &&
+	    ivi->shell_client.status == BOUND_FAILED) {
+		ivi->shell_client.status = BOUND_OK;
+		return;
+	}
+
 	wl_list_for_each(output, &ivi->outputs, link) {
 		/* reset the active surf if there's one present */
 		if (output->active) {
@@ -1383,22 +1438,30 @@ bind_agl_shell(struct wl_client *client,
 		return;
 	}
 
-	resource = wl_resource_create(client, &agl_shell_interface,
-				      1, id);
+	resource = wl_resource_create(client, &agl_shell_interface, version, id);
 	if (!resource) {
 		wl_client_post_no_memory(client);
 		return;
 	}
 
 	if (ivi->shell_client.resource) {
-		wl_resource_post_error(resource, WL_DISPLAY_ERROR_INVALID_OBJECT,
-				       "agl_shell has already been bound");
-		return;
+		if (wl_resource_get_version(resource) == 1) {
+			wl_resource_post_error(resource, WL_DISPLAY_ERROR_INVALID_OBJECT,
+					       "agl_shell has already been bound");
+			return;
+		}
+
+		agl_shell_send_bound_fail(resource);
+		ivi->shell_client.status = BOUND_FAILED;
 	}
 
 	wl_resource_set_implementation(resource, &agl_shell_implementation,
 				       ivi, unbind_agl_shell);
 	ivi->shell_client.resource = resource;
+
+	if (ivi->shell_client.status == BOUND_OK &&
+	    wl_resource_get_version(resource) >= AGL_SHELL_BOUND_OK_SINCE_VERSION)
+		agl_shell_send_bound_ok(ivi->shell_client.resource);
 }
 
 static void
@@ -1457,7 +1520,7 @@ int
 ivi_shell_create_global(struct ivi_compositor *ivi)
 {
 	ivi->agl_shell = wl_global_create(ivi->compositor->wl_display,
-					  &agl_shell_interface, 1,
+					  &agl_shell_interface, 2,
 					  ivi, bind_agl_shell);
 	if (!ivi->agl_shell) {
 		weston_log("Failed to create wayland global.\n");