mirror of
https://github.com/labwc/labwc.git
synced 2025-11-02 09:01:47 -05:00
f347a818e3
Our codebase for ssd scenes has grown with a lot of technical debts: - We needed to call `ssd_get_part()` everywhere to get the scene node of a ssd part. We then needed to cast it to `wlr_scene_rect` and `wlr_scene_buffer`. This bloated our codebase and even blocked duplicated button types in `<titlebar><layout>`. - `ssd_get_part_type()` was a dirty hack. It compared parent, grandparent and grandgrandparent of a node with each subtree in the ssd to get the part type of the node. To resolve this issues, this commit changes how ssd scenes are managed: - Access scene rects and scene buffers just as a member of `struct ssd`. - `ssd_part` is now a attachment to a scene node that can be accessed via node_descriptor->data, with a new node-descriptor type `LAB_NODE_DESC_SSD_PART`. `LAB_NODE_DESC_SSD_BUTTON` is unified into it. Now the scene graph under ssd->tree looks like below. The parentheses indicate the type of ssd_part attached to the node: ssd->tree (LAB_SSD_NONE) +--titlebar (LAB_SSD_PART_TITLEBAR) | +--inactive | | +--background bar | | +--left corner | | +--right corner | | +--title (LAB_SSD_PART_TITLE) | | +--iconify button (LAB_SSD_BUTTON_ICONIFY) | | | +--normal close icon image | | | +--hovered close icon image | | | +--... | | +--window icon (LAB_SSD_BUTTON_WINDOW_ICON) | | | +--window icon image | | +--... | +--active | +--... +--border | +--inactive | | +--top | | +--... | +--active | +--top | +--... +--shadow | +--inactive | | +--top | | +--... | +--active | +--top | +--... +--extents +--top +--... When hovering on SSD, `get_cursor_context()` traverses this scene node from the leaf. If it finds a `ssd_part` attached to the node, it returns `ssd_part_type` that represents the resizing direction, button types or `Title`/`Titlebar`.
127 lines
3.6 KiB
C
127 lines
3.6 KiB
C
/* SPDX-License-Identifier: GPL-2.0-only */
|
|
#ifndef LABWC_SSD_H
|
|
#define LABWC_SSD_H
|
|
|
|
#include "common/border.h"
|
|
#include "common/edge.h"
|
|
#include "config/types.h"
|
|
|
|
enum ssd_active_state {
|
|
SSD_INACTIVE = 0,
|
|
SSD_ACTIVE = 1,
|
|
};
|
|
|
|
#define FOR_EACH_ACTIVE_STATE(active) for (active = SSD_INACTIVE; active <= SSD_ACTIVE; active++)
|
|
|
|
struct wlr_cursor;
|
|
|
|
/*
|
|
* Shadows should start at a point inset from the actual window border, see
|
|
* discussion on https://github.com/labwc/labwc/pull/1648. This constant
|
|
* specifies inset as a multiple of visible shadow size.
|
|
*/
|
|
#define SSD_SHADOW_INSET 0.3
|
|
|
|
/*
|
|
* Sequence these according to the order they should be processed for
|
|
* press and hover events. Bear in mind that some of their respective
|
|
* interactive areas overlap, so for example buttons need to come before title.
|
|
*/
|
|
enum ssd_part_type {
|
|
LAB_SSD_NONE = 0,
|
|
|
|
LAB_SSD_BUTTON_CLOSE = 1,
|
|
LAB_SSD_BUTTON_MAXIMIZE,
|
|
LAB_SSD_BUTTON_ICONIFY,
|
|
LAB_SSD_BUTTON_WINDOW_ICON,
|
|
LAB_SSD_BUTTON_WINDOW_MENU,
|
|
LAB_SSD_BUTTON_SHADE,
|
|
LAB_SSD_BUTTON_OMNIPRESENT,
|
|
/* only for internal use */
|
|
LAB_SSD_BUTTON_FIRST = LAB_SSD_BUTTON_CLOSE,
|
|
LAB_SSD_BUTTON_LAST = LAB_SSD_BUTTON_OMNIPRESENT,
|
|
LAB_SSD_BUTTON,
|
|
|
|
LAB_SSD_PART_TITLEBAR,
|
|
LAB_SSD_PART_TITLE,
|
|
|
|
LAB_SSD_PART_CORNER_TOP_LEFT,
|
|
LAB_SSD_PART_CORNER_TOP_RIGHT,
|
|
LAB_SSD_PART_CORNER_BOTTOM_RIGHT,
|
|
LAB_SSD_PART_CORNER_BOTTOM_LEFT,
|
|
LAB_SSD_PART_TOP,
|
|
LAB_SSD_PART_RIGHT,
|
|
LAB_SSD_PART_BOTTOM,
|
|
LAB_SSD_PART_LEFT,
|
|
|
|
LAB_SSD_CLIENT,
|
|
LAB_SSD_FRAME,
|
|
LAB_SSD_ROOT,
|
|
LAB_SSD_MENU,
|
|
LAB_SSD_OSD,
|
|
LAB_SSD_LAYER_SURFACE,
|
|
LAB_SSD_LAYER_SUBSURFACE,
|
|
LAB_SSD_UNMANAGED,
|
|
LAB_SSD_ALL,
|
|
LAB_SSD_END_MARKER
|
|
};
|
|
|
|
/* Forward declare arguments */
|
|
struct ssd;
|
|
struct ssd_hover_state;
|
|
struct ssd_part;
|
|
struct view;
|
|
struct wlr_scene;
|
|
struct wlr_scene_node;
|
|
|
|
/*
|
|
* Public SSD API
|
|
*
|
|
* For convenience in dealing with non-SSD views, this API allows NULL
|
|
* ssd/button/node arguments and attempts to do something sensible in
|
|
* that case (e.g. no-op/return default values).
|
|
*
|
|
* NULL scene/view arguments are not allowed.
|
|
*/
|
|
struct ssd *ssd_create(struct view *view, bool active);
|
|
struct border ssd_get_margin(const struct ssd *ssd);
|
|
int ssd_get_corner_width(void);
|
|
void ssd_update_margin(struct ssd *ssd);
|
|
void ssd_set_active(struct ssd *ssd, bool active);
|
|
void ssd_update_title(struct ssd *ssd);
|
|
void ssd_update_geometry(struct ssd *ssd);
|
|
void ssd_destroy(struct ssd *ssd);
|
|
void ssd_set_titlebar(struct ssd *ssd, bool enabled);
|
|
|
|
void ssd_enable_keybind_inhibit_indicator(struct ssd *ssd, bool enable);
|
|
void ssd_enable_shade(struct ssd *ssd, bool enable);
|
|
|
|
struct ssd_hover_state *ssd_hover_state_new(void);
|
|
void ssd_update_button_hover(struct wlr_scene_node *node,
|
|
struct ssd_hover_state *hover_state);
|
|
|
|
enum ssd_part_type ssd_part_get_type(const struct ssd_part *part);
|
|
struct view *ssd_part_get_view(const struct ssd_part *part);
|
|
|
|
/* Public SSD helpers */
|
|
|
|
/*
|
|
* Returns a part type that represents a mouse context like "Top", "Left" and
|
|
* "TRCorner" when the cursor is on the window border or resizing handle.
|
|
*/
|
|
enum ssd_part_type ssd_get_resizing_type(const struct ssd *ssd,
|
|
struct wlr_cursor *cursor);
|
|
enum lab_edge ssd_resize_edges(enum ssd_part_type type);
|
|
bool ssd_part_contains(enum ssd_part_type whole, enum ssd_part_type candidate);
|
|
enum lab_ssd_mode ssd_mode_parse(const char *mode);
|
|
|
|
/* TODO: clean up / update */
|
|
struct border ssd_thickness(struct view *view);
|
|
struct wlr_box ssd_max_extents(struct view *view);
|
|
|
|
/* SSD debug helpers */
|
|
bool ssd_debug_is_root_node(const struct ssd *ssd, struct wlr_scene_node *node);
|
|
const char *ssd_debug_get_node_name(const struct ssd *ssd,
|
|
struct wlr_scene_node *node);
|
|
|
|
#endif /* LABWC_SSD_H */
|