wayland/shortcuts-inhibit: track active state and prevent duplicate

inhibitors

Author: bbedward

src/wayland/shortcuts_inhibit/inhibitor.cpp

@@ -36,6 +36,10 @@ void ShortcutsInhibitor::setWindow(QObject* window) {
 	this->bWindowObject = proxyWindow ? window : nullptr;
 }
 
+bool ShortcutsInhibitor::isActive() const {
+	return this->inhibitor ? this->inhibitor->isActive() : false;
+}
+
 void ShortcutsInhibitor::boundWindowChanged() {
 	auto* window = this->bBoundWindow.value();
 	auto* proxyWindow = qobject_cast<ProxyWindowBase*>(window);
@@ -134,13 +138,31 @@ void ShortcutsInhibitor::onWaylandSurfaceCreated() {
 		return;
 	}
 
-	delete this->inhibitor;
+	if (this->inhibitor) {
+		QObject::disconnect(this->inhibitor, nullptr, this, nullptr);
+		delete this->inhibitor;
+		this->inhibitor = nullptr;
+	}
 	this->inhibitor = manager->createShortcutsInhibitor(this->mWaylandWindow);
+
+	if (this->inhibitor) {
+		QObject::connect(
+		    this->inhibitor,
+		    &impl::ShortcutsInhibitor::activeChanged,
+		    this,
+		    &ShortcutsInhibitor::activeChanged
+		);
+	}
 }
 
 void ShortcutsInhibitor::onWaylandSurfaceDestroyed() {
-	delete this->inhibitor;
-	this->inhibitor = nullptr;
+	if (this->inhibitor) {
+		QObject::disconnect(this->inhibitor, nullptr, this, nullptr);
+		auto wasActive = this->inhibitor->isActive();
+		delete this->inhibitor;
+		this->inhibitor = nullptr;
+		if (wasActive) { emit this->activeChanged(); }
+	}
 }
 
 } // namespace qs::wayland::shortcuts_inhibit

src/wayland/shortcuts_inhibit/inhibitor.hpp

@@ -32,6 +32,16 @@ class ShortcutsInhibitor: public QObject {
 	///
   /// Must be set to a non null value to enable the inhibitor.
 	Q_PROPERTY(QObject* window READ window WRITE setWindow NOTIFY windowChanged);
+	/// Whether the inhibitor is currently active. The inhibitor is active when the compositor
+	/// has granted the request and shortcuts are being inhibited.
+	///
+	/// The compositor may deactivate the inhibitor if the user requests normal shortcuts to be restored.
+	/// When inactive, there is no way to programmatically reactivate it - the user must do so through
+	/// compositor-specific mechanisms.
+	///
+	/// Note that if the surface loses focus or is destroyed, the inhibitor becomes irrelevant and this
+	/// property will become false, but no inactive event is sent by the compositor in those cases.
+	Q_PROPERTY(bool active READ isActive NOTIFY activeChanged);
 	// clang-format on
 
 public:
@@ -43,10 +53,12 @@ class ShortcutsInhibitor: public QObject {
 	void setWindow(QObject* window);
 
 	[[nodiscard]] QBindable<bool> bindableEnabled() { return &this->bEnabled; }
+	[[nodiscard]] bool isActive() const;
 
 signals:
 	void enabledChanged();
 	void windowChanged();
+	void activeChanged();
 
 private slots:
 	void onWindowDestroyed();

src/wayland/shortcuts_inhibit/proto.cpp

@@ -36,15 +36,42 @@ ShortcutsInhibitManager::createShortcutsInhibitor(QtWaylandClient::QWaylandWindo
 		return nullptr;
 	}
 
+	auto* wlSurface = surface->surface();
+
+	if (this->inhibitors.contains(wlSurface)) {
+		qCWarning(logShortcutsInhibit)
+		    << "An inhibitor already exists for surface, skipping creation." << wlSurface;
+		return nullptr;
+	}
+
 	auto* inhibitor =
-	    new ShortcutsInhibitor(this->inhibit_shortcuts(surface->surface(), inputDevice->object()));
-	qCDebug(logShortcutsInhibit) << "Created inhibitor" << inhibitor;
+	    new ShortcutsInhibitor(this->inhibit_shortcuts(wlSurface, inputDevice->object()), wlSurface);
+	this->inhibitors.insert(wlSurface, inhibitor);
+	qCDebug(logShortcutsInhibit) << "Created inhibitor" << inhibitor << "for surface" << wlSurface;
 	return inhibitor;
 }
 
+void ShortcutsInhibitManager::destroyShortcutsInhibitor(ShortcutsInhibitor* inhibitor) {
+	if (inhibitor) { this->inhibitors.remove(inhibitor->surface()); }
+}
+
 ShortcutsInhibitor::~ShortcutsInhibitor() {
-	qCDebug(logShortcutsInhibit) << "Destroyed inhibitor" << this;
+	qCDebug(logShortcutsInhibit) << "Destroying inhibitor" << this << "for surface" << this->mSurface;
+	auto* manager = ShortcutsInhibitManager::instance();
+	if (manager) { manager->destroyShortcutsInhibitor(this); }
 	if (this->isInitialized()) this->destroy();
 }
 
+void ShortcutsInhibitor::zwp_keyboard_shortcuts_inhibitor_v1_active() {
+	qCDebug(logShortcutsInhibit) << "Inhibitor became active" << this;
+	this->mActive = true;
+	emit this->activeChanged();
+}
+
+void ShortcutsInhibitor::zwp_keyboard_shortcuts_inhibitor_v1_inactive() {
+	qCDebug(logShortcutsInhibit) << "Inhibitor became inactive" << this;
+	this->mActive = false;
+	emit this->activeChanged();
+}
+
 } // namespace qs::wayland::shortcuts_inhibit::impl

src/wayland/shortcuts_inhibit/proto.hpp

@@ -18,17 +18,40 @@ class ShortcutsInhibitManager
 	explicit ShortcutsInhibitManager();
 
 	ShortcutsInhibitor* createShortcutsInhibitor(QtWaylandClient::QWaylandWindow* surface);
+	void destroyShortcutsInhibitor(ShortcutsInhibitor* inhibitor);
 
 	static ShortcutsInhibitManager* instance();
+
+private:
+	QHash<wl_surface*, ShortcutsInhibitor*> inhibitors;
 };
 
-class ShortcutsInhibitor: public QtWayland::zwp_keyboard_shortcuts_inhibitor_v1 {
+class ShortcutsInhibitor
+    : public QObject
+    , public QtWayland::zwp_keyboard_shortcuts_inhibitor_v1 {
+	Q_OBJECT;
+
 public:
-	explicit ShortcutsInhibitor(::zwp_keyboard_shortcuts_inhibitor_v1* inhibitor)
-	    : QtWayland::zwp_keyboard_shortcuts_inhibitor_v1(inhibitor) {}
+	explicit ShortcutsInhibitor(::zwp_keyboard_shortcuts_inhibitor_v1* inhibitor, wl_surface* surface)
+	    : QtWayland::zwp_keyboard_shortcuts_inhibitor_v1(inhibitor)
+	    , mSurface(surface) {}
 
 	~ShortcutsInhibitor() override;
 	Q_DISABLE_COPY_MOVE(ShortcutsInhibitor);
+
+	[[nodiscard]] bool isActive() const { return this->mActive; }
+	[[nodiscard]] wl_surface* surface() const { return this->mSurface; }
+
+signals:
+	void activeChanged();
+
+protected:
+	void zwp_keyboard_shortcuts_inhibitor_v1_active() override;
+	void zwp_keyboard_shortcuts_inhibitor_v1_inactive() override;
+
+private:
+	bool mActive = false;
+	wl_surface* mSurface;
 };
 
 } // namespace qs::wayland::shortcuts_inhibit::impl