main: Handle terminating event
[apps/homescreen.git] / homescreen / src / main.cpp
index 2c2f7c0..a98a15b 100644 (file)
@@ -3,6 +3,7 @@
  * Copyright (C) 2016, 2017 Mentor Graphics Development (Deutschland) GmbH
  * Copyright (c) 2017, 2018 TOYOTA MOTOR CORPORATION
  * Copyright (c) 2022 Konsulko Group
+ * Copyright (c) 2023 Collabora, Ltd.
  */
 
 #include <QGuiApplication>
@@ -15,6 +16,7 @@
 #include <QtQml/qqml.h>
 #include <QQuickWindow>
 #include <QTimer>
+#include <QScreen>
 
 #include <weather.h>
 #include <bluetooth.h>
 #include "homescreenhandler.h"
 #include "hmi-debug.h"
 
-#include <qpa/qplatformnativeinterface.h>
+// meson will define these
+#include QT_QPA_HEADER
 #include <wayland-client.h>
 
-#include "wayland-agl-shell-client-protocol.h"
-#include "wayland-agl-shell-desktop-client-protocol.h"
-#include "shell.h"
+#include "agl-shell-client-protocol.h"
+
+#include <thread>
+#include "AglShellGrpcClient.h"
+
+#ifndef MIN
+#define MIN(a, b) (((a) < (b)) ? (a) : (b))
+#endif
+
+QScreen *
+find_screen(const char *screen_name)
+{
+       QList<QScreen *> screens = qApp->screens();
+       QScreen *found = nullptr;
+       QString qstr_name = QString::fromUtf8(screen_name, -1);
+
+       for (QScreen *xscreen : screens) {
+               if (qstr_name == xscreen->name()) {
+                       found = xscreen;
+                       break;
+               }
+       }
+
+       return found;
+}
 
 struct shell_data {
        struct agl_shell *shell;
-       struct agl_shell_desktop *shell_desktop;
+       HomescreenHandler *homescreenHandler;
+       bool wait_for_bound;
+       bool bound_ok;
+       int ver;
 };
 
 static void
-agl_shell_desktop_application(void *data,
-                             struct agl_shell_desktop *agl_shell_desktop,
-                             const char *app_id)
+agl_shell_bound_ok(void *data, struct agl_shell *agl_shell)
 {
-       HomescreenHandler *homescreenHandler = static_cast<HomescreenHandler *>(data);
+       struct shell_data *shell_data = static_cast<struct shell_data *>(data);
+       shell_data->wait_for_bound = false;
 
-       if (homescreenHandler)
-               homescreenHandler->addAppToStack(app_id);
+       shell_data->bound_ok = true;
 }
 
 static void
-agl_shell_desktop_state_app(void *data,
-                           struct agl_shell_desktop *agl_shell_desktop,
-                           const char *app_id,
-                           const char *app_data,
-                           uint32_t state,
-                           uint32_t role)
+agl_shell_bound_fail(void *data, struct agl_shell *agl_shell)
 {
-       HomescreenHandler *homescreenHandler = static_cast<HomescreenHandler *>(data);
+       struct shell_data *shell_data = static_cast<struct shell_data *>(data);
+       shell_data->wait_for_bound = false;
+
+       shell_data->bound_ok = false;
+}
+
+static void
+agl_shell_app_state(void *data, struct agl_shell *agl_shell,
+               const char *app_id, uint32_t state)
+{
+       /* unused */
+}
+
+static void
+agl_shell_app_on_output(void *data, struct agl_shell *agl_shell,
+               const char *app_id, const char *output_name)
+{
+       struct shell_data *shell_data = static_cast<struct shell_data *>(data);
+       HomescreenHandler *homescreenHandler = shell_data->homescreenHandler;
 
-       if (homescreenHandler && state == AGL_SHELL_DESKTOP_APP_STATE_DESTROYED)
-               homescreenHandler->deactivateApp(app_id);
+       if (!homescreenHandler)
+               return;
+
+       // a couple of use-cases, if there is no app_id in the app_list then it
+       // means this is a request to map the application, from the start to a
+       // different output that the default one. We'd get an
+       // AGL_SHELL_APP_STATE_STARTED which will handle activation.
+       //
+       // if there's an app_id then it means we might have gotten an event to
+       // move the application to another output; so we'd need to process it
+       // by explicitly calling processAppStatusEvent() which would ultimately
+       // activate the application on other output. We'd have to pick-up the
+       // last activated window and activate the default output.
+       //
+       // finally if the outputs are identical probably that's an user-error -
+       // but the compositor won't activate it again, so we don't handle that.
+       std::pair new_pending_app = std::pair(QString(app_id),
+                                             QString(output_name));
+       homescreenHandler->pending_app_list.push_back(new_pending_app);
+
+       if (homescreenHandler->apps_stack.contains(QString(app_id))) {
+               qDebug() << "Got event to move " << app_id <<
+                       " to another output " << output_name;
+
+               homescreenHandler->processAppStatusEvent(app_id, "started");
+       }
 }
 
-static const struct agl_shell_desktop_listener shell_desktop_listener = {
-   agl_shell_desktop_application,
-   agl_shell_desktop_state_app
+
+#ifdef AGL_SHELL_BOUND_OK_SINCE_VERSION
+static const struct agl_shell_listener shell_listener = {
+       agl_shell_bound_ok,
+       agl_shell_bound_fail,
+       agl_shell_app_state,
+       agl_shell_app_on_output,
 };
+#endif
 
 static void
 global_add(void *data, struct wl_registry *reg, uint32_t name,
-          const char *interface, uint32_t)
+          const char *interface, uint32_t ver)
 {
        struct shell_data *shell_data = static_cast<struct shell_data *>(data);
 
@@ -77,15 +145,20 @@ global_add(void *data, struct wl_registry *reg, uint32_t name,
                return;
 
        if (strcmp(interface, agl_shell_interface.name) == 0) {
-               shell_data->shell = static_cast<struct agl_shell *>(
-                       wl_registry_bind(reg, name, &agl_shell_interface, 1)
-               );
-       }
+               if (ver >= 2) {
+                       shell_data->shell =
+                               static_cast<struct agl_shell *>(
+                                       wl_registry_bind(reg, name, &agl_shell_interface, MIN(8, ver)));
+#ifdef AGL_SHELL_BOUND_OK_SINCE_VERSION
+                       agl_shell_add_listener(shell_data->shell, &shell_listener, data);
+#endif
+               } else {
+                       shell_data->shell =
+                               static_cast<struct agl_shell *>(
+                                       wl_registry_bind(reg, name, &agl_shell_interface, 1));
+               }
+               shell_data->ver = ver;
 
-       if (strcmp(interface, agl_shell_desktop_interface.name) == 0) {
-               shell_data->shell_desktop = static_cast<struct agl_shell_desktop *>(
-                       wl_registry_bind(reg, name, &agl_shell_desktop_interface, 1)
-               );
        }
 }
 
@@ -117,6 +190,14 @@ getWlOutput(QPlatformNativeInterface *native, QScreen *screen)
        return static_cast<struct ::wl_output*>(output);
 }
 
+static struct wl_display *
+getWlDisplay(QPlatformNativeInterface *native)
+{
+       return static_cast<struct wl_display *>(
+               native->nativeResourceForIntegration("display")
+       );
+}
+
 
 static void
 register_agl_shell(QPlatformNativeInterface *native, struct shell_data *shell_data)
@@ -124,9 +205,7 @@ register_agl_shell(QPlatformNativeInterface *native, struct shell_data *shell_da
        struct wl_display *wl;
        struct wl_registry *registry;
 
-       wl = static_cast<struct wl_display *>(
-                       native->nativeResourceForIntegration("display")
-       );
+       wl = getWlDisplay(native);
        registry = wl_display_get_registry(wl);
 
        wl_registry_add_listener(registry, &registry_listener, shell_data);
@@ -149,62 +228,104 @@ create_component(QPlatformNativeInterface *native, QQmlComponent *comp,
        return getWlSurface(native, win);
 }
 
-static QScreen *
-find_screen(const char *screen_name)
+
+static void
+load_agl_shell(QPlatformNativeInterface *native, QQmlApplicationEngine *engine,
+              struct agl_shell *agl_shell, QScreen *screen)
 {
-       QList<QScreen *> screens = qApp->screens();
-       QScreen *found = nullptr;
-       QString qstr_name = QString::fromUtf8(screen_name, -1);
+       struct wl_surface *bg;
+       struct wl_output *output;
+       int32_t x, y;
+       int32_t width, height;
+       QObject *qobj_bg;
+       QSize size = screen->size();
 
-       for (QScreen *xscreen : screens) {
-               if (qstr_name == xscreen->name()) {
-                       found = xscreen;
-                       break;
-               }
-       }
+       // this incorporates the panels directly, but in doing so, it
+       // would also need to specify an activation area the same area
+       // in order to void overlapping any new activation window
+       QQmlComponent bg_comp(engine, QUrl("qrc:/background_with_panels.qml"));
+       qInfo() << bg_comp.errors();
 
-       return found;
+       bg = create_component(native, &bg_comp, screen, &qobj_bg);
+
+       output = getWlOutput(native, screen);
+
+       qDebug() << "Normal mode - with single surface";
+       qDebug() << "Setting homescreen to screen  " << screen->name();
+       agl_shell_set_background(agl_shell, bg, output);
+
+       // 216 is the width size of the panel
+       x = 0;
+       y = 216;
+
+       width  = size.width();
+       height = size.height() - (2 * y);
+
+       qDebug() << "Using custom rectangle " << width << "x" << height
+               << "+" << x << "x" << y << " for activation";
+       qDebug() << "Panels should be embedded the background surface";
+
+#ifdef AGL_SHELL_SET_ACTIVATE_REGION_SINCE_VERSION
+       agl_shell_set_activate_region(agl_shell, output,
+                                     x, y, width, height);
+#endif
 }
 
 static void
-load_agl_shell_app(QPlatformNativeInterface *native,
-                  QQmlApplicationEngine *engine,
-                  struct agl_shell *agl_shell,
-                  const char *screen_name,
-                   bool is_demo)
+load_agl_shell_for_ci(QPlatformNativeInterface *native,
+                     QQmlApplicationEngine *engine,
+                     struct agl_shell *agl_shell, QScreen *screen)
 {
        struct wl_surface *bg, *top, *bottom;
        struct wl_output *output;
        QObject *qobj_bg, *qobj_top, *qobj_bottom;
-       QScreen *screen = nullptr;
 
-       if (is_demo) {
-               QQmlComponent bg_comp(engine, QUrl("qrc:/background_demo.qml"));
-               qInfo() << bg_comp.errors();
+       QQmlComponent bg_comp(engine, QUrl("qrc:/background_demo.qml"));
+       qInfo() << bg_comp.errors();
 
-               QQmlComponent top_comp(engine, QUrl("qrc:/toppanel_demo.qml"));
-               qInfo() << top_comp.errors();
+       QQmlComponent top_comp(engine, QUrl("qrc:/toppanel_demo.qml"));
+       qInfo() << top_comp.errors();
 
-               QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel_demo.qml"));
-               qInfo() << bot_comp.errors();
+       QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel_demo.qml"));
+       qInfo() << bot_comp.errors();
 
-               top = create_component(native, &top_comp, screen, &qobj_top);
-               bottom = create_component(native, &bot_comp, screen, &qobj_bottom);
-               bg = create_component(native, &bg_comp, screen, &qobj_bg);
-       } else {
-               QQmlComponent bg_comp(engine, QUrl("qrc:/background.qml"));
-               qInfo() << bg_comp.errors();
+       top = create_component(native, &top_comp, screen, &qobj_top);
+       bottom = create_component(native, &bot_comp, screen, &qobj_bottom);
+       bg = create_component(native, &bg_comp, screen, &qobj_bg);
 
-               QQmlComponent top_comp(engine, QUrl("qrc:/toppanel.qml"));
-               qInfo() << top_comp.errors();
+       /* engine.rootObjects() works only if we had a load() */
+       StatusBarModel *statusBar = qobj_top->findChild<StatusBarModel *>("statusBar");
+       if (statusBar) {
+               qDebug() << "got statusBar objectname, doing init()";
+               statusBar->init(engine->rootContext());
+       }
 
-               QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel.qml"));
-               qInfo() << bot_comp.errors();
+       output = getWlOutput(native, screen);
 
-               top = create_component(native, &top_comp, screen, &qobj_top);
-               bottom = create_component(native, &bot_comp, screen, &qobj_bottom);
-               bg = create_component(native, &bg_comp, screen, &qobj_bg);
-       }
+       qDebug() << "Setting homescreen to screen  " << screen->name();
+
+       agl_shell_set_background(agl_shell, bg, output);
+       agl_shell_set_panel(agl_shell, top, output, AGL_SHELL_EDGE_TOP);
+       agl_shell_set_panel(agl_shell, bottom, output, AGL_SHELL_EDGE_BOTTOM);
+
+       qDebug() << "CI mode - with multiple surfaces";
+}
+
+static void
+app_status_callback(::agl_shell_ipc::AppStateResponse app_response, void *data);
+
+static void
+run_in_thread(GrpcClient *client)
+{
+       grpc::Status status = client->Wait();
+}
+
+static void
+load_agl_shell_app(QPlatformNativeInterface *native, QQmlApplicationEngine *engine,
+                  struct shell_data shell_data, const char *screen_name, bool is_demo)
+{
+       QScreen *screen = nullptr;
+       HomescreenHandler *homescreenHandler = shell_data.homescreenHandler;
 
        if (!screen_name)
                screen = qApp->primaryScreen();
@@ -216,30 +337,56 @@ load_agl_shell_app(QPlatformNativeInterface *native,
                return;
        }
 
-       qDebug() << "found primary screen " << qApp->primaryScreen()->name() <<
-               "first screen " << qApp->screens().first()->name();
-       output = getWlOutput(native, screen);
-
-       /* engine.rootObjects() works only if we had a load() */
-       StatusBarModel *statusBar = qobj_top->findChild<StatusBarModel *>("statusBar");
-       if (statusBar) {
-               qDebug() << "got statusBar objectname, doing init()";
-               statusBar->init(engine->rootContext());
+       if (is_demo) {
+               load_agl_shell_for_ci(native, engine, shell_data.shell, screen);
+       } else {
+               load_agl_shell(native, engine, shell_data.shell, screen);
        }
 
-       agl_shell_set_panel(agl_shell, top, output, AGL_SHELL_EDGE_TOP);
-       agl_shell_set_panel(agl_shell, bottom, output, AGL_SHELL_EDGE_BOTTOM);
-       qDebug() << "Setting homescreen to screen  " << screen->name();
-
-       agl_shell_set_background(agl_shell, bg, output);
-
        /* Delay the ready signal until after Qt has done all of its own setup
         * in a.exec() */
-       QTimer::singleShot(500, [agl_shell](){
-               agl_shell_ready(agl_shell);
+       QTimer::singleShot(500, [shell_data](){
+               qDebug() << "sending ready to compositor";
+               agl_shell_ready(shell_data.shell);
        });
 }
 
+static void
+app_status_callback(::agl_shell_ipc::AppStateResponse app_response, void *data)
+{
+       HomescreenHandler *homescreenHandler = static_cast<HomescreenHandler *>(data);
+
+       if (!homescreenHandler) {
+               return;
+       }
+
+       auto app_id = QString(app_response.app_id().c_str());
+       auto state = app_response.state();
+
+       qDebug() << "appstateresponse: app_id " << app_id << "state " << state;
+
+       switch (state) {
+       case AGL_SHELL_APP_STATE_STARTED:
+               qDebug() << "Got AGL_SHELL_APP_STATE_STARTED for app_id " << app_id;
+               homescreenHandler->processAppStatusEvent(app_id, "started");
+               break;
+       case AGL_SHELL_APP_STATE_TERMINATED:
+               qDebug() << "Got AGL_SHELL_APP_STATE_TERMINATED for app_id " << app_id;
+               homescreenHandler->processAppStatusEvent(app_id, "terminated");
+               break;
+       case AGL_SHELL_APP_STATE_ACTIVATED:
+               qDebug() << "Got AGL_SHELL_APP_STATE_ACTIVATED for app_id " << app_id;
+               homescreenHandler->addAppToStack(app_id);
+               break;
+       case AGL_SHELL_APP_STATE_DEACTIVATED:
+               qDebug() << "Got AGL_SHELL_APP_STATE_DEACTIVATED for app_id " << app_id;
+               homescreenHandler->processAppStatusEvent(app_id, "deactivated");
+               break;
+       default:
+               break;
+       }
+}
+
 int main(int argc, char *argv[])
 {
        setenv("QT_QPA_PLATFORM", "wayland", 1);
@@ -248,7 +395,9 @@ int main(int argc, char *argv[])
        QGuiApplication app(argc, argv);
        const char *screen_name;
        bool is_demo_val = false;
-       struct shell_data shell_data = { nullptr, nullptr };
+       bool is_embedded_panels = false;
+       int ret = 0;
+       struct shell_data shell_data = { nullptr, nullptr, true, false, 0 };
 
        QPlatformNativeInterface *native = qApp->platformNativeInterface();
        screen_name = getenv("HOMESCREEN_START_SCREEN");
@@ -257,6 +406,10 @@ int main(int argc, char *argv[])
        if (is_demo && strcmp(is_demo, "1") == 0)
                is_demo_val = true;
 
+       const char *embedded_panels = getenv("HOMESCREEN_EMBEDDED_PANELS");
+       if (embedded_panels && strcmp(embedded_panels, "1") == 0)
+               is_embedded_panels = true;
+
        QCoreApplication::setOrganizationDomain("LinuxFoundation");
        QCoreApplication::setOrganizationName("AutomotiveGradeLinux");
        QCoreApplication::setApplicationName("HomeScreen");
@@ -265,20 +418,34 @@ int main(int argc, char *argv[])
        // we need to have an app_id
        app.setDesktopFileName("homescreen");
 
+       GrpcClient *client = new GrpcClient();
+       // create a new thread to listner for gRPC events
+       std::thread th = std::thread(run_in_thread, client);
+
        register_agl_shell(native, &shell_data);
        if (!shell_data.shell) {
                fprintf(stderr, "agl_shell extension is not advertised. "
                        "Are you sure that agl-compositor is running?\n");
                exit(EXIT_FAILURE);
        }
-       if (!shell_data.shell_desktop) {
-               fprintf(stderr, "agl_shell_desktop extension is not advertised. "
-                       "Are you sure that agl-compositor is running?\n");
-               exit(EXIT_FAILURE);
+
+       qDebug() << "agl-shell interface is at version " << shell_data.ver;
+       if (shell_data.ver >= 2) {
+               while (ret != -1 && shell_data.wait_for_bound) {
+                       ret = wl_display_dispatch(getWlDisplay(native));
+
+                       if (shell_data.wait_for_bound)
+                               continue;
+               }
+
+               if (!shell_data.bound_ok) {
+                       qInfo() << "agl_shell extension already in use by other shell client.";
+                       exit(EXIT_FAILURE);
+               }
        }
 
+
        std::shared_ptr<struct agl_shell> agl_shell{shell_data.shell, agl_shell_destroy};
-       Shell *aglShell = new Shell(agl_shell, &app);
 
        // Import C++ class to QML
        qmlRegisterType<StatusBarModel>("HomeScreen", 1, 0, "StatusBarModel");
@@ -286,9 +453,15 @@ int main(int argc, char *argv[])
 
        ApplicationLauncher *launcher = new ApplicationLauncher();
        launcher->setCurrent(QStringLiteral("launcher"));
-       HomescreenHandler* homescreenHandler = new HomescreenHandler(aglShell, launcher);
 
-       agl_shell_desktop_add_listener(shell_data.shell_desktop, &shell_desktop_listener, homescreenHandler);
+       HomescreenHandler* homescreenHandler = new HomescreenHandler(launcher);
+       shell_data.homescreenHandler = homescreenHandler;
+       shell_data.homescreenHandler->setGrpcClient(client);
+
+       // blocks until we're sure connected with the server
+       HMI_DEBUG("HomescreenHandler", "Checking if connected to the gRPC server...");
+       client->WaitForConnected(500, 10);
+       client->AppStatusState(app_status_callback, homescreenHandler);
 
        QQmlApplicationEngine engine;
        QQmlContext *context = engine.rootContext();
@@ -298,12 +471,8 @@ int main(int argc, char *argv[])
        context->setContextProperty("weather", new Weather());
        context->setContextProperty("bluetooth", new Bluetooth(false, context));
 
-       // We add it here even if we don't use it
-       context->setContextProperty("shell", aglShell);
-
-       // 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, shell_data.shell, screen_name, is_demo_val);
+       load_agl_shell_app(native, &engine, shell_data,
+                          screen_name, is_demo_val);
 
        return app.exec();
 }