Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
WindowQuery.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
7
8#include <QString>
9#include <QVariant>
10
11#include <optional>
12
13#include "MatchTypes.h"
14
15namespace PhosphorRules {
16
37{
38 // ── Window attributes — absent during windowless context resolution ──
39 std::optional<QString> appId;
40 std::optional<QString> windowClass;
41 std::optional<QString> title;
42 std::optional<QString> windowRole;
43 std::optional<QString> desktopFile;
44 std::optional<int> pid;
45 std::optional<PhosphorProtocol::WindowType> windowType;
46 std::optional<bool> isSticky;
47 std::optional<bool> isFullscreen;
48 std::optional<bool> isMinimized;
49 std::optional<bool> isMaximized;
50 std::optional<bool> isFocused;
51 std::optional<bool> isTransient;
52 std::optional<bool> isNotification;
53 std::optional<int> width;
54 std::optional<int> height;
55 std::optional<bool> keepAbove;
56 std::optional<bool> keepBelow;
57 std::optional<bool> skipTaskbar;
58 std::optional<bool> skipPager;
59 std::optional<bool> skipSwitcher;
60 std::optional<bool> isModal;
61 std::optional<bool> hasDecoration;
62 std::optional<bool> isResizable;
63 std::optional<bool> isMovable;
64 std::optional<bool> isMaximizable;
65 std::optional<int> positionX;
66 std::optional<int> positionY;
67 std::optional<QString> captionNormal;
68 std::optional<bool> isFloating;
69 std::optional<bool> isSnapped;
70 std::optional<QString> zone;
71 std::optional<bool> isTiled;
73
74 // ── Context attributes — always present (except the three optionals below) ──
75 QString screenId;
77 QString activity;
78 QString mode;
80 QString
82 QString activeLayout;
84 QString colorScheme;
85
91 std::optional<int> tiledWindowCount;
92
93 // The screen-shape members follow tiledWindowCount because this header is
94 // installed and new members are appended.
97
104 std::optional<int> screenWidth;
105 std::optional<int> screenHeight;
106
109 bool hasWindow() const
110 {
111 for (const auto& d : kFieldTable) {
112 if (d.source == FieldSource::Window && valueForField(d.field).has_value()) {
113 return true;
114 }
115 }
116 return false;
117 }
118
131 std::optional<QVariant> valueForField(Field field) const
132 {
133 switch (field) {
134 case Field::AppId:
135 return appId ? std::optional<QVariant>(*appId) : std::nullopt;
137 return windowClass ? std::optional<QVariant>(*windowClass) : std::nullopt;
139 return desktopFile ? std::optional<QVariant>(*desktopFile) : std::nullopt;
141 return windowRole ? std::optional<QVariant>(*windowRole) : std::nullopt;
142 case Field::Title:
143 return title ? std::optional<QVariant>(*title) : std::nullopt;
144 case Field::Pid:
145 return pid ? std::optional<QVariant>(*pid) : std::nullopt;
147 return windowType ? std::optional<QVariant>(static_cast<int>(*windowType)) : std::nullopt;
148 case Field::IsSticky:
149 return isSticky ? std::optional<QVariant>(*isSticky) : std::nullopt;
151 return isFullscreen ? std::optional<QVariant>(*isFullscreen) : std::nullopt;
153 return isMinimized ? std::optional<QVariant>(*isMinimized) : std::nullopt;
154 case Field::ScreenId:
155 return std::optional<QVariant>(screenId);
157 return std::optional<QVariant>(virtualDesktop);
158 case Field::Activity:
159 return std::optional<QVariant>(activity);
160 case Field::Mode:
161 return std::optional<QVariant>(mode);
163 return std::optional<QVariant>(screenOrientation);
165 return std::optional<QVariant>(activeLayout);
167 return std::optional<QVariant>(colorScheme);
169 return screenWidth ? std::optional<QVariant>(*screenWidth) : std::nullopt;
171 return screenHeight ? std::optional<QVariant>(*screenHeight) : std::nullopt;
173 return std::optional<QVariant>(screenAspectRatio);
175 return tiledWindowCount ? std::optional<QVariant>(*tiledWindowCount) : std::nullopt;
177 return isMaximized ? std::optional<QVariant>(*isMaximized) : std::nullopt;
178 case Field::IsFocused:
179 return isFocused ? std::optional<QVariant>(*isFocused) : std::nullopt;
181 return isTransient ? std::optional<QVariant>(*isTransient) : std::nullopt;
183 return isNotification ? std::optional<QVariant>(*isNotification) : std::nullopt;
184 case Field::Width:
185 return width ? std::optional<QVariant>(*width) : std::nullopt;
186 case Field::Height:
187 return height ? std::optional<QVariant>(*height) : std::nullopt;
188 case Field::KeepAbove:
189 return keepAbove ? std::optional<QVariant>(*keepAbove) : std::nullopt;
190 case Field::KeepBelow:
191 return keepBelow ? std::optional<QVariant>(*keepBelow) : std::nullopt;
193 return skipTaskbar ? std::optional<QVariant>(*skipTaskbar) : std::nullopt;
194 case Field::SkipPager:
195 return skipPager ? std::optional<QVariant>(*skipPager) : std::nullopt;
197 return skipSwitcher ? std::optional<QVariant>(*skipSwitcher) : std::nullopt;
198 case Field::IsModal:
199 return isModal ? std::optional<QVariant>(*isModal) : std::nullopt;
201 return hasDecoration ? std::optional<QVariant>(*hasDecoration) : std::nullopt;
203 return isResizable ? std::optional<QVariant>(*isResizable) : std::nullopt;
204 case Field::IsMovable:
205 return isMovable ? std::optional<QVariant>(*isMovable) : std::nullopt;
207 return isMaximizable ? std::optional<QVariant>(*isMaximizable) : std::nullopt;
208 case Field::PositionX:
209 return positionX ? std::optional<QVariant>(*positionX) : std::nullopt;
210 case Field::PositionY:
211 return positionY ? std::optional<QVariant>(*positionY) : std::nullopt;
213 return captionNormal ? std::optional<QVariant>(*captionNormal) : std::nullopt;
215 return isFloating ? std::optional<QVariant>(*isFloating) : std::nullopt;
216 case Field::IsSnapped:
217 return isSnapped ? std::optional<QVariant>(*isSnapped) : std::nullopt;
218 case Field::Zone:
219 return zone ? std::optional<QVariant>(*zone) : std::nullopt;
220 case Field::IsTiled:
221 return isTiled ? std::optional<QVariant>(*isTiled) : std::nullopt;
222 }
223 return std::nullopt;
224 }
225};
226
227} // namespace PhosphorRules
Definition ActionParams.h:25
Field
Match fields.
Definition MatchTypes.h:23
@ IsFocused
Definition MatchTypes.h:39
@ WindowType
Definition MatchTypes.h:31
@ IsSticky
Definition MatchTypes.h:32
@ PositionX
Definition MatchTypes.h:52
@ TiledWindowCount
context — tiled windows on this screen + desktop
Definition MatchTypes.h:63
@ PositionY
Definition MatchTypes.h:53
@ AppId
Definition MatchTypes.h:25
@ Width
Definition MatchTypes.h:42
@ VirtualDesktop
context — always present
Definition MatchTypes.h:36
@ IsMovable
window can be moved
Definition MatchTypes.h:65
@ SkipTaskbar
Definition MatchTypes.h:46
@ IsNotification
Definition MatchTypes.h:41
@ KeepAbove
Definition MatchTypes.h:44
@ IsFullscreen
Definition MatchTypes.h:33
@ ScreenWidth
context — the resolving screen's width in device pixels
Definition MatchTypes.h:75
@ HasDecoration
Definition MatchTypes.h:50
@ IsTiled
managed by a tiling-family engine — autotile or scrolling (distinct from IsSnapped)
Definition MatchTypes.h:59
@ WindowClass
Definition MatchTypes.h:26
@ IsMinimized
Definition MatchTypes.h:34
@ IsFloating
floated out of tiling (any placement engine)
Definition MatchTypes.h:56
@ Mode
context — current placement mode (snapping / tiling / scrolling)
Definition MatchTypes.h:61
@ CaptionNormal
Definition MatchTypes.h:54
@ ScreenHeight
context — the resolving screen's height in device pixels
Definition MatchTypes.h:76
@ IsMaximized
Definition MatchTypes.h:38
@ ScreenId
context — always present
Definition MatchTypes.h:35
@ ActiveLayout
context — the layout id currently resolved for the screen (snap UUID, "autotile:<algo>",...
Definition MatchTypes.h:70
@ KeepBelow
Definition MatchTypes.h:45
@ WindowRole
Definition MatchTypes.h:28
@ ScreenOrientation
context — "portrait" / "landscape" of the resolving screen
Definition MatchTypes.h:68
@ ScreenAspectRatio
context — the resolving screen's nearest common aspect ratio ("16:9", "32:9", …)
Definition MatchTypes.h:77
@ Pid
Definition MatchTypes.h:29
@ Zone
the snap zone's UUID the window occupies
Definition MatchTypes.h:58
@ Title
Definition MatchTypes.h:30
@ IsResizable
Definition MatchTypes.h:51
@ IsSnapped
occupies a snap zone
Definition MatchTypes.h:57
@ IsModal
Definition MatchTypes.h:49
@ SkipPager
Definition MatchTypes.h:47
@ DesktopFile
Definition MatchTypes.h:27
@ IsMaximizable
window can be maximized
Definition MatchTypes.h:66
@ SkipSwitcher
Definition MatchTypes.h:48
@ ColorScheme
context — "light" / "dark" system colour scheme, session-wide
Definition MatchTypes.h:73
@ Activity
context — always present
Definition MatchTypes.h:37
@ Height
Definition MatchTypes.h:43
@ IsTransient
Definition MatchTypes.h:40
@ Window
absent during windowless context queries
Definition MatchTypes.h:200
constexpr FieldDescriptor kFieldTable[]
The master field table — indexed by static_cast<int>(field).
Definition MatchTypes.h:217
The evaluation input — an attribute bag matched against a MatchExpression.
Definition WindowQuery.h:37
std::optional< QString > appId
Definition WindowQuery.h:39
QString activeLayout
layout id resolved for the screen (snap UUID / "autotile:<algo>" / "scrolling:"); empty where unpopul...
Definition WindowQuery.h:82
std::optional< bool > isModal
modal dialog
Definition WindowQuery.h:60
std::optional< bool > keepBelow
window set to stay below others
Definition WindowQuery.h:56
std::optional< int > positionY
frame top edge Y in px
Definition WindowQuery.h:66
std::optional< bool > isMaximizable
window can be maximized
Definition WindowQuery.h:64
std::optional< int > width
frame width in px
Definition WindowQuery.h:53
std::optional< QString > zone
the snap zone's UUID the window occupies
Definition WindowQuery.h:70
std::optional< bool > isFloating
floated out of any placement engine (snapping, autotile, or scrolling)
Definition WindowQuery.h:68
QString activity
empty = all activities
Definition WindowQuery.h:77
std::optional< bool > isMinimized
Definition WindowQuery.h:48
std::optional< QString > desktopFile
Definition WindowQuery.h:43
std::optional< bool > isFullscreen
Definition WindowQuery.h:47
std::optional< bool > isMovable
window can be moved
Definition WindowQuery.h:63
std::optional< bool > hasDecoration
has a server-side title-bar / border
Definition WindowQuery.h:61
std::optional< QString > captionNormal
title without the WM-added app-name suffix
Definition WindowQuery.h:67
std::optional< bool > isResizable
window can be resized
Definition WindowQuery.h:62
std::optional< QVariant > valueForField(Field field) const
Resolve field to its current value.
Definition WindowQuery.h:131
std::optional< int > screenHeight
Definition WindowQuery.h:105
std::optional< bool > isNotification
notification / critical-notification / on-screen-display surface
Definition WindowQuery.h:52
QString mode
placement-mode wire token — the ModeToken vocabulary in MatchTypes.h; a floating window has no mode (...
Definition WindowQuery.h:78
std::optional< bool > isSticky
Definition WindowQuery.h:46
std::optional< bool > skipSwitcher
hidden from the window switcher
Definition WindowQuery.h:59
std::optional< bool > skipPager
hidden from the pager
Definition WindowQuery.h:58
std::optional< bool > isMaximized
Definition WindowQuery.h:49
QString screenOrientation
"portrait" / "landscape" of the resolving screen; empty = unknown (no geometry provider)
Definition WindowQuery.h:81
QString colorScheme
"light" / "dark" system colour scheme; empty = unknown (no provider)
Definition WindowQuery.h:84
QString screenId
Definition WindowQuery.h:75
std::optional< bool > isFocused
Definition WindowQuery.h:50
std::optional< QString > title
Definition WindowQuery.h:41
std::optional< bool > isTransient
dialog/utility/popup/menu/tooltip/splash family, or has a transient parent
Definition WindowQuery.h:51
std::optional< int > positionX
frame left edge X in px
Definition WindowQuery.h:65
std::optional< bool > isTiled
managed by a tiling-family engine — autotile or scrolling (distinct from isSnapped)
Definition WindowQuery.h:71
std::optional< QString > windowClass
Definition WindowQuery.h:40
std::optional< QString > windowRole
Definition WindowQuery.h:42
std::optional< int > screenWidth
The resolving screen's size in DEVICE pixels (its mode, not the scaled logical size).
Definition WindowQuery.h:104
std::optional< bool > skipTaskbar
hidden from the taskbar
Definition WindowQuery.h:57
std::optional< int > tiledWindowCount
Tiled-window count for the screen + desktop being resolved.
Definition WindowQuery.h:91
std::optional< bool > isSnapped
occupies a snap zone (snap mode only)
Definition WindowQuery.h:69
QString screenAspectRatio
nearest common aspect ratio of the resolving screen ("16:9", "32:9", …); empty = the size is unknown
Definition WindowQuery.h:95
std::optional< int > height
frame height in px
Definition WindowQuery.h:54
std::optional< bool > keepAbove
window set to stay above others
Definition WindowQuery.h:55
int virtualDesktop
0 = all desktops
Definition WindowQuery.h:76
std::optional< PhosphorProtocol::WindowType > windowType
Definition WindowQuery.h:45
bool hasWindow() const
True if any window attribute is set — i.e.
Definition WindowQuery.h:109
std::optional< int > pid
Definition WindowQuery.h:44