homescreenhandler: Add support for starting apps on different outputs
[apps/homescreen.git] / homescreen / src / main.cpp
index 74ec4f4..d2967ca 100644 (file)
@@ -1,18 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * Copyright (C) 2016, 2017 Mentor Graphics Development (Deutschland) GmbH
  * Copyright (c) 2017, 2018 TOYOTA MOTOR CORPORATION
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Copyright (c) 2022 Konsulko Group
  */
 
 #include <QGuiApplication>
 #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 "agl-shell-client-protocol.h"
 #include "shell.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)
+{
+       struct shell_data *shell_data = static_cast<struct shell_data *>(data);
+       shell_data->wait_for_bound = false;
+
+       shell_data->bound_ok = true;
+}
+
+static void
+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)
+{
+       struct shell_data *shell_data = static_cast<struct shell_data *>(data);
+       HomescreenHandler *homescreenHandler = shell_data->homescreenHandler;
 
-       if (homescreenHandler)
+       if (!homescreenHandler)
+               return;
+
+       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;
+               // handled by HomescreenHandler::processAppStatusEvent
+               break;
+       case AGL_SHELL_APP_STATE_ACTIVATED:
+               qDebug() << "Got AGL_SHELL_APP_STATE_ACTIVATED for app_id " << app_id;
                homescreenHandler->addAppToStack(app_id);
+               break;
+       default:
+               break;
+       }
 }
 
 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_app_on_output(void *data, struct agl_shell *agl_shell,
+               const char *app_id, const char *output_name)
 {
-       HomescreenHandler *homescreenHandler = static_cast<HomescreenHandler *>(data);
+       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->appTerminated(app_id);
+       if (!homescreenHandler)
+               return;
+
+       std::pair new_pending_app = std::pair(QString(app_id),
+                                             QString(output_name));
+       homescreenHandler->pending_app_list.push_back(new_pending_app);
 }
 
-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);
 
@@ -87,15 +142,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)
-               );
        }
 }
 
@@ -127,6 +187,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)
@@ -134,9 +202,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);
@@ -159,71 +225,70 @@ 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 top_comp(engine, QUrl("qrc:/toppanel_demo.qml"));
-               qInfo() << top_comp.errors();
+       QQmlComponent bg_comp(engine, QUrl("qrc:/background_demo.qml"));
+       qInfo() << bg_comp.errors();
 
-               QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel_demo.qml"));
-               qInfo() << bot_comp.errors();
+       QQmlComponent top_comp(engine, QUrl("qrc:/toppanel_demo.qml"));
+       qInfo() << top_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();
-
-               QQmlComponent top_comp(engine, QUrl("qrc:/toppanel.qml"));
-               qInfo() << top_comp.errors();
-
-               QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel.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);
-       }
-
-       if (!screen_name)
-               screen = qApp->primaryScreen();
-       else
-               screen = find_screen(screen_name);
+       QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel_demo.qml"));
+       qInfo() << bot_comp.errors();
 
-       qDebug() << "found primary screen " << qApp->primaryScreen()->name() <<
-               "first screen " << qApp->screens().first()->name();
-       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);
 
        /* engine.rootObjects() works only if we had a load() */
        StatusBarModel *statusBar = qobj_top->findChild<StatusBarModel *>("statusBar");
@@ -232,83 +297,127 @@ load_agl_shell_app(QPlatformNativeInterface *native,
                statusBar->init(engine->rootContext());
        }
 
-       agl_shell_set_panel(agl_shell, top, output, AGL_SHELL_EDGE_TOP);
-       agl_shell_set_panel(agl_shell, bottom, output, AGL_SHELL_EDGE_BOTTOM);
+       output = getWlOutput(native, screen);
+
        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
+load_agl_shell_app(QPlatformNativeInterface *native, QQmlApplicationEngine *engine,
+                  struct agl_shell *agl_shell, const char *screen_name, bool is_demo)
+{
+       QScreen *screen = nullptr;
+
+       if (!screen_name)
+               screen = qApp->primaryScreen();
+       else
+               screen = find_screen(screen_name);
+
+       if (!screen) {
+               qDebug() << "No outputs present in the system.";
+               return;
+       }
+
+       if (is_demo) {
+               load_agl_shell_for_ci(native, engine, agl_shell, screen);
+       } else {
+               load_agl_shell(native, engine, agl_shell, screen);
+       }
 
        /* Delay the ready signal until after Qt has done all of its own setup
         * in a.exec() */
        QTimer::singleShot(500, [agl_shell](){
+               qDebug() << "sending ready to compositor";
                agl_shell_ready(agl_shell);
        });
 }
 
 int main(int argc, char *argv[])
 {
-    setenv("QT_QPA_PLATFORM", "wayland", 1);
-    setenv("QT_QUICK_CONTROLS_STYLE", "AGL", 1);
-    QGuiApplication a(argc, argv);
-    const char *screen_name;
-    bool is_demo_val = false;
-    struct shell_data shell_data = { nullptr, nullptr };
-
-    QPlatformNativeInterface *native = qApp->platformNativeInterface();
-    screen_name = getenv("HOMESCREEN_START_SCREEN");
-
-    const char *is_demo = getenv("HOMESCREEN_DEMO_CI");
-    if (is_demo && strcmp(is_demo, "1") == 0)
-        is_demo_val = true;
-
-    QCoreApplication::setOrganizationDomain("LinuxFoundation");
-    QCoreApplication::setOrganizationName("AutomotiveGradeLinux");
-    QCoreApplication::setApplicationName("HomeScreen");
-    QCoreApplication::setApplicationVersion("0.7.0");
-    /* we need to have an app_id */
-    a.setDesktopFileName("homescreen");
-
-    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);
-    }
-
-    std::shared_ptr<struct agl_shell> agl_shell{shell_data.shell, agl_shell_destroy};
-    Shell *aglShell = new Shell(agl_shell, &a);
-
-    // import C++ class to QML
-    qmlRegisterType<StatusBarModel>("HomeScreen", 1, 0, "StatusBarModel");
-    qmlRegisterType<MasterVolume>("MasterVolume", 1, 0, "MasterVolume");
-
-    ApplicationLauncher *launcher = new ApplicationLauncher();
-    launcher->setCurrent(QStringLiteral("launcher"));
-    HomescreenHandler* homescreenHandler = new HomescreenHandler(aglShell, launcher);
-    homescreenHandler->init();
-
-    agl_shell_desktop_add_listener(shell_data.shell_desktop, &shell_desktop_listener, homescreenHandler);
-
-    QQmlApplicationEngine engine;
-    QQmlContext *context = engine.rootContext();
-
-    context->setContextProperty("homescreenHandler", homescreenHandler);
-    context->setContextProperty("launcher", launcher);
-    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);
-
-    return a.exec();
+       setenv("QT_QPA_PLATFORM", "wayland", 1);
+       setenv("QT_QUICK_CONTROLS_STYLE", "AGL", 1);
+
+       QGuiApplication app(argc, argv);
+       const char *screen_name;
+       bool is_demo_val = false;
+       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");
+
+       const char *is_demo = getenv("HOMESCREEN_DEMO_CI");
+       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");
+       QCoreApplication::setApplicationVersion("0.7.0");
+
+       // we need to have an app_id
+       app.setDesktopFileName("homescreen");
+
+       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);
+       }
+
+       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");
+       qmlRegisterType<MasterVolume>("MasterVolume", 1, 0, "MasterVolume");
+
+       ApplicationLauncher *launcher = new ApplicationLauncher();
+       launcher->setCurrent(QStringLiteral("launcher"));
+
+       HomescreenHandler* homescreenHandler = new HomescreenHandler(aglShell, launcher);
+       shell_data.homescreenHandler = homescreenHandler;
+
+       QQmlApplicationEngine engine;
+       QQmlContext *context = engine.rootContext();
+
+       context->setContextProperty("homescreenHandler", homescreenHandler);
+       context->setContextProperty("launcher", launcher);
+       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);
+
+       load_agl_shell_app(native, &engine, shell_data.shell,
+                          screen_name, is_demo_val);
+
+       return app.exec();
 }