mirrors/labwc
1
0
Fork 0
mirror of https://github.com/labwc/labwc.git synced 2025-10-29 05:40:24 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
labwc/include/view.h

193 lines
6.1 KiB
C
Raw Normal View History

include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef __LABWC_VIEW_H
#define __LABWC_VIEW_H
#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <wayland-util.h>
#include <wlr/util/box.h>
view: create derived structs ...for XDG toplevels and XWayland views to only include applicable wl_listeners for each type of view.
2022-11-22 20:13:06 +00:00
/*
* In labwc, a view is a container for surfaces which can be moved around by
* the user. In practice this means XDG toplevel and XWayland windows.
*/
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
enum view_type {
LAB_XDG_SHELL_VIEW,
#if HAVE_XWAYLAND
LAB_XWAYLAND_VIEW,
#endif
};
ssd: Allocate `struct ssd` and `struct ssd_hover_state` separately - Store a pointer to the `struct view` in `struct ssd` - Pass `struct ssd *` instead of `struct view *` to ssd functions - Add `ssd_get_margin()` convenience function
2022-11-26 16:46:28 -05:00
struct view;
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
struct view_impl {
void (*configure)(struct view *view, struct wlr_box geo);
void (*close)(struct view *view);
const char *(*get_string_prop)(struct view *view, const char *prop);
void (*map)(struct view *view);
void (*set_activated)(struct view *view, bool activated);
void (*set_fullscreen)(struct view *view, bool fullscreen);
void (*unmap)(struct view *view);
void (*maximize)(struct view *view, bool maximize);
view: add move_to_front to `struct view_impl` ...to increase xwayland and xdg-shell encapsulation and to avoid passing a function pointer as an argument in `xwayland_move_sub_views_to_front()` which is inconsistent with labwc design patterns. Rename view-impl.c to view-impl-common.c Move function declarations that are common to view-implementations from view.h into view-impl-common.h
2023-02-05 19:29:24 +00:00
void (*move_to_front)(struct view *view);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
};
struct view {
struct server *server;
enum view_type type;
const struct view_impl *impl;
struct wl_list link;
view: Add documentation for view->output
2023-02-21 08:14:11 -05:00
/*
* The output that the view is displayed on. Specifically:
*
* - For floating views, this is the output nearest to the
* center of the view. It is computed automatically when the
* view is moved or the output layout changes.
*
* - For fullscreen/maximized/tiled views, this is the output
* used to compute the view's geometry. The view remains on
* the same output unless it is disabled or disconnected.
*
* Many view functions (e.g. view_center(), view_fullscreen(),
* view_maximize(), etc.) allow specifying a particular output
view: Add view_set_output()
2023-02-28 11:46:48 -05:00
* by calling view_set_output() beforehand.
view: Add documentation for view->output
2023-02-21 08:14:11 -05:00
*/
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
struct output *output;
struct workspace *workspace;
struct wlr_surface *surface;
struct wlr_scene_tree *scene_tree;
struct wlr_scene_node *scene_node;
bool mapped;
bool been_mapped;
view/ssd: Move ssd->enabled to view->ssd_enabled
2022-11-21 15:38:20 -05:00
bool ssd_enabled;
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
bool minimized;
bool maximized;
view: Tidy up view->output/view->fullscreen redundancy A fullscreen view currently has its output specified twice by: - struct output *output - struct wlr_output *fullscreen view->fullscreen may also become a dangling pointer if the output is disconnected, because view_on_output_destroy() clears view->output but not view->fullscreen. To eliminate the redundancy and the dangling pointer, let's change view->fullscreen to a Boolean and rely on view->output to specify the output. Along the way, change a few related usages of struct wlr_output to struct output as well. No functional change intended. v2: Don't allow entering fullscreen on disabled output (makes conditions for entering/leaving fullscreen symmetric) v3: Use output_is_usable() helper
2023-02-15 02:12:22 -05:00
bool fullscreen;
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
uint32_t tiled; /* private, enum view_edge in src/view.c */
SnapToRegion: Evacuate tiled views from destroying outputs
2022-07-07 19:05:54 +02:00
SnapToRegion: Allow for live config updates
2023-01-01 18:12:20 +01:00
/* Pointer to an output owned struct region, may be NULL */
SnapToRegion: Add view_snap_to_region()
2022-07-06 17:04:21 +02:00
struct region *tiled_region;
SnapToRegion: Evacuate tiled views from destroying outputs
2022-07-07 19:05:54 +02:00
/* Set to region->name when tiled_region is free'd by a destroying output */
char *tiled_region_evacuate;
view: Use wlr_box for current/pending geometry
2023-02-08 23:19:14 -05:00
/*
* Geometry of the wlr_surface contained within the view, as
* currently displayed. Should be kept in sync with the
* scene-graph at all times.
*/
struct wlr_box current;
/*
* Expected geometry after any pending move/resize requests
* have been processed. Should match current geometry when no
* move/resize requests are pending.
*/
struct wlr_box pending;
/*
* Saved geometry which will be restored when the view returns
* to normal/floating state after being maximized/fullscreen/
* tiled. Values are undefined/out-of-date when the view is not
* maximized/fullscreen/tiled.
*/
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
struct wlr_box natural_geometry;
view: Use wlr_box for current/pending geometry
2023-02-08 23:19:14 -05:00
/* used by xdg-shell views */
uint32_t pending_configure_serial;
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
ssd: Allocate `struct ssd` and `struct ssd_hover_state` separately - Store a pointer to the `struct view` in `struct ssd` - Pass `struct ssd *` instead of `struct view *` to ssd functions - Add `ssd_get_margin()` convenience function
2022-11-26 16:46:28 -05:00
struct ssd *ssd;
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
src/foreign.c: refactor
2023-02-01 09:27:25 +01:00
struct foreign_toplevel {
struct wlr_foreign_toplevel_handle_v1 *handle;
struct wl_listener maximize;
struct wl_listener minimize;
struct wl_listener fullscreen;
struct wl_listener activate;
struct wl_listener close;
struct wl_listener destroy;
} toplevel;
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
struct wl_listener map;
struct wl_listener unmap;
struct wl_listener destroy;
struct wl_listener surface_destroy;
struct wl_listener commit;
struct wl_listener request_move;
struct wl_listener request_resize;
struct wl_listener request_minimize;
struct wl_listener request_maximize;
struct wl_listener request_fullscreen;
struct wl_listener set_title;
view: create derived structs ...for XDG toplevels and XWayland views to only include applicable wl_listeners for each type of view.
2022-11-22 20:13:06 +00:00
};
struct xdg_toplevel_view {
struct view base;
view: Move xdg_surface + xwayland_surface to derived structs Add xdg_surface_from_view() + xwayland_surface_from_view() accessors that assert() the view is of the expected type before returning. Fix a real bug in xdg.c parent_of() that dereferenced `view->xdg_surface->toplevel` without first checking `view->type`. The goal of the new accessors is to catch similar bugs in future.
2022-11-25 13:41:12 -05:00
struct wlr_xdg_surface *xdg_surface;
view: create derived structs ...for XDG toplevels and XWayland views to only include applicable wl_listeners for each type of view.
2022-11-22 20:13:06 +00:00
/* Events unique to xdg-toplevel views */
struct wl_listener set_app_id;
struct wl_listener new_popup;
};
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_set_activated(struct view *view);
view: Add view_set_output()
2023-02-28 11:46:48 -05:00
void view_set_output(struct view *view, struct output *output);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_close(struct view *view);
/**
* view_move_resize - resize and move view
* @view: view to be resized and moved
* @geo: the new geometry
* NOTE: Only use this when the view actually changes width and/or height
* otherwise the serials might cause a delay in moving xdg-shell clients.
* For move only, use view_move()
*/
void view_move_resize(struct view *view, struct wlr_box geo);
void view_move(struct view *view, int x, int y);
void view_moved(struct view *view);
void view_minimize(struct view *view, bool minimized);
void view_store_natural_geometry(struct view *view);
view: Comment updates
2023-03-05 01:58:24 -05:00
/**
* view_center - center view within some region
* @view: view to be centered
* @ref: optional reference region (in layout coordinates) to center
* within; if NULL, view is centered within usable area of its output
*/
view: Set view->output prior to calling view_center()
2023-02-20 16:23:53 -05:00
void view_center(struct view *view, const struct wlr_box *ref);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_restore_to(struct view *view, struct wlr_box geometry);
view: Add view_set_untiled()
2022-11-21 13:17:14 -05:00
void view_set_untiled(struct view *view);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_maximize(struct view *view, bool maximize,
bool store_natural_geometry);
xdg: Set view->output prior to view_set_fullscreen()
2023-02-20 13:36:15 -05:00
void view_set_fullscreen(struct view *view, bool fullscreen);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_toggle_maximize(struct view *view);
void view_toggle_decorations(struct view *view);
void view_toggle_always_on_top(struct view *view);
src/workspaces.c: prevent re-focus for always-on-top views Before this patch a focused always-on-top view lost its keyboard focus when switching workspaces. Now the view keeps its focus.
2022-12-29 04:50:21 +01:00
bool view_is_always_on_top(struct view *view);
SnapToRegion: Allow for live config updates
2023-01-01 18:12:20 +01:00
bool view_is_tiled(struct view *view);
src/view.c: view_is_floating() add missing tiled_region_evacuate Also - remove static inline (e.g. trust the compiler to optimize) - move from include/view.h to src/view.c
2023-02-11 09:36:42 +01:00
bool view_is_floating(struct view *view);
view: Rename/move workspaces_send_to() to view_move_to_workspace() This function semantically belongs in view.c since it modifies `struct view`. Also a minor formatting fix in view_toggle_always_on_top().
2022-11-21 13:03:49 -05:00
void view_move_to_workspace(struct view *view, struct workspace *workspace);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_set_decorations(struct view *view, bool decorations);
void view_toggle_fullscreen(struct view *view);
void view_adjust_for_layout_change(struct view *view);
void view_move_to_edge(struct view *view, const char *direction);
void view_snap_to_edge(struct view *view, const char *direction,
bool store_natural_geometry);
SnapToRegion: Add view_snap_to_region()
2022-07-06 17:04:21 +02:00
void view_snap_to_region(struct view *view, struct region *region,
bool store_natural_geometry);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
const char *view_get_string_prop(struct view *view, const char *prop);
void view_update_title(struct view *view);
void view_update_app_id(struct view *view);
view: Add view_reload_ssd() Gather related logic from `reload_config_and_theme()` in `server.c` and `ssd_reload()` in `ssd.c` into a new function, `view_reload_ssd()`. Also drop the `view->mapped` check since we want to update any view that has SSD nodes created, mapped or not.
2022-11-26 02:13:42 -05:00
void view_reload_ssd(struct view *view);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_adjust_size(struct view *view, int *w, int *h);
view: Add view_evacuate_region() helper v2: Modify asserts as suggested by Consolatis
2023-02-16 11:54:18 -05:00
void view_evacuate_region(struct view *view);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
void view_on_output_destroy(struct view *view);
void view_destroy(struct view *view);
view: Move xdg_surface + xwayland_surface to derived structs Add xdg_surface_from_view() + xwayland_surface_from_view() accessors that assert() the view is of the expected type before returning. Fix a real bug in xdg.c parent_of() that dereferenced `view->xdg_surface->toplevel` without first checking `view->type`. The goal of the new accessors is to catch similar bugs in future.
2022-11-25 13:41:12 -05:00
/* xdg.c */
struct wlr_xdg_surface *xdg_surface_from_view(struct view *view);
include: Break out view.h from labwc.h IMHO it encourages better design (by making dependencies more obvious) to have source file/header file pairs like view.c/view.h, rather than a monolithic header like labwc.h with everything in it. I don't think we need to break up all of labwc.h at once, but maybe we can start pulling it apart bit by bit as it's convenient. Also: - Move "struct border" to ssd.h so that view.h can use it without pulling in all of labwc.h. - Add a missing required #include within scaled_font_buffer.h (forward declaration of "struct font" is not enough).
2022-11-21 10:10:39 -05:00
#endif /* __LABWC_VIEW_H */
Reference in a new issue Copy permalink