2 * Copyright © 2008 Kristian Høgsberg
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
26 #include <xkbcommon/xkbcommon.h>
27 #include <wayland-client.h>
29 #include "../shared/config-parser.h"
30 #include "subsurface-client-protocol.h"
32 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
34 #define container_of(ptr, type, member) ({ \
35 const __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
36 (type *)( (char *)__mptr - offsetof(type,member) );})
45 void (*run)(struct task *task, uint32_t events);
57 display_create(int *argc, char *argv[]);
60 display_destroy(struct display *display);
63 display_set_user_data(struct display *display, void *data);
66 display_get_user_data(struct display *display);
69 display_get_display(struct display *display);
71 struct wl_compositor *
72 display_get_compositor(struct display *display);
75 display_get_shell(struct display *display);
78 display_get_output(struct display *display);
81 display_get_serial(struct display *display);
83 typedef void (*display_global_handler_t)(struct display *display,
85 const char *interface,
86 uint32_t version, void *data);
89 display_set_global_handler(struct display *display,
90 display_global_handler_t handler);
92 display_bind(struct display *display, uint32_t name,
93 const struct wl_interface *interface, uint32_t version);
95 typedef void (*display_output_handler_t)(struct output *output, void *data);
98 * The output configure handler is called, when a new output is connected
99 * and we know its current mode, or when the current mode changes.
100 * Test and set the output user data in your handler to know, if the
101 * output is new. Note: 'data' in the configure handler is the display
105 display_set_output_configure_handler(struct display *display,
106 display_output_handler_t handler);
108 struct wl_data_source *
109 display_create_data_source(struct display *display);
111 #ifdef EGL_NO_DISPLAY
113 display_get_egl_display(struct display *d);
116 display_get_argb_egl_config(struct display *d);
119 display_acquire_window_surface(struct display *display,
120 struct window *window,
123 display_release_window_surface(struct display *display,
124 struct window *window);
127 #define SURFACE_OPAQUE 0x01
128 #define SURFACE_SHM 0x02
130 #define SURFACE_HINT_RESIZE 0x10
133 display_create_surface(struct display *display,
134 struct wl_surface *surface,
135 struct rectangle *rectangle,
139 display_get_buffer_for_surface(struct display *display,
140 cairo_surface_t *surface);
142 struct wl_cursor_image *
143 display_get_pointer_image(struct display *display, int pointer);
146 display_defer(struct display *display, struct task *task);
149 display_watch_fd(struct display *display,
150 int fd, uint32_t events, struct task *task);
153 display_unwatch_fd(struct display *display, int fd);
156 display_run(struct display *d);
159 display_exit(struct display *d);
179 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
180 uint32_t time, uint32_t key, uint32_t unicode,
181 enum wl_keyboard_key_state state, void *data);
183 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
184 struct input *device, void *data);
186 typedef void (*window_data_handler_t)(struct window *window,
192 typedef void (*window_drop_handler_t)(struct window *window,
194 int32_t x, int32_t y, void *data);
196 typedef void (*window_close_handler_t)(struct window *window, void *data);
197 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
199 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
200 int enter, void *data);
202 typedef void (*widget_resize_handler_t)(struct widget *widget,
203 int32_t width, int32_t height,
205 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
207 typedef int (*widget_enter_handler_t)(struct widget *widget,
209 float x, float y, void *data);
210 typedef void (*widget_leave_handler_t)(struct widget *widget,
211 struct input *input, void *data);
212 typedef int (*widget_motion_handler_t)(struct widget *widget,
213 struct input *input, uint32_t time,
214 float x, float y, void *data);
215 typedef void (*widget_button_handler_t)(struct widget *widget,
216 struct input *input, uint32_t time,
218 enum wl_pointer_button_state state,
220 typedef void (*widget_axis_handler_t)(struct widget *widget,
221 struct input *input, uint32_t time,
227 window_create(struct display *display);
229 window_create_transient(struct display *display, struct window *parent,
230 int32_t x, int32_t y, uint32_t flags);
232 window_create_custom(struct display *display);
235 window_has_focus(struct window *window);
237 typedef void (*menu_func_t)(struct window *window, int index, void *data);
240 window_show_menu(struct display *display,
241 struct input *input, uint32_t time, struct window *parent,
242 int32_t x, int32_t y,
243 menu_func_t func, const char **entries, int count);
246 window_show_frame_menu(struct window *window,
247 struct input *input, uint32_t time);
250 window_get_buffer_transform(struct window *window);
253 window_set_buffer_transform(struct window *window,
254 enum wl_output_transform transform);
257 window_get_buffer_scale(struct window *window);
260 window_set_buffer_scale(struct window *window,
264 window_destroy(struct window *window);
267 window_add_widget(struct window *window, void *data);
269 enum subsurface_mode {
270 SUBSURFACE_SYNCHRONIZED,
271 SUBSURFACE_DESYNCHRONIZED
275 window_add_subsurface(struct window *window, void *data,
276 enum subsurface_mode default_mode);
278 typedef void (*data_func_t)(void *data, size_t len,
279 int32_t x, int32_t y, void *user_data);
282 window_get_display(struct window *window);
284 window_move(struct window *window, struct input *input, uint32_t time);
286 window_get_allocation(struct window *window, struct rectangle *allocation);
288 window_schedule_redraw(struct window *window);
290 window_schedule_resize(struct window *window, int width, int height);
293 window_damage(struct window *window, int32_t x, int32_t y,
294 int32_t width, int32_t height);
297 window_get_surface(struct window *window);
300 window_get_wl_surface(struct window *window);
302 struct wl_shell_surface *
303 window_get_wl_shell_surface(struct window *window);
305 enum window_buffer_type {
306 WINDOW_BUFFER_TYPE_EGL_WINDOW,
307 WINDOW_BUFFER_TYPE_SHM,
311 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
312 int32_t x, int32_t y, int32_t width, int32_t height);
315 window_set_buffer_type(struct window *window, enum window_buffer_type type);
318 window_is_fullscreen(struct window *window);
321 window_set_fullscreen(struct window *window, int fullscreen);
324 window_set_fullscreen_method(struct window *window,
325 enum wl_shell_surface_fullscreen_method method);
327 window_is_maximized(struct window *window);
330 window_set_maximized(struct window *window, int maximized);
333 window_set_user_data(struct window *window, void *data);
336 window_get_user_data(struct window *window);
339 window_set_key_handler(struct window *window,
340 window_key_handler_t handler);
343 window_set_keyboard_focus_handler(struct window *window,
344 window_keyboard_focus_handler_t handler);
347 window_set_data_handler(struct window *window,
348 window_data_handler_t handler);
351 window_set_drop_handler(struct window *window,
352 window_drop_handler_t handler);
355 window_set_close_handler(struct window *window,
356 window_close_handler_t handler);
358 window_set_fullscreen_handler(struct window *window,
359 window_fullscreen_handler_t handler);
361 window_set_output_handler(struct window *window,
362 window_output_handler_t handler);
365 window_set_title(struct window *window, const char *title);
368 window_get_title(struct window *window);
371 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
374 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
377 widget_destroy_tooltip(struct widget *parent);
380 widget_add_widget(struct widget *parent, void *data);
383 widget_destroy(struct widget *widget);
385 widget_set_default_cursor(struct widget *widget, int cursor);
387 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
390 widget_set_allocation(struct widget *widget,
391 int32_t x, int32_t y, int32_t width, int32_t height);
393 widget_set_size(struct widget *widget, int32_t width, int32_t height);
395 widget_set_transparent(struct widget *widget, int transparent);
397 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
400 widget_get_user_data(struct widget *widget);
403 widget_cairo_create(struct widget *widget);
406 widget_get_wl_surface(struct widget *widget);
409 widget_get_last_time(struct widget *widget);
412 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
415 widget_set_redraw_handler(struct widget *widget,
416 widget_redraw_handler_t handler);
418 widget_set_resize_handler(struct widget *widget,
419 widget_resize_handler_t handler);
421 widget_set_enter_handler(struct widget *widget,
422 widget_enter_handler_t handler);
424 widget_set_leave_handler(struct widget *widget,
425 widget_leave_handler_t handler);
427 widget_set_motion_handler(struct widget *widget,
428 widget_motion_handler_t handler);
430 widget_set_button_handler(struct widget *widget,
431 widget_button_handler_t handler);
433 widget_set_axis_handler(struct widget *widget,
434 widget_axis_handler_t handler);
437 widget_schedule_redraw(struct widget *widget);
440 frame_create(struct window *window, void *data);
443 frame_set_child_size(struct widget *widget, int child_width, int child_height);
446 input_set_pointer_image(struct input *input, int pointer);
449 input_get_position(struct input *input, int32_t *x, int32_t *y);
451 #define MOD_SHIFT_MASK 0x01
452 #define MOD_ALT_MASK 0x02
453 #define MOD_CONTROL_MASK 0x04
456 input_get_modifiers(struct input *input);
459 input_grab(struct input *input, struct widget *widget, uint32_t button);
462 input_ungrab(struct input *input);
465 input_get_focus_widget(struct input *input);
468 input_get_display(struct input *input);
471 input_get_seat(struct input *input);
473 struct wl_data_device *
474 input_get_data_device(struct input *input);
477 input_set_selection(struct input *input,
478 struct wl_data_source *source, uint32_t time);
481 input_accept(struct input *input, const char *type);
485 input_receive_drag_data(struct input *input, const char *mime_type,
486 data_func_t func, void *user_data);
489 input_receive_selection_data(struct input *input, const char *mime_type,
490 data_func_t func, void *data);
492 input_receive_selection_data_to_fd(struct input *input,
493 const char *mime_type, int fd);
496 output_set_user_data(struct output *output, void *data);
499 output_get_user_data(struct output *output);
502 output_set_destroy_handler(struct output *output,
503 display_output_handler_t handler);
506 output_get_allocation(struct output *output, struct rectangle *allocation);
509 output_get_wl_output(struct output *output);
511 enum wl_output_transform
512 output_get_transform(struct output *output);
515 output_get_scale(struct output *output);
518 keysym_modifiers_add(struct wl_array *modifiers_map,
522 keysym_modifiers_get_mask(struct wl_array *modifiers_map,