cycle: refactor to aggregate type definitions into cycle.h

We declared `cycle_state` struct in `labwc.h` and `cycle_osd_scene`
struct in `output.h`, which was unclean in terms of separation of
concerns.

So this commit firstly moves `cycle_state` to `cycle.h`, then replaces
`cycle_osd_scene` in `output.h` with `cycle_osd_output` in `cycle.h`
which is dynamically allocated in a similar manner to
`session_lock_output`. This ensures that all states about alt-tabbing
are stored in `server->cycle`.

Also, this commit fixes a rare memory leak in `output->cycle_osd.items`
when an output is destroyed while alt-tabbing, by freeing it when the
osd tree is destroyed.
This commit is contained in:
tokyo4j 2025-12-29 02:50:45 +09:00 committed by Johan Malm
parent 276d4e61f9
commit dfe428ae14
8 changed files with 95 additions and 72 deletions

View file

@ -4,6 +4,7 @@
#include <stdbool.h> #include <stdbool.h>
#include <wayland-server-core.h> #include <wayland-server-core.h>
#include <wlr/util/box.h>
#include "config/types.h" #include "config/types.h"
struct output; struct output;
@ -49,6 +50,27 @@ struct cycle_filter {
enum cycle_app_id_filter app_id; enum cycle_app_id_filter app_id;
}; };
struct cycle_state {
struct view *selected_view;
struct wl_list views;
struct wl_list osd_outputs; /* struct cycle_osd_output.link */
bool preview_was_shaded;
bool preview_was_enabled;
struct wlr_scene_node *preview_node;
struct wlr_scene_node *preview_dummy;
struct lab_scene_rect *preview_outline;
struct cycle_filter filter;
};
struct cycle_osd_output {
struct wl_list link; /* struct cycle_state.osd_outputs */
struct output *output;
struct wl_listener tree_destroy;
struct wl_list items; /* struct cycle_osd_item.link */
struct wlr_scene_tree *tree;
};
struct buf; struct buf;
struct view; struct view;
struct server; struct server;
@ -92,15 +114,14 @@ struct cycle_osd_item {
struct cycle_osd_impl { struct cycle_osd_impl {
/* /*
* Create a scene-tree of OSD for an output. * Create a scene-tree of OSD for an output and fill
* This sets output->cycle_osd.{items,tree}. * osd_output->items.
*/ */
void (*create)(struct output *output); void (*init)(struct cycle_osd_output *osd_output);
/* /*
* Update output->cycle_osd.tree to highlight * Update the OSD to highlight server->cycle.selected_view.
* server->cycle_state.selected_view.
*/ */
void (*update)(struct output *output); void (*update)(struct cycle_osd_output *osd_output);
}; };
extern struct cycle_osd_impl cycle_osd_classic_impl; extern struct cycle_osd_impl cycle_osd_classic_impl;

View file

@ -303,16 +303,7 @@ struct server {
struct wlr_security_context_manager_v1 *security_context_manager_v1; struct wlr_security_context_manager_v1 *security_context_manager_v1;
/* Set when in cycle (alt-tab) mode */ /* Set when in cycle (alt-tab) mode */
struct cycle_state { struct cycle_state cycle;
struct view *selected_view;
struct wl_list views;
bool preview_was_shaded;
bool preview_was_enabled;
struct wlr_scene_node *preview_node;
struct wlr_scene_node *preview_dummy;
struct lab_scene_rect *preview_outline;
struct cycle_filter filter;
} cycle;
struct theme *theme; struct theme *theme;

View file

@ -19,11 +19,6 @@ struct output {
struct wlr_scene_tree *session_lock_tree; struct wlr_scene_tree *session_lock_tree;
struct wlr_scene_buffer *workspace_osd; struct wlr_scene_buffer *workspace_osd;
struct cycle_osd_scene {
struct wl_list items; /* struct cycle_osd_item */
struct wlr_scene_tree *tree;
} cycle_osd;
/* In output-relative scene coordinates */ /* In output-relative scene coordinates */
struct wlr_box usable_area; struct wlr_box usable_area;

View file

@ -6,6 +6,7 @@
#include <wlr/util/log.h> #include <wlr/util/log.h>
#include "common/lab-scene-rect.h" #include "common/lab-scene-rect.h"
#include "common/list.h" #include "common/list.h"
#include "common/mem.h"
#include "common/scene-helpers.h" #include "common/scene-helpers.h"
#include "config/rcxml.h" #include "config/rcxml.h"
#include "labwc.h" #include "labwc.h"
@ -314,6 +315,21 @@ insert_view_ordered_by_age(struct wl_list *views, struct view *new_view)
wl_list_insert(link, &new_view->cycle_link); wl_list_insert(link, &new_view->cycle_link);
} }
static void
handle_osd_tree_destroy(struct wl_listener *listener, void *data)
{
struct cycle_osd_output *osd_output =
wl_container_of(listener, osd_output, tree_destroy);
struct cycle_osd_item *item, *tmp;
wl_list_for_each_safe(item, tmp, &osd_output->items, link) {
wl_list_remove(&item->link);
free(item);
}
wl_list_remove(&osd_output->tree_destroy.link);
wl_list_remove(&osd_output->link);
free(osd_output);
}
/* Return false on failure */ /* Return false on failure */
static bool static bool
init_cycle(struct server *server, struct cycle_filter filter) init_cycle(struct server *server, struct cycle_filter filter)
@ -366,8 +382,17 @@ init_cycle(struct server *server, struct cycle_filter filter)
if (!output_is_usable(output)) { if (!output_is_usable(output)) {
continue; continue;
} }
get_osd_impl()->create(output);
assert(output->cycle_osd.tree); struct cycle_osd_output *osd_output = znew(*osd_output);
wl_list_append(&server->cycle.osd_outputs, &osd_output->link);
osd_output->output = output;
wl_list_init(&osd_output->items);
get_osd_impl()->init(osd_output);
osd_output->tree_destroy.notify = handle_osd_tree_destroy;
wl_signal_add(&osd_output->tree->node.events.destroy,
&osd_output->tree_destroy);
} }
} }
@ -380,11 +405,9 @@ update_cycle(struct server *server)
struct cycle_state *cycle = &server->cycle; struct cycle_state *cycle = &server->cycle;
if (rc.window_switcher.osd.show) { if (rc.window_switcher.osd.show) {
struct output *output; struct cycle_osd_output *osd_output;
wl_list_for_each(output, &server->outputs, link) { wl_list_for_each(osd_output, &cycle->osd_outputs, link) {
if (output->cycle_osd.tree) { get_osd_impl()->update(osd_output);
get_osd_impl()->update(output);
}
} }
} }
@ -394,8 +417,8 @@ update_cycle(struct server *server)
/* Outline current window */ /* Outline current window */
if (rc.window_switcher.outlines) { if (rc.window_switcher.outlines) {
if (view_is_focusable(server->cycle.selected_view)) { if (view_is_focusable(cycle->selected_view)) {
update_preview_outlines(server->cycle.selected_view); update_preview_outlines(cycle->selected_view);
} }
} }
} }
@ -404,17 +427,10 @@ update_cycle(struct server *server)
static void static void
destroy_cycle(struct server *server) destroy_cycle(struct server *server)
{ {
struct output *output; struct cycle_osd_output *osd_output, *tmp;
wl_list_for_each(output, &server->outputs, link) { wl_list_for_each_safe(osd_output, tmp, &server->cycle.osd_outputs, link) {
struct cycle_osd_item *item, *tmp; /* calls handle_osd_tree_destroy() */
wl_list_for_each_safe(item, tmp, &output->cycle_osd.items, link) { wlr_scene_node_destroy(&osd_output->tree->node);
wl_list_remove(&item->link);
free(item);
}
if (output->cycle_osd.tree) {
wlr_scene_node_destroy(&output->cycle_osd.tree->node);
output->cycle_osd.tree = NULL;
}
} }
restore_preview_node(server); restore_preview_node(server);
@ -424,8 +440,8 @@ destroy_cycle(struct server *server)
server->cycle.preview_outline = NULL; server->cycle.preview_outline = NULL;
} }
struct view *view, *tmp; struct view *view, *tmp2;
wl_list_for_each_safe(view, tmp, &server->cycle.views, cycle_link) { wl_list_for_each_safe(view, tmp2, &server->cycle.views, cycle_link) {
wl_list_remove(&view->cycle_link); wl_list_remove(&view->cycle_link);
view->cycle_link = (struct wl_list){0}; view->cycle_link = (struct wl_list){0};
} }

View file

@ -77,10 +77,9 @@ create_fields_scene(struct server *server, struct view *view,
} }
static void static void
cycle_osd_classic_create(struct output *output) cycle_osd_classic_init(struct cycle_osd_output *osd_output)
{ {
assert(!output->cycle_osd.tree && wl_list_empty(&output->cycle_osd.items)); struct output *output = osd_output->output;
struct server *server = output->server; struct server *server = output->server;
struct theme *theme = server->theme; struct theme *theme = server->theme;
struct window_switcher_classic_theme *switcher_theme = struct window_switcher_classic_theme *switcher_theme =
@ -104,7 +103,7 @@ cycle_osd_classic_create(struct output *output)
h += switcher_theme->item_height; h += switcher_theme->item_height;
} }
output->cycle_osd.tree = wlr_scene_tree_create(output->cycle_osd_tree); osd_output->tree = wlr_scene_tree_create(output->cycle_osd_tree);
float *text_color = theme->osd_label_text_color; float *text_color = theme->osd_label_text_color;
float *bg_color = theme->osd_bg_color; float *bg_color = theme->osd_bg_color;
@ -118,7 +117,7 @@ cycle_osd_classic_create(struct output *output)
.width = w, .width = w,
.height = h, .height = h,
}; };
lab_scene_rect_create(output->cycle_osd.tree, &bg_opts); lab_scene_rect_create(osd_output->tree, &bg_opts);
int y = padding; int y = padding;
@ -136,7 +135,7 @@ cycle_osd_classic_create(struct output *output)
} }
struct scaled_font_buffer *font_buffer = struct scaled_font_buffer *font_buffer =
scaled_font_buffer_create(output->cycle_osd.tree); scaled_font_buffer_create(osd_output->tree);
wlr_scene_node_set_position(&font_buffer->scene_buffer->node, wlr_scene_node_set_position(&font_buffer->scene_buffer->node,
x, y + (switcher_theme->item_height - font_height(&font)) / 2); x, y + (switcher_theme->item_height - font_height(&font)) / 2);
scaled_font_buffer_update(font_buffer, workspace_name, 0, scaled_font_buffer_update(font_buffer, workspace_name, 0,
@ -159,9 +158,9 @@ cycle_osd_classic_create(struct output *output)
struct view *view; struct view *view;
wl_list_for_each(view, &server->cycle.views, cycle_link) { wl_list_for_each(view, &server->cycle.views, cycle_link) {
struct cycle_osd_classic_item *item = znew(*item); struct cycle_osd_classic_item *item = znew(*item);
wl_list_append(&output->cycle_osd.items, &item->base.link); wl_list_append(&osd_output->items, &item->base.link);
item->base.view = view; item->base.view = view;
item->base.tree = wlr_scene_tree_create(output->cycle_osd.tree); item->base.tree = wlr_scene_tree_create(osd_output->tree);
node_descriptor_create(&item->base.tree->node, node_descriptor_create(&item->base.tree->node,
LAB_NODE_CYCLE_OSD_ITEM, NULL, item); LAB_NODE_CYCLE_OSD_ITEM, NULL, item);
/* /*
@ -218,23 +217,24 @@ cycle_osd_classic_create(struct output *output)
error:; error:;
/* Center OSD */ /* Center OSD */
wlr_scene_node_set_position(&output->cycle_osd.tree->node, wlr_scene_node_set_position(&osd_output->tree->node,
output_box.x + (output_box.width - w) / 2, output_box.x + (output_box.width - w) / 2,
output_box.y + (output_box.height - h) / 2); output_box.y + (output_box.height - h) / 2);
} }
static void static void
cycle_osd_classic_update(struct output *output) cycle_osd_classic_update(struct cycle_osd_output *osd_output)
{ {
struct server *server = osd_output->output->server;
struct cycle_osd_classic_item *item; struct cycle_osd_classic_item *item;
wl_list_for_each(item, &output->cycle_osd.items, base.link) { wl_list_for_each(item, &osd_output->items, base.link) {
bool active = item->base.view == output->server->cycle.selected_view; bool active = item->base.view == server->cycle.selected_view;
wlr_scene_node_set_enabled(&item->normal_tree->node, !active); wlr_scene_node_set_enabled(&item->normal_tree->node, !active);
wlr_scene_node_set_enabled(&item->active_tree->node, active); wlr_scene_node_set_enabled(&item->active_tree->node, active);
} }
} }
struct cycle_osd_impl cycle_osd_classic_impl = { struct cycle_osd_impl cycle_osd_classic_impl = {
.create = cycle_osd_classic_create, .init = cycle_osd_classic_init,
.update = cycle_osd_classic_update, .update = cycle_osd_classic_update,
}; };

View file

@ -117,9 +117,9 @@ create_label(struct wlr_scene_tree *parent, struct view *view,
static struct cycle_osd_thumbnail_item * static struct cycle_osd_thumbnail_item *
create_item_scene(struct wlr_scene_tree *parent, struct view *view, create_item_scene(struct wlr_scene_tree *parent, struct view *view,
struct output *output) struct cycle_osd_output *osd_output)
{ {
struct server *server = output->server; struct server *server = osd_output->output->server;
struct theme *theme = server->theme; struct theme *theme = server->theme;
struct window_switcher_thumbnail_theme *switcher_theme = struct window_switcher_thumbnail_theme *switcher_theme =
&theme->osd_window_switcher_thumbnail; &theme->osd_window_switcher_thumbnail;
@ -137,7 +137,7 @@ create_item_scene(struct wlr_scene_tree *parent, struct view *view,
} }
struct cycle_osd_thumbnail_item *item = znew(*item); struct cycle_osd_thumbnail_item *item = znew(*item);
wl_list_append(&output->cycle_osd.items, &item->base.link); wl_list_append(&osd_output->items, &item->base.link);
struct wlr_scene_tree *tree = wlr_scene_tree_create(parent); struct wlr_scene_tree *tree = wlr_scene_tree_create(parent);
node_descriptor_create(&tree->node, LAB_NODE_CYCLE_OSD_ITEM, NULL, item); node_descriptor_create(&tree->node, LAB_NODE_CYCLE_OSD_ITEM, NULL, item);
item->base.tree = tree; item->base.tree = tree;
@ -159,7 +159,7 @@ create_item_scene(struct wlr_scene_tree *parent, struct view *view,
switcher_theme->item_height, (float[4]) {0}); switcher_theme->item_height, (float[4]) {0});
/* thumbnail */ /* thumbnail */
struct wlr_buffer *thumb_buffer = render_thumb(output, view); struct wlr_buffer *thumb_buffer = render_thumb(osd_output->output, view);
if (thumb_buffer) { if (thumb_buffer) {
struct wlr_scene_buffer *thumb_scene_buffer = struct wlr_scene_buffer *thumb_scene_buffer =
wlr_scene_buffer_create(tree, thumb_buffer); wlr_scene_buffer_create(tree, thumb_buffer);
@ -226,17 +226,16 @@ get_items_geometry(struct output *output, struct theme *theme,
} }
static void static void
cycle_osd_thumbnail_create(struct output *output) cycle_osd_thumbnail_init(struct cycle_osd_output *osd_output)
{ {
assert(!output->cycle_osd.tree && wl_list_empty(&output->cycle_osd.items)); struct output *output = osd_output->output;
struct server *server = output->server; struct server *server = output->server;
struct theme *theme = server->theme; struct theme *theme = server->theme;
struct window_switcher_thumbnail_theme *switcher_theme = struct window_switcher_thumbnail_theme *switcher_theme =
&theme->osd_window_switcher_thumbnail; &theme->osd_window_switcher_thumbnail;
int padding = theme->osd_border_width + switcher_theme->padding; int padding = theme->osd_border_width + switcher_theme->padding;
output->cycle_osd.tree = wlr_scene_tree_create(output->cycle_osd_tree); osd_output->tree = wlr_scene_tree_create(output->cycle_osd_tree);
int nr_views = wl_list_length(&server->cycle.views); int nr_views = wl_list_length(&server->cycle.views);
assert(nr_views > 0); assert(nr_views > 0);
@ -248,7 +247,7 @@ cycle_osd_thumbnail_create(struct output *output)
int index = 0; int index = 0;
wl_list_for_each(view, &server->cycle.views, cycle_link) { wl_list_for_each(view, &server->cycle.views, cycle_link) {
struct cycle_osd_thumbnail_item *item = create_item_scene( struct cycle_osd_thumbnail_item *item = create_item_scene(
output->cycle_osd.tree, view, output); osd_output->tree, view, osd_output);
if (!item) { if (!item) {
break; break;
} }
@ -268,7 +267,7 @@ cycle_osd_thumbnail_create(struct output *output)
.height = nr_rows * switcher_theme->item_height + 2 * padding, .height = nr_rows * switcher_theme->item_height + 2 * padding,
}; };
struct lab_scene_rect *bg = struct lab_scene_rect *bg =
lab_scene_rect_create(output->cycle_osd.tree, &bg_opts); lab_scene_rect_create(osd_output->tree, &bg_opts);
wlr_scene_node_lower_to_bottom(&bg->tree->node); wlr_scene_node_lower_to_bottom(&bg->tree->node);
/* center */ /* center */
@ -277,15 +276,16 @@ cycle_osd_thumbnail_create(struct output *output)
&output_box); &output_box);
int lx = output_box.x + (output_box.width - bg_opts.width) / 2; int lx = output_box.x + (output_box.width - bg_opts.width) / 2;
int ly = output_box.y + (output_box.height - bg_opts.height) / 2; int ly = output_box.y + (output_box.height - bg_opts.height) / 2;
wlr_scene_node_set_position(&output->cycle_osd.tree->node, lx, ly); wlr_scene_node_set_position(&osd_output->tree->node, lx, ly);
} }
static void static void
cycle_osd_thumbnail_update(struct output *output) cycle_osd_thumbnail_update(struct cycle_osd_output *osd_output)
{ {
struct server *server = osd_output->output->server;
struct cycle_osd_thumbnail_item *item; struct cycle_osd_thumbnail_item *item;
wl_list_for_each(item, &output->cycle_osd.items, base.link) { wl_list_for_each(item, &osd_output->items, base.link) {
bool active = (item->base.view == output->server->cycle.selected_view); bool active = (item->base.view == server->cycle.selected_view);
wlr_scene_node_set_enabled(&item->active_bg->tree->node, active); wlr_scene_node_set_enabled(&item->active_bg->tree->node, active);
wlr_scene_node_set_enabled( wlr_scene_node_set_enabled(
&item->active_label->scene_buffer->node, active); &item->active_label->scene_buffer->node, active);
@ -295,6 +295,6 @@ cycle_osd_thumbnail_update(struct output *output)
} }
struct cycle_osd_impl cycle_osd_thumbnail_impl = { struct cycle_osd_impl cycle_osd_thumbnail_impl = {
.create = cycle_osd_thumbnail_create, .init = cycle_osd_thumbnail_init,
.update = cycle_osd_thumbnail_update, .update = cycle_osd_thumbnail_update,
}; };

View file

@ -542,7 +542,6 @@ handle_new_output(struct wl_listener *listener, void *data)
wl_signal_add(&wlr_output->events.request_state, &output->request_state); wl_signal_add(&wlr_output->events.request_state, &output->request_state);
wl_list_init(&output->regions); wl_list_init(&output->regions);
wl_list_init(&output->cycle_osd.items);
/* /*
* Create layer-trees (background, bottom, top and overlay) and * Create layer-trees (background, bottom, top and overlay) and

View file

@ -550,6 +550,7 @@ server_init(struct server *server)
wl_list_init(&server->views); wl_list_init(&server->views);
wl_list_init(&server->unmanaged_surfaces); wl_list_init(&server->unmanaged_surfaces);
wl_list_init(&server->cycle.views); wl_list_init(&server->cycle.views);
wl_list_init(&server->cycle.osd_outputs);
server->scene = wlr_scene_create(); server->scene = wlr_scene_create();
if (!server->scene) { if (!server->scene) {