File indexing completed on 2024-05-12 17:00:19

 /*
     SPDX-FileCopyrightText: 2014 Martin Gräßlin <mgraesslin@kde.org>
     SPDX-FileCopyrightText: 2015 Marco Martin <mart@kde.org>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #include "windoweffects.h"
 #include "waylandintegration.h"
 
 #include <QDebug>
 #include <QExposeEvent>
 #include <QGuiApplication>
 #include <QWidget>
 
 #include <KWayland/Client/blur.h>
 #include <KWayland/Client/compositor.h>
 #include <KWayland/Client/connection_thread.h>
 #include <KWayland/Client/contrast.h>
 #include <KWayland/Client/plasmashell.h>
 #include <KWayland/Client/plasmawindowmanagement.h>
 #include <KWayland/Client/region.h>
 #include <KWayland/Client/registry.h>
 #include <KWayland/Client/slide.h>
 #include <KWayland/Client/surface.h>
 #include <private/qwaylandwindow_p.h>
 
 WindowEffects::WindowEffects()
     : QObject()
     ,  KWindowEffectsPrivateV2()
 {
     auto registry = WaylandIntegration::self()->registry();
 
     // The KWindowEffects API doesn't provide any signals to notify that the particular
     // effect has become unavailable. So we re-install effects when the corresponding globals
     // are added.
     connect(registry, &KWayland::Client::Registry::blurAnnounced, this, [this]() {
         for (auto it = m_blurRegions.constBegin(); it != m_blurRegions.constEnd(); ++it) {
             installBlur(it.key(), true, *it);
         }
     });
     connect(registry, &KWayland::Client::Registry::blurRemoved, this, [this]() {
         for (auto it = m_blurRegions.constBegin(); it != m_blurRegions.constEnd(); ++it) {
             installBlur(it.key(), false, *it);
         }
     });
 
     connect(registry, &KWayland::Client::Registry::contrastAnnounced, this, [this]() {
         for (auto it = m_backgroundConstrastRegions.constBegin(); it != m_backgroundConstrastRegions.constEnd(); ++it) {
             installContrast(it.key(), true, it->contrast, it->intensity, it->saturation, it->region);
         }
     });
     connect(registry, &KWayland::Client::Registry::contrastRemoved, this, [this]() {
         for (auto it = m_backgroundConstrastRegions.constBegin(); it != m_backgroundConstrastRegions.constEnd(); ++it) {
             installContrast(it.key(), false);
         }
     });
 
     connect(registry, &KWayland::Client::Registry::slideAnnounced, this, [this]() {
         for (auto it = m_slideMap.constBegin(); it != m_slideMap.constEnd(); ++it) {
             installSlide(it.key(), it->location, it->offset);
         }
     });
     connect(registry, &KWayland::Client::Registry::slideRemoved, this, [this]() {
         for (auto it = m_slideMap.constBegin(); it != m_slideMap.constEnd(); ++it) {
             installSlide(it.key(), KWindowEffects::SlideFromLocation::NoEdge, 0);
         }
     });
 }
 
 WindowEffects::~WindowEffects()
 {
 }
 
 QWindow *WindowEffects::windowForId(WId wid)
 {
     QWindow *window = nullptr;
 
     for (auto win : qApp->allWindows()) {
         if (win->winId() == wid) {
             window = win;
             break;
         }
     }
     return window;
 }
 
 void WindowEffects::trackWindow(QWindow *window)
 {
     if (!m_windowWatchers.contains(window)) {
         window->installEventFilter(this);
         auto conn = connect(window, &QObject::destroyed, this, [this, window]() {
             resetBlur(window);
             m_blurRegions.remove(window);
             resetContrast(window);
             m_backgroundConstrastRegions.remove(window);
             m_slideMap.remove(window);
             m_windowWatchers.remove(window);
         });
         m_windowWatchers[window] << conn;
         auto waylandWindow = dynamic_cast<QtWaylandClient::QWaylandWindow *>(window->handle());
         if (waylandWindow) {
             auto conn = connect(waylandWindow, &QtWaylandClient::QWaylandWindow::wlSurfaceDestroyed, this, [this, window]() {
                 resetBlur(window);
                 resetContrast(window);
             });
             m_windowWatchers[window] << conn;
         }
     }
 }
 
 void WindowEffects::releaseWindow(QWindow *window)
 {
     if (!m_blurRegions.contains(window) && !m_backgroundConstrastRegions.contains(window) && !m_slideMap.contains(window)) {
         for (const auto &conn : m_windowWatchers[window]) {
             disconnect(conn);
         }
         window->removeEventFilter(this);
         m_windowWatchers.remove(window);
     }
 }
 
 // Helper function to replace a QObject value in the map and delete the old one.
 template<typename MapType>
 void replaceValue(MapType &map, typename MapType::key_type key, typename MapType::mapped_type value)
 {
     if (auto oldValue = map.take(key)) {
         oldValue->deleteLater();
     }
     if (value) {
         map[key] = value;
     }
 }
 
 void WindowEffects::resetBlur(QWindow *window, KWayland::Client::Blur *blur)
 {
     replaceValue(m_blurs, window, blur);
 }
 
 void WindowEffects::resetContrast(QWindow *window, KWayland::Client::Contrast *contrast)
 {
     replaceValue(m_contrasts, window, contrast);
 }
 
 bool WindowEffects::eventFilter(QObject *watched, QEvent *event)
 {
     if (event->type() == QEvent::Expose) {
         auto ee = static_cast<QExposeEvent *>(event);
 
         if ((ee->region().isNull())) {
             return false;
         }
 
         auto window = qobject_cast<QWindow *>(watched);
         if (!window) {
             return false;
         }
 
         {
             auto it = m_blurRegions.constFind(window);
             if (it != m_blurRegions.constEnd()) {
                 installBlur(window, true, *it);
             }
         }
         {
             auto it = m_backgroundConstrastRegions.constFind(window);
             if (it != m_backgroundConstrastRegions.constEnd()) {
                 installContrast(window, true, it->contrast, it->intensity, it->saturation, it->region);
             }
         }
     }
     return false;
 }
 
 bool WindowEffects::isEffectAvailable(KWindowEffects::Effect effect)
 {
     switch (effect) {
     case KWindowEffects::BackgroundContrast:
         return WaylandIntegration::self()->waylandContrastManager() != nullptr;
     case KWindowEffects::BlurBehind:
         return WaylandIntegration::self()->waylandBlurManager() != nullptr;
     case KWindowEffects::Slide:
         return WaylandIntegration::self()->waylandSlideManager() != nullptr;
     default:
         return false;
     }
 }
 
 void WindowEffects::slideWindow(WId id, KWindowEffects::SlideFromLocation location, int offset)
 {
     auto window = windowForId(id);
     if (!window) {
         return;
     }
     if (location != KWindowEffects::SlideFromLocation::NoEdge) {
         m_slideMap[window] = SlideData{
             .location = location,
             .offset = offset,
         };
         trackWindow(window);
     } else {
         m_slideMap.remove(window);
         releaseWindow(window);
     }
 
     installSlide(window, location, offset);
 }
 
 void WindowEffects::installSlide(QWindow *window, KWindowEffects::SlideFromLocation location, int offset)
 {
     if (!WaylandIntegration::self()->waylandSlideManager()) {
         return;
     }
     KWayland::Client::Surface *surface = KWayland::Client::Surface::fromWindow(window);
     if (surface) {
         if (location != KWindowEffects::SlideFromLocation::NoEdge) {
             auto slide = WaylandIntegration::self()->waylandSlideManager()->createSlide(surface, surface);
 
             KWayland::Client::Slide::Location convertedLoc;
             switch (location) {
             case KWindowEffects::SlideFromLocation::TopEdge:
                 convertedLoc = KWayland::Client::Slide::Location::Top;
                 break;
             case KWindowEffects::SlideFromLocation::LeftEdge:
                 convertedLoc = KWayland::Client::Slide::Location::Left;
                 break;
             case KWindowEffects::SlideFromLocation::RightEdge:
                 convertedLoc = KWayland::Client::Slide::Location::Right;
                 break;
             case KWindowEffects::SlideFromLocation::BottomEdge:
             default:
                 convertedLoc = KWayland::Client::Slide::Location::Bottom;
                 break;
             }
 
             slide->setLocation(convertedLoc);
             slide->setOffset(offset);
             slide->commit();
         } else {
             WaylandIntegration::self()->waylandSlideManager()->removeSlide(surface);
         }
 
         WaylandIntegration::self()->waylandConnection()->flush();
     }
 }
 
 #if KWINDOWSYSTEM_BUILD_DEPRECATED_SINCE(5, 81)
 QList<QSize> WindowEffects::windowSizes(const QList<WId> &ids)
 {
     Q_UNUSED(ids)
     QList<QSize> sizes;
     return sizes;
 }
 #endif
 
 #if KWINDOWSYSTEM_BUILD_DEPRECATED_SINCE(5, 82)
 void WindowEffects::presentWindows(WId controller, const QList<WId> &ids)
 {
     Q_UNUSED(controller)
     Q_UNUSED(ids)
 }
 #endif
 
 #if KWINDOWSYSTEM_BUILD_DEPRECATED_SINCE(5, 82)
 void WindowEffects::presentWindows(WId controller, int desktop)
 {
     Q_UNUSED(controller)
     Q_UNUSED(desktop)
 }
 #endif
 
 #if KWINDOWSYSTEM_BUILD_DEPRECATED_SINCE(5, 82)
 void WindowEffects::highlightWindows(WId controller, const QList<WId> &ids)
 {
     Q_UNUSED(controller)
     Q_UNUSED(ids)
 }
 #endif
 
 void WindowEffects::enableBlurBehind(WId winId, bool enable, const QRegion &region)
 {
     auto window = windowForId(winId);
     if (!window) {
         return;
     }
     if (enable) {
         trackWindow(window);
         m_blurRegions[window] = region;
     } else {
         resetBlur(window);
         m_blurRegions.remove(window);
         releaseWindow(window);
     }
 
     installBlur(window, enable, region);
 }
 
 void WindowEffects::installBlur(QWindow *window, bool enable, const QRegion &region)
 {
     if (!WaylandIntegration::self()->waylandBlurManager()) {
         return;
     }
     KWayland::Client::Surface *surface = KWayland::Client::Surface::fromWindow(window);
 
     if (surface) {
         if (enable) {
             auto blur = WaylandIntegration::self()->waylandBlurManager()->createBlur(surface, surface);
             std::unique_ptr<KWayland::Client::Region> wlRegion(WaylandIntegration::self()->waylandCompositor()->createRegion(region, nullptr));
             blur->setRegion(wlRegion.get());
             blur->commit();
             resetBlur(window, blur);
         } else {
             resetBlur(window);
             WaylandIntegration::self()->waylandBlurManager()->removeBlur(surface);
         }
 
         WaylandIntegration::self()->waylandConnection()->flush();
     }
 }
 
 void WindowEffects::enableBackgroundContrast(WId winId, bool enable, qreal contrast, qreal intensity, qreal saturation, const QRegion &region)
 {
     auto window = windowForId(winId);
     if (!window) {
         return;
     }
     if (enable) {
         trackWindow(window);
         m_backgroundConstrastRegions[window].contrast = contrast;
         m_backgroundConstrastRegions[window].intensity = intensity;
         m_backgroundConstrastRegions[window].saturation = saturation;
         m_backgroundConstrastRegions[window].region = region;
     } else {
         resetContrast(window);
         m_backgroundConstrastRegions.remove(window);
         releaseWindow(window);
     }
 
     installContrast(window, enable, contrast, intensity, saturation, region);
 }
 
 void WindowEffects::installContrast(QWindow *window, bool enable, qreal contrast, qreal intensity, qreal saturation, const QRegion &region)
 {
     if (!WaylandIntegration::self()->waylandContrastManager()) {
         return;
     }
     KWayland::Client::Surface *surface = KWayland::Client::Surface::fromWindow(window);
     if (surface) {
         if (enable) {
             auto backgroundContrast = WaylandIntegration::self()->waylandContrastManager()->createContrast(surface, surface);
             std::unique_ptr<KWayland::Client::Region> wlRegion(WaylandIntegration::self()->waylandCompositor()->createRegion(region, nullptr));
             backgroundContrast->setRegion(wlRegion.get());
             backgroundContrast->setContrast(contrast);
             backgroundContrast->setIntensity(intensity);
             backgroundContrast->setSaturation(saturation);
             backgroundContrast->commit();
             resetContrast(window, backgroundContrast);
         } else {
             resetContrast(window);
             WaylandIntegration::self()->waylandContrastManager()->removeContrast(surface);
         }
 
         WaylandIntegration::self()->waylandConnection()->flush();
     }
 }
 
 void WindowEffects::setBackgroundFrost(QWindow *window, QColor color, const QRegion &region)
 {
     if (!WaylandIntegration::self()->waylandContrastManager()) {
         return;
     }
 
     KWayland::Client::Surface *surface = KWayland::Client::Surface::fromWindow(window);
     if (!surface) {
         return;
     }
     if (!color.isValid()) {
         resetContrast(window);
         WaylandIntegration::self()->waylandContrastManager()->removeContrast(surface);
         return;
     }
 
     auto backgroundContrast = WaylandIntegration::self()->waylandContrastManager()->createContrast(surface, surface);
     std::unique_ptr<KWayland::Client::Region> wlRegion(WaylandIntegration::self()->waylandCompositor()->createRegion(region, nullptr));
     backgroundContrast->setRegion(wlRegion.get());
     backgroundContrast->setFrost(color);
     backgroundContrast->commit();
     resetContrast(window, backgroundContrast);
 
     WaylandIntegration::self()->waylandConnection()->flush();
 }
 
 #if KWINDOWSYSTEM_BUILD_DEPRECATED_SINCE(5, 67)
 void WindowEffects::markAsDashboard(WId window)
 {
     Q_UNUSED(window)
 }
 #endif