Hyprland/src/desktop/view/Group.cpp

#include "Group.hpp"
#include "Window.hpp"

#include "../../render/decorations/CHyprGroupBarDecoration.hpp"
#include "../../layout/target/WindowGroupTarget.hpp"
#include "../../layout/target/WindowTarget.hpp"
#include "../../layout/target/Target.hpp"
#include "../../layout/space/Space.hpp"
#include "../../layout/LayoutManager.hpp"
#include "../../desktop/state/FocusState.hpp"
#include "../../Compositor.hpp"
#include "managers/EventManager.hpp"

#include <algorithm>

using namespace Desktop;
using namespace Desktop::View;

std::vector<WP<CGroup>>& View::groups() {
    static std::vector<WP<CGroup>> g;
    return g;
}

SP<CGroup> CGroup::create(std::vector<PHLWINDOWREF>&& windows) {
    auto x      = SP<CGroup>(new CGroup(std::move(windows)));
    x->m_self   = x;
    x->m_target = Layout::CWindowGroupTarget::create(x);
    groups().emplace_back(x);

    x->init();

    return x;
}

CGroup::CGroup(std::vector<PHLWINDOWREF>&& windows) : m_windows(std::move(windows)) {
    ;
}

void CGroup::init() {
    // for proper group logic:
    //  - add all windows to us
    //  - replace the first window with our target
    //  - remove all window targets from layout
    //  - apply updates

    // FIXME: what if some windows are grouped? For now we only do 1-window but YNK
    for (const auto& w : m_windows) {
        RASSERT(!w->m_group, "CGroup: windows cannot contain grouped in init, this will explode");
        w->m_group = m_self.lock();
        m_groupPolicyFlags |= w->m_groupRules;
    }

    g_layoutManager->switchTargets(m_windows.at(0)->m_target, m_target);

    for (const auto& w : m_windows) {
        w->m_target->setSpaceGhost(m_target->space());
    }

    for (const auto& w : m_windows) {
        applyWindowDecosAndUpdates(w.lock());
    }

    updateWindowVisibility();

    g_pEventManager->postEvent(SHyprIPCEvent({.event = "togglegroup", .data = std::format("1,{:x}", rc<uintptr_t>(m_windows.at(0).get()))}));
}

void CGroup::destroy() {
    const auto POWNER = head();

    while (!m_windows.empty()) {
        if (m_windows.size() == 1) {
            remove(m_windows.at(0).lock());
            break;
        }

        remove(m_windows.at(0).lock());
    }

    if (POWNER)
        g_pEventManager->postEvent(SHyprIPCEvent({.event = "togglegroup", .data = std::format("0,{:x}", rc<uintptr_t>(POWNER.get()))}));
}

CGroup::~CGroup() {
    if (m_target->space())
        m_target->assignToSpace(nullptr);
    std::erase_if(groups(), [this](const auto& e) { return !e || e == m_self; });
}

bool CGroup::has(PHLWINDOW w) const {
    return std::ranges::contains(m_windows, w);
}

void CGroup::add(PHLWINDOW w) {
    static auto INSERT_AFTER_CURRENT = CConfigValue<Config::INTEGER>("group:insert_after_current");

    if (w->m_group) {
        if (w->m_group == m_self)
            return;

        const auto WINDOWS = w->m_group->windows();
        for (const auto& w : WINDOWS) {
            w->m_group->remove(w.lock());
            add(w.lock());
        }

        return;
    }

    if (w->layoutTarget()->space()) {
        // remove the target from a space if it is in one
        g_layoutManager->removeTarget(w->layoutTarget());
    }

    w->m_group = m_self.lock();
    m_groupPolicyFlags |= w->m_groupRules;
    w->m_target->setSpaceGhost(m_target->space());
    w->m_target->setFloating(m_target->floating());

    // a window in a group lives on the group's monitor/workspace
    if (const auto WS = m_target->workspace(); WS && w->m_monitor != WS->m_monitor) {
        w->m_monitor = WS->m_monitor;
        w->moveToWorkspace(WS);
    }

    if (*INSERT_AFTER_CURRENT) {
        m_windows.insert(m_windows.begin() + m_current + 1, w);
        m_current++;
    } else {
        m_windows.emplace_back(w);
        m_current = m_windows.size() - 1;
    }

    applyWindowDecosAndUpdates(w);
    updateWindowVisibility();
    m_target->recalc();
}

void CGroup::remove(PHLWINDOW w, Math::eDirection dir, eRemoveFromGroupReason reason) {
    std::optional<size_t> idx;
    for (size_t i = 0; i < m_windows.size(); ++i) {
        if (m_windows.at(i) == w) {
            idx = i;
            break;
        }
    }

    if (!idx)
        return;

    if ((m_current >= *idx && idx != 0) || (m_current >= m_windows.size() - 1 && m_current > 0))
        m_current--;

    auto g = m_self.lock(); // keep ref to avoid uaf after w->m_group.reset()

    w->m_group.reset();
    removeWindowDecos(w);

    w->setInputBlocked(INPUT_BLOCK_GROUP_INACTIVE, false);
    *w->alpha(WINDOW_ALPHA_LAYOUT) = 1.F;

    const bool REMOVING_GROUP = m_windows.size() <= 1;

    if (REMOVING_GROUP) {
        w->m_target->assignToSpace(nullptr);
        g_layoutManager->switchTargets(m_target, w->m_target);
    }

    // we do it after the above because switchTargets expects this to be a valid group
    m_windows.erase(m_windows.begin() + *idx);

    if (!m_windows.empty())
        updateWindowVisibility();

    // do this here: otherwise the new current is hidden and workspace rules get wrong data
    if (!REMOVING_GROUP) {
        std::optional<Vector2D> focalPoint;
        if (dir != Math::DIRECTION_DEFAULT) {
            const auto box = m_target->position();
            switch (dir) {
                case Math::DIRECTION_RIGHT: focalPoint = Vector2D(box.x + box.w, box.y + box.h / 2.0); break;
                case Math::DIRECTION_LEFT: focalPoint = Vector2D(box.x, box.y + box.h / 2.0); break;
                case Math::DIRECTION_DOWN: focalPoint = Vector2D(box.x + box.w / 2.0, box.y + box.h); break;
                case Math::DIRECTION_UP: focalPoint = Vector2D(box.x + box.w / 2.0, box.y); break;
                default: break;
            }
        }

        // We don't need to assign a window to a new space if we intend to unmap it
        if (reason == REMOVE_FROM_GROUP_REASON_UNMAP_WINDOW)
            return;
        w->m_target->assignToSpace(m_target->space(), focalPoint);
    }
}

void CGroup::moveCurrent(bool next) {
    size_t idx = m_current;

    if (next) {
        idx++;
        if (idx >= m_windows.size())
            idx = 0;
    } else {
        if (idx == 0)
            idx = m_windows.size() - 1;
        else
            idx--;
    }

    setCurrent(idx);
}

void CGroup::setCurrent(size_t idx) {
    if (idx == m_current)
        return;

    const auto FS_STATE  = m_target->fullscreenMode();
    const auto WASFOCUS  = Desktop::focusState()->window() == current();
    auto       oldWindow = m_windows.at(m_current).lock();

    if (FS_STATE != FSMODE_NONE)
        g_pCompositor->setWindowFullscreenInternal(oldWindow, FSMODE_NONE);

    m_current = std::clamp(idx, sc<size_t>(0), m_windows.size() - 1);
    updateWindowVisibility();

    auto newWindow = m_windows.at(m_current).lock();

    if (FS_STATE != FSMODE_NONE) {
        g_pCompositor->setWindowFullscreenInternal(newWindow, FS_STATE);
        newWindow->m_target->warpPositionSize();
        oldWindow->m_target->setPositionGlobal(newWindow->m_target->position()); // TODO: this is a hack and sucks
    }

    if (WASFOCUS)
        Desktop::focusState()->rawWindowFocus(current(), FOCUS_REASON_GROUP_CURRENT_WINDOW_CHANGE);
}

void CGroup::setCurrent(PHLWINDOW w) {
    if (w == current())
        return;

    for (size_t i = 0; i < m_windows.size(); ++i) {
        if (m_windows.at(i) == w) {
            setCurrent(i);
            return;
        }
    }
}

size_t CGroup::getCurrentIdx() const {
    return m_current;
}

PHLWINDOW CGroup::head() const {
    return m_windows.front().lock();
}

PHLWINDOW CGroup::tail() const {
    return m_windows.back().lock();
}

PHLWINDOW CGroup::current() const {
    return m_windows.at(m_current).lock();
}

PHLWINDOW CGroup::next() const {
    return (m_current >= m_windows.size() - 1 ? m_windows.front() : m_windows.at(m_current + 1)).lock();
}

PHLWINDOW CGroup::fromIndex(size_t idx) const {
    if (idx >= m_windows.size())
        return nullptr;

    return m_windows.at(idx).lock();
}

const std::vector<PHLWINDOWREF>& CGroup::windows() const {
    return m_windows;
}

void CGroup::applyWindowDecosAndUpdates(PHLWINDOW x) {
    x->addWindowDeco(makeUnique<CHyprGroupBarDecoration>(x));

    x->m_ruleApplicator->propertiesChanged(Desktop::Rule::RULE_PROP_GROUP | Desktop::Rule::RULE_PROP_ON_WORKSPACE);
    x->updateWindowDecos();
    x->updateDecorationValues();
}

void CGroup::removeWindowDecos(PHLWINDOW x) {
    x->removeWindowDeco(x->getDecorationByType(DECORATION_GROUPBAR));

    x->m_ruleApplicator->propertiesChanged(Desktop::Rule::RULE_PROP_GROUP | Desktop::Rule::RULE_PROP_ON_WORKSPACE);
    x->updateWindowDecos();
    x->updateDecorationValues();
}

void CGroup::updateWindowVisibility() {
    for (size_t i = 0; i < m_windows.size(); ++i) {
        if (i == m_current) {
            auto& x = m_windows.at(i);
            x->setInputBlocked(INPUT_BLOCK_GROUP_INACTIVE, false);
            *x->alpha(WINDOW_ALPHA_LAYOUT) = 1.F;
            x->m_ruleApplicator->propertiesChanged(Desktop::Rule::RULE_PROP_GROUP | Desktop::Rule::RULE_PROP_ON_WORKSPACE);
            x->updateWindowDecos();
            x->updateDecorationValues();
        } else {
            auto& x = m_windows.at(i);
            x->setInputBlocked(INPUT_BLOCK_GROUP_INACTIVE, true);
            *x->alpha(WINDOW_ALPHA_LAYOUT) = 0.F;
        }
    }

    m_target->recalc();

    m_target->damageEntire();
}

size_t CGroup::size() const {
    return m_windows.size();
}

bool CGroup::locked() const {
    return m_groupPolicyFlags & GROUP_LOCK;
}

void CGroup::setLocked(bool x) {
    if (x)
        m_groupPolicyFlags |= GROUP_LOCK;
    else
        m_groupPolicyFlags &= ~GROUP_LOCK;
}

bool CGroup::denied() const {
    return m_groupPolicyFlags & GROUP_DENY;
}

void CGroup::setDenied(bool x) {
    if (x)
        m_groupPolicyFlags |= GROUP_DENY;
    else
        m_groupPolicyFlags &= ~GROUP_DENY;
}

void CGroup::updateWorkspace(PHLWORKSPACE ws) {
    if (!ws)
        return;

    for (const auto& w : windows()) {
        w->m_monitor = ws->m_monitor;
        w->moveToWorkspace(ws);
        w->updateToplevel();
        w->updateWindowDecos();
        w->m_target->setSpaceGhost(ws->m_space);
    }
}

void CGroup::swapWithNext() {
    const bool HAD_FOCUS = Desktop::focusState()->window() == m_windows.at(m_current);

    size_t     idx = m_current + 1 >= m_windows.size() ? 0 : m_current + 1;
    std::iter_swap(m_windows.begin() + m_current, m_windows.begin() + idx);
    m_current = idx;

    updateWindowVisibility();

    if (HAD_FOCUS)
        Desktop::focusState()->fullWindowFocus(m_windows.at(m_current).lock(), FOCUS_REASON_DESKTOP_STATE_CHANGE);
}

void CGroup::swapWithLast() {
    const bool HAD_FOCUS = Desktop::focusState()->window() == m_windows.at(m_current);

    size_t     idx = m_current == 0 ? m_windows.size() - 1 : m_current - 1;
    std::iter_swap(m_windows.begin() + m_current, m_windows.begin() + idx);
    m_current = idx;

    updateWindowVisibility();

    if (HAD_FOCUS)
        Desktop::focusState()->fullWindowFocus(m_windows.at(m_current).lock(), FOCUS_REASON_DESKTOP_STATE_CHANGE);
}