From 40e6e78a19483dc5822ded81cea041f3983a877f Mon Sep 17 00:00:00 2001
From: Marius Vlad <marius.vlad@collabora.com>
Date: Wed, 24 Jun 2020 16:37:50 +0300
Subject: Add protocol remote role and bounding box

Bug-AGL: SPEC-3447

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Icdcd76a75177dd7dd20a3a4e69fa1b79edc5de8d
---
 app/main.cpp                       |  3 ++-
 app/protocol/agl-shell-desktop.xml | 33 ++++++++++++++++++++++++++++++---
 app/shell-desktop.cpp              |  6 ++++--
 app/shell-desktop.h                |  4 +++-
 4 files changed, 39 insertions(+), 7 deletions(-)

(limited to 'app')

diff --git a/app/main.cpp b/app/main.cpp
index 8d731d2..f78897f 100644
--- a/app/main.cpp
+++ b/app/main.cpp
@@ -266,7 +266,8 @@ int main(int argc, char *argv[])
 	// note that x and y initial positioning values have to be specified
 	// here (the last two args)
 	aglShell->set_window_props(nullptr, my_app_id,
-				   AGL_SHELL_DESKTOP_APP_ROLE_POPUP, 0, 0);
+				   AGL_SHELL_DESKTOP_APP_ROLE_POPUP,
+				   0, 0, 0, 0, 0, 0);
 
 	// Load qml
 	QQmlApplicationEngine engine;
diff --git a/app/protocol/agl-shell-desktop.xml b/app/protocol/agl-shell-desktop.xml
index 9ef4cca..e7b9493 100644
--- a/app/protocol/agl-shell-desktop.xml
+++ b/app/protocol/agl-shell-desktop.xml
@@ -37,6 +37,7 @@
       <entry name="fullscreen" value="1"/>
       <entry name="split_vertical" value="2"/>
       <entry name="split_horizontal" value="3"/>
+      <entry name="remote" value="4"/>
     </enum>
 
     <enum name="app_state">
@@ -71,9 +72,31 @@
 
     <request name="set_app_property">
       <description summary="set properties for a client identified by app_id">
-        Ask the compositor to make a toplevel obey the app_role and, depending
-        on the role, to use the the x and y values as initial positional values.
-        The x and y values would only make sense for certain roles.
+        Ask the compositor to make a top-level window obey the 'app_role' enum
+        and, depending on that role, to use some of the arguments as initial
+        values to take into account.
+
+        Note that x, y, bx, by, width and height would only make sense for the
+        pop-up role, with the output argument being applicable to all the roles.
+        The width and height values define the maximum area which the
+        top-level window should be placed into. Note this doesn't correspond to
+        top-level surface size, but to a bounding box which will be used to
+        clip the surface to, in case the surface area extends that of this
+        bounding box. Both of these values need to be larger than 0 (zero) to be
+        taken into account by the compositor. Any negative values for the width
+        and height will be discarded.
+
+        The x and y values will serve as the (initial) position values.
+        The bx and by values are the top-left x and y value of the bounding box.
+        Any clipping happening to the bounding box will not affect the surface
+        size or the position of the underlying surface backing the top-level
+        window. The bx and by values, like the positional values, could be
+        both set to zero, or even negative values. The compositor will pass
+        those on without any further validation.
+
+        The initial position values and the bounding rectangle will still be
+        in effect on a subsequent activation request of the 'app_id', assuming
+        it was previously de-activated at some point in time.
 
         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
         description of app_id.
@@ -82,6 +105,10 @@
       <arg name="role" type="uint" enum="app_role"/>
       <arg name="x" type="int"/>
       <arg name="y" type="int"/>
+      <arg name="bx" type="int"/>
+      <arg name="by" type="int"/>
+      <arg name="width" type="int"/>
+      <arg name="height" type="int"/>
       <arg name="output" type="object" interface="wl_output"/>
     </request>
 
diff --git a/app/shell-desktop.cpp b/app/shell-desktop.cpp
index 2aa5ee1..7cd239d 100644
--- a/app/shell-desktop.cpp
+++ b/app/shell-desktop.cpp
@@ -77,7 +77,9 @@ void Shell::deactivate_app(const QString &app_id)
 	flush_connection();
 }
 
-void Shell::set_window_props(QWindow *win, const QString &app_id, uint32_t props, int x, int y)
+void Shell::set_window_props(QWindow *win, const QString &app_id,
+			     uint32_t props, int x, int y, int bx, int by,
+			     int bwidth, int bheight)
 {
 	QScreen *screen = nullptr;
 	struct wl_output *output;
@@ -95,6 +97,6 @@ void Shell::set_window_props(QWindow *win, const QString &app_id, uint32_t props
 	output = getWlOutput(screen);
 	agl_shell_desktop_set_app_property(this->shell.get(),
 					   app_id.toStdString().c_str(),
-					   props, x, y, output);
+					   props, x, y, bx, by, bwidth, bheight, output);
 	flush_connection();
 }
diff --git a/app/shell-desktop.h b/app/shell-desktop.h
index 0b1c6be..fe9b8ba 100644
--- a/app/shell-desktop.h
+++ b/app/shell-desktop.h
@@ -55,7 +55,9 @@ signals:
 public slots: // calls out of qml into CPP
 	void activate_app(QWindow *win, const QString &app_id, const QString &app_data);
 	void deactivate_app(const QString &app_id);
-	void set_window_props(QWindow *win, const QString &app_id, uint32_t props, int x, int y);
+	void set_window_props(QWindow *win, const QString &app_id,
+			uint32_t props, int x, int y, int bx, int by,
+			int bwidth, int bheight);
 };
 
 #endif // SHELLDESKTOP_H
-- 
cgit 1.2.3-korg