From 2520041da914ce50e44b757c92024f472c5fce19 Mon Sep 17 00:00:00 2001
From: Corey Berla <corey@berla.me>
Date: Wed, 16 Aug 2023 13:37:44 -0700
Subject: [PATCH 1/3] introspect: Move code for reuse

---
 js/misc/introspect.js | 59 ++++++++++++++++++++++++-------------------
 1 file changed, 33 insertions(+), 26 deletions(-)

diff --git a/js/misc/introspect.js b/js/misc/introspect.js
index 3453d1a94..3dcd75b5e 100644
--- a/js/misc/introspect.js
+++ b/js/misc/introspect.js
@@ -121,6 +121,37 @@ export class IntrospectService {
             type === Meta.WindowType.UTILITY;
     }
 
+    _getWindowDict(window, app) {
+        let focusWindow = global.display.get_focus_window();
+        let windowId = window.get_id();
+        let frameRect = window.get_frame_rect();
+        let title = window.get_title();
+        let wmClass = window.get_wm_class();
+        let sandboxedAppId = window.get_sandboxed_app_id();
+        let windowDict = {
+            'app-id': GLib.Variant.new('s', app.get_id()),
+            'client-type': GLib.Variant.new('u', window.get_client_type()),
+            'is-hidden': GLib.Variant.new('b', window.is_hidden()),
+            'has-focus': GLib.Variant.new('b', window === focusWindow),
+            'width': GLib.Variant.new('u', frameRect.width),
+            'height': GLib.Variant.new('u', frameRect.height),
+        };
+
+        // These properties may not be available for all windows:
+        if (title != null)
+            windowDict['title'] = GLib.Variant.new('s', title);
+
+        if (wmClass != null)
+            windowDict['wm-class'] = GLib.Variant.new('s', wmClass);
+
+        if (sandboxedAppId != null) {
+            windowDict['sandboxed-app-id'] =
+                GLib.Variant.new('s', sandboxedAppId);
+        }
+
+        return windowDict;
+    }
+
     async GetRunningApplicationsAsync(params, invocation) {
         try {
             await this._senderChecker.checkInvocation(invocation);
@@ -133,7 +164,6 @@ export class IntrospectService {
     }
 
     async GetWindowsAsync(params, invocation) {
-        let focusWindow = global.display.get_focus_window();
         let apps = this._appSystem.get_running();
         let windowsList = {};
 
@@ -151,31 +181,8 @@ export class IntrospectService {
                     continue;
 
                 let windowId = window.get_id();
-                let frameRect = window.get_frame_rect();
-                let title = window.get_title();
-                let wmClass = window.get_wm_class();
-                let sandboxedAppId = window.get_sandboxed_app_id();
-
-                windowsList[windowId] = {
-                    'app-id': GLib.Variant.new('s', app.get_id()),
-                    'client-type': GLib.Variant.new('u', window.get_client_type()),
-                    'is-hidden': GLib.Variant.new('b', window.is_hidden()),
-                    'has-focus': GLib.Variant.new('b', window === focusWindow),
-                    'width': GLib.Variant.new('u', frameRect.width),
-                    'height': GLib.Variant.new('u', frameRect.height),
-                };
-
-                // These properties may not be available for all windows:
-                if (title != null)
-                    windowsList[windowId]['title'] = GLib.Variant.new('s', title);
-
-                if (wmClass != null)
-                    windowsList[windowId]['wm-class'] = GLib.Variant.new('s', wmClass);
-
-                if (sandboxedAppId != null) {
-                    windowsList[windowId]['sandboxed-app-id'] =
-                        GLib.Variant.new('s', sandboxedAppId);
-                }
+                let windowDict = this._getWindowVariant(window, app);
+                windowsList[windowId] = new GLib.Variant('a{sv}', windowDict);
             }
         }
         invocation.return_value(new GLib.Variant('(a{ta{sv}})', [windowsList]));

From 4326a2d5683045d027f9f15564445c6daba9515f Mon Sep 17 00:00:00 2001
From: Corey Berla <corey@berla.me>
Date: Wed, 16 Aug 2023 14:37:29 -0700
Subject: [PATCH 2/3] introspect: Include 'id' in window variant

From the GetWindows method, id is included as the key, but for
future uses, lets also include it as a value of the dictionary.
---
 js/misc/introspect.js | 1 +
 1 file changed, 1 insertion(+)

diff --git a/js/misc/introspect.js b/js/misc/introspect.js
index 3dcd75b5e..4918d610b 100644
--- a/js/misc/introspect.js
+++ b/js/misc/introspect.js
@@ -131,6 +131,7 @@ export class IntrospectService {
         let windowDict = {
             'app-id': GLib.Variant.new('s', app.get_id()),
             'client-type': GLib.Variant.new('u', window.get_client_type()),
+            'id': GLib.Variant.new('t', windowId),
             'is-hidden': GLib.Variant.new('b', window.is_hidden()),
             'has-focus': GLib.Variant.new('b', window === focusWindow),
             'width': GLib.Variant.new('u', frameRect.width),

From 7b45ac72ec34f75219d8f5c28d71e0a489a3ac1d Mon Sep 17 00:00:00 2001
From: Corey Berla <corey@berla.me>
Date: Wed, 16 Aug 2023 10:24:19 -0700
Subject: [PATCH 3/3] introspect: Enhance WindowsChanged DBus API

Splits WindowsChanged into 3 signals: WindowAdded, WindowChanged,
WindowRemoved and nclude the window as an argument.  This gives us
the necessary information to tracked each window changed, rather than
requiring continuous calls to GetWindows (returning all windows).

The main consumer of the shell-introspect signals is
xdg-desktop-portal-gnome, so an API break seems reasonable, rather
than introducing a new API.

See: https://gitlab.gnome.org/GNOME/xdg-desktop-portal-gnome/-/merge_requests/93
---
 .../org.gnome.Shell.Introspect.xml            | 23 +++++++++++++++----
 js/misc/introspect.js                         | 20 +++++++++++++++-
 src/shell-window-tracker.c                    | 16 +++++++++----
 src/shell-window-tracker.h                    |  6 +++++
 4 files changed, 56 insertions(+), 9 deletions(-)

diff --git a/data/dbus-interfaces/org.gnome.Shell.Introspect.xml b/data/dbus-interfaces/org.gnome.Shell.Introspect.xml
index cb19cfec5..875e3facc 100644
--- a/data/dbus-interfaces/org.gnome.Shell.Introspect.xml
+++ b/data/dbus-interfaces/org.gnome.Shell.Introspect.xml
@@ -19,11 +19,26 @@
     <signal name="RunningApplicationsChanged" />
 
     <!--
-        WindowsChanged:
-        @short_description: Notifies when any window opens or closes
+        WindowAdded:
+        @short_description: Notifies when any window opens
     -->
-    <signal name="WindowsChanged" />
-
+    <signal name="WindowAdded">
+      <arg type="a{sv}" name="window" />
+    </signal>
+    <!--
+        WindowChanged:
+        @short_description: Notifies when any window changes
+    -->
+    <signal name="WindowChanged">
+      <arg type="a{sv}" name="window" />
+    </signal>
+    <!--
+        WindowRemoved:
+        @short_description: Notifies when any window closes
+    -->
+    <signal name="WindowRemoved">
+      <arg type="a{sv}" name="window" />
+    </signal>
     <!--
         GetRunningApplications:
         @short_description: Retrieves the description of all running applications
diff --git a/js/misc/introspect.js b/js/misc/introspect.js
index 4918d610b..45e69f414 100644
--- a/js/misc/introspect.js
+++ b/js/misc/introspect.js
@@ -44,7 +44,25 @@ export class IntrospectService {
         });
 
         tracker.connect('tracked-windows-changed',
-            () => this._dbusImpl.emit_signal('WindowsChanged', null));
+            (self, window, app, action) => {
+                if (!this._isEligibleWindow(window))
+                    return;
+                let windowDict = this._getWindowDict(window, app);
+                let windowVariant = new GLib.Variant('(a{sv})', [windowDict]);
+                switch (action) {
+                case Shell.WindowTrackerAction.ADDED:
+                    this._dbusImpl.emit_signal('WindowAdded', windowVariant);
+                    break;
+                case Shell.WindowTrackerAction.CHANGED:
+                    this._dbusImpl.emit_signal('WindowChanged', windowVariant);
+                    break;
+                case Shell.WindowTrackerAction.REMOVED:
+                    this._dbusImpl.emit_signal('WindowRemoved', windowVariant);
+                    break;
+                default:
+                    log(`Incorrect window action ${action}`);
+                }
+            });
 
         this._syncRunningApplications();
 
diff --git a/src/shell-window-tracker.c b/src/shell-window-tracker.c
index 6a7240e47..6cee4d61e 100644
--- a/src/shell-window-tracker.c
+++ b/src/shell-window-tracker.c
@@ -122,7 +122,9 @@ shell_window_tracker_class_init (ShellWindowTrackerClass *klass)
                                                    G_SIGNAL_RUN_LAST,
                                                    0,
                                                    NULL, NULL, NULL,
-                                                   G_TYPE_NONE, 0);
+                                                   G_TYPE_NONE,
+                                                   3, META_TYPE_WINDOW, SHELL_TYPE_APP,
+                                                   G_TYPE_INT);
 }
 
 static gboolean
@@ -529,8 +531,12 @@ on_title_changed (MetaWindow  *window,
                   GParamSpec  *pspec,
                   gpointer     user_data)
 {
+  ShellApp *app;
   ShellWindowTracker *self = SHELL_WINDOW_TRACKER (user_data);
-  g_signal_emit (self, signals[TRACKED_WINDOWS_CHANGED], 0);
+
+  app = get_app_for_window (self, window);
+
+  g_signal_emit (self, signals[TRACKED_WINDOWS_CHANGED], 0, window, app, SHELL_WINDOW_TRACKER_CHANGED);
 }
 
 static void
@@ -569,7 +575,7 @@ track_window (ShellWindowTracker *self,
 
   _shell_app_add_window (app, window);
 
-  g_signal_emit (self, signals[TRACKED_WINDOWS_CHANGED], 0);
+  g_signal_emit (self, signals[TRACKED_WINDOWS_CHANGED], 0, window, app, SHELL_WINDOW_TRACKER_ADDED);
 }
 
 static void
@@ -590,6 +596,7 @@ disassociate_window (ShellWindowTracker   *self,
   if (!app)
     return;
 
+  g_object_ref (window);
   g_object_ref (app);
 
   g_hash_table_remove (self->window_to_app, window);
@@ -600,8 +607,9 @@ disassociate_window (ShellWindowTracker   *self,
   g_signal_handlers_disconnect_by_func (window, G_CALLBACK (on_gtk_application_id_changed), self);
   g_signal_handlers_disconnect_by_func (window, G_CALLBACK (on_window_unmanaged), self);
 
-  g_signal_emit (self, signals[TRACKED_WINDOWS_CHANGED], 0);
+  g_signal_emit (self, signals[TRACKED_WINDOWS_CHANGED], 0, window, app, SHELL_WINDOW_TRACKER_REMOVED);
 
+  g_object_unref (window);
   g_object_unref (app);
 }
 
diff --git a/src/shell-window-tracker.h b/src/shell-window-tracker.h
index 87c38f882..9a57e3c29 100644
--- a/src/shell-window-tracker.h
+++ b/src/shell-window-tracker.h
@@ -16,6 +16,12 @@ G_BEGIN_DECLS
 G_DECLARE_FINAL_TYPE (ShellWindowTracker, shell_window_tracker,
                       SHELL, WINDOW_TRACKER, GObject)
 
+typedef enum {
+  SHELL_WINDOW_TRACKER_ADDED,
+  SHELL_WINDOW_TRACKER_CHANGED,
+  SHELL_WINDOW_TRACKER_REMOVED
+} ShellWindowTrackerAction;
+
 ShellWindowTracker* shell_window_tracker_get_default(void);
 
 ShellApp *shell_window_tracker_get_window_app (ShellWindowTracker *tracker, MetaWindow *metawin);