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 "../shared/zalloc.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 fail_on_null(void *p);
63 xstrdup(const char *s);
65 xrealloc(char *p, size_t s);
68 display_create(int *argc, char *argv[]);
71 display_destroy(struct display *display);
74 display_set_user_data(struct display *display, void *data);
77 display_get_user_data(struct display *display);
80 display_get_display(struct display *display);
83 display_has_subcompositor(struct display *display);
86 display_get_cairo_device(struct display *display);
88 struct wl_compositor *
89 display_get_compositor(struct display *display);
92 display_get_output(struct display *display);
95 display_get_serial(struct display *display);
97 typedef void (*display_global_handler_t)(struct display *display,
99 const char *interface,
100 uint32_t version, void *data);
103 display_set_global_handler(struct display *display,
104 display_global_handler_t handler);
106 display_set_global_handler_remove(struct display *display,
107 display_global_handler_t remove_handler);
109 display_bind(struct display *display, uint32_t name,
110 const struct wl_interface *interface, uint32_t version);
112 typedef void (*display_output_handler_t)(struct output *output, void *data);
115 * The output configure handler is called, when a new output is connected
116 * and we know its current mode, or when the current mode changes.
117 * Test and set the output user data in your handler to know, if the
118 * output is new. Note: 'data' in the configure handler is the display
122 display_set_output_configure_handler(struct display *display,
123 display_output_handler_t handler);
125 struct wl_data_source *
126 display_create_data_source(struct display *display);
128 #ifdef EGL_NO_DISPLAY
130 display_get_egl_display(struct display *d);
133 display_get_argb_egl_config(struct display *d);
136 display_acquire_window_surface(struct display *display,
137 struct window *window,
140 display_release_window_surface(struct display *display,
141 struct window *window);
144 #define SURFACE_OPAQUE 0x01
145 #define SURFACE_SHM 0x02
147 #define SURFACE_HINT_RESIZE 0x10
149 #define SURFACE_HINT_RGB565 0x100
152 display_create_surface(struct display *display,
153 struct wl_surface *surface,
154 struct rectangle *rectangle,
158 display_get_buffer_for_surface(struct display *display,
159 cairo_surface_t *surface);
161 struct wl_cursor_image *
162 display_get_pointer_image(struct display *display, int pointer);
165 display_defer(struct display *display, struct task *task);
168 display_watch_fd(struct display *display,
169 int fd, uint32_t events, struct task *task);
172 display_unwatch_fd(struct display *display, int fd);
175 display_run(struct display *d);
178 display_exit(struct display *d);
198 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
199 uint32_t time, uint32_t key, uint32_t unicode,
200 enum wl_keyboard_key_state state, void *data);
202 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
203 struct input *device, void *data);
205 typedef void (*window_data_handler_t)(struct window *window,
211 typedef void (*window_drop_handler_t)(struct window *window,
213 int32_t x, int32_t y, void *data);
215 typedef void (*window_close_handler_t)(void *data);
216 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
218 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
219 int enter, void *data);
221 typedef void (*widget_resize_handler_t)(struct widget *widget,
222 int32_t width, int32_t height,
224 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
226 typedef int (*widget_enter_handler_t)(struct widget *widget,
228 float x, float y, void *data);
229 typedef void (*widget_leave_handler_t)(struct widget *widget,
230 struct input *input, void *data);
231 typedef int (*widget_motion_handler_t)(struct widget *widget,
232 struct input *input, uint32_t time,
233 float x, float y, void *data);
234 typedef void (*widget_button_handler_t)(struct widget *widget,
235 struct input *input, uint32_t time,
237 enum wl_pointer_button_state state,
239 typedef void (*widget_touch_down_handler_t)(struct widget *widget,
247 typedef void (*widget_touch_up_handler_t)(struct widget *widget,
253 typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
260 typedef void (*widget_touch_frame_handler_t)(struct widget *widget,
261 struct input *input, void *data);
262 typedef void (*widget_touch_cancel_handler_t)(struct widget *widget,
263 struct input *input, void *data);
264 typedef void (*widget_axis_handler_t)(struct widget *widget,
265 struct input *input, uint32_t time,
271 window_create(struct display *display);
273 window_create_custom(struct display *display);
276 window_set_transient_for(struct window *window, struct window *parent_window);
278 window_get_transient_for(struct window *window);
281 window_has_focus(struct window *window);
283 typedef void (*menu_func_t)(struct window *window,
284 struct input *input, int index, void *data);
287 window_show_menu(struct display *display,
288 struct input *input, uint32_t time, struct window *parent,
289 int32_t x, int32_t y,
290 menu_func_t func, const char **entries, int count);
293 window_show_frame_menu(struct window *window,
294 struct input *input, uint32_t time);
297 window_get_buffer_transform(struct window *window);
300 window_set_buffer_transform(struct window *window,
301 enum wl_output_transform transform);
304 window_get_buffer_scale(struct window *window);
307 window_set_buffer_scale(struct window *window,
311 window_get_output_scale(struct window *window);
314 window_destroy(struct window *window);
317 window_add_widget(struct window *window, void *data);
319 enum subsurface_mode {
320 SUBSURFACE_SYNCHRONIZED,
321 SUBSURFACE_DESYNCHRONIZED
325 window_add_subsurface(struct window *window, void *data,
326 enum subsurface_mode default_mode);
328 typedef void (*data_func_t)(void *data, size_t len,
329 int32_t x, int32_t y, void *user_data);
332 window_get_display(struct window *window);
334 window_move(struct window *window, struct input *input, uint32_t time);
336 window_get_allocation(struct window *window, struct rectangle *allocation);
338 window_schedule_redraw(struct window *window);
340 window_schedule_resize(struct window *window, int width, int height);
343 window_damage(struct window *window, int32_t x, int32_t y,
344 int32_t width, int32_t height);
347 window_get_surface(struct window *window);
350 window_get_wl_surface(struct window *window);
352 struct wl_subsurface *
353 widget_get_wl_subsurface(struct widget *widget);
355 enum window_buffer_type {
356 WINDOW_BUFFER_TYPE_EGL_WINDOW,
357 WINDOW_BUFFER_TYPE_SHM,
361 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
362 int32_t x, int32_t y, int32_t width, int32_t height);
365 window_set_buffer_type(struct window *window, enum window_buffer_type type);
368 window_is_fullscreen(struct window *window);
371 window_set_fullscreen(struct window *window, int fullscreen);
374 window_is_maximized(struct window *window);
377 window_set_maximized(struct window *window, int maximized);
380 window_set_user_data(struct window *window, void *data);
383 window_get_user_data(struct window *window);
386 window_set_key_handler(struct window *window,
387 window_key_handler_t handler);
390 window_set_keyboard_focus_handler(struct window *window,
391 window_keyboard_focus_handler_t handler);
394 window_set_data_handler(struct window *window,
395 window_data_handler_t handler);
398 window_set_drop_handler(struct window *window,
399 window_drop_handler_t handler);
402 window_set_close_handler(struct window *window,
403 window_close_handler_t handler);
405 window_set_fullscreen_handler(struct window *window,
406 window_fullscreen_handler_t handler);
408 window_set_output_handler(struct window *window,
409 window_output_handler_t handler);
412 window_set_title(struct window *window, const char *title);
415 window_get_title(struct window *window);
418 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
420 enum preferred_format {
421 WINDOW_PREFERRED_FORMAT_NONE,
422 WINDOW_PREFERRED_FORMAT_RGB565
426 window_set_preferred_format(struct window *window,
427 enum preferred_format format);
430 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
433 widget_destroy_tooltip(struct widget *parent);
436 widget_add_widget(struct widget *parent, void *data);
439 widget_destroy(struct widget *widget);
441 widget_set_default_cursor(struct widget *widget, int cursor);
443 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
446 widget_set_allocation(struct widget *widget,
447 int32_t x, int32_t y, int32_t width, int32_t height);
449 widget_set_size(struct widget *widget, int32_t width, int32_t height);
451 widget_set_transparent(struct widget *widget, int transparent);
453 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
456 widget_get_user_data(struct widget *widget);
459 widget_cairo_create(struct widget *widget);
462 widget_get_wl_surface(struct widget *widget);
465 widget_get_last_time(struct widget *widget);
468 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
471 widget_set_redraw_handler(struct widget *widget,
472 widget_redraw_handler_t handler);
474 widget_set_resize_handler(struct widget *widget,
475 widget_resize_handler_t handler);
477 widget_set_enter_handler(struct widget *widget,
478 widget_enter_handler_t handler);
480 widget_set_leave_handler(struct widget *widget,
481 widget_leave_handler_t handler);
483 widget_set_motion_handler(struct widget *widget,
484 widget_motion_handler_t handler);
486 widget_set_button_handler(struct widget *widget,
487 widget_button_handler_t handler);
489 widget_set_touch_down_handler(struct widget *widget,
490 widget_touch_down_handler_t handler);
492 widget_set_touch_up_handler(struct widget *widget,
493 widget_touch_up_handler_t handler);
495 widget_set_touch_motion_handler(struct widget *widget,
496 widget_touch_motion_handler_t handler);
498 widget_set_touch_frame_handler(struct widget *widget,
499 widget_touch_frame_handler_t handler);
501 widget_set_touch_cancel_handler(struct widget *widget,
502 widget_touch_cancel_handler_t handler);
504 widget_set_axis_handler(struct widget *widget,
505 widget_axis_handler_t handler);
507 widget_schedule_redraw(struct widget *widget);
509 widget_set_use_cairo(struct widget *widget, int use_cairo);
512 window_frame_create(struct window *window, void *data);
515 window_frame_set_child_size(struct widget *widget, int child_width,
519 input_set_pointer_image(struct input *input, int pointer);
522 input_get_position(struct input *input, int32_t *x, int32_t *y);
525 input_get_touch(struct input *input, int32_t id, float *x, float *y);
527 #define MOD_SHIFT_MASK 0x01
528 #define MOD_ALT_MASK 0x02
529 #define MOD_CONTROL_MASK 0x04
532 input_get_modifiers(struct input *input);
535 touch_grab(struct input *input, int32_t touch_id);
538 touch_ungrab(struct input *input);
541 input_grab(struct input *input, struct widget *widget, uint32_t button);
544 input_ungrab(struct input *input);
547 input_get_focus_widget(struct input *input);
550 input_get_display(struct input *input);
553 input_get_seat(struct input *input);
555 struct wl_data_device *
556 input_get_data_device(struct input *input);
559 input_set_selection(struct input *input,
560 struct wl_data_source *source, uint32_t time);
563 input_accept(struct input *input, const char *type);
567 input_receive_drag_data(struct input *input, const char *mime_type,
568 data_func_t func, void *user_data);
570 input_receive_drag_data_to_fd(struct input *input,
571 const char *mime_type, int fd);
574 input_receive_selection_data(struct input *input, const char *mime_type,
575 data_func_t func, void *data);
577 input_receive_selection_data_to_fd(struct input *input,
578 const char *mime_type, int fd);
581 output_set_user_data(struct output *output, void *data);
584 output_get_user_data(struct output *output);
587 output_set_destroy_handler(struct output *output,
588 display_output_handler_t handler);
591 output_get_allocation(struct output *output, struct rectangle *allocation);
594 output_get_wl_output(struct output *output);
596 enum wl_output_transform
597 output_get_transform(struct output *output);
600 output_get_scale(struct output *output);
603 keysym_modifiers_add(struct wl_array *modifiers_map,
607 keysym_modifiers_get_mask(struct wl_array *modifiers_map,