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);
66 display_create(int *argc, char *argv[]);
69 display_destroy(struct display *display);
72 display_set_user_data(struct display *display, void *data);
75 display_get_user_data(struct display *display);
78 display_get_display(struct display *display);
81 display_has_subcompositor(struct display *display);
84 display_get_cairo_device(struct display *display);
86 struct wl_compositor *
87 display_get_compositor(struct display *display);
90 display_get_output(struct display *display);
93 display_get_serial(struct display *display);
95 typedef void (*display_global_handler_t)(struct display *display,
97 const char *interface,
98 uint32_t version, void *data);
101 display_set_global_handler(struct display *display,
102 display_global_handler_t handler);
104 display_set_global_handler_remove(struct display *display,
105 display_global_handler_t remove_handler);
107 display_bind(struct display *display, uint32_t name,
108 const struct wl_interface *interface, uint32_t version);
110 typedef void (*display_output_handler_t)(struct output *output, void *data);
113 * The output configure handler is called, when a new output is connected
114 * and we know its current mode, or when the current mode changes.
115 * Test and set the output user data in your handler to know, if the
116 * output is new. Note: 'data' in the configure handler is the display
120 display_set_output_configure_handler(struct display *display,
121 display_output_handler_t handler);
123 struct wl_data_source *
124 display_create_data_source(struct display *display);
126 #ifdef EGL_NO_DISPLAY
128 display_get_egl_display(struct display *d);
131 display_get_argb_egl_config(struct display *d);
134 display_acquire_window_surface(struct display *display,
135 struct window *window,
138 display_release_window_surface(struct display *display,
139 struct window *window);
142 #define SURFACE_OPAQUE 0x01
143 #define SURFACE_SHM 0x02
145 #define SURFACE_HINT_RESIZE 0x10
147 #define SURFACE_HINT_RGB565 0x100
150 display_create_surface(struct display *display,
151 struct wl_surface *surface,
152 struct rectangle *rectangle,
156 display_get_buffer_for_surface(struct display *display,
157 cairo_surface_t *surface);
159 struct wl_cursor_image *
160 display_get_pointer_image(struct display *display, int pointer);
163 display_defer(struct display *display, struct task *task);
166 display_watch_fd(struct display *display,
167 int fd, uint32_t events, struct task *task);
170 display_unwatch_fd(struct display *display, int fd);
173 display_run(struct display *d);
176 display_exit(struct display *d);
196 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
197 uint32_t time, uint32_t key, uint32_t unicode,
198 enum wl_keyboard_key_state state, void *data);
200 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
201 struct input *device, void *data);
203 typedef void (*window_data_handler_t)(struct window *window,
209 typedef void (*window_drop_handler_t)(struct window *window,
211 int32_t x, int32_t y, void *data);
213 typedef void (*window_close_handler_t)(void *data);
214 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
216 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
217 int enter, void *data);
219 typedef void (*widget_resize_handler_t)(struct widget *widget,
220 int32_t width, int32_t height,
222 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
224 typedef int (*widget_enter_handler_t)(struct widget *widget,
226 float x, float y, void *data);
227 typedef void (*widget_leave_handler_t)(struct widget *widget,
228 struct input *input, void *data);
229 typedef int (*widget_motion_handler_t)(struct widget *widget,
230 struct input *input, uint32_t time,
231 float x, float y, void *data);
232 typedef void (*widget_button_handler_t)(struct widget *widget,
233 struct input *input, uint32_t time,
235 enum wl_pointer_button_state state,
237 typedef void (*widget_touch_down_handler_t)(struct widget *widget,
245 typedef void (*widget_touch_up_handler_t)(struct widget *widget,
251 typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
258 typedef void (*widget_touch_frame_handler_t)(struct widget *widget,
259 struct input *input, void *data);
260 typedef void (*widget_touch_cancel_handler_t)(struct widget *widget,
261 struct input *input, void *data);
262 typedef void (*widget_axis_handler_t)(struct widget *widget,
263 struct input *input, uint32_t time,
269 window_create(struct display *display);
271 window_create_transient(struct display *display, struct window *parent,
272 int32_t x, int32_t y, uint32_t flags);
274 window_create_custom(struct display *display);
277 window_has_focus(struct window *window);
279 typedef void (*menu_func_t)(struct window *window,
280 struct input *input, int index, void *data);
283 window_show_menu(struct display *display,
284 struct input *input, uint32_t time, struct window *parent,
285 int32_t x, int32_t y,
286 menu_func_t func, const char **entries, int count);
289 window_show_frame_menu(struct window *window,
290 struct input *input, uint32_t time);
293 window_get_buffer_transform(struct window *window);
296 window_set_buffer_transform(struct window *window,
297 enum wl_output_transform transform);
300 window_get_buffer_scale(struct window *window);
303 window_set_buffer_scale(struct window *window,
307 window_get_output_scale(struct window *window);
310 window_destroy(struct window *window);
313 window_add_widget(struct window *window, void *data);
315 enum subsurface_mode {
316 SUBSURFACE_SYNCHRONIZED,
317 SUBSURFACE_DESYNCHRONIZED
321 window_add_subsurface(struct window *window, void *data,
322 enum subsurface_mode default_mode);
324 typedef void (*data_func_t)(void *data, size_t len,
325 int32_t x, int32_t y, void *user_data);
328 window_get_display(struct window *window);
330 window_move(struct window *window, struct input *input, uint32_t time);
332 window_get_allocation(struct window *window, struct rectangle *allocation);
334 window_schedule_redraw(struct window *window);
336 window_schedule_resize(struct window *window, int width, int height);
339 window_damage(struct window *window, int32_t x, int32_t y,
340 int32_t width, int32_t height);
343 window_get_surface(struct window *window);
346 window_get_wl_surface(struct window *window);
348 struct wl_subsurface *
349 widget_get_wl_subsurface(struct widget *widget);
351 enum window_buffer_type {
352 WINDOW_BUFFER_TYPE_EGL_WINDOW,
353 WINDOW_BUFFER_TYPE_SHM,
357 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
358 int32_t x, int32_t y, int32_t width, int32_t height);
361 window_set_buffer_type(struct window *window, enum window_buffer_type type);
364 window_is_transient(struct window *window);
367 window_is_fullscreen(struct window *window);
370 window_set_fullscreen(struct window *window, int fullscreen);
373 window_set_fullscreen_method(struct window *window,
374 enum wl_shell_surface_fullscreen_method method);
376 window_is_maximized(struct window *window);
379 window_set_maximized(struct window *window, int maximized);
382 window_set_user_data(struct window *window, void *data);
385 window_get_user_data(struct window *window);
388 window_set_key_handler(struct window *window,
389 window_key_handler_t handler);
392 window_set_keyboard_focus_handler(struct window *window,
393 window_keyboard_focus_handler_t handler);
396 window_set_data_handler(struct window *window,
397 window_data_handler_t handler);
400 window_set_drop_handler(struct window *window,
401 window_drop_handler_t handler);
404 window_set_close_handler(struct window *window,
405 window_close_handler_t handler);
407 window_set_fullscreen_handler(struct window *window,
408 window_fullscreen_handler_t handler);
410 window_set_output_handler(struct window *window,
411 window_output_handler_t handler);
414 window_set_title(struct window *window, const char *title);
417 window_get_title(struct window *window);
420 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
422 enum preferred_format {
423 WINDOW_PREFERRED_FORMAT_NONE,
424 WINDOW_PREFERRED_FORMAT_RGB565
428 window_set_preferred_format(struct window *window,
429 enum preferred_format format);
432 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
435 widget_destroy_tooltip(struct widget *parent);
438 widget_add_widget(struct widget *parent, void *data);
441 widget_destroy(struct widget *widget);
443 widget_set_default_cursor(struct widget *widget, int cursor);
445 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
448 widget_set_allocation(struct widget *widget,
449 int32_t x, int32_t y, int32_t width, int32_t height);
451 widget_set_size(struct widget *widget, int32_t width, int32_t height);
453 widget_set_transparent(struct widget *widget, int transparent);
455 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
458 widget_get_user_data(struct widget *widget);
461 widget_cairo_create(struct widget *widget);
464 widget_get_wl_surface(struct widget *widget);
467 widget_get_last_time(struct widget *widget);
470 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
473 widget_set_redraw_handler(struct widget *widget,
474 widget_redraw_handler_t handler);
476 widget_set_resize_handler(struct widget *widget,
477 widget_resize_handler_t handler);
479 widget_set_enter_handler(struct widget *widget,
480 widget_enter_handler_t handler);
482 widget_set_leave_handler(struct widget *widget,
483 widget_leave_handler_t handler);
485 widget_set_motion_handler(struct widget *widget,
486 widget_motion_handler_t handler);
488 widget_set_button_handler(struct widget *widget,
489 widget_button_handler_t handler);
491 widget_set_touch_down_handler(struct widget *widget,
492 widget_touch_down_handler_t handler);
494 widget_set_touch_up_handler(struct widget *widget,
495 widget_touch_up_handler_t handler);
497 widget_set_touch_motion_handler(struct widget *widget,
498 widget_touch_motion_handler_t handler);
500 widget_set_touch_frame_handler(struct widget *widget,
501 widget_touch_frame_handler_t handler);
503 widget_set_touch_cancel_handler(struct widget *widget,
504 widget_touch_cancel_handler_t handler);
506 widget_set_axis_handler(struct widget *widget,
507 widget_axis_handler_t handler);
509 widget_schedule_redraw(struct widget *widget);
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);
524 #define MOD_SHIFT_MASK 0x01
525 #define MOD_ALT_MASK 0x02
526 #define MOD_CONTROL_MASK 0x04
529 input_get_modifiers(struct input *input);
532 touch_grab(struct input *input, int32_t touch_id);
535 touch_ungrab(struct input *input);
538 input_grab(struct input *input, struct widget *widget, uint32_t button);
541 input_ungrab(struct input *input);
544 input_get_focus_widget(struct input *input);
547 input_get_display(struct input *input);
550 input_get_seat(struct input *input);
552 struct wl_data_device *
553 input_get_data_device(struct input *input);
556 input_set_selection(struct input *input,
557 struct wl_data_source *source, uint32_t time);
560 input_accept(struct input *input, const char *type);
564 input_receive_drag_data(struct input *input, const char *mime_type,
565 data_func_t func, void *user_data);
567 input_receive_drag_data_to_fd(struct input *input,
568 const char *mime_type, int fd);
571 input_receive_selection_data(struct input *input, const char *mime_type,
572 data_func_t func, void *data);
574 input_receive_selection_data_to_fd(struct input *input,
575 const char *mime_type, int fd);
578 output_set_user_data(struct output *output, void *data);
581 output_get_user_data(struct output *output);
584 output_set_destroy_handler(struct output *output,
585 display_output_handler_t handler);
588 output_get_allocation(struct output *output, struct rectangle *allocation);
591 output_get_wl_output(struct output *output);
593 enum wl_output_transform
594 output_get_transform(struct output *output);
597 output_get_scale(struct output *output);
600 keysym_modifiers_add(struct wl_array *modifiers_map,
604 keysym_modifiers_get_mask(struct wl_array *modifiers_map,