PhosphorEngine::IWindowRegistry Class Reference

#include <phosphor-engine/include/PhosphorEngine/IWindowRegistry.h>

Inheritance diagram for PhosphorEngine::IWindowRegistry:

Public Member Functions
virtual	~IWindowRegistry ()=default
virtual QString	canonicalizeWindowId (const QString &rawWindowId)=0
	Freeze (on first contact) and return the canonical id for rawWindowId's instance.
virtual QString	canonicalizeForLookup (const QString &rawWindowId) const =0
virtual QString	appIdFor (const QString &instanceId) const =0
	The app identity recorded for instanceId, or empty when the instance is unknown.
virtual std::optional< bool >	minimizedState (const QString &windowId) const
	Tri-state compositor minimize state for windowId.

Constructor & Destructor Documentation

~IWindowRegistry()

virtual PhosphorEngine::IWindowRegistry::~IWindowRegistry ( )

virtualdefault

Member Function Documentation

appIdFor()

virtual QString PhosphorEngine::IWindowRegistry::appIdFor ( const QString &  instanceId ) const

pure virtual

The app identity recorded for instanceId, or empty when the instance is unknown.

Takes a BARE instance id: unlike minimizedState, which accepts either form, this does not split a composite appId|instanceId and answers empty for one. Callers holding a window id should extract the instance part first (or use a service-level currentAppIdFor, which does it for them).

Implemented in PhosphorEngine::WindowRegistry.

canonicalizeForLookup()

virtual QString PhosphorEngine::IWindowRegistry::canonicalizeForLookup ( const QString &  rawWindowId ) const

pure virtual

Implemented in PhosphorEngine::WindowRegistry.

canonicalizeWindowId()

virtual QString PhosphorEngine::IWindowRegistry::canonicalizeWindowId ( const QString &  rawWindowId )

pure virtual

Freeze (on first contact) and return the canonical id for rawWindowId's instance.

The mapping is seeded once and never re-seeded, so a mid-session class mutation keeps resolving to the identity the stores were keyed with. That single stable key per window, for the window's whole life, is the invariant every keyed store depends on: engines key their membership maps at adopt time and have no re-key path, so an implementation that let the canonical CHANGE mid-life would strand live state rather than correct it.

The freeze is deliberately unconditional, including for an id whose appId part is empty (KWin reports a blank class for a surface it has not finished mapping). Callers needing a window's app identity must ask appIdFor / currentAppIdFor, which read the metadata record and self-correct when the class arrives, rather than parsing it back out of the frozen id.

Implemented in PhosphorEngine::WindowRegistry.

minimizedState()

virtual std::optional< bool > PhosphorEngine::IWindowRegistry::minimizedState ( const QString &  windowId ) const

inlinevirtual

Tri-state compositor minimize state for windowId.

Engaged true/false when the compositor has reported the window's minimize state; std::nullopt when it is UNKNOWN (no record for the window, or the metadata push never carried the field). SEEDING and TILING consumers — anything that would place, move, or count a window in a layout — must treat nullopt conservatively rather than as false: collapsing unknown into "not minimized" is the fail-open that seeds hidden windows into tiling layouts and persists minimize-suspension floats. CAPTURE-side consumers may deliberately require engaged-true (.value_or(false)) when their traffic is causally ordered after the minimize edge's metadata push (recordFreeGeometry / recordFloatingClose document this per site) — refusing a capture on unknown would lose genuine free positions, the opposite failure.

Default implementation reports unknown so registry-less engines and test fakes stay honest instead of claiming visibility.

Reimplemented in PhosphorEngine::WindowRegistry.

---

The documentation for this class was generated from the following file:

• phosphor-engine/include/PhosphorEngine/IWindowRegistry.h