One window's single, authoritative placement record — the unit of the unified, engine-agnostic restore model.
More...
#include <phosphor-engine/include/PhosphorEngine/WindowPlacement.h>
|
| bool | isValid () const |
| |
| EngineSlot | slotFor (const QString &engineId) const |
| | The slot for engineId, or a default (empty) slot if this engine has no recorded state for the window.
|
| |
| QRect | freeGeometryFor (const QString &screenId) const |
| | The shared free/float geometry for screenId, or an invalid rect if none has been captured on that screen yet.
|
| |
| QRect | anyFreeGeometry () const |
| | Any captured free/float geometry (the first valid rect in unspecified hash order — there is no per-screen recency to pick a "newest"), used as a cross-screen fallback when the exact screen has none.
|
| |
| bool | hasRestorableContent () const |
| | Whether this record carries anything worth restoring.
|
| |
| bool | sameContentAs (const WindowPlacement &o) const |
| | Content equality IGNORING sequence (the store stamps a fresh sequence on every record(), so it must not count as a change).
|
| |
| QJsonObject | toJson () const |
| |
One window's single, authoritative placement record — the unit of the unified, engine-agnostic restore model.
The WindowPlacementStore holds at most ONE record per window (NOT one per engine). The record carries:
- per-engine STATE in
engines (keyed by IPlacementEngine::engineId()): each engine's own slot + state, independent of the others (per-mode float independence — floating in snap does not float in autotile);
- ONE SHARED free/float GEOMETRY in
freeGeometryByScreen: the position the window occupies when it is NOT engine-managed, shared across snap/autotile but keyed PER SCREEN so a window remembers a distinct free spot per monitor. Written ONLY from a genuine free/floating frame; FROZEN while the window is snapped or tiled. A zone/tile rect never enters this map.
Extensibility: a new engine needs no change here — it keys its own slot under its engineId() and reads/writes the shared geometry. Core code never interprets an EngineSlot::state beyond equality.
◆ anyFreeGeometry()
| QRect PhosphorEngine::WindowPlacement::anyFreeGeometry |
( |
| ) |
const |
|
inline |
Any captured free/float geometry (the first valid rect in unspecified hash order — there is no per-screen recency to pick a "newest"), used as a cross-screen fallback when the exact screen has none.
Returns an invalid rect when the window has no free geometry on record at all.
◆ autotileEngineId()
| static QLatin1String PhosphorEngine::WindowPlacement::autotileEngineId |
( |
| ) |
|
|
inlinestatic |
◆ freeGeometryFor()
| QRect PhosphorEngine::WindowPlacement::freeGeometryFor |
( |
const QString & |
screenId | ) |
const |
|
inline |
The shared free/float geometry for screenId, or an invalid rect if none has been captured on that screen yet.
◆ fromJson()
| static WindowPlacement PhosphorEngine::WindowPlacement::fromJson |
( |
const QString & |
appId, |
|
|
const QJsonObject & |
obj |
|
) |
| |
|
inlinestatic |
◆ hasRestorableContent()
| bool PhosphorEngine::WindowPlacement::hasRestorableContent |
( |
| ) |
const |
|
inline |
Whether this record carries anything worth restoring.
True when the window has a captured free/float geometry, OR a MANAGED slot (snapped/tiled, which restore by zone/tile reference), OR a slot that still references a zone (zoneIds — a floated-from-snap window's pre-float zones) or a tile order.
A bare slot with no geometry, no zone reference, and no tile order — whether floating (a never-snapped floated window captured frame-less) or the retired free token — has NOTHING to restore. Snapping now defaults every unmanaged window to floating, so this geometry-less floated residue is exactly the case that must be rejected: it must NOT be persisted, and the snap restore's accept predicate must never CONSUME it from the per-app FIFO. At MaxPerApp entries per app, such residue would otherwise starve and even evict (removeFirst) the window's real placement, silently breaking geometry restore.
◆ isValid()
| bool PhosphorEngine::WindowPlacement::isValid |
( |
| ) |
const |
|
inline |
◆ sameContentAs()
| bool PhosphorEngine::WindowPlacement::sameContentAs |
( |
const WindowPlacement & |
o | ) |
const |
|
inline |
Content equality IGNORING sequence (the store stamps a fresh sequence on every record(), so it must not count as a change).
Lets the merge in record() short-circuit a re-capture that produced an identical placement — the save-time refreshOpenWindowPlacements() re-captures every open window each tick, and without this an unchanged window would re-mark dirty and reschedule the save timer forever (a self-perpetuating save/capture loop).
◆ slotFor()
| EngineSlot PhosphorEngine::WindowPlacement::slotFor |
( |
const QString & |
engineId | ) |
const |
|
inline |
The slot for engineId, or a default (empty) slot if this engine has no recorded state for the window.
◆ snapEngineId()
| static QLatin1String PhosphorEngine::WindowPlacement::snapEngineId |
( |
| ) |
|
|
inlinestatic |
Built-in engine-slot ids.
Cross-engine readers (resnap, teardown capture, autotile's snap-defer gate) key slotFor() on these instead of spelling the id inline — same drift-prevention rationale as the state-token accessors below. Each engine's own engineId() override returns the same spelling.
◆ stateFloating()
| static QLatin1String PhosphorEngine::WindowPlacement::stateFloating |
( |
| ) |
|
|
inlinestatic |
◆ stateFree()
| static QLatin1String PhosphorEngine::WindowPlacement::stateFree |
( |
| ) |
|
|
inlinestatic |
Common state-token vocabulary.
Engines may define more; these cover the built-in snap/autotile states. Retired snap state — snapping is now two-state (snapped/floating). No engine produces it any more; a legacy free record persisted by an older build deserializes to this token and is restored as floating (see SnapEngine::resolveWindowRestore). Retained only for that legacy-record mapping and the tests that exercise it.
◆ stateSnapped()
| static QLatin1String PhosphorEngine::WindowPlacement::stateSnapped |
( |
| ) |
|
|
inlinestatic |
◆ stateTiled()
| static QLatin1String PhosphorEngine::WindowPlacement::stateTiled |
( |
| ) |
|
|
inlinestatic |
◆ toJson()
| QJsonObject PhosphorEngine::WindowPlacement::toJson |
( |
| ) |
const |
|
inline |
◆ activity
| QString PhosphorEngine::WindowPlacement::activity |
empty = all-activities / unknown
◆ appId
| QString PhosphorEngine::WindowPlacement::appId |
window class; FIFO key for close/reopen (uuid changes)
◆ engines
| QHash<QString, EngineSlot> PhosphorEngine::WindowPlacement::engines |
◆ freeGeometryByScreen
| QHash<QString, QRect> PhosphorEngine::WindowPlacement::freeGeometryByScreen |
◆ kind
◆ screenId
| QString PhosphorEngine::WindowPlacement::screenId |
last managed-context screen
◆ sequence
| quint64 PhosphorEngine::WindowPlacement::sequence = 0 |
◆ virtualDesktop
| int PhosphorEngine::WindowPlacement::virtualDesktop = 0 |
0 = all-desktops / sticky / unknown
◆ windowId
| QString PhosphorEngine::WindowPlacement::windowId |
full appId|uuid; exact key for daemon-restart (uuid stable)
The documentation for this struct was generated from the following file:
1.9.8