Filter actions in WindowManager.perform_action ()

ScreenshotManager: simplify composite_stage_cursor (#2740)

Add cursor to the `image` directly instead of copying `image` to `target` and then adding cursor

Don't handle window menus for windows that are not normal (#2736)

Addresses #2723

Rework modal actions (#2739)

We currently have duplicate keybinding filters across multiple components. This PR removes keybinding filter capabilities from modal proxies and instead introduces ModalActions flags. Then WindowManager filters keybindings based on these flags

Author: lenemter

lib/Gestures/Gesture.vala

@@ -41,7 +41,22 @@ namespace Gala {
         MULTITASKING_VIEW,
         ZOOM,
         CUSTOM,
-        N_ACTIONS
+        N_ACTIONS;
+
+        public ModalActions to_modal_action () {
+            switch (this) {
+                case SWITCH_WORKSPACE:
+                    return ModalActions.SWITCH_WORKSPACE;
+                case SWITCH_WINDOWS:
+                    return ModalActions.SWITCH_WINDOWS;
+                case MULTITASKING_VIEW:
+                    return ModalActions.MULTITASKING_VIEW;
+                case ZOOM:
+                    return ModalActions.ZOOM;
+                default:
+                    return ModalActions.NONE;
+            }
+        }
     }
 
     public ModalActions gesture_action_to_modal_action (GestureAction gesture_action) {

lib/Gestures/GestureController.vala

@@ -157,7 +157,7 @@ public class Gala.GestureController : Object {
 
         var recognized_action = GestureSettings.get_action (gesture, out _action_info);
         recognizing = (
-            recognized_action == action && !wm.filter_action (gesture_action_to_modal_action (recognized_action)) ||
+            recognized_action == action && !wm.filter_action (recognized_action.to_modal_action ()) ||
             backend == scroll_backend && recognized_action == NONE
         );
 

lib/WindowManager.vala

@@ -38,11 +38,6 @@ namespace Gala {
         MEDIA_KEYS
     }
 
-    /**
-     * Function that should return true if the given shortcut should be blocked.
-     */
-    public delegate bool KeybindingFilter (Meta.KeyBinding binding);
-
     /**
      * A minimal class mostly used to identify your call to {@link WindowManager.push_modal} and used
      * to end your modal mode again with {@link WindowManager.pop_modal}

src/ScreenshotManager.vala

@@ -345,7 +345,7 @@ public class Gala.ScreenshotManager : Object {
                 image.set_device_scale (resource_scale, resource_scale);
             }
 
-            image = composite_stage_cursor (image, { rect.x, rect.y, rect.width, rect.height });
+            composite_stage_cursor (image, { rect.x, rect.y, rect.width, rect.height });
         }
 
         unconceal_text ();
@@ -592,7 +592,7 @@ public class Gala.ScreenshotManager : Object {
         return image;
     }
 
-    private Cairo.ImageSurface composite_stage_cursor (Cairo.ImageSurface image, Cairo.RectangleInt image_rect) {
+    private void composite_stage_cursor (Cairo.ImageSurface image, Cairo.RectangleInt image_rect) {
 #if HAS_MUTTER48
         unowned var cursor_tracker = wm.get_display ().get_compositor ().get_backend ().get_cursor_tracker ();
 #else
@@ -603,12 +603,12 @@ public class Gala.ScreenshotManager : Object {
 
         var region = new Cairo.Region.rectangle (image_rect);
         if (!region.contains_point ((int) coords.x, (int) coords.y)) {
-            return image;
+            return;
         }
 
-        unowned Cogl.Texture texture = cursor_tracker.get_sprite ();
+        unowned Cogl.Texture? texture = cursor_tracker.get_sprite ();
         if (texture == null) {
-            return image;
+            return;
         }
 
         int width = (int)texture.get_width ();
@@ -618,18 +618,10 @@ public class Gala.ScreenshotManager : Object {
         texture.get_data (Cogl.PixelFormat.RGBA_8888, 0, data);
 
         var cursor_image = new Cairo.ImageSurface.for_data (data, Cairo.Format.ARGB32, width, height, width * 4);
-        var target = new Cairo.ImageSurface (Cairo.Format.ARGB32, image_rect.width, image_rect.height);
-
-        var cr = new Cairo.Context (target);
-        cr.set_operator (Cairo.Operator.OVER);
-        cr.set_source_surface (image, 0, 0);
-        cr.paint ();
-
+        var cr = new Cairo.Context (image);
         cr.set_operator (Cairo.Operator.OVER);
         cr.set_source_surface (cursor_image, coords.x - image_rect.x, coords.y - image_rect.y);
         cr.paint ();
-
-        return (Cairo.ImageSurface)cr.get_target ();
     }
 
     private async void wait_stage_repaint () {

src/Widgets/WindowSwitcher/WindowSwitcher.vala

@@ -443,7 +443,7 @@ public class Gala.WindowSwitcher : CanvasActor, GestureTarget, RootTarget {
 
     private void push_modal () {
         modal_proxy = wm.push_modal (get_stage (), true);
-        modal_proxy.allow_actions (SWITCH_WINDOWS);
+        modal_proxy.allow_actions (SWITCH_WINDOWS | LOCATE_POINTER | MEDIA_KEYS);
     }
 
     private void close_switcher (uint32 time, bool cancel = false) {

src/WindowManager.vala

@@ -785,6 +785,10 @@ namespace Gala {
 
             switch (type) {
                 case ActionType.SHOW_MULTITASKING_VIEW:
+                    if (filter_action (MULTITASKING_VIEW)) {
+                        break;
+                    }
+
                     if (multitasking_view.is_opened ())
                         multitasking_view.close ();
                     else
@@ -847,9 +851,17 @@ namespace Gala {
                         current.stick ();
                     break;
                 case ActionType.SWITCH_TO_WORKSPACE_PREVIOUS:
+                    if (filter_action (SWITCH_WORKSPACE)) {
+                        break;
+                    }
+
                     switch_to_next_workspace (Meta.MotionDirection.LEFT, Meta.CURRENT_TIME);
                     break;
                 case ActionType.SWITCH_TO_WORKSPACE_NEXT:
+                    if (filter_action (SWITCH_WORKSPACE)) {
+                        break;
+                    }
+
                     switch_to_next_workspace (Meta.MotionDirection.RIGHT, Meta.CURRENT_TIME);
                     break;
                 case ActionType.MOVE_CURRENT_WORKSPACE_LEFT:
@@ -872,7 +884,7 @@ namespace Gala {
                     launch_action (ActionKeys.PANEL_MAIN_MENU_ACTION);
                     break;
                 case ActionType.WINDOW_OVERVIEW:
-                    if (window_overview == null) {
+                    if (window_overview == null || filter_action (WINDOW_OVERVIEW)) {
                         break;
                     }
 
@@ -884,7 +896,7 @@ namespace Gala {
                     critical ("Window overview is deprecated");
                     break;
                 case ActionType.WINDOW_OVERVIEW_ALL:
-                    if (window_overview == null) {
+                    if (window_overview == null || filter_action (WINDOW_OVERVIEW)) {
                         break;
                     }
 
@@ -895,11 +907,19 @@ namespace Gala {
                     }
                     break;
                 case ActionType.SWITCH_TO_WORKSPACE_LAST:
+                    if (filter_action (SWITCH_WORKSPACE)) {
+                        break;
+                    }
+
                     unowned var manager = display.get_workspace_manager ();
                     unowned var workspace = manager.get_workspace_by_index (manager.get_n_workspaces () - 1);
                     workspace.activate (display.get_current_time ());
                     break;
                 case ActionType.SCREENSHOT_CURRENT:
+                    if (filter_action (SCREENSHOT_WINDOW)) {
+                        break;
+                    }
+
                     screenshot_manager.handle_screenshot_current_window_shortcut.begin (false);
                     break;
                 default:
@@ -909,70 +929,68 @@ namespace Gala {
         }
 
         public override void show_window_menu (Meta.Window window, Meta.WindowMenuType menu, int x, int y) {
-            switch (menu) {
-                case Meta.WindowMenuType.WM:
-                    if (NotificationStack.is_notification (window)) {
-                        return;
-                    }
+            if (menu != WM) {
+                warning ("Unsupported window menu type");
+                return;
+            }
 
-                    WindowFlags flags = WindowFlags.NONE;
-                    if (window.can_minimize ())
-                        flags |= WindowFlags.CAN_HIDE;
+            if (!Utils.get_window_is_normal (window) || NotificationStack.is_notification (window)) {
+                return;
+            }
 
-                    if (window.can_maximize ())
-                        flags |= WindowFlags.CAN_MAXIMIZE;
+            WindowFlags flags = WindowFlags.NONE;
+            if (window.can_minimize ())
+                flags |= WindowFlags.CAN_HIDE;
+
+            if (window.can_maximize ())
+                flags |= WindowFlags.CAN_MAXIMIZE;
 
 #if HAS_MUTTER49
-                    if (window.is_maximized ())
-                        flags |= WindowFlags.IS_MAXIMIZED;
+            if (window.is_maximized ())
+                flags |= WindowFlags.IS_MAXIMIZED;
 
-                    if (window.maximized_vertically && !window.maximized_horizontally)
-                        flags |= WindowFlags.IS_TILED;
+            if (window.maximized_vertically && !window.maximized_horizontally)
+                flags |= WindowFlags.IS_TILED;
 #else
-                    var maximize_flags = window.get_maximized ();
-                    if (maximize_flags > 0) {
-                        flags |= WindowFlags.IS_MAXIMIZED;
+            var maximize_flags = window.get_maximized ();
+            if (maximize_flags > 0) {
+                flags |= WindowFlags.IS_MAXIMIZED;
 
-                        if (Meta.MaximizeFlags.VERTICAL in maximize_flags && !(Meta.MaximizeFlags.HORIZONTAL in maximize_flags)) {
-                            flags |= WindowFlags.IS_TILED;
-                        }
-                    }
+                if (Meta.MaximizeFlags.VERTICAL in maximize_flags && !(Meta.MaximizeFlags.HORIZONTAL in maximize_flags)) {
+                    flags |= WindowFlags.IS_TILED;
+                }
+            }
 #endif
 
-                    if (window.allows_move ())
-                        flags |= WindowFlags.ALLOWS_MOVE;
+            if (window.allows_move ())
+                flags |= WindowFlags.ALLOWS_MOVE;
 
-                    if (window.allows_resize ())
-                        flags |= WindowFlags.ALLOWS_RESIZE;
+            if (window.allows_resize ())
+                flags |= WindowFlags.ALLOWS_RESIZE;
 
-                    if (window.is_above ())
-                        flags |= WindowFlags.ALWAYS_ON_TOP;
+            if (window.is_above ())
+                flags |= WindowFlags.ALWAYS_ON_TOP;
 
-                    if (window.on_all_workspaces)
-                        flags |= WindowFlags.ON_ALL_WORKSPACES;
+            if (window.on_all_workspaces)
+                flags |= WindowFlags.ON_ALL_WORKSPACES;
 
-                    if (window.can_close ())
-                        flags |= WindowFlags.CAN_CLOSE;
+            if (window.can_close ())
+                flags |= WindowFlags.CAN_CLOSE;
 
-                    unowned var workspace = window.get_workspace ();
-                    if (workspace != null) {
-                        unowned var manager = window.display.get_workspace_manager ();
-                        var workspace_index = workspace.workspace_index;
-                        if (workspace_index != 0) {
-                            flags |= WindowFlags.ALLOWS_MOVE_LEFT;
-                        }
-
-                        if (workspace_index != manager.n_workspaces - 2 || Utils.get_n_windows (workspace) != 1) {
-                            flags |= WindowFlags.ALLOWS_MOVE_RIGHT;
-                        }
-                    }
+            unowned var workspace = window.get_workspace ();
+            if (workspace != null) {
+                unowned var manager = window.display.get_workspace_manager ();
+                var workspace_index = workspace.workspace_index;
+                if (workspace_index != 0) {
+                    flags |= WindowFlags.ALLOWS_MOVE_LEFT;
+                }
 
-                    daemon_manager.show_window_menu.begin (flags, x, y);
-                    break;
-                case Meta.WindowMenuType.APP:
-                    // FIXME we don't have any sort of app menus
-                    break;
+                if (workspace_index != manager.n_workspaces - 2 || Utils.get_n_windows (workspace) != 1) {
+                    flags |= WindowFlags.ALLOWS_MOVE_RIGHT;
+                }
             }
+
+            daemon_manager.show_window_menu.begin (flags, x, y);
         }
 
         public override void show_tile_preview (Meta.Window window, Mtk.Rectangle tile_rect, int tile_monitor_number) {