refactor: provide osd as separate application

This aligns the implementation with KScreen. It's a prerequisite for
our port to Qt 6.

Author: romangg

CMakeLists.txt

@@ -16,6 +16,8 @@ set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH})
 include(KDEInstallDirs)
 include(KDECMakeSettings)
 include(KDECompilerSettings NO_POLICY_SCOPE)
+include(ECMConfiguredInstall)
+include(ECMGenerateDBusServiceFile)
 include(ECMInstallIcons)
 include(ECMMarkAsTest)
 include(ECMQtDeclareLoggingCategory)
@@ -29,6 +31,15 @@ find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
     DBusAddons
     Declarative
     I18n
+    WindowSystem
+)
+
+find_package(LayerShellQt)
+set_package_properties(LayerShellQt PROPERTIES
+    DESCRIPTION "Layer shell Qt bindings"
+    URL "https://invent.kde.org/plasma/layer-shell-qt"
+    PURPOSE "Required for the screen selection osd"
+    TYPE REQUIRED
 )
 
 set(MIN_DISMAN_VERSION "0.519.80")

plasma-integration/CMakeLists.txt

@@ -1,3 +1,4 @@
 add_subdirectory(kded)
+add_subdirectory(osd)
 add_subdirectory(plasmoid)
 ki18n_install(po)

plasma-integration/kded/CMakeLists.txt

@@ -11,9 +11,7 @@ set(kdisplay_daemon_SRCS
     daemon.cpp
     config.cpp
     generator.cpp
-    osd.cpp
-    osdmanager.cpp
-    osdaction.cpp
+    ../osd/osdaction.cpp
     ${CMAKE_SOURCE_DIR}/common/orientation_sensor.cpp
     ${CMAKE_SOURCE_DIR}/common/utils.cpp
 )
@@ -32,6 +30,10 @@ qt5_add_dbus_adaptor(kdisplay_daemon_SRCS
     daemon.h
     KDisplayDaemon
 )
+qt5_add_dbus_interface(kdisplay_daemon_SRCS
+  ../osd/org.kwinft.kdisplay.osdService.xml
+  osdservice_interface
+)
 
 add_library(kdisplayd MODULE ${kdisplay_daemon_SRCS})
 
@@ -51,12 +53,3 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/kdisplayd.desktop.cmake
 kcoreaddons_desktop_to_json(kdisplayd ${CMAKE_CURRENT_BINARY_DIR}/kdisplayd.desktop)
 
 install(TARGETS kdisplayd DESTINATION ${KDE_INSTALL_PLUGINDIR}/kf5/kded)
-
-set(QML_FILES
-    qml/Osd.qml
-    qml/OsdItem.qml
-    qml/OsdSelector.qml
-    qml/OutputIdentifier.qml
-)
-
-install(FILES ${QML_FILES} DESTINATION ${KDE_INSTALL_DATADIR}/kded_kdisplay/qml)

plasma-integration/kded/daemon.cpp

@@ -13,7 +13,7 @@
 #include "generator.h"
 #include "kdisplay_daemon_debug.h"
 #include "kdisplayadaptor.h"
-#include "osdmanager.h"
+#include "osdservice_interface.h"
 
 #include <disman/configmonitor.h>
 #include <disman/getconfigoperation.h>
@@ -37,6 +37,7 @@ KDisplayDaemon::KDisplayDaemon(QObject* parent, const QList<QVariant>&)
     , m_orientationSensor(new OrientationSensor(this))
 {
     Disman::Log::instance();
+    qMetaTypeId<KDisplay::OsdAction>();
 
     connect(new Disman::GetConfigOperation,
             &Disman::GetConfigOperation::finished,
@@ -68,8 +69,15 @@ void KDisplayDaemon::init(Disman::ConfigOperation* op)
     connect(action, &QAction::triggered, this, &KDisplayDaemon::displayButton);
 
     new KdisplayAdaptor(this);
-    // Initialize OSD manager to register its dbus interface
-    m_osdManager = new OsdManager(this);
+
+    QString const osdService = QStringLiteral("org.kwinft.kdisplay.osdService");
+    QString const osdPath = QStringLiteral("/org/kwinft/kdisplay/osdService");
+    m_osdServiceInterface = new OrgKwinftKdisplayOsdServiceInterface(
+        osdService, osdPath, QDBusConnection::sessionBus(), this);
+
+    // Set a longer timeout to not assume timeout while the osd is still shown
+    m_osdServiceInterface->setTimeout(
+        std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::seconds(60)).count());
 
     connect(cfg, &Disman::Config::output_added, this, &KDisplayDaemon::applyConfig);
     connect(cfg, &Disman::Config::output_removed, this, &KDisplayDaemon::applyConfig);
@@ -160,26 +168,25 @@ void KDisplayDaemon::applyConfig()
 {
     qCDebug(KDISPLAY_KDED) << "Applying config";
 
-    const bool showOsd = m_monitoredConfig->outputs().size() > 1 && !m_startingUp
+    auto const should_show_osd = m_monitoredConfig->outputs().size() > 1 && !m_startingUp
         && m_monitoredConfig->cause() == Disman::Config::Cause::generated;
 
-    if (showOsd) {
+    if (should_show_osd) {
         qCDebug(KDISPLAY_KDED) << "Getting ideal config from user via OSD...";
-        auto action = m_osdManager->showActionSelector();
-        connect(action, &OsdAction::selected, this, &KDisplayDaemon::applyOsdAction);
+        show_osd();
     } else {
-        m_osdManager->hideOsd();
+        m_osdServiceInterface->hideOsd();
     }
 }
 
 void KDisplayDaemon::applyLayoutPreset(const QString& presetName)
 {
-    const QMetaEnum actionEnum = QMetaEnum::fromType<OsdAction::Action>();
+    auto const actionEnum = QMetaEnum::fromType<KDisplay::OsdAction::Action>();
     Q_ASSERT(actionEnum.isValid());
 
     bool ok;
-    auto action
-        = static_cast<OsdAction::Action>(actionEnum.keyToValue(qPrintable(presetName), &ok));
+    auto action = static_cast<KDisplay::OsdAction::Action>(
+        actionEnum.keyToValue(qPrintable(presetName), &ok));
     if (!ok) {
         qCWarning(KDISPLAY_KDED) << "Cannot apply unknown screen layout preset named" << presetName;
         return;
@@ -201,7 +208,7 @@ void KDisplayDaemon::setAutoRotate(bool value)
     refreshConfig();
 }
 
-void KDisplayDaemon::applyOsdAction(OsdAction::Action action)
+void KDisplayDaemon::applyOsdAction(KDisplay::OsdAction::Action action)
 {
     qCDebug(KDISPLAY_KDED) << "Applying OSD action:" << action;
 
@@ -218,27 +225,24 @@ void KDisplayDaemon::configChanged()
     updateOrientation();
 }
 
-void KDisplayDaemon::showOsd(const QString& icon, const QString& text)
-{
-    QDBusMessage msg = QDBusMessage::createMethodCall(QLatin1String("org.kde.plasmashell"),
-                                                      QLatin1String("/org/kde/osdService"),
-                                                      QLatin1String("org.kde.osdService"),
-                                                      QLatin1String("showText"));
-    msg << icon << text;
-    QDBusConnection::sessionBus().asyncCall(msg);
-}
-
-void KDisplayDaemon::showOutputIdentifier()
+void KDisplayDaemon::show_osd()
 {
-    m_osdManager->showOutputIdentifiers();
+    auto call = m_osdServiceInterface->showActionSelector();
+    auto watcher = new QDBusPendingCallWatcher(call);
+    connect(watcher, &QDBusPendingCallWatcher::finished, this, [this, watcher] {
+        watcher->deleteLater();
+        QDBusReply<int> reply = *watcher;
+        if (!reply.isValid()) {
+            return;
+        }
+        applyOsdAction(static_cast<KDisplay::OsdAction::Action>(reply.value()));
+    });
 }
 
 void KDisplayDaemon::displayButton()
 {
     qCDebug(KDISPLAY_KDED) << "displayBtn triggered";
-
-    auto action = m_osdManager->showActionSelector();
-    connect(action, &OsdAction::selected, this, &KDisplayDaemon::applyOsdAction);
+    show_osd();
 }
 
 void KDisplayDaemon::setMonitorForChanges(bool enabled)

plasma-integration/kded/daemon.h

@@ -7,21 +7,22 @@
 #ifndef KSCREEN_DAEMON_H
 #define KSCREEN_DAEMON_H
 
-#include "osdaction.h"
+#include "../osd/osdaction.h"
 
 #include <disman/config.h>
 
 #include <kdedmodule.h>
 
 #include <QVariant>
 
+class OrgKwinftKdisplayOsdServiceInterface;
+
 namespace Disman
 {
 class ConfigOperation;
 }
 
 class OrientationSensor;
-class OsdManager;
 
 class KDisplayDaemon : public KDEDModule
 {
@@ -50,21 +51,19 @@ public Q_SLOTS:
     void displayButton();
     void setMonitorForChanges(bool enabled);
 
-    void showOutputIdentifier();
-    void applyOsdAction(OsdAction::Action action);
+    void show_osd();
+    void applyOsdAction(KDisplay::OsdAction::Action action);
 
     void doApplyConfig(Disman::ConfigPtr const& config);
     void refreshConfig();
 
-    void showOsd(const QString& icon, const QString& text);
-
     void update_auto_rotate();
     void updateOrientation();
 
     Disman::ConfigPtr m_monitoredConfig;
     bool m_monitoring;
     bool m_configDirty = true;
-    OsdManager* m_osdManager;
+    OrgKwinftKdisplayOsdServiceInterface* m_osdServiceInterface;
     OrientationSensor* m_orientationSensor;
     bool m_startingUp = true;
 };

plasma-integration/kded/generator.cpp

@@ -15,7 +15,7 @@
 namespace Generator
 {
 
-Disman::ConfigPtr displaySwitch(OsdAction::Action action, Disman::ConfigPtr const& config)
+Disman::ConfigPtr displaySwitch(KDisplay::OsdAction::Action action, Disman::ConfigPtr const& config)
 {
     qCDebug(KDISPLAY_KDED) << "Display Switch";
 
@@ -33,17 +33,17 @@ Disman::ConfigPtr displaySwitch(OsdAction::Action action, Disman::ConfigPtr cons
 
     auto success = false;
     switch (action) {
-    case OsdAction::ExtendLeft: {
+    case KDisplay::OsdAction::ExtendLeft: {
         qCDebug(KDISPLAY_KDED) << "Extend to left";
         success = generator.extend(Disman::Generator::Extend_direction::left);
         break;
     }
-    case OsdAction::ExtendRight: {
+    case KDisplay::OsdAction::ExtendRight: {
         qCDebug(KDISPLAY_KDED) << "Extend to right";
         success = generator.extend(Disman::Generator::Extend_direction::right);
         break;
     }
-    case OsdAction::SwitchToExternal: {
+    case KDisplay::OsdAction::SwitchToExternal: {
         qCDebug(KDISPLAY_KDED) << "Turn off embedded (laptop)";
         auto embedded = generator.embedded();
         if (embedded) {
@@ -52,18 +52,18 @@ Disman::ConfigPtr displaySwitch(OsdAction::Action action, Disman::ConfigPtr cons
         }
         break;
     }
-    case OsdAction::SwitchToInternal: {
+    case KDisplay::OsdAction::SwitchToInternal: {
         qCDebug(KDISPLAY_KDED) << "Turn off external screen";
         // TODO: Why would a user want to do that?
         qCWarning(KDISPLAY_KDED)
             << "Weird option to turn off external was selected, just do nothing instead.";
         break;
     }
-    case OsdAction::Clone: {
+    case KDisplay::OsdAction::Clone: {
         success = generator.replicate();
         break;
     }
-    case OsdAction::NoAction:
+    case KDisplay::OsdAction::NoAction:
         return nullptr;
     }
 

plasma-integration/kded/generator.h

@@ -6,13 +6,14 @@
 */
 #pragma once
 
-#include "osdaction.h"
+#include "../osd/osdaction.h"
 
 #include <disman/types.h>
 
 namespace Generator
 {
 
-Disman::ConfigPtr displaySwitch(OsdAction::Action action, Disman::ConfigPtr const& config);
+Disman::ConfigPtr displaySwitch(KDisplay::OsdAction::Action action,
+                                Disman::ConfigPtr const& config);
 
 }