wlroots/include/wlr/xwayland.h

313 lines
8.1 KiB
C
Raw Normal View History

/*
* This an unstable interface of wlroots. No guarantees are made regarding the
* future consistency of this API.
*/
#ifndef WLR_USE_UNSTABLE
#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
#endif
#ifndef WLR_XWAYLAND_H
#define WLR_XWAYLAND_H
#include <stdbool.h>
2018-02-12 20:29:23 +00:00
#include <time.h>
#include <wlr/config.h>
#include <wlr/types/wlr_compositor.h>
2017-11-22 13:10:06 +00:00
#include <wlr/types/wlr_seat.h>
#include <xcb/xcb.h>
struct wlr_xwm;
2017-11-02 15:49:22 +00:00
struct wlr_xwayland_cursor;
struct wlr_xwayland_server {
pid_t pid;
struct wl_client *client;
struct wl_event_source *sigusr1_source;
int wm_fd[2], wl_fd[2];
time_t server_start;
2017-09-28 12:54:57 +00:00
/* Anything above display is reset on Xwayland restart, rest is conserved */
int display;
char display_name[16];
int x_fd[2];
struct wl_event_source *x_fd_read_event[2];
bool lazy;
2020-05-19 15:28:23 +00:00
bool enable_wm;
struct wl_display *wl_display;
struct {
struct wl_signal ready;
struct wl_signal destroy;
} events;
struct wl_listener client_destroy;
struct wl_listener display_destroy;
void *data;
};
2020-05-19 15:28:23 +00:00
struct wlr_xwayland_server_options {
bool lazy;
bool enable_wm;
};
struct wlr_xwayland_server_ready_event {
struct wlr_xwayland_server *server;
int wm_fd;
};
struct wlr_xwayland {
struct wlr_xwayland_server *server;
struct wlr_xwm *xwm;
struct wlr_xwayland_cursor *cursor;
const char *display_name;
struct wl_display *wl_display;
struct wlr_compositor *compositor;
struct wlr_seat *seat;
2017-09-28 12:54:57 +00:00
struct {
struct wl_signal ready;
2017-09-28 12:54:57 +00:00
struct wl_signal new_surface;
} events;
2017-12-13 22:54:19 +00:00
/**
* Add a custom event handler to xwayland. Return 1 if the event was
* handled or 0 to use the default wlr-xwayland handler. wlr-xwayland will
* free the event.
*/
int (*user_event_handler)(struct wlr_xwm *xwm, xcb_generic_event_t *event);
struct wl_listener server_ready;
struct wl_listener server_destroy;
struct wl_listener seat_destroy;
2017-09-28 12:54:57 +00:00
void *data;
};
2017-10-05 14:49:47 +00:00
enum wlr_xwayland_surface_decorations {
WLR_XWAYLAND_SURFACE_DECORATIONS_ALL = 0,
WLR_XWAYLAND_SURFACE_DECORATIONS_NO_BORDER = 1,
WLR_XWAYLAND_SURFACE_DECORATIONS_NO_TITLE = 2,
};
2017-10-05 20:23:37 +00:00
struct wlr_xwayland_surface_hints {
uint32_t flags;
uint32_t input;
int32_t initial_state;
xcb_pixmap_t icon_pixmap;
xcb_window_t icon_window;
int32_t icon_x, icon_y;
xcb_pixmap_t icon_mask;
xcb_window_t window_group;
};
struct wlr_xwayland_surface_size_hints {
uint32_t flags;
int32_t x, y;
int32_t width, height;
int32_t min_width, min_height;
int32_t max_width, max_height;
int32_t width_inc, height_inc;
int32_t base_width, base_height;
int32_t min_aspect_num, min_aspect_den;
int32_t max_aspect_num, max_aspect_den;
uint32_t win_gravity;
};
2018-04-12 03:09:13 +00:00
/**
* An Xwayland user interface component. It has an absolute position in
* layout-local coordinates.
*
* When a surface is ready to be displayed, the `map` event is emitted. When a
* surface should no longer be displayed, the `unmap` event is emitted. The
2018-05-03 20:59:43 +00:00
* `unmap` event is guaranteed to be emitted before the `destroy` event if the
2018-04-12 03:09:13 +00:00
* view is destroyed when mapped.
*/
struct wlr_xwayland_surface {
xcb_window_t window_id;
struct wlr_xwm *xwm;
uint32_t surface_id;
2017-10-24 18:37:18 +00:00
struct wl_list link;
2017-10-24 18:37:18 +00:00
struct wl_list unpaired_link;
2017-09-28 12:54:57 +00:00
struct wlr_surface *surface;
int16_t x, y;
uint16_t width, height;
2017-10-27 17:05:14 +00:00
uint16_t saved_width, saved_height;
bool override_redirect;
bool mapped;
2017-09-28 12:54:57 +00:00
2017-09-29 13:57:21 +00:00
char *title;
char *class;
char *instance;
2018-09-03 07:07:07 +00:00
char *role;
2017-09-29 20:43:14 +00:00
pid_t pid;
bool has_utf8_title;
2017-09-29 13:57:21 +00:00
struct wl_list children; // wlr_xwayland_surface::parent_link
struct wlr_xwayland_surface *parent;
struct wl_list parent_link; // wlr_xwayland_surface::children
2017-09-29 21:03:01 +00:00
xcb_atom_t *window_type;
size_t window_type_len;
xcb_atom_t *protocols;
size_t protocols_len;
2017-10-05 14:49:47 +00:00
uint32_t decorations;
2017-10-05 20:23:37 +00:00
struct wlr_xwayland_surface_hints *hints;
uint32_t hints_urgency;
struct wlr_xwayland_surface_size_hints *size_hints;
2018-04-08 20:28:01 +00:00
bool pinging;
struct wl_event_source *ping_timer;
// _NET_WM_STATE
bool modal;
bool fullscreen;
2018-04-12 03:09:13 +00:00
bool maximized_vert, maximized_horz;
2020-07-18 19:37:02 +00:00
bool minimized;
bool has_alpha;
2017-09-28 12:54:57 +00:00
struct {
struct wl_signal destroy;
struct wl_signal request_configure;
2017-10-27 14:48:09 +00:00
struct wl_signal request_move;
struct wl_signal request_resize;
2020-07-18 19:37:02 +00:00
struct wl_signal request_minimize;
2017-10-27 17:05:14 +00:00
struct wl_signal request_maximize;
struct wl_signal request_fullscreen;
struct wl_signal request_activate;
2017-10-27 17:05:14 +00:00
struct wl_signal map;
struct wl_signal unmap;
struct wl_signal set_title;
struct wl_signal set_class;
2018-09-03 07:07:07 +00:00
struct wl_signal set_role;
2017-09-29 18:22:35 +00:00
struct wl_signal set_parent;
2017-09-29 21:03:01 +00:00
struct wl_signal set_pid;
struct wl_signal set_window_type;
2018-07-19 11:07:11 +00:00
struct wl_signal set_hints;
struct wl_signal set_decorations;
struct wl_signal set_override_redirect;
struct wl_signal set_geometry;
2018-04-08 20:28:01 +00:00
struct wl_signal ping_timeout;
2017-09-28 12:54:57 +00:00
} events;
struct wl_listener surface_destroy;
2017-09-28 12:54:57 +00:00
void *data;
};
struct wlr_xwayland_surface_configure_event {
struct wlr_xwayland_surface *surface;
int16_t x, y;
uint16_t width, height;
uint16_t mask; // xcb_config_window_t
};
2017-10-27 14:48:09 +00:00
// TODO: maybe add a seat to these
struct wlr_xwayland_move_event {
struct wlr_xwayland_surface *surface;
};
struct wlr_xwayland_resize_event {
struct wlr_xwayland_surface *surface;
uint32_t edges;
};
2020-07-18 19:37:02 +00:00
struct wlr_xwayland_minimize_event {
struct wlr_xwayland_surface *surface;
bool minimize;
};
struct wlr_xwayland_server *wlr_xwayland_server_create(
2020-05-19 15:28:23 +00:00
struct wl_display *display, struct wlr_xwayland_server_options *options);
void wlr_xwayland_server_destroy(struct wlr_xwayland_server *server);
/** Create an Xwayland server and XWM.
2018-08-02 22:29:34 +00:00
*
* The server supports a lazy mode in which Xwayland is only started when a
* client tries to connect.
*
* Note: wlr_xwayland will setup a global SIGUSR1 handler on the compositor
* process.
*/
struct wlr_xwayland *wlr_xwayland_create(struct wl_display *wl_display,
struct wlr_compositor *compositor, bool lazy);
2017-10-27 17:05:14 +00:00
void wlr_xwayland_destroy(struct wlr_xwayland *wlr_xwayland);
2017-11-02 15:49:22 +00:00
void wlr_xwayland_set_cursor(struct wlr_xwayland *wlr_xwayland,
uint8_t *pixels, uint32_t stride, uint32_t width, uint32_t height,
int32_t hotspot_x, int32_t hotspot_y);
void wlr_xwayland_surface_activate(struct wlr_xwayland_surface *surface,
2018-03-31 04:35:08 +00:00
bool activated);
2017-10-27 17:05:14 +00:00
/**
* Restack surface relative to sibling.
* If sibling is NULL, then the surface is moved to the top or the bottom
* of the stack (depending on the mode).
*/
void wlr_xwayland_surface_restack(struct wlr_xwayland_surface *surface,
struct wlr_xwayland_surface *sibling, enum xcb_stack_mode_t mode);
void wlr_xwayland_surface_configure(struct wlr_xwayland_surface *surface,
2018-03-31 04:35:08 +00:00
int16_t x, int16_t y, uint16_t width, uint16_t height);
2017-10-27 17:05:14 +00:00
void wlr_xwayland_surface_close(struct wlr_xwayland_surface *surface);
2020-07-18 19:37:02 +00:00
void wlr_xwayland_surface_set_minimized(struct wlr_xwayland_surface *surface,
bool minimized);
void wlr_xwayland_surface_set_maximized(struct wlr_xwayland_surface *surface,
2018-03-31 04:35:08 +00:00
bool maximized);
2017-10-27 17:05:14 +00:00
void wlr_xwayland_surface_set_fullscreen(struct wlr_xwayland_surface *surface,
2018-03-31 04:35:08 +00:00
bool fullscreen);
2017-10-27 17:05:14 +00:00
2017-11-22 13:10:06 +00:00
void wlr_xwayland_set_seat(struct wlr_xwayland *xwayland,
2018-03-31 04:35:08 +00:00
struct wlr_seat *seat);
2018-04-03 00:57:09 +00:00
bool wlr_surface_is_xwayland_surface(struct wlr_surface *surface);
struct wlr_xwayland_surface *wlr_xwayland_surface_from_wlr_surface(
2018-04-08 20:28:01 +00:00
struct wlr_surface *surface);
void wlr_xwayland_surface_ping(struct wlr_xwayland_surface *surface);
2018-04-03 00:57:09 +00:00
/** Metric to guess if an OR window should "receive" focus
*
* In the pure X setups, window managers usually straight up ignore override
* redirect windows, and never touch them. (we have to handle them for mapping)
*
* When such a window wants to receive keyboard input (e.g. rofi/dzen) it will
* use mechanics we don't support (sniffing/grabbing input).
* [Sadly this is unrelated to xwayland-keyboard-grab]
*
* To still support these windows, while keeping general OR semantics as is, we
* need to hand a subset of windows focus.
* The dirty truth is, we need to hand focus to any Xwayland window, though
* pretending this window has focus makes it easier to handle unmap.
*
* This function provides a handy metric based on the window type to guess if
* the OR window wants focus.
* It's probably not perfect, nor exactly intended but works in practice.
*
* Returns: true if the window should receive focus
* false if it should be ignored
*/
bool wlr_xwayland_or_surface_wants_focus(
const struct wlr_xwayland_surface *surface);
#endif