homescreenhandler: Handle dynamic movement of windows
[apps/homescreen.git] / homescreen / src / main.cpp
index db9eafe..d0bd2c3 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 <weather.h>
 #include <bluetooth.h>
+
 #include "applicationlauncher.h"
 #include "statusbarmodel.h"
 #include "mastervolume.h"
 #include "homescreenhandler.h"
 #include "hmi-debug.h"
-#include "chromecontroller.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 "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;
+       HomescreenHandler *homescreenHandler;
+       bool wait_for_bound;
+       bool bound_ok;
+       int ver;
+};
+
+static void
+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)
+{
+       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)
+               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;
+       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;
+       }
+}
+
+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)
+               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() << "Gove event to move " << app_id <<
+                       " to another output " << output_name;
+               homescreenHandler->processAppStatusEvent(app_id, "started");
+       }
+}
+
+
+#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 agl_shell **shell = static_cast<struct agl_shell **>(data);
+       struct shell_data *shell_data = static_cast<struct shell_data *>(data);
+
+       if (!shell_data)
+               return;
 
        if (strcmp(interface, agl_shell_interface.name) == 0) {
-               *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;
+
        }
 }
 
@@ -82,26 +210,29 @@ 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 struct agl_shell *
-register_agl_shell(QPlatformNativeInterface *native)
+static void
+register_agl_shell(QPlatformNativeInterface *native, struct shell_data *shell_data)
 {
        struct wl_display *wl;
        struct wl_registry *registry;
-       struct agl_shell *shell = nullptr;
 
-       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);
+       wl_registry_add_listener(registry, &registry_listener, shell_data);
 
        /* Roundtrip to get all globals advertised by the compositor */
        wl_display_roundtrip(wl);
        wl_registry_destroy(registry);
-
-       return shell;
 }
 
 static struct wl_surface *
@@ -117,133 +248,199 @@ create_component(QPlatformNativeInterface *native, QQmlComponent *comp,
        return getWlSurface(native, win);
 }
 
+
 static void
-load_agl_shell_app(QPlatformNativeInterface *native,
-                  QQmlApplicationEngine *engine,
-                  struct agl_shell *agl_shell, QUrl &bindingAddress)
+load_agl_shell(QPlatformNativeInterface *native, QQmlApplicationEngine *engine,
+              struct agl_shell *agl_shell, QScreen *screen)
 {
-       struct wl_surface *bg, *top, *bottom;
+       struct wl_surface *bg;
        struct wl_output *output;
+       int32_t x, y;
+       int32_t width, height;
+       QObject *qobj_bg;
+       QSize size = screen->size();
+
+       // 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();
+
+       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_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;
 
-       QQmlComponent bg_comp(engine, QUrl("qrc:/background.qml"));
+       QQmlComponent bg_comp(engine, QUrl("qrc:/background_demo.qml"));
        qInfo() << bg_comp.errors();
 
-       QQmlComponent top_comp(engine, QUrl("qrc:/toppanel.qml"));
+       QQmlComponent top_comp(engine, QUrl("qrc:/toppanel_demo.qml"));
        qInfo() << top_comp.errors();
 
-       QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel.qml"));
+       QQmlComponent bot_comp(engine, QUrl("qrc:/bottompanel_demo.qml"));
        qInfo() << bot_comp.errors();
 
-       QScreen *screen = qApp->screens().first();
-       if (!screen)
-               return;
-
-       output = getWlOutput(native, screen);
-
-       bg = create_component(native, &bg_comp, screen, &qobj_bg);
        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");
        if (statusBar) {
                qDebug() << "got statusBar objectname, doing init()";
-               statusBar->init(bindingAddress, engine->rootContext());
+               statusBar->init(engine->rootContext());
        }
 
+       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);
 
-       agl_shell_set_background(agl_shell, bg, output);
+       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[])
 {
-    QGuiApplication a(argc, argv);
-    QPlatformNativeInterface *native = qApp->platformNativeInterface();
-    struct agl_shell *agl_shell = nullptr;
-
-    QCoreApplication::setOrganizationDomain("LinuxFoundation");
-    QCoreApplication::setOrganizationName("AutomotiveGradeLinux");
-    QCoreApplication::setApplicationName("HomeScreen");
-    QCoreApplication::setApplicationVersion("0.7.0");
-
-    QCommandLineParser parser;
-    parser.addPositionalArgument("port", a.translate("main", "port for binding"));
-    parser.addPositionalArgument("secret", a.translate("main", "secret for binding"));
-    parser.addHelpOption();
-    parser.addVersionOption();
-    parser.process(a);
-    QStringList positionalArguments = parser.positionalArguments();
-
-    int port = 1700;
-    QString token = "wm";
-    QString graphic_role = "homescreen"; // defined in layers.json in Window Manager
-
-    if (positionalArguments.length() == 2) {
-        port = positionalArguments.takeFirst().toInt();
-        token = positionalArguments.takeFirst();
-    }
-
-    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");
-           exit(EXIT_FAILURE);
-    }
-
-    std::shared_ptr<struct agl_shell> shell{agl_shell, agl_shell_destroy};
-    Shell *aglShell = new Shell(shell, &a);
-
-    // import C++ class to QML
-    // qmlRegisterType<ApplicationLauncher>("HomeScreen", 1, 0, "ApplicationLauncher");
-    qmlRegisterType<StatusBarModel>("HomeScreen", 1, 0, "StatusBarModel");
-    qmlRegisterType<MasterVolume>("MasterVolume", 1, 0, "MasterVolume");
-    qmlRegisterUncreatableType<ChromeController>("SpeechChrome", 1, 0, "SpeechChromeController",
-                                                 QLatin1String("SpeechChromeController is uncreatable."));
-
-    ApplicationLauncher *launcher = new ApplicationLauncher();
-
-    HomescreenHandler* homescreenHandler = new HomescreenHandler(aglShell);
-    homescreenHandler->init(port, token.toStdString().c_str());
-
-    QUrl bindingAddress;
-    bindingAddress.setScheme(QStringLiteral("ws"));
-    bindingAddress.setHost(QStringLiteral("localhost"));
-    bindingAddress.setPort(port);
-    bindingAddress.setPath(QStringLiteral("/api"));
-
-    QUrlQuery query;
-    query.addQueryItem(QStringLiteral("token"), token);
-    bindingAddress.setQuery(query);
-
-    QQmlApplicationEngine engine;
-    QQmlContext *context = engine.rootContext();
-    context->setContextProperty("bindingAddress", bindingAddress);
-
-    context->setContextProperty("homescreenHandler", homescreenHandler);
-    context->setContextProperty("launcher", launcher);
-    context->setContextProperty("weather", new Weather(bindingAddress));
-    context->setContextProperty("bluetooth", new Bluetooth(bindingAddress, context));
-    context->setContextProperty("speechChromeController", new ChromeController(bindingAddress, &engine));
-    // 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, agl_shell, bindingAddress);
-
-    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();
 }