EngineTypes.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <QHashFunctions>
#include <QLatin1StringView>
#include <QList>
#include <QRect>
#include <QString>
#include <QStringList>
 
namespace PhosphorEngine {
 
struct TilingStateKey
{
    QString screenId;
    int desktop = 1;
    QString activity;
 
    bool operator==(const TilingStateKey& other) const
    {
        return screenId == other.screenId && desktop == other.desktop && activity == other.activity;
    }
};
 
inline size_t qHash(const TilingStateKey& key, size_t seed = 0)
{
    return qHashMulti(seed, key.screenId, key.desktop, key.activity);
}
 
enum class SnapIntent {
    UserInitiated,
    AutoRestored,
};
 
enum class WindowKind : int {
    Unknown = 0,
    Normal = 1,
    Transient = 2,
};
 
inline WindowKind clampWindowKindFromWire(int wire)
{
    switch (wire) {
    case static_cast<int>(WindowKind::Normal):
        return WindowKind::Normal;
    case static_cast<int>(WindowKind::Transient):
        return WindowKind::Transient;
    default:
        return WindowKind::Unknown;
    }
}
 
struct ResnapEntry
{
    QString windowId;
    int zonePosition = 0;
    QString screenId;
    int virtualDesktop = 0;
};
 
struct PendingRestore
{
    QStringList zoneIds;
    QString screenId;
    int virtualDesktop = 0;
    QString layoutId;
    QList<int> zoneNumbers;
    WindowKind windowKind = WindowKind::Unknown;
};
 
struct SnapResult
{
    bool shouldSnap = false;
    QRect geometry;
    QString zoneId;
    QStringList zoneIds;
    QString screenId;
    int virtualDesktop = 0;
 
    bool isValid() const
    {
        return shouldSnap && geometry.isValid() && !zoneId.isEmpty();
    }
 
    static SnapResult noSnap()
    {
        return SnapResult{false, QRect(), QString(), QStringList(), QString()};
    }
};
 
struct UnfloatResult
{
    bool found = false;
    QStringList zoneIds;
    QRect geometry;
    QString screenId;
};
 
struct ZoneAssignmentEntry
{
    QString windowId{};
    QString sourceZoneId{};
    QString targetZoneId{};
    QStringList targetZoneIds{};
    QRect targetGeometry{};
    QString targetScreenId{};
};
 
enum class StickyWindowHandling {
    TreatAsNormal = 0,
    RestoreOnly = 1,
    IgnoreAll = 2
};
 
inline constexpr QLatin1StringView RestoreSentinel("__restore__");
 
} // namespace PhosphorEngine