Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
DaemonClient.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
6#include "phosphorcompositor_export.h"
14
15#include <QObject>
16#include <QRect>
17#include <QString>
18#include <QStringList>
19
20class QDBusServiceWatcher;
21
23
24class PHOSPHORCOMPOSITOR_EXPORT DaemonClient : public QObject
25{
26 Q_OBJECT
27
28public:
29 explicit DaemonClient(QObject* parent = nullptr);
30 ~DaemonClient() override;
31
32 bool isDaemonReady() const
33 {
34 // "Ready" means REACHABLE: probeDaemonAvailable sets this without
35 // wiring the signal subscriptions (only a successful registerBridge
36 // does). Callers needing the signal stream must register.
37 return m_daemonReady;
38 }
39
42 {
43 m_dragHandler = handler;
44 }
45
47 {
48 m_geometryHandler = handler;
49 }
50
52 {
53 m_lifecycleHandler = handler;
54 }
55
79 void registerBridge(const QString& compositorId, int apiVersion, const QStringList& capabilities);
80
81 // Window lifecycle notifications (plugin → daemon)
82 void notifyWindowOpened(const QString& windowId, const QString& screenId, int minWidth = 0, int minHeight = 0);
84 void notifyWindowClosed(const QString& windowId);
85 void notifyWindowActivated(const QString& windowId, const QString& screenId);
88 void notifyActiveWindowScreenChanged(const QString& windowId, const QString& screenId);
89
90 // Drag operations (plugin → daemon)
103 void beginDrag(const QString& windowId, const QRect& frameGeometry, const QString& startScreenId,
104 int mouseButtons = 0);
105 void updateDragCursor(const QString& windowId, int cursorX, int cursorY, int modifiers = 0, int mouseButtons = 0);
106 void endDrag(const QString& windowId, int cursorX, int cursorY, int modifiers = 0, int mouseButtons = 0,
107 bool cancelled = false);
108
109 // Screen notifications (plugin → daemon)
110 void notifyCursorScreenChanged(const QString& screenId);
111 void notifyPrimaryScreen(const QString& screenName);
112
113 // Queries (plugin → daemon, async results via signals)
117 void queryVirtualScreens(const QString& screenId);
118 void pruneStaleWindows(const QStringList& liveWindowIds);
119
120 // Daemon availability probe (async — emits daemonReady if responsive).
121 // The default comes from the shared constant rather than a literal so the
122 // two cannot drift.
123 //
124 // NOTE: this entry point currently has NO caller in the repo. The
125 // compositor plugin reaches readiness through registerBridge instead.
126 // Kept as part of the library's public surface, but do not read the
127 // constant's own doc as evidence of a live probe site.
129
130Q_SIGNALS:
133 void bridgeRegistered(const QString& sessionId, int peerApiVersion);
134 void bridgeRejected(const QString& reason);
135
136 void floatingWindowsReceived(const QStringList& windowIds);
137 void snappedWindowsReceived(const QStringList& windowIds);
138 void pendingRestoreGeometriesReceived(const QString& json);
139 void virtualScreensReceived(const QString& screenId, const PhosphorProtocol::WindowGeometryList& geometries);
140
142 void virtualScreensChanged(const QString& screenId);
143
146 void dragPolicyReceived(const QString& windowId, const PhosphorProtocol::DragPolicy& policy);
149 void dragOutcomeReceived(const QString& windowId, const PhosphorProtocol::DragOutcome& outcome);
150
151 void snapAssistReady(const QString& windowId, const QString& screenId,
156
157private Q_SLOTS:
158 void onDaemonReadySignal();
159 void onServiceRegistered();
160 void onServiceUnregistered();
161 void handleApplyGeometry(const QString& windowId, int x, int y, int w, int h, const QString& zoneId,
162 const QString& screenId, bool sizeOnly);
163 void handleApplyGeometriesBatch(const PhosphorProtocol::WindowGeometryList& geometries, const QString& action);
164 void handleRaiseWindows(const QStringList& windowIds);
165 void handleActivateWindow(const QString& windowId);
166 void handleDragPolicyChanged(const QString& windowId, const PhosphorProtocol::DragPolicy& newPolicy);
167 void handleWindowFloatingChanged(const QString& windowId, bool isFloating, const QString& screenId);
168 void handleRestoreSizeDuringDrag(const QString& windowId, int width, int height);
169 void handleMoveWindowToZone(const QString& windowId, const QString& screenId, int x, int y, int w, int h);
170 void handleSnapAllWindows(const QString& screenId);
171 void handleSnapAssistReady(const QString& windowId, const QString& screenId,
173
174private:
175 void connectDaemonSignals();
176 void disconnectDaemonSignals();
179 bool reportAdmitted(const char* method);
180
181 QDBusServiceWatcher* m_serviceWatcher = nullptr;
182 IDragHandler* m_dragHandler = nullptr;
183 IGeometryHandler* m_geometryHandler = nullptr;
184 ILifecycleHandler* m_lifecycleHandler = nullptr;
185
186 bool m_daemonReady = false;
187 bool m_daemonSignalsConnected = false;
188 bool m_registrationInFlight = false;
189 QString m_sessionId;
192 bool m_warnedUnregisteredReport = false;
193};
194
195} // namespace PhosphorCompositor
DaemonClient(QObject *parent=nullptr)
void setDragHandler(IDragHandler *handler)
Definition DaemonClient.h:41
void endDrag(const QString &windowId, int cursorX, int cursorY, int modifiers=0, int mouseButtons=0, bool cancelled=false)
void registerBridge(const QString &compositorId, int apiVersion, const QStringList &capabilities)
Register this client as THE compositor bridge.
void pruneStaleWindows(const QStringList &liveWindowIds)
void notifyCursorScreenChanged(const QString &screenId)
void notifyWindowActivated(const QString &windowId, const QString &screenId)
void queryVirtualScreens(const QString &screenId)
void bridgeRegistered(const QString &sessionId, int peerApiVersion)
void snappedWindowsReceived(const QStringList &windowIds)
void floatingWindowsReceived(const QStringList &windowIds)
void beginDrag(const QString &windowId, const QRect &frameGeometry, const QString &startScreenId, int mouseButtons=0)
Canonical drag surface, mirroring org.phosphor_works.Placement.WindowDrag.
void setGeometryHandler(IGeometryHandler *handler)
Definition DaemonClient.h:46
void virtualScreensChanged(const QString &screenId)
void notifyWindowOpened(const QString &windowId, const QString &screenId, int minWidth=0, int minHeight=0)
void snapAssistReady(const QString &windowId, const QString &screenId, const PhosphorProtocol::EmptyZoneList &zones)
void dragOutcomeReceived(const QString &windowId, const PhosphorProtocol::DragOutcome &outcome)
Daemon's reply to endDrag.
void pendingRestoreGeometriesReceived(const QString &json)
void probeDaemonAvailable(int timeoutMs=PhosphorProtocol::Service::DaemonReadyProbeTimeoutMs)
void notifyPrimaryScreen(const QString &screenName)
void notifyWindowClosed(const QString &windowId)
void notifyActiveWindowScreenChanged(const QString &windowId, const QString &screenId)
The focused window moved to screenId without a new activation (WindowTracking.activeWindowScreenChang...
void bridgeRejected(const QString &reason)
void virtualScreensReceived(const QString &screenId, const PhosphorProtocol::WindowGeometryList &geometries)
void notifyWindowOpenedBatch(const PhosphorProtocol::WindowOpenedList &windows)
bool isDaemonReady() const
Definition DaemonClient.h:32
void dragPolicyReceived(const QString &windowId, const PhosphorProtocol::DragPolicy &policy)
Daemon's reply to beginDrag.
void updateDragCursor(const QString &windowId, int cursorX, int cursorY, int modifiers=0, int mouseButtons=0)
void setLifecycleHandler(ILifecycleHandler *handler)
Definition DaemonClient.h:51
Definition IDragHandler.h:13
Definition IGeometryHandler.h:30
Definition ILifecycleHandler.h:12
Definition DaemonClient.h:22
constexpr int DaemonReadyProbeTimeoutMs
Definition ServiceConstants.h:944
QList< EmptyZoneEntry > EmptyZoneList
Definition ZoneTypes.h:58
QList< WindowGeometryEntry > WindowGeometryList
Definition WindowTypes.h:102
QList< WindowOpenedEntry > WindowOpenedList
Definition WindowTypes.h:130
Drag outcome — daemon-authoritative decision about what to apply at drag end.
Definition DragTypes.h:103
Drag policy — daemon-authoritative decision about how a drag should be handled.
Definition DragTypes.h:76