refactor: Only (re)compute layout and pointer focus on frame or pointer move.

Author: phkaeser

doc/ROADMAP.md

@@ -37,11 +37,9 @@ See the [Detailed Feature List](FEATURES.md) for details.
 
 * Infrastructure
   * [done] Support copy-paste and middle-click paste ([#399](https://github.com/phkaeser/wlmaker/issues/399)).
+  * [done] Refactors pointer focus and layout computation to compute only once per frame.
   * [done] Adds `wlmtool` to parse XDG desktop files: Eliminates need for `wmmenugen`.
     * Fix: Handle `Terminal` flag and launch applications in a suitable terminal.
-  * Recompute pointer focus max once per frame.
-    * [done] Add wlmtk_output_tracker_t for keeping all outputs tracker.
-    * [done] Use wlmtk_output_tracker_t in wlmtk_layer_t, wlmaker_background_t and wlmaker_lock_t.
   * Read keymap from `/etc/default/keyboard` or similar.
   * Support keypad (tap to click) and middle click alternatives.
   * Support configurable means (eg. Alt+) to emulate right-click on laptop.

include/toolkit/bordered.h

@@ -40,8 +40,8 @@ extern "C" {
 struct _wlmtk_bordered_t {
     /** Super class of the bordered. */
     wlmtk_container_t         super_container;
-    /** Virtual method table of the super container before extending it. */
-    wlmtk_container_vmt_t     orig_super_container_vmt;
+    /** Virtual method table of the super element before extending it. */
+    wlmtk_element_vmt_t       orig_super_element_vmt;
 
     /** Points to the element that will be enclosed by the border. */
     wlmtk_element_t           *element_ptr;

include/toolkit/box.h

@@ -24,7 +24,7 @@
 
 #include "libbase/libbase.h"
 
-#include "container.h"
+#include "container.h"  // IWYU pragma: keep
 #include "element.h"
 #include "style.h"
 
@@ -47,8 +47,8 @@ typedef enum {
 struct _wlmtk_box_t {
     /** Super class of the box. */
     wlmtk_container_t         super_container;
-    /** Virtual method table of the superclass' container. */
-    wlmtk_container_vmt_t     orig_super_container_vmt;
+    /** Virtual method table of the superclass' element. */
+    wlmtk_element_vmt_t       orig_super_element_vmt;
     /** Orientation of the box. */
     wlmtk_box_orientation_t   orientation;
 

include/toolkit/container.h

@@ -38,29 +38,13 @@ typedef struct _wlmtk_container_vmt_t wlmtk_container_vmt_t;
 extern "C" {
 #endif  // __cplusplus
 
-/** Virtual method table of the container. */
-struct _wlmtk_container_vmt_t {
-    /**
-     * Updates the layout of the container elements.
-     *
-     * @param container_ptr
-     *
-     * @return true if there was a change to the layout, eg. if elements got
-     * re-positioned.
-     */
-    bool (*update_layout)(wlmtk_container_t *container_ptr);
-};
-
 /** State of the container. */
 struct _wlmtk_container_t {
     /** Super class of the container. */
     wlmtk_element_t           super_element;
     /** Virtual method table of the super element before extending it. */
     wlmtk_element_vmt_t       orig_super_element_vmt;
 
-    /** Virtual method table for the container. */
-    wlmtk_container_vmt_t     vmt;
-
     /**
      * Elements contained here.
      *
@@ -85,8 +69,8 @@ struct _wlmtk_container_t {
     /** Stores the element with current keyboard focus. May be NULL. */
     wlmtk_element_t           *keyboard_focus_element_ptr;
 
-    /** @private inhibitor, to prevent recursive layout updates. */
-    bool                      inhibit_layout_update;
+    /** @private Stores whether the layout had been invalidated. */
+    bool                      invalidated_layout;
 };
 
 /**
@@ -98,18 +82,6 @@ struct _wlmtk_container_t {
  */
 bool wlmtk_container_init(wlmtk_container_t *container_ptr);
 
-/**
- * Extends the container's virtual methods.
- *
- * @param container_ptr
- * @param container_vmt_ptr
- *
- * @return The previous virtual method table.
- */
-wlmtk_container_vmt_t wlmtk_container_extend(
-    wlmtk_container_t *container_ptr,
-    const wlmtk_container_vmt_t *container_vmt_ptr);
-
 /**
  * Initializes the container, and attach to WLR sene graph.
  *
@@ -254,18 +226,15 @@ void wlmtk_container_set_keyboard_focus_element(
     bool enabled);
 
 /**
- * Updates the layout of the container, and recomputes pointer focus as needed.
+ * Informs the container (and parents) that the layout needs to be recomputed.
  *
  * Must be called if an element is added or removed, or if any of the child
  * elements changes visibility or dimensions. Propagates to the parent
  * container(s).
  *
- * If needed: Trigger a poitner focus computation.
- *
  * @param container_ptr
  */
-void wlmtk_container_update_layout_and_pointer_focus(
-    wlmtk_container_t *container_ptr);
+void wlmtk_container_invalidate_layout(wlmtk_container_t *container_ptr);
 
 /**
  * Returns the wlroots scene graph tree for this node.

include/toolkit/element.h

@@ -22,7 +22,6 @@
 
 #include <libbase/libbase.h>
 #include <stdbool.h>
-#include <stddef.h>
 #include <stdint.h>
 #include <wayland-server-core.h>
 #include <xkbcommon/xkbcommon.h>
@@ -90,7 +89,7 @@ struct _wlmtk_element_vmt_t {
      * @param motion_event_ptr
      *
      * @return Whether the motion is accepted by this element (or any of it's
-     * cohildren). In that case, the caller should accept this element as
+     * children). In that case, the caller should accept this element as
      * having pointer focus.
      */
     bool (*pointer_accepts_motion)(
@@ -175,6 +174,13 @@ struct _wlmtk_element_vmt_t {
         xkb_keysym_t keysym,
         enum xkb_key_direction direction,
         uint32_t modifiers);
+
+    /**
+     * Redraws this element. For containers, will (re)arrange children.
+     *
+     * @param element_ptr
+     */
+    void (*layout)(wlmtk_element_t *element_ptr);
 };
 
 /** State of an element. */
@@ -438,6 +444,13 @@ void wlmtk_element_pointer_blur(wlmtk_element_t *element_ptr);
  */
 void wlmtk_element_pointer_grab_cancel(wlmtk_element_t *element_ptr);
 
+/** Calls @ref wlmtk_element_vmt_t::keyboard_blur. */
+static inline void wlmtk_element_keyboard_blur(
+    wlmtk_element_t *element_ptr)
+{
+    element_ptr->vmt.keyboard_blur(element_ptr);
+}
+
 /** Calls @ref wlmtk_element_vmt_t::keyboard_event. */
 static inline bool wlmtk_element_keyboard_event(
     wlmtk_element_t *element_ptr,
@@ -458,13 +471,10 @@ static inline bool wlmtk_element_keyboard_sym(
         element_ptr, keysym, direction, modifiers);
 }
 
-/** Calls @ref wlmtk_element_vmt_t::keyboard_blur. */
-static inline void wlmtk_element_keyboard_blur(
-    wlmtk_element_t *element_ptr)
+/** Calls @ref wlmtk_element_vmt_t::layout, if given. */
+static inline void wlmtk_element_layout(wlmtk_element_t *element_ptr)
 {
-    if (NULL != element_ptr->vmt.keyboard_blur) {
-        element_ptr->vmt.keyboard_blur(element_ptr);
-    }
+    element_ptr->vmt.layout(element_ptr);
 }
 
 /**
@@ -508,6 +518,8 @@ typedef struct {
     bool                      keyboard_event_called;
     /** Indicates that @ref wlmtk_element_vmt_t::keyboard_sym() was called. */
     bool                      keyboard_sym_called;
+    /** Indicates that @ref wlmtk_element_vmt_t::layout() was called. */
+    bool                      layout_called;
 
     /** Last axis event received. */
     struct wlr_pointer_axis_event wlr_pointer_axis_event;

include/toolkit/panel.h

@@ -24,7 +24,7 @@
 #include <stdbool.h>
 #include <stdint.h>
 
-#include "container.h"
+#include "container.h"  // IWYU pragma: keep
 #include "element.h"
 
 /** Forward declaration: An element of a layer, we call it: Panel. */
@@ -90,9 +90,6 @@ struct _wlmtk_panel_t {
     /** The panel's virtual method table. */
     wlmtk_panel_vmt_t         vmt;
 
-    /** Virtual method table of the superclass' container. */
-    wlmtk_container_vmt_t     orig_super_container_vmt;
-
     /** Popup container. Panels may contain popups. */
     wlmtk_container_t         popup_container;
 

src/toolkit/bordered.c

@@ -26,8 +26,7 @@
 
 /* == Declarations ========================================================= */
 
-static bool _wlmtk_bordered_container_update_layout(
-    wlmtk_container_t *container_ptr);
+static void _wlmtk_bordered_element_layout(wlmtk_element_t *element_ptr);
 
 static wlmtk_rectangle_t * _wlmtk_bordered_create_border_rectangle(
     wlmtk_bordered_t *bordered_ptr);
@@ -38,9 +37,9 @@ static void _wlmtk_bordered_set_positions(wlmtk_bordered_t *bordered_ptr);
 
 /* == Data ================================================================= */
 
-/** Virtual method table: @ref wlmtk_container_t at @ref wlmtk_bordered_t. */
-static const wlmtk_container_vmt_t bordered_container_vmt = {
-    .update_layout = _wlmtk_bordered_container_update_layout,
+/** Virtual method table: @ref wlmtk_element_t at @ref wlmtk_bordered_t. */
+static const wlmtk_element_vmt_t bordered_element_vmt = {
+    .layout = _wlmtk_bordered_element_layout,
 };
 
 /* == Exported methods ===================================================== */
@@ -55,8 +54,8 @@ bool wlmtk_bordered_init(wlmtk_bordered_t *bordered_ptr,
     if (!wlmtk_container_init(&bordered_ptr->super_container)) {
         return false;
     }
-    bordered_ptr->orig_super_container_vmt = wlmtk_container_extend(
-        &bordered_ptr->super_container, &bordered_container_vmt);
+    bordered_ptr->orig_super_element_vmt = wlmtk_element_extend(
+        wlmtk_bordered_element(bordered_ptr), &bordered_element_vmt);
 
     bordered_ptr->element_ptr = element_ptr;
     wlmtk_container_add_element(&bordered_ptr->super_container,
@@ -106,7 +105,11 @@ void wlmtk_bordered_set_style(wlmtk_bordered_t *bordered_ptr,
 {
     bordered_ptr->style = *style_ptr;
 
-    _wlmtk_bordered_container_update_layout(&bordered_ptr->super_container);
+    wlmtk_element_layout(wlmtk_bordered_element(bordered_ptr));
+    if (NULL != wlmtk_bordered_element(bordered_ptr)->parent_container_ptr) {
+        wlmtk_container_invalidate_layout(
+            wlmtk_bordered_element(bordered_ptr)->parent_container_ptr);
+    }
 
     // Guard clause. Actually, if *any* of the rectangles was not created.
     if (NULL == bordered_ptr->western_border_rectangle_ptr) return;
@@ -133,16 +136,14 @@ wlmtk_element_t *wlmtk_bordered_element(wlmtk_bordered_t *bordered_ptr)
 /**
  * Updates the layout of the bordered element.
  *
- * @param container_ptr
+ * @param element_ptr
  */
-bool _wlmtk_bordered_container_update_layout(
-    wlmtk_container_t *container_ptr)
+void _wlmtk_bordered_element_layout(wlmtk_element_t *element_ptr)
 {
     wlmtk_bordered_t *bordered_ptr = BS_CONTAINER_OF(
-        container_ptr, wlmtk_bordered_t, super_container);
-
+        element_ptr, wlmtk_bordered_t, super_container.super_element);
+    bordered_ptr->orig_super_element_vmt.layout(element_ptr);
     _wlmtk_bordered_set_positions(bordered_ptr);
-    return true;
 }
 
 /* ------------------------------------------------------------------------- */
@@ -292,9 +293,8 @@ void test_init_fini(bs_test_t *test_ptr)
         0, 2, 2, 20);
 
     // Update layout, test updated positions.
-    fe_ptr->dimensions.width = 200;
-    fe_ptr->dimensions.height = 120;
-    wlmtk_container_update_layout_and_pointer_focus(&bordered.super_container);
+    wlmtk_fake_element_set_dimensions(fe_ptr, 200, 120);
+    wlmtk_element_layout(wlmtk_bordered_element(&bordered));
     test_rectangle_pos(
         test_ptr, bordered.northern_border_rectangle_ptr,
         0, 0, 204, 2);