6#include "phosphorscrollengine_export.h"
20#include <QElapsedTimer>
48struct ScrollEvacueePark;
104 return m_scrollingScreens;
129 using IPlacementEngine::windowOpened;
130 void windowOpened(
const QString& windowId,
const QString& screenId,
int minWidth,
int minHeight)
override;
143 int minHeight)
override;
145 std::optional<PhosphorEngine::PlacementStateKey>
heldKeyForWindow(
const QString& windowId)
const override;
148 QStringList
parkOutput(
const QString& physicalScreenId)
override;
149 bool readoptParked(
const QString& windowId,
const QString& parkedPhysicalId,
150 const QString& returnedPhysicalId)
override;
151 void dropParked(
const QString& windowId,
const QString& physicalScreenId,
int desktop,
152 const QString& activity)
override;
153 bool hasParked(
const QString& windowId,
const QString& physicalScreenId)
const override;
160 void windowFocused(
const QString& windowId,
const QString& screenId)
override;
168 void onWindowResized(
const QString& rawWindowId,
const QRect& oldFrame,
const QRect& newFrame,
169 const QString& screenId)
override;
177 void setWindowFloat(
const QString& windowId,
bool shouldFloat,
const QString& screenId = QString())
override;
427 void focusTab(
int ordinal,
const QString& screenId);
565 const QStringList& windowIds);
705 return m_context.stickyPinnedDesktop(screenId);
821 return m_dragInsertPreview.has_value();
825 return m_dragInsertPreview ? m_dragInsertPreview->targetScreenId : QString();
832 return m_dragInsertPreview && m_dragInsertPreview->hadPriorState ? m_dragInsertPreview->priorKey.screenId
839 return m_dragInsertPreview ? m_dragInsertPreview->windowId : QString();
919 m_crossSurfaceResolver = resolver;
961 m_persistSaveFn = std::move(saveFn);
962 m_persistLoadFn = std::move(loadFn);
999 m_fuzzyClaimGraceMs = graceMs;
1001 std::optional<PhosphorEngine::WindowPlacement>
capturePlacement(
const QString& windowId)
const override;
1003 void retile(
const QString& screenId = QString())
override;
1014 using FloatPredicate = std::function<bool(
const QString& windowId,
const QString& screenId)>;
1017 m_floatPredicate = std::move(predicate);
1030 m_restorePositionPredicate = std::move(predicate);
1042 m_openParamsResolver = std::move(resolver);
1051 using ModeResolver = std::function<bool(
const QString& screenId,
int desktop,
const QString& activity)>;
1059 m_snappingModeResolver = std::move(resolver);
1069 m_scrollingModeResolver = std::move(resolver);
1076 m_autotileModeResolver = std::move(resolver);
1093 std::function<QVariantMap(
const QString& screenId,
int desktop,
const QString& activity)>;
1103 std::function<QRect(
const QString&)> screenGeometry)
1105 m_availableGeometryProvider = std::move(availableGeometry);
1106 m_screenGeometryProvider = std::move(screenGeometry);
1114 m_allScreenGeometriesProvider = std::move(allScreenGeometries);
1119 m_contextGapProvider = std::move(provider);
1143 return overridesForScreen(screenId);
1219 QString canonicalizeForLookup(
const QString& rawWindowId)
const;
1222 QString currentAppIdFor(
const QString& anyWindowId)
const;
1225 return m_context.currentKeyForScreen(screenId);
1234 QVariantMap overridesForScreen(
const QString& screenId)
const
1236 return m_perScreenOverrides.value(currentKeyForScreen(screenId));
1251 bool announceStripContextIfChanged(
const QString& screenId);
1259 QString resolveOperationScreen(
const QString& screenId)
const;
1262 void clearTabStripsForScreen(
const QString& screenId);
1292 QStringList& releasedWindows);
1300 void forgetReleasedWindowMemories(
const QString& windowId);
1304 void recordSurvivingPlacement(
const QString& windowId);
1308 std::optional<PhosphorEngine::WindowPlacement>
1309 capturePlacementIn(
const QString& windowId,
const ScrollState* state,
1326 void consumePendingInitialOrder(
const QString& screenId,
const QString& windowId);
1330 void sweepStatelessScreenBookkeeping(
const QSet<QString>& screenIds);
1364 QSet<QString>& displacedScreens);
1371 void finishDisplacedRelease(QStringList& displacedWindows,
const QSet<QString>& displacedScreens);
1391 std::optional<PhosphorProtocol::ScrollAxis> preResolvedFallbackAxis = std::nullopt);
1400 const QString& windowId,
const ScrollLayoutParams& params,
int minWidth,
int minHeight);
1406 QVector<StashedTile> columnTilesWithHiddenMembers(
const ScrollState* state,
int columnIndex)
const;
1411 const QVector<StashedColumn>& columns,
bool* fresh);
1415 bool refuseUnderFloatFocus(
const ScrollState* state,
const QString& action,
const QString& screenId);
1424 void forgetStashedWindowWhere(
const QString& windowId,
1426 bool movedColumnsOnly =
false);
1435 void sweepStripStashForAliveness(
const QSet<QString>& aliveWindowIds);
1457 ScrollLayoutParams layoutParamsForScreen(
const QString& screenId,
int columnCountOverride = -1)
const;
1481 enum class UnseenContextOverrides : quint8 {
1485 ScrollLayoutParams layoutParamsForKey(
const PhosphorEngine::PlacementStateKey& key,
int columnCountOverride = -1,
1486 UnseenContextOverrides unseen = UnseenContextOverrides::Defaults)
const;
1491 StripAxis resolveStripAxis(
const QRect& workArea)
const;
1499 QVector<VisibleTile> visibleTiles(
const QString& screenId,
const ScrollLayoutParams& params)
const;
1504 void applyLayout(
const QString& screenId,
bool focusWindowAfter =
false);
1527 bool insertOpenedWindow(ScrollState* state,
const QString& windowId,
const QString& screenId,
int minWidthIn,
1528 int minHeightIn, ScrollOpenParams* outOpenParams =
nullptr,
bool migration =
false,
1529 QString* outDisplacedTab =
nullptr,
bool adoption =
false);
1532 void installContextResolver();
1534 struct PendingMembership;
1535 void collectMembershipWork(
const QString& windowId,
const QString& screenId,
1536 const PhosphorEngine::PlacementStateKey& currentKey,
1537 const PhosphorEngine::DesktopSpan& span,
bool adoptAllowed,
1538 QList<PendingMembership>& pending)
const;
1539 PhosphorEngine::MembershipReconcileResult applyMembershipWork(
const QString& screenId,
1540 const PhosphorEngine::PlacementStateKey& currentKey,
1541 const QList<PendingMembership>& pending);
1544 bool adoptIntoContext(
const QString& windowId,
const PhosphorEngine::PlacementStateKey& key);
1547 void releaseMembership(
const QString& windowId,
const PhosphorEngine::PlacementStateKey& key);
1552 void dropFromOtherContexts(
const QString& windowId,
const PhosphorEngine::PlacementStateKey& keepKey);
1556 void swapContextRectMemory(
const QString& screenId,
const PhosphorEngine::PlacementStateKey& oldKey,
1557 const PhosphorEngine::PlacementStateKey& newKey);
1560 void forgetContextMemo(
const PhosphorEngine::PlacementStateKey& key,
const QString& windowId);
1563 void seedFloatRestoreForOpen(
const QString& windowId,
int minWidth,
int minHeight);
1565 void finishFloatedOpen(ScrollState* state,
const QString& windowId,
const QString& screenId,
int minWidth,
1566 int minHeight,
bool migration,
bool oversized,
bool placedBefore,
1567 const PhosphorEngine::WindowPlacement* record);
1569 bool restoreFloatRecordForOpen(
const QString& windowId,
const QString& screenId,
const QList<QSize>& managedSizes);
1570 bool emitGatedFloatGeometryRestore(
const QString& windowId,
const PhosphorEngine::WindowPlacement& record,
1571 const QString& screenId,
const QList<QSize>& managedSizes);
1572 void restoreFreeSizeForFloatedOpen(
const QString& windowId,
const QString& screenId,
bool placedBefore,
1573 const QList<QSize>& managedSizes);
1575 QList<QSize> managedSizesOnScreen(
const QString& screenId)
const;
1577 void consumeStripStashTileForFloat(ScrollState* state,
const PhosphorEngine::PlacementStateKey& key,
1578 const QString& windowId);
1581 enum class FloatAnnounce : quint8 {
1585 void announceFloat(FloatAnnounce announce,
const QString& windowId,
bool floating,
const QString& screenId);
1586 void setWindowFloatAnnounced(
const QString& rawWindowId,
bool shouldFloat,
const QString& screenId,
1587 FloatAnnounce announce);
1589 void rememberReleasedFullscreenHold(
const QString& windowId);
1590 void announceReleasedFullscreenHolds();
1597 void settleReannouncedFullscreenHold(
const QString& windowId);
1600 void applyReturnedTile(
const PhosphorEngine::PlacementStateKey& key);
1601 bool floatWindowInternal(ScrollState* state,
const PhosphorEngine::PlacementStateKey& key,
const QString& windowId,
1602 const QString& screenId, FloatAnnounce announce = FloatAnnounce::Active,
1603 bool fullscreenHold =
false,
bool applyAfter =
true);
1604 bool unfloatWindowInternal(ScrollState* state,
const QString& windowId,
const QString& screenId,
1605 bool applyAfter =
true, FloatAnnounce announce = FloatAnnounce::Active);
1617 bool moveActiveWindowAcrossBoundary(ScrollState* state,
const QString& screenId,
const QString& direction,
1618 bool swap, QString* landingScreen =
nullptr);
1621 void adoptAsFloatAfterRefusal(ScrollState* owner,
const QString& windowId,
const QSize& minSize,
1622 const QString& announceScreen);
1629 bool focusAcrossBoundary(
const QString& screenId,
const QString& direction,
const QString& focusedBefore);
1637 void focusInDirectionResolved(
const QString& direction,
const PhosphorEngine::NavigationContext& ctx,
1638 const QString& screen, ScrollState* state,
const ScrollLayoutParams& params);
1641 void clearSourceFloatFocusAfterCrossing(
const QString& sourceScreenId);
1651 void scrollViewResolved(
int deltaPx,
const QString& screen, ScrollState* state,
const ScrollLayoutParams& params,
1654 PhosphorEngine::IWindowTrackingService* m_windowTracker =
nullptr;
1655 PhosphorScreens::ScreenManager* m_screenManager =
nullptr;
1660 std::function<QRect(
const QString&)> m_availableGeometryProvider;
1661 std::function<QRect(
const QString&)> m_screenGeometryProvider;
1662 std::function<QList<QRect>()> m_allScreenGeometriesProvider;
1667 QPointer<PhosphorEngine::WindowRegistry> m_windowRegistry;
1668 PhosphorEngine::ICrossSurfaceResolver* m_crossSurfaceResolver =
nullptr;
1670 PhosphorEngine::PerScreenStates<ScrollState> m_states;
1671 PhosphorEngine::ScreenContextTracker m_context;
1672 QSet<QString> m_scrollingScreens;
1673 QString m_activeScreen;
1679 QStringList m_pendingSelfActivations;
1684 void queueSelfActivation(
const QString& windowId);
1686 static constexpr int kMaxPendingSelfActivations = 16;
1706 QHash<QString, qint64> m_pendingSelfActivationQueuedAt;
1707 QElapsedTimer m_selfActivationClock;
1708 static constexpr qint64 kSelfActivationEchoExpiryMs = 1000;
1736 QSet<QString> m_declinedOpenFocus;
1741 int m_arrivalBurstDepth = 0;
1742 QHash<PhosphorEngine::PlacementStateKey, bool> m_burstPendingApplies;
1744 QSet<QString> m_crossScreenClaimsExhausted;
1749 bool m_isDesktopContextSwitch =
false;
1788 QSet<QString> m_forceEmitScreens;
1808 QSet<PhosphorEngine::PlacementStateKey> m_pendingFocusEmitContexts;
1815 QHash<QString, QString> m_announcedStripEpoch;
1818 QList<qreal> m_presetColumnWidths{1.0 / 3.0, 0.5, 2.0 / 3.0, 0.75, 1.0};
1819 QList<qreal> m_presetWindowHeights{1.0 / 3.0, 0.5, 2.0 / 3.0, 0.75, 1.0};
1824 int m_stripAxis = 0;
1825 bool m_alwaysCenterSingleColumn =
false;
1830 bool m_cropStraddlers =
false;
1842 ColumnWidth m_defaultColumnWidth = ColumnWidth::makeProportion(0.5);
1847 bool m_defaultWidthClientDecides =
false;
1848 ColumnDisplay m_defaultColumnDisplay = ColumnDisplay::Normal;
1851 TabIndicatorParams m_tabIndicator{};
1856 bool m_respectMinimumSize =
true;
1857 bool m_centerShortColumns =
false;
1866 bool m_smartGaps =
false;
1868 WindowHeight m_defaultWindowHeight{};
1873 bool m_defaultHeightClientDecides =
false;
1889 QHash<QString, QRect> m_lastAppliedRect;
1901 QSet<QString> m_lastAppliedWindowedFs;
1910 QSet<QString> m_lastAppliedMaximizedToEdges;
1921 QHash<QString, QString> m_parkedScrollEdge;
1929 QHash<PhosphorEngine::PlacementStateKey, QHash<QString, QRect>> m_contextRectMemory;
1930 QHash<PhosphorEngine::PlacementStateKey, QHash<QString, QString>> m_contextParkedEdge;
1935 QHash<QString, FloatRestore> m_floatRestore;
1937 QStringList m_releasedFullscreenHolds;
1940 QSet<QString> m_closedFullscreenHolds;
1952 std::optional<DragInsertPreview> m_dragInsertPreview;
1956 QString m_interactiveDragWindow;
1960 static FloatRestore captureDragSlot(
const ScrollStrip& strip,
const QString& windowId);
1967 bool dragPreviewRestoreSlot(ScrollState* state,
const QString& windowId,
const FloatRestore& slot,
1968 const ScrollLayoutParams& params,
const QString& screenId);
1974 static void restoreTabbedHeightOwner(ScrollStrip& strip,
const QString& windowId,
const FloatRestore& slot);
1983 std::optional<QSize> dragDropClientSize(
const DragInsertPreview& preview)
const;
1991 FloatRestore dragDropIntents(
const DragInsertPreview& preview,
const std::optional<QSize>& clientSize,
1992 const ScrollLayoutParams& params)
const;
1997 void dropClosedWindowFromDragPreview(
const QString& windowId);
2008 bool writeDragAutoScrollTarget(
const ScrollState& state,
const ScrollLayoutParams& params,
int direction,
2009 const QPoint& cursorPos);
2014 bool repairDragAutoScrollTarget(
const QPoint& cursorPos);
2016 QSet<QString> m_scrollFloatedWindows;
2022 QHash<QString, QStringList> m_pendingInitialOrder;
2026 QHash<QString, QSet<QString>> m_consumedInitialOrder;
2034 QHash<QString, QString> m_pendingInitialFocus;
2048 buildStashFromState(
const ScrollState* state,
2049 std::optional<PhosphorProtocol::ScrollAxis> preResolvedFallbackAxis = std::nullopt)
const;
2055 QHash<PhosphorEngine::PlacementStateKey, StashedStrip> m_stripStash;
2056 QHash<PhosphorEngine::PlacementStateKey, QSet<QString>> m_stripStashConsumed;
2062 qint64 m_fuzzyClaimGraceMs;
2064 quint64 m_stashSequence = 0;
2066 quint64 m_floatLeaveSequence = 0;
2068 QSet<QString> m_pendingRetiles;
2071 QSet<QString> m_screensWithTabStrips;
2075 QHash<QString, QString> m_lastTabStripPayload;
2099 bool effectiveAlwaysCenterSingleColumn(
const QVariantMap& overrides)
const;
2100 bool effectiveCenterShortColumns(
const QVariantMap& overrides)
const;
2101 bool effectiveRespectMinimumSize(
const QVariantMap& overrides)
const;
2102 bool effectiveSmartGaps(
const QVariantMap& overrides)
const;
2106 bool effectiveCropStraddlers(
const QVariantMap& overrides)
const;
2112 bool effectiveFocusNewWindows(
const QString& screenId)
const;
2118 bool groupSameAppAsTabs()
const;
2129 int tabGroupColumnIndex(
const ScrollStrip& strip,
const std::function<
bool(
const QString&)>& inGroup)
const;
2139 struct GroupedOpenHost
2144 GroupedOpenHost groupedOpenHost(
const ScrollStrip& strip,
const QString& windowId,
const QString& appId,
2145 const QString& screenId,
const ScrollOpenParams& openParams)
const;
2152 bool insertGroupedOpen(ScrollState* state,
const QString& windowId,
const QString& appId,
const QString& screenId,
2153 const ScrollLayoutParams& params,
int minWidth,
int minHeight,
2154 const ScrollOpenParams& openParams, QString* outDisplacedTab,
bool* outNamed);
2162 static bool effectiveBoolOverride(
const QVariantMap& overrides,
const QString& key,
bool fallback);
2163 ColumnWidth effectiveDefaultColumnWidth(
const QString& screenId)
const;
2164 ColumnWidth effectiveDefaultColumnWidth(
const QVariantMap& overrides)
const;
2171 ColumnWidth effectiveDefaultColumnWidth(
const QVariantMap& overrides,
const QList<qreal>& presetWidths)
const;
2179 static std::optional<qreal> ruleColumnWidthFraction(
const QVariantMap& overrides);
2187 bool effectiveWidthClientDecides(
const QVariantMap& overrides)
const;
2196 std::optional<ColumnWidth> resetDefaultColumnWidthFor(
const QVariantMap& overrides,
2197 const ScrollLayoutParams& params)
const;
2198 ColumnDisplay effectiveDefaultColumnDisplay(
const QString& screenId)
const;
2199 ColumnDisplay effectiveDefaultColumnDisplay(
const QVariantMap& overrides)
const;
2207 WindowHeight effectiveDefaultWindowHeight(
const QString& screenId,
const QRect& workArea, StripAxis axis)
const;
2208 WindowHeight effectiveDefaultWindowHeight(
const QVariantMap& overrides,
const QRect& workArea,
2209 StripAxis axis)
const;
2211 WindowHeight effectiveDefaultWindowHeight(
const QVariantMap& overrides,
const QRect& workArea, StripAxis axis,
2212 const QList<qreal>& presetHeights)
const;
2219 static std::optional<qreal> ruleWindowHeightFraction(
const QVariantMap& overrides);
2224 bool effectiveHeightClientDecides(
const QVariantMap& overrides)
const;
2249 bool commitClientDecidedHeight(ScrollStrip& strip,
const QString& windowId,
const QString& screenId,
2250 const QVariantMap& overrides,
const ScrollLayoutParams& params,
2251 std::optional<QSize> clientSize = std::nullopt)
const;
2262 static ColumnWidth clientDecidedColumnWidth(
const QSize& clientSize,
const ScrollLayoutParams& params,
2263 ColumnDisplay display);
2273 std::optional<QSize> clientSizeForDecidedWidth(
const QString& windowId,
const QString& screenId,
2274 const QVariantMap& overrides)
const;
2280 std::optional<WindowHeight> resetDefaultWindowHeightFor(
const QVariantMap& overrides)
const;
2285 TabIndicatorParams effectiveTabIndicator(
const QString& screenId)
const;
2286 TabIndicatorParams effectiveTabIndicator(
const QVariantMap& overrides)
const;
2289 QList<qreal> effectivePresetColumnWidths(
const QVariantMap& overrides)
const;
2290 QList<qreal> effectivePresetWindowHeights(
const QVariantMap& overrides)
const;
2293 StripAxis effectiveStripAxis(
const QVariantMap& overrides,
const QRect& workArea)
const;
2316 QHash<PhosphorEngine::PlacementStateKey, QVariantMap> m_perScreenOverrides;
2317 std::function<void()> m_persistSaveFn;
2318 std::function<void()> m_persistLoadFn;
2319 FloatPredicate m_floatPredicate;
2320 RestorePositionPredicate m_restorePositionPredicate{};
2321 OpenParamsResolver m_openParamsResolver;
2322 ModeResolver m_snappingModeResolver;
2323 ModeResolver m_scrollingModeResolver;
2324 ModeResolver m_autotileModeResolver;
2325 ContextGapProvider m_contextGapProvider;
2329 bool isEvacueeParkedKey(
const PhosphorEngine::PlacementStateKey& key)
const;
2331 std::unique_ptr<ScrollEvacueePark> m_evacueePark;
2335 QSize committedFloorFor(
const QString& windowId)
const;
2338 int committedCrossFloorFor(
const QString& windowId,
const StripAxis& axis)
const;
2341 int committedPeekPx(
const QString& windowId,
const StripAxis& axis)
const;
2344 void forgetCommittedExtents(
const QString& windowId);
2347 bool dropCommittedForUserResize(
const QString& windowId,
const StripAxis& axis);
2350 bool dropCommittedCrossForUserResize(
const QString& windowId,
const StripAxis& axis);
2355 void dropCommittedForLoweredMinimum(
const QString& windowId,
const QSize& oldMin,
const QSize& newMin);
2369 bool settleCommittedFloors(ScrollState& state,
const PhosphorEngine::PlacementStateKey& key,
2370 const ScrollLayoutParams& params);
2373 bool settleCommittedCrossFloor(
const ScrollStrip& strip,
const PhosphorEngine::PlacementStateKey& key,
2374 const ScrollLayoutParams& params,
const QString& windowId,
2375 CommittedCrossExtent& cross)
const;
2393 void endStalePeeks(
const ScrollStrip& strip,
const ResolvedStrip& resolved,
2394 const PhosphorEngine::PlacementStateKey& key,
const ScrollLayoutParams& params,
2395 const QRect& screenRect,
int parkTop);
2398 enum class OfferAxis : quint8 {
2407 bool everyOtherColumnOffers(
const QString& windowId,
const PhosphorEngine::PlacementStateKey& key,
2408 const StripAxis& axis,
const std::function<
bool(
int)>& accepts,
2409 OfferAxis offerAxis = OfferAxis::Main)
const;
2413 static ScrollLayoutParams withoutCommittedFloorOf(
const ScrollLayoutParams& params,
const QString& windowId);
2420 bool outgrowsWorkArea(
const ScrollState& state,
const QString& windowId,
const ScrollLayoutParams& params)
const;
2425 bool floatIfOutgrowsWorkArea(ScrollState* state,
const PhosphorEngine::PlacementStateKey& key,
2426 const QString& windowId,
const char* reason,
bool applyAfter =
true);
2440 QHash<QString, CommittedExtent> m_committedExtents;
How KWin's desktop positions moved in one change of its desktop list: for each 1-based position in th...
Definition DesktopRemap.h:29
Resolves the neighbouring surface — output or virtual desktop — in a direction, for cross-surface win...
Definition ICrossSurfaceResolver.h:21
LayoutSupport
How this engine relates to user-selectable layouts — the entries the layout picker,...
Definition IPlacementEngine.h:955
@ Templates
The engine consumes a first-class TEMPLATE object rather than a placement layout.
Definition IPlacementEngine.h:972
Per-screen placement state contract.
Definition IPlacementState.h:28
Definition IWindowTrackingService.h:35
Abstract base class for placement engines.
Definition PlacementEngineBase.h:36
Definition WindowRegistry.h:113
Centralized screen-topology service.
Definition Manager.h:86
Definition DesktopRemap.h:12
StickyWindowHandling
Definition EngineTypes.h:238
@ TreatAsNormal
Definition EngineTypes.h:239
StickyPinPhase
Which half of the sticky-screen pin pass to run.
Definition EngineTypes.h:323
std::function< bool(const QString &)> StickyPredicate
Answers whether a window is on all desktops.
Definition EngineTypes.h:247
std::function< DesktopSpan(const QString &)> DesktopSpanQuery
Answers a window's DesktopSpan.
Definition EngineTypes.h:292
Definition IWindowTrackingService.h:28
Where a drag-insert preview should place the dragged window, in the TARGET ENGINE's slot vocabulary.
Definition IPlacementEngine.h:538
Context for a cross-engine window handoff.
Definition IPlacementEngine.h:863
What a membership pass did, so the caller can drive the bookkeeping the engines cannot reach: the pla...
Definition EngineTypes.h:299
Target window + screen for a navigation or lifecycle operation.
Definition NavigationContext.h:18
Identity of a per-screen placement state: a window's placement is scoped to the (screen,...
Definition EngineTypes.h:25
static QLatin1String scrollingEngineId()
Definition WindowPlacement.h:275