ShellWindow: Only handle common code

leolost2605 · leolost2605 · commit e65e63e6a356 · 2025-10-15T16:24:58.000+02:00
Move things that only apply to PanelWindows there. Also rely on
subclasses to provide a GestureTarget for property updates instead
of trying to handle all cases.
This cleans up a lot of code that was necessary to handle the stuff
needed by all subclass.
This makes sure we only update things when actually needed. For example
ExtendedBehaviorWindows never need to update their target.
This will also provide more flexibility in the future if we want to
introduce other specialized windows. This also allows to change more
stuff in subclasses without affecting other subclasses.
diff --git a/src/ShellClients/ExtendedBehaviorWindow.vala b/src/ShellClients/ExtendedBehaviorWindow.vala
@@ -0,0 +1,13 @@
+/*
+ * Copyright 2025 elementary, Inc. (https://elementary.io)
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ * Authored by: Leonhard Kargl <leo.kargl@proton.me>
+ */
+
+public class Gala.ExtendedBehaviorWindow : ShellWindow {
+    public ExtendedBehaviorWindow (Meta.Window window) {
+        var target = new PropertyTarget (CUSTOM, window.get_compositor_private (), "opacity", typeof (uint), 255u, 0u);
+        Object (window: window, position: Position.CENTER, hide_target: target);
+    }
+}
diff --git a/src/ShellClients/PanelWindow.vala b/src/ShellClients/PanelWindow.vala
@@ -71,20 +71,26 @@ public class Gala.PanelWindow : ShellWindow, RootTarget {
         workspace_hide_tracker.switching_workspace_progress_updated.connect ((value) => workspace_gesture_controller.progress = value);
         workspace_hide_tracker.window_state_changed_progress_updated.connect (workspace_gesture_controller.goto);
 
+        window.size_changed.connect (update_target);
+        notify["position"].connect (update_target);
+        update_target ();
+
         add_gesture_controller (user_gesture_controller);
         add_gesture_controller (workspace_gesture_controller);
+
+        var window_actor = (Meta.WindowActor) window.get_compositor_private ();
+
+        window_actor.notify["width"].connect (update_clip);
+        window_actor.notify["height"].connect (update_clip);
+        window_actor.notify["translation-y"].connect (update_clip);
+        notify["position"].connect (update_clip);
     }
 
     public void request_visible_in_multitasking_view () {
         visible_in_multitasking_view = true;
         actor.add_action (new DragDropAction (DESTINATION, "multitaskingview-window"));
     }
 
-    protected override void update_target () {
-        base.update_target ();
-        workspace_hide_tracker.recalculate_all_workspaces ();
-    }
-
     protected override double get_hidden_progress () {
         var user_workspace_hidden_progress = double.min (
             user_gesture_controller.progress,
@@ -214,4 +220,26 @@ public class Gala.PanelWindow : ShellWindow, RootTarget {
                 return TOP;
         }
     }
+
+    private void update_target () {
+        var to_value = anchor == TOP ? -get_custom_window_rect ().height : get_custom_window_rect ().height;
+        hide_target = new PropertyTarget (CUSTOM, actor, "translation-y", typeof (float), 0f, (float) to_value);
+
+        workspace_hide_tracker.recalculate_all_workspaces ();
+    }
+
+    private void update_clip () {
+        var monitor_geom = window.display.get_monitor_geometry (window.get_monitor ());
+        var window_actor = (Meta.WindowActor) window.get_compositor_private ();
+
+        var y = window_actor.y + window_actor.translation_y;
+
+        if (y + window_actor.height > monitor_geom.y + monitor_geom.height) {
+            window_actor.set_clip (0, 0, window_actor.width, monitor_geom.y + monitor_geom.height - y);
+        } else if (y < monitor_geom.y) {
+            window_actor.set_clip (0, monitor_geom.y - y, window_actor.width, window_actor.height);
+        } else {
+            window_actor.remove_clip ();
+        }
+    }
 }
diff --git a/src/ShellClients/ShellClientsManager.vala b/src/ShellClients/ShellClientsManager.vala
@@ -199,7 +199,7 @@ public class Gala.ShellClientsManager : Object, GestureTarget {
     }
 
     public void make_centered (Meta.Window window) requires (!is_itself_positioned (window)) {
-        positioned_windows[window] = new ShellWindow (window, CENTER);
+        positioned_windows[window] = new ExtendedBehaviorWindow (window);
 
         // connect_after so we make sure that any queued move is unqueued
         window.unmanaging.connect_after ((_window) => positioned_windows.remove (_window));
diff --git a/src/ShellClients/ShellWindow.vala b/src/ShellClients/ShellWindow.vala
@@ -8,39 +8,19 @@
 public class Gala.ShellWindow : PositionedWindow, GestureTarget {
     public bool restore_previous_x11_region { private get; set; default = false; }
 
-    private Meta.WindowActor window_actor;
+    /**
+     * A gesture target that will receive a CUSTOM update every time a gesture
+     * is propagated, with the progress gotten via {@link get_hidden_progress()}
+     */
+    public GestureTarget hide_target { get; construct set; }
+
     private double multitasking_view_progress = 0;
     private int animations_ongoing = 0;
 
-    private PropertyTarget property_target;
-
     public ShellWindow (Meta.Window window, Position position, Variant? position_data = null) {
         base (window, position, position_data);
     }
 
-    construct {
-        window_actor = (Meta.WindowActor) window.get_compositor_private ();
-
-        window_actor.notify["width"].connect (update_clip);
-        window_actor.notify["height"].connect (update_clip);
-        window_actor.notify["translation-y"].connect (update_clip);
-        notify["position"].connect (update_clip);
-
-        window.size_changed.connect (update_target);
-        notify["position"].connect (update_target);
-        update_target ();
-    }
-
-    protected virtual void update_target () {
-        property_target = new PropertyTarget (
-            CUSTOM, window_actor,
-            get_animation_property (),
-            get_property_type (),
-            calculate_value (false),
-            calculate_value (true)
-        );
-    }
-
     public virtual void propagate (UpdateType update_type, GestureAction action, double progress) {
         switch (update_type) {
             case START:
@@ -53,7 +33,7 @@ public class Gala.ShellWindow : PositionedWindow, GestureTarget {
                     multitasking_view_progress = progress;
                 }
 
-                property_target.propagate (UPDATE, CUSTOM, get_hidden_progress ());
+                hide_target.propagate (UPDATE, CUSTOM, get_hidden_progress ());
                 break;
 
             case END:
@@ -71,6 +51,8 @@ public class Gala.ShellWindow : PositionedWindow, GestureTarget {
     }
 
     private void update_visibility () {
+        unowned var window_actor = (Meta.WindowActor) window.get_compositor_private ();
+
         var visible = get_hidden_progress () < 0.1;
         var animating = animations_ongoing > 0;
 
@@ -104,63 +86,11 @@ public class Gala.ShellWindow : PositionedWindow, GestureTarget {
                 return true;
             }
 
-            unowned var window_actor = (Meta.WindowActor) transient.get_compositor_private ();
+            unowned var transient_window_actor = (Meta.WindowActor) transient.get_compositor_private ();
 
-            window_actor.visible = visible && !animating;
+            transient_window_actor.visible = visible && !animating;
 
             return true;
         });
     }
-
-    private string get_animation_property () {
-        switch (position) {
-            case TOP:
-            case BOTTOM:
-                return "translation-y";
-            default:
-                return "opacity";
-        }
-    }
-
-    private Type get_property_type () {
-        switch (position) {
-            case TOP:
-            case BOTTOM:
-                return typeof (float);
-            default:
-                return typeof (uint);
-        }
-    }
-
-    private Value calculate_value (bool hidden) {
-        var custom_rect = get_custom_window_rect ();
-
-        switch (position) {
-            case TOP:
-                return hidden ? -custom_rect.height : 0f;
-            case BOTTOM:
-                return hidden ? custom_rect.height : 0f;
-            default:
-                return hidden ? 0u : 255u;
-        }
-    }
-
-    private void update_clip () {
-        if (position != TOP && position != BOTTOM) {
-            window_actor.remove_clip ();
-            return;
-        }
-
-        var monitor_geom = window.display.get_monitor_geometry (window.get_monitor ());
-
-        var y = window_actor.y + window_actor.translation_y;
-
-        if (y + window_actor.height > monitor_geom.y + monitor_geom.height) {
-            window_actor.set_clip (0, 0, window_actor.width, monitor_geom.y + monitor_geom.height - y);
-        } else if (y < monitor_geom.y) {
-            window_actor.set_clip (0, monitor_geom.y - y, window_actor.width, window_actor.height);
-        } else {
-            window_actor.remove_clip ();
-        }
-    }
 }
diff --git a/src/meson.build b/src/meson.build
@@ -42,6 +42,7 @@ gala_bin_sources = files(
     'HotCorners/Barrier.vala',
     'HotCorners/HotCorner.vala',
     'HotCorners/HotCornerManager.vala',
+    'ShellClients/ExtendedBehaviorWindow.vala',
     'ShellClients/HideTracker.vala',
     'ShellClients/ManagedClient.vala',
     'ShellClients/NotificationsClient.vala',

Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ public class Gala.ShellClientsManager : Object, GestureTarget {`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`public void make_centered (Meta.Window window) requires (!is_itself_positioned (window)) {`
`202`		`- positioned_windows[window] = new ShellWindow (window, CENTER);`
	`202`	`+ positioned_windows[window] = new ExtendedBehaviorWindow (window);`
`203`	`203`
`204`	`204`	`// connect_after so we make sure that any queued move is unqueued`
`205`	`205`	`window.unmanaging.connect_after ((_window) => positioned_windows.remove (_window));`