wayland: close rofi on outside click in capture mode

Handle click-to-exit natively in the Wayland pointer path.

When capture mode is enabled, pointer events are compared against the
visible menu rectangle. Pointer presses outside that rectangle cancel
the active view, while inside clicks continue through the normal
widget event path.

This allows click-to-exit to work on Wayland without compositor-side
scripts or hacks.

Fix doxygen and remove stray comment
Seperated outside-click handling into its own function

Author: benny-e

include/view.h

@@ -408,11 +408,12 @@ void rofi_view_ellipsize_listview(RofiViewState *state,
  */
 gboolean rofi_set_im_window_pos(int new_x, int new_y);
 
-// Wayland click-to-exit helper
+// Cancel the current view
+void rofi_view_cancel(RofiViewState *state);
 
+// Wayland click-to-exit helper
 gboolean wayland_rofi_view_capture_click_outside_enabled(void);
 void wayland_rofi_view_get_menu_rect(int *x, int *y, int *w, int *h);
-void wayland_rofi_view_cancel(RofiViewState *state);
 
 /**
  * @param wid to test.

source/wayland/display.c

@@ -22,6 +22,8 @@
  *   SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
+#include <stdio.h>
+
 #define G_LOG_DOMAIN "Wayland"
 #pragma GCC diagnostic ignored "-Wunused-variable"
 #pragma GCC diagnostic ignored "-Wunused-parameter"
@@ -65,8 +67,8 @@
 #endif
 #include "keyboard-shortcuts-inhibit-unstable-v1-protocol.h"
 #include "primary-selection-unstable-v1-protocol.h"
-#include "wlr-layer-shell-unstable-v1-protocol.h"
 #include "text-input-unstable-v3-protocol.h"
+#include "wlr-layer-shell-unstable-v1-protocol.h"
 
 #define wayland_output_get_dpi(output, scale, dimension)                       \
   ((output)->current.physical_##dimension > 0 && (scale) > 0                   \
@@ -581,8 +583,26 @@ static void wayland_pointer_send_events(wayland_seat *self) {
     return;
   }
 
+  gboolean capture = wayland_rofi_view_capture_click_outside_enabled();
+  int menu_x = 0, menu_y = 0, menu_w = 0, menu_h = 0;
+
+  if (capture) {
+    wayland_rofi_view_get_menu_rect(&menu_x, &menu_y, &menu_w, &menu_h);
+    if (menu_w <= 0 || menu_h <= 0) {
+      capture = FALSE;
+    }
+  }
+
   if (self->motion.x > -1 || self->motion.y > -1) {
-    rofi_view_handle_mouse_motion(state, self->motion.x, self->motion.y,
+    int motion_x = self->motion.x;
+    int motion_y = self->motion.y;
+
+    if (capture) {
+      motion_x -= menu_x;
+      motion_y -= menu_y;
+    }
+
+    rofi_view_handle_mouse_motion(state, motion_x, motion_y,
                                   config.hover_select);
     self->motion.x = -1;
     self->motion.y = -1;
@@ -602,17 +622,43 @@ static void wayland_pointer_send_events(wayland_seat *self) {
   }
 
   if (self->button.button > 0) {
+    gboolean inside = TRUE;
+
+    if (capture) {
+      inside = self->button.x >= menu_x && self->button.x < menu_x + menu_w &&
+               self->button.y >= menu_y && self->button.y < menu_y + menu_h;
+    }
+
     if (self->button.pressed) {
-      rofi_view_handle_mouse_motion(state, self->button.x, self->button.y,
-                                    FALSE);
+      if (capture && !inside) {
+
+        wayland_rofi_view_cancel(state);
+
+        self->button.button = 0;
+        rofi_view_maybe_update(state);
+        return;
+      }
+
+      int button_x = self->button.x;
+      int button_y = self->button.y;
+
+      if (capture) {
+        button_x -= menu_x;
+        button_y -= menu_y;
+      }
+
+      rofi_view_handle_mouse_motion(state, button_x, button_y, FALSE);
       nk_bindings_seat_handle_button(wayland->bindings_seat, NULL, button,
                                      NK_BINDINGS_BUTTON_STATE_PRESS,
                                      self->button.time);
     } else {
-      nk_bindings_seat_handle_button(wayland->bindings_seat, NULL, button,
-                                     NK_BINDINGS_BUTTON_STATE_RELEASE,
-                                     self->button.time);
+      if (!capture || inside) {
+        nk_bindings_seat_handle_button(wayland->bindings_seat, NULL, button,
+                                       NK_BINDINGS_BUTTON_STATE_RELEASE,
+                                       self->button.time);
+      }
     }
+
     self->button.button = 0;
   }
 
@@ -1201,9 +1247,9 @@ static void update_cursor_rectangle(struct zwp_text_input_v3 *text_input) {
 static void text_input_enter(void *data, struct zwp_text_input_v3 *text_input,
                              struct wl_surface *surface) {
   zwp_text_input_v3_enable(text_input);
-  zwp_text_input_v3_set_content_type(
-      text_input, ZWP_TEXT_INPUT_V3_CONTENT_HINT_NONE,
-      ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NORMAL);
+  zwp_text_input_v3_set_content_type(text_input,
+                                     ZWP_TEXT_INPUT_V3_CONTENT_HINT_NONE,
+                                     ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NORMAL);
   update_cursor_rectangle(text_input);
   zwp_text_input_v3_commit(text_input);
 }
@@ -1234,11 +1280,9 @@ static void text_input_commit_string(void *data,
   }
 }
 
-static void
-text_input_delete_surrounding_text(void *data,
-                                   struct zwp_text_input_v3 *text_input,
-                                   uint32_t before_length,
-                                   uint32_t after_length) {}
+static void text_input_delete_surrounding_text(
+    void *data, struct zwp_text_input_v3 *text_input, uint32_t before_length,
+    uint32_t after_length) {}
 
 static void text_input_done(void *data, struct zwp_text_input_v3 *text_input,
                             uint32_t serial) {}
@@ -1287,18 +1331,18 @@ static wayland_output *wayland_output_by_name(const char *name) {
 }
 double wayland_get_dpi_estimation(void) {
   double retv = -1.0;
-  if ( wayland == 0 ) {
+  if (wayland == 0) {
     return -1.0;
   }
   gsize noutputs = g_hash_table_size(wayland->outputs);
-  if ( noutputs == 1) {
+  if (noutputs == 1) {
     GHashTableIter iter;
     wayland_output *output;
     g_hash_table_iter_init(&iter, wayland->outputs);
     if (g_hash_table_iter_next(&iter, NULL, (gpointer *)&output)) {
       return wayland_output_get_dpi(output, output->current.scale, height);
     }
-  } else if (noutputs > 1 && config.monitor != NULL ) {
+  } else if (noutputs > 1 && config.monitor != NULL) {
     wayland_output *output = wayland_output_by_name(config.monitor);
     if (output != NULL) {
       return wayland_output_get_dpi(output, output->current.scale, height);
@@ -1708,7 +1752,8 @@ static gboolean wayland_display_late_setup(void) {
     layer = ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND;
   } else {
     layer = ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY;
-    g_warning("Unknown wayland layer: %s, using default overlay", config.wayland_layer);
+    g_warning("Unknown wayland layer: %s, using default overlay",
+              config.wayland_layer);
   }
   wayland->wlr_surface = zwlr_layer_shell_v1_get_layer_surface(
       wayland->layer_shell, wayland->surface, wlo, layer, "rofi");
@@ -1915,8 +1960,8 @@ static void wayland_get_clipboard_data(int cb_type, ClipboardCb callback,
   if (cb_type == CLIPBOARD_DEFAULT) {
     wl_data_offer_receive(clipboard->offer, "text/plain;charset=utf-8", fds[1]);
   } else {
-    zwp_primary_selection_offer_v1_receive(clipboard->offer, "text/plain;charset=utf-8",
-                                           fds[1]);
+    zwp_primary_selection_offer_v1_receive(clipboard->offer,
+                                           "text/plain;charset=utf-8", fds[1]);
   }
   close(fds[1]);
 

source/wayland/view.c

@@ -83,8 +83,6 @@ static struct {
   int monitor_width;
   int monitor_height;
 
-  gboolean capture_click_outside;
-
   int surface_width;
   int surface_height;
 
@@ -102,6 +100,15 @@ static struct {
     .fullscreen = FALSE,
     .monitor_width = 0,
     .monitor_height = 0,
+
+    .surface_width = 0,
+    .surface_height = 0,
+
+    .menu_width = 0,
+    .menu_height = 0,
+
+    .menu_x = 0,
+    .menu_y = 0,
 };
 
 static void wayland_rofi_view_get_current_monitor(int *width, int *height) {
@@ -152,52 +159,38 @@ static int rofi_get_offset_px(RofiViewState *state, RofiOrientation ori) {
   return distance_get_pixel(offset, ori);
 }
 
-static void wayland_rofi_view_window_update_size(RofiViewState *state) {
-  if (state == NULL) {
-    return;
-  }
-
-  int offset_x = rofi_get_offset_px(state, ROFI_ORIENTATION_HORIZONTAL);
-  int offset_y = rofi_get_offset_px(state, ROFI_ORIENTATION_VERTICAL);
-
-  /* The widget itself should always keep the visible menu size. */
-  widget_resize(WIDGET(state->main_window), state->width, state->height);
-
-  /* Store visible menu size. */
-  WlState.menu_width = state->width;
-  WlState.menu_height = state->height;
-
-  if (!WlState.capture_click_outside) {
-    WlState.surface_width = state->width;
-    WlState.surface_height = state->height;
-    WlState.menu_x = 0;
-    WlState.menu_y = 0;
-
-    g_debug("normal mode: surface=%dx%d menu=%dx%d", WlState.surface_width,
-            WlState.surface_height, WlState.menu_width, WlState.menu_height);
+static void window_update_size_normal(RofiViewState *state, int offset_x,
+                                      int offset_y) {
+  WlState.surface_width = state->width;
+  WlState.surface_height = state->height;
+  WlState.menu_x = 0;
+  WlState.menu_y = 0;
 
-    display_set_surface_dimensions(state->width, state->height, offset_x,
-                                   offset_y, rofi_get_location(state));
-    rofi_view_pool_refresh();
-    return;
-  }
+  /* Click-capture is limited to the current output. If the menu is larger than
+   * the output and visually overflows onto another output, the overflowed area
+   * will not be part of the capture surface and clicks there will not trigger
+   * click-to-exit.
+   */
+  display_set_surface_dimensions(state->width, state->height, offset_x,
+                                 offset_y, rofi_get_location(state));
+}
 
-  /* Capture mode: surface becomes fullscreen, menu stays normal size. */
+static void window_update_size_with_outside_click(RofiViewState *state,
+                                                  int offset_x, int offset_y) {
   int screen_width = 0;
   int screen_height = 0;
+  int loc = rofi_get_location(state);
+
   wayland_rofi_view_get_current_monitor(&screen_width, &screen_height);
 
   if (screen_width <= 0 || screen_height <= 0) {
-    /* Fallback so we do not create a broken surface. */
     screen_width = state->width;
     screen_height = state->height;
   }
 
   WlState.surface_width = screen_width;
   WlState.surface_height = screen_height;
 
-  int loc = rofi_get_location(state);
-
   switch (loc) {
   case WL_NORTH_WEST:
     WlState.menu_x = offset_x;
@@ -244,26 +237,29 @@ static void wayland_rofi_view_window_update_size(RofiViewState *state) {
     break;
   }
 
-  /* Keep the actual layer surface fullscreen for outside-click capture. */
   display_set_surface_dimensions(WlState.surface_width, WlState.surface_height,
                                  0, 0, WL_NORTH_WEST);
-
-  g_debug("capture mode: surface=%dx%d menu=%dx%d pos=(%d,%d) loc=%d "
-          "offsets=(%d,%d)",
-          WlState.surface_width, WlState.surface_height, WlState.menu_width,
-          WlState.menu_height, WlState.menu_x, WlState.menu_y, loc, offset_x,
-          offset_y);
-
-  rofi_view_pool_refresh();
 }
 
-void wayland_rofi_view_cancel(RofiViewState *state) {
+static void wayland_rofi_view_window_update_size(RofiViewState *state) {
   if (state == NULL) {
     return;
   }
 
-  state->retv = MENU_CANCEL;
-  state->quit = TRUE;
+  int offset_x = rofi_get_offset_px(state, ROFI_ORIENTATION_HORIZONTAL);
+  int offset_y = rofi_get_offset_px(state, ROFI_ORIENTATION_VERTICAL);
+
+  widget_resize(WIDGET(state->main_window), state->width, state->height);
+
+  WlState.menu_width = state->width;
+  WlState.menu_height = state->height;
+
+  if (config.click_to_exit) {
+    window_update_size_with_outside_click(state, offset_x, offset_y);
+  } else {
+    window_update_size_normal(state, offset_x, offset_y);
+  }
+  rofi_view_pool_refresh();
 }
 
 static void wayland_rofi_view_set_size(RofiViewState *state, gint width,
@@ -335,15 +331,6 @@ static void wayland___create_window(MenuFlags menu_flags) {
 
   WlState.flags = menu_flags;
 
-  /* Reset Wayland-local click-capture state for this view instance. */
-  WlState.capture_click_outside = config.click_to_exit ? TRUE : FALSE;
-  WlState.surface_width = 0;
-  WlState.surface_height = 0;
-  WlState.menu_width = 0;
-  WlState.menu_height = 0;
-  WlState.menu_x = 0;
-  WlState.menu_y = 0;
-
   // Setup dpi
   PangoFontMap *font_map = pango_cairo_font_map_get_default();
   if (config.dpi > 1) {
@@ -433,7 +420,7 @@ static void wayland_rofi_view_update(RofiViewState *state, gboolean qr) {
   int buffer_width = state->width;
   int buffer_height = state->height;
 
-  if (WlState.capture_click_outside) {
+  if (config.click_to_exit) {
     buffer_width = WlState.surface_width;
     buffer_height = WlState.surface_height;
   }
@@ -461,7 +448,7 @@ static void wayland_rofi_view_update(RofiViewState *state, gboolean qr) {
   // Always paint as overlay over the background.
   cairo_set_operator(d, CAIRO_OPERATOR_OVER);
 
-  if (WlState.capture_click_outside) {
+  if (config.click_to_exit) {
     g_debug("draw capture mode: surface=%dx%d menu=%dx%d pos=(%d,%d)",
             WlState.surface_width, WlState.surface_height, WlState.menu_width,
             WlState.menu_height, WlState.menu_x, WlState.menu_y);
@@ -481,12 +468,6 @@ static void wayland_rofi_view_update(RofiViewState *state, gboolean qr) {
   }
 }
 
-/**
- * @param state The Menu Handle
- *
- * Check if a finalize function is set, and if sets executes it.
- */
-
 static void wayland_rofi_view_frame_callback(void) {
   if (WlState.repaint_source == 0) {
     WlState.repaint_source = g_idle_add_full(
@@ -539,14 +520,6 @@ static void wayland_rofi_view_cleanup(void) {
     WlState.repaint_source = 0;
   }
 
-  WlState.capture_click_outside = FALSE;
-  WlState.surface_width = 0;
-  WlState.surface_height = 0;
-  WlState.menu_width = 0;
-  WlState.menu_height = 0;
-  WlState.menu_x = 0;
-  WlState.menu_y = 0;
-
   input_history_save();
 }
 
@@ -564,7 +537,7 @@ static void wayland_rofi_view_pool_refresh(void) {
 }
 
 gboolean wayland_rofi_view_capture_click_outside_enabled(void) {
-  return WlState.capture_click_outside;
+  return config.click_to_exit;
 }
 
 void wayland_rofi_view_get_menu_rect(int *x, int *y, int *w, int *h) {