homescreen/homescreen: Bind to agl_shell_desktop
authorMarius Vlad <marius.vlad@collabora.com>
Wed, 22 Jul 2020 10:31:00 +0000 (13:31 +0300)
committerMarius Vlad <marius.vlad@collabora.com>
Thu, 23 Jul 2020 10:38:32 +0000 (13:38 +0300)
Bind to agl-shell-desktop protocol. Useful to propage events
from to QML about applications launched.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
homescreen/homescreen.pro
homescreen/protocol/agl-shell-desktop.xml [new file with mode: 0644]
homescreen/src/main.cpp
homescreen/src/shell.h

index ca9ea3b..ae705f9 100644 (file)
@@ -63,4 +63,5 @@ RESOURCES += \
 
 
 WAYLANDCLIENTSOURCES += \
-    protocol/agl-shell.xml
+    protocol/agl-shell.xml \
+    protocol/agl-shell-desktop.xml
diff --git a/homescreen/protocol/agl-shell-desktop.xml b/homescreen/protocol/agl-shell-desktop.xml
new file mode 100644 (file)
index 0000000..e8ae153
--- /dev/null
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="agl_shell_desktop">
+  <copyright>
+    Copyright © 2020 Collabora, Ltd.
+
+    Permission is hereby granted, free of charge, to any person obtaining a
+    copy of this software and associated documentation files (the "Software"),
+    to deal in the Software without restriction, including without limitation
+    the rights to use, copy, modify, merge, publish, distribute, sublicense,
+    and/or sell copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice (including the next
+    paragraph) shall be included in all copies or substantial portions of the
+    Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+    DEALINGS IN THE SOFTWARE.
+  </copyright>
+  <interface name="agl_shell_desktop" version="1">
+    <description summary="Private extension to allow applications activate other apps">
+      This extension can be used by regular application to instruct to compositor
+      to activate or switch to other running (regular) applications. The client
+      is responsbile for filtering their own app_id when receiving application id.
+
+      The compositor will allow clients to bind to this interface only if the
+      policy engine allows it.
+    </description>
+
+    <enum name="app_role">
+      <entry name="popup" value="0"/>
+      <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">
+      <entry name="activated" value="0"/>
+      <entry name="deactivated" value="1"/>
+    </enum>
+
+    <event name="application">
+      <description summary="advertise application id">
+        The compositor may choose to advertise one or more application ids which
+        can be used to activate/switch to.
+
+        When this global is bound, the compositor will send all application ids
+        available for activation, but may send additional application id at any
+        time (when they've been mapped in the compositor).
+      </description>
+      <arg name="app_id" type="string"/>
+    </event>
+
+    <request name="activate_app">
+      <description summary="make client current window">
+        Ask the compositor to make a toplevel to become the current/focused
+        window for window management purposes.
+
+        See xdg_toplevel.set_app_id from the xdg-shell protocol for a
+        description of app_id.
+      </description>
+      <arg name="app_id" type="string"/>
+      <arg name="app_data" type="string" allow-null="true"/>
+      <arg name="output" type="object" interface="wl_output"/>
+    </request>
+
+    <request name="set_app_property">
+      <description summary="set properties for a client identified by app_id">
+        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.
+      </description>
+      <arg name="app_id" type="string"/>
+      <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>
+
+    <request name="deactivate_app">
+      <description summary="de-activate/hide window identified by app_id">
+        Ask the compositor to hide the toplevel window for window
+        management purposes. Depending on the window role, this request
+        will either display the previously active window (or the background
+        in case there's no previously activate surface) or temporarly (or
+        until a 'activate_app' is called upon) hide the surface. All
+        the surfaces are identifiable by using the app_id, and no actions are
+        taken in case the app_id is not/was not present.
+
+        See xdg_toplevel.set_app_id from the xdg-shell protocol for a
+        description of app_id.
+      </description>
+      <arg name="app_id" type="string"/>
+    </request>
+
+    <event name="state_app">
+      <description summary="event sent when application has suffered state modification">
+        Notifies application(s) when other application have suffered state modifications.
+      </description>
+      <arg name="app_id" type="string"/>
+      <arg name="app_data" type="string" allow-null="true"/>
+      <arg name="state" type="uint" enum="app_state"/>
+      <arg name="role" type="uint" enum="app_role"/>
+    </event>
+
+  </interface>
+</protocol>
index 742daa6..2d9ac4d 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * Copyright (C) 2016, 2017 Mentor Graphics Development (Deutschland) GmbH
  * Copyright (c) 2017, 2018 TOYOTA MOTOR CORPORATION
+ * Copyright (c) 2020 Collabora, Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include <wayland-client.h>
 
 #include "wayland-agl-shell-client-protocol.h"
+#include "wayland-agl-shell-desktop-client-protocol.h"
 #include "shell.h"
 
+struct shell_container {
+       struct agl_shell *agl_shell;
+       struct agl_shell_desktop *agl_shell_desktop;
+       // used to propagate events from C/C++ event handlers from the protocol
+       // to the QML in case we need them
+       Shell *a_shell;
+};
+
+static void
+application_id_event(void *data, struct agl_shell_desktop *agl_shell_desktop,
+               const char *app_id)
+{
+}
+
+static void
+application_state_event(void *data, struct agl_shell_desktop *agl_shell_desktop,
+                    const char *app_id, const char *app_data,
+                    uint32_t app_state, uint32_t app_role)
+{
+}
+
+static const struct agl_shell_desktop_listener agl_shell_desktop_listener = {
+       application_id_event,
+       application_state_event,
+};
+
+
 static void
 global_add(void *data, struct wl_registry *reg, uint32_t name,
-          const char *interface, uint32_t)
+          const char *interface, uint32_t version)
 {
-       struct agl_shell **shell = static_cast<struct agl_shell **>(data);
+       struct shell_container *sc = static_cast<struct shell_container *>(data);
 
        if (strcmp(interface, agl_shell_interface.name) == 0) {
-               *shell = static_cast<struct agl_shell *>(
+               sc->agl_shell = static_cast<struct agl_shell *>(
                        wl_registry_bind(reg, name, &agl_shell_interface, 1)
                );
+       } else if (strcmp(interface, agl_shell_desktop_interface.name) == 0) {
+               sc->agl_shell_desktop = static_cast<struct agl_shell_desktop *>(
+                       wl_registry_bind(reg, name, &agl_shell_desktop_interface, 1)
+               );
+
+               agl_shell_desktop_add_listener(sc->agl_shell_desktop,
+                                              &agl_shell_desktop_listener, sc);
        }
 }
 
@@ -83,25 +119,33 @@ getWlOutput(QPlatformNativeInterface *native, QScreen *screen)
 }
 
 
-static struct agl_shell *
+static struct shell_container *
 register_agl_shell(QPlatformNativeInterface *native)
 {
        struct wl_display *wl;
        struct wl_registry *registry;
-       struct agl_shell *shell = nullptr;
+       struct shell_container *sc = new shell_container();
 
        wl = static_cast<struct wl_display *>(
                        native->nativeResourceForIntegration("display")
        );
        registry = wl_display_get_registry(wl);
 
-       wl_registry_add_listener(registry, &registry_listener, &shell);
+       wl_registry_add_listener(registry, &registry_listener, sc);
 
        /* Roundtrip to get all globals advertised by the compositor */
        wl_display_roundtrip(wl);
        wl_registry_destroy(registry);
 
-       return shell;
+       if (!sc->agl_shell) {
+               delete sc;
+       }
+
+       if (!sc->agl_shell_desktop) {
+               delete sc;
+       }
+
+       return sc;
 }
 
 static struct wl_surface *
@@ -137,13 +181,14 @@ find_screen(const char *screen_name)
 static void
 load_agl_shell_app(QPlatformNativeInterface *native,
                   QQmlApplicationEngine *engine,
-                  struct agl_shell *agl_shell, QUrl &bindingAddress,
+                  struct shell_container *sc, QUrl &bindingAddress,
                   const char *screen_name)
 {
        struct wl_surface *bg, *top, *bottom;
        struct wl_output *output;
        QObject *qobj_bg, *qobj_top, *qobj_bottom;
        QScreen *screen = nullptr;
+       struct agl_shell *agl_shell = sc->agl_shell;
 
        QQmlComponent bg_comp(engine, QUrl("qrc:/background.qml"));
        qInfo() << bg_comp.errors();
@@ -192,9 +237,10 @@ int main(int argc, char *argv[])
     setenv("QT_QPA_PLATFORM", "wayland", 1);
     QGuiApplication a(argc, argv);
     const char *screen_name;
+    int ret;
 
     QPlatformNativeInterface *native = qApp->platformNativeInterface();
-    struct agl_shell *agl_shell = nullptr;
+    struct shell_container *sc = nullptr;
     screen_name = getenv("HOMESCREEN_START_SCREEN");
 
     QCoreApplication::setOrganizationDomain("LinuxFoundation");
@@ -223,15 +269,17 @@ int main(int argc, char *argv[])
 
     HMI_DEBUG("HomeScreen","port = %d, token = %s", port, token.toStdString().c_str());
 
-    agl_shell = register_agl_shell(native);
-    if (!agl_shell) {
-           fprintf(stderr, "agl_shell extension is not advertised. "
-                           "Are you sure that agl-compositor is running?\n");
+    sc = register_agl_shell(native);
+    if (!sc) {
            exit(EXIT_FAILURE);
     }
 
-    std::shared_ptr<struct agl_shell> shell{agl_shell, agl_shell_destroy};
-    Shell *aglShell = new Shell(shell, &a);
+    std::shared_ptr<struct agl_shell>
+           shell{sc->agl_shell, agl_shell_destroy};
+    std::shared_ptr<struct agl_shell_desktop>
+           shell_desktop{sc->agl_shell_desktop, agl_shell_desktop_destroy};
+    Shell *aglShell = new Shell(shell, shell_desktop, &a);
+    sc->a_shell = aglShell;
 
     // import C++ class to QML
     // qmlRegisterType<ApplicationLauncher>("HomeScreen", 1, 0, "ApplicationLauncher");
@@ -270,7 +318,10 @@ int main(int argc, char *argv[])
     /* instead of loading main.qml we load one-by-one each of the QMLs,
      * divided now between several surfaces: panels, background.
      */
-    load_agl_shell_app(native, &engine, agl_shell, bindingAddress, screen_name);
+    load_agl_shell_app(native, &engine, sc, bindingAddress, screen_name);
+
+    ret = a.exec();
 
-    return a.exec();
+    delete sc;
+    return ret;
 }
index 8bf0e9b..0e7de82 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2019 Collabora Ltd.
+ * Copyright © 2019, 2020 Collabora Ltd.
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -33,6 +33,7 @@
 #include <QWindow>
 #include <memory>
 #include "wayland-agl-shell-client-protocol.h"
+#include "wayland-agl-shell-desktop-client-protocol.h"
 
 /*
  * Basic type to wrap the agl_shell wayland object into a QObject, so that it
@@ -45,9 +46,12 @@ class Shell : public QObject
 
 public:
     std::shared_ptr<struct agl_shell> shell;
+    std::shared_ptr<struct agl_shell_desktop> shell_desktop;
 
-    Shell(std::shared_ptr<struct agl_shell> shell, QObject *parent = nullptr) :
-        QObject(parent), shell(shell) 
+    Shell(std::shared_ptr<struct agl_shell> shell,
+         std::shared_ptr<struct agl_shell_desktop> shell_desktop,
+         QObject *parent = nullptr) :
+        QObject(parent), shell(shell), shell_desktop(shell_desktop)
     {}
 public slots:
     void activate_app(QWindow *win, const QString &app_id);