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"
31 #include "subsurface-client-protocol.h"
33 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
35 #define container_of(ptr, type, member) ({ \
36 const __typeof__( ((type *)0)->member ) *__mptr = (ptr); \
37 (type *)( (char *)__mptr - offsetof(type,member) );})
46 void (*run)(struct task *task, uint32_t events);
58 fail_on_null(void *p);
64 xstrdup(const char *s);
67 display_create(int *argc, char *argv[]);
70 display_destroy(struct display *display);
73 display_set_user_data(struct display *display, void *data);
76 display_get_user_data(struct display *display);
79 display_get_display(struct display *display);
82 display_has_subcompositor(struct display *display);
85 display_get_cairo_device(struct display *display);
87 struct wl_compositor *
88 display_get_compositor(struct display *display);
91 display_get_shell(struct display *display);
94 display_get_output(struct display *display);
97 display_get_serial(struct display *display);
99 typedef void (*display_global_handler_t)(struct display *display,
101 const char *interface,
102 uint32_t version, void *data);
105 display_set_global_handler(struct display *display,
106 display_global_handler_t handler);
108 display_bind(struct display *display, uint32_t name,
109 const struct wl_interface *interface, uint32_t version);
111 typedef void (*display_output_handler_t)(struct output *output, void *data);
114 * The output configure handler is called, when a new output is connected
115 * and we know its current mode, or when the current mode changes.
116 * Test and set the output user data in your handler to know, if the
117 * output is new. Note: 'data' in the configure handler is the display
121 display_set_output_configure_handler(struct display *display,
122 display_output_handler_t handler);
124 struct wl_data_source *
125 display_create_data_source(struct display *display);
127 #ifdef EGL_NO_DISPLAY
129 display_get_egl_display(struct display *d);
132 display_get_argb_egl_config(struct display *d);
135 display_acquire_window_surface(struct display *display,
136 struct window *window,
139 display_release_window_surface(struct display *display,
140 struct window *window);
143 #define SURFACE_OPAQUE 0x01
144 #define SURFACE_SHM 0x02
146 #define SURFACE_HINT_RESIZE 0x10
148 #define SURFACE_HINT_RGB565 0x100
151 display_create_surface(struct display *display,
152 struct wl_surface *surface,
153 struct rectangle *rectangle,
157 display_get_buffer_for_surface(struct display *display,
158 cairo_surface_t *surface);
160 struct wl_cursor_image *
161 display_get_pointer_image(struct display *display, int pointer);
164 display_defer(struct display *display, struct task *task);
167 display_watch_fd(struct display *display,
168 int fd, uint32_t events, struct task *task);
171 display_unwatch_fd(struct display *display, int fd);
174 display_run(struct display *d);
177 display_exit(struct display *d);
197 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
198 uint32_t time, uint32_t key, uint32_t unicode,
199 enum wl_keyboard_key_state state, void *data);
201 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
202 struct input *device, void *data);
204 typedef void (*window_data_handler_t)(struct window *window,
210 typedef void (*window_drop_handler_t)(struct window *window,
212 int32_t x, int32_t y, void *data);
214 typedef void (*window_close_handler_t)(struct window *window, void *data);
215 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
217 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
218 int enter, void *data);
220 typedef void (*widget_resize_handler_t)(struct widget *widget,
221 int32_t width, int32_t height,
223 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
225 typedef int (*widget_enter_handler_t)(struct widget *widget,
227 float x, float y, void *data);
228 typedef void (*widget_leave_handler_t)(struct widget *widget,
229 struct input *input, void *data);
230 typedef int (*widget_motion_handler_t)(struct widget *widget,
231 struct input *input, uint32_t time,
232 float x, float y, void *data);
233 typedef void (*widget_button_handler_t)(struct widget *widget,
234 struct input *input, uint32_t time,
236 enum wl_pointer_button_state state,
238 typedef void (*widget_touch_down_handler_t)(struct widget *widget,
245 typedef void (*widget_touch_up_handler_t)(struct widget *widget,
250 typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
256 typedef void (*widget_touch_frame_handler_t)(struct widget *widget,void *data);
257 typedef void (*widget_touch_cancel_handler_t)(struct widget *widget, void *data);
258 typedef void (*widget_axis_handler_t)(struct widget *widget,
259 struct input *input, uint32_t time,
265 window_create(struct display *display);
267 window_create_transient(struct display *display, struct window *parent,
268 int32_t x, int32_t y, uint32_t flags);
270 window_create_custom(struct display *display);
273 window_has_focus(struct window *window);
275 typedef void (*menu_func_t)(struct window *window, int index, void *data);
278 window_show_menu(struct display *display,
279 struct input *input, uint32_t time, struct window *parent,
280 int32_t x, int32_t y,
281 menu_func_t func, const char **entries, int count);
284 window_show_frame_menu(struct window *window,
285 struct input *input, uint32_t time);
288 window_get_buffer_transform(struct window *window);
291 window_set_buffer_transform(struct window *window,
292 enum wl_output_transform transform);
295 window_get_buffer_scale(struct window *window);
298 window_set_buffer_scale(struct window *window,
302 window_get_output_scale(struct window *window);
305 window_destroy(struct window *window);
308 window_add_widget(struct window *window, void *data);
310 enum subsurface_mode {
311 SUBSURFACE_SYNCHRONIZED,
312 SUBSURFACE_DESYNCHRONIZED
316 window_add_subsurface(struct window *window, void *data,
317 enum subsurface_mode default_mode);
319 typedef void (*data_func_t)(void *data, size_t len,
320 int32_t x, int32_t y, void *user_data);
323 window_get_display(struct window *window);
325 window_move(struct window *window, struct input *input, uint32_t time);
327 window_get_allocation(struct window *window, struct rectangle *allocation);
329 window_schedule_redraw(struct window *window);
331 window_schedule_resize(struct window *window, int width, int height);
334 window_damage(struct window *window, int32_t x, int32_t y,
335 int32_t width, int32_t height);
338 window_get_surface(struct window *window);
341 window_get_wl_surface(struct window *window);
343 struct wl_shell_surface *
344 window_get_wl_shell_surface(struct window *window);
346 enum window_buffer_type {
347 WINDOW_BUFFER_TYPE_EGL_WINDOW,
348 WINDOW_BUFFER_TYPE_SHM,
352 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
353 int32_t x, int32_t y, int32_t width, int32_t height);
356 window_set_buffer_type(struct window *window, enum window_buffer_type type);
359 window_is_fullscreen(struct window *window);
362 window_set_fullscreen(struct window *window, int fullscreen);
365 window_set_fullscreen_method(struct window *window,
366 enum wl_shell_surface_fullscreen_method method);
368 window_is_maximized(struct window *window);
371 window_set_maximized(struct window *window, int maximized);
374 window_set_user_data(struct window *window, void *data);
377 window_get_user_data(struct window *window);
380 window_set_key_handler(struct window *window,
381 window_key_handler_t handler);
384 window_set_keyboard_focus_handler(struct window *window,
385 window_keyboard_focus_handler_t handler);
388 window_set_data_handler(struct window *window,
389 window_data_handler_t handler);
392 window_set_drop_handler(struct window *window,
393 window_drop_handler_t handler);
396 window_set_close_handler(struct window *window,
397 window_close_handler_t handler);
399 window_set_fullscreen_handler(struct window *window,
400 window_fullscreen_handler_t handler);
402 window_set_output_handler(struct window *window,
403 window_output_handler_t handler);
406 window_set_title(struct window *window, const char *title);
409 window_get_title(struct window *window);
412 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
414 enum preferred_format {
415 WINDOW_PREFERRED_FORMAT_NONE,
416 WINDOW_PREFERRED_FORMAT_RGB565
420 window_set_preferred_format(struct window *window,
421 enum preferred_format format);
424 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
427 widget_destroy_tooltip(struct widget *parent);
430 widget_add_widget(struct widget *parent, void *data);
433 widget_destroy(struct widget *widget);
435 widget_set_default_cursor(struct widget *widget, int cursor);
437 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
440 widget_set_allocation(struct widget *widget,
441 int32_t x, int32_t y, int32_t width, int32_t height);
443 widget_set_size(struct widget *widget, int32_t width, int32_t height);
445 widget_set_transparent(struct widget *widget, int transparent);
447 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
450 widget_get_user_data(struct widget *widget);
453 widget_cairo_create(struct widget *widget);
456 widget_get_wl_surface(struct widget *widget);
459 widget_get_last_time(struct widget *widget);
462 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
465 widget_set_redraw_handler(struct widget *widget,
466 widget_redraw_handler_t handler);
468 widget_set_resize_handler(struct widget *widget,
469 widget_resize_handler_t handler);
471 widget_set_enter_handler(struct widget *widget,
472 widget_enter_handler_t handler);
474 widget_set_leave_handler(struct widget *widget,
475 widget_leave_handler_t handler);
477 widget_set_motion_handler(struct widget *widget,
478 widget_motion_handler_t handler);
480 widget_set_button_handler(struct widget *widget,
481 widget_button_handler_t handler);
483 widget_set_touch_down_handler(struct widget *widget,
484 widget_touch_down_handler_t handler);
486 widget_set_touch_up_handler(struct widget *widget,
487 widget_touch_up_handler_t handler);
489 widget_set_touch_motion_handler(struct widget *widget,
490 widget_touch_motion_handler_t handler);
492 widget_set_touch_frame_handler(struct widget *widget,
493 widget_touch_frame_handler_t handler);
495 widget_set_touch_cancel_handler(struct widget *widget,
496 widget_touch_cancel_handler_t handler);
498 widget_set_axis_handler(struct widget *widget,
499 widget_axis_handler_t handler);
501 widget_schedule_redraw(struct widget *widget);
504 frame_create(struct window *window, void *data);
507 frame_set_child_size(struct widget *widget, int child_width, int child_height);
510 input_set_pointer_image(struct input *input, int pointer);
513 input_get_position(struct input *input, int32_t *x, int32_t *y);
515 #define MOD_SHIFT_MASK 0x01
516 #define MOD_ALT_MASK 0x02
517 #define MOD_CONTROL_MASK 0x04
520 input_get_modifiers(struct input *input);
523 input_grab(struct input *input, struct widget *widget, uint32_t button);
526 input_ungrab(struct input *input);
529 input_get_focus_widget(struct input *input);
532 input_get_display(struct input *input);
535 input_get_seat(struct input *input);
537 struct wl_data_device *
538 input_get_data_device(struct input *input);
541 input_set_selection(struct input *input,
542 struct wl_data_source *source, uint32_t time);
545 input_accept(struct input *input, const char *type);
549 input_receive_drag_data(struct input *input, const char *mime_type,
550 data_func_t func, void *user_data);
553 input_receive_selection_data(struct input *input, const char *mime_type,
554 data_func_t func, void *data);
556 input_receive_selection_data_to_fd(struct input *input,
557 const char *mime_type, int fd);
560 output_set_user_data(struct output *output, void *data);
563 output_get_user_data(struct output *output);
566 output_set_destroy_handler(struct output *output,
567 display_output_handler_t handler);
570 output_get_allocation(struct output *output, struct rectangle *allocation);
573 output_get_wl_output(struct output *output);
575 enum wl_output_transform
576 output_get_transform(struct output *output);
579 output_get_scale(struct output *output);
582 keysym_modifiers_add(struct wl_array *modifiers_map,
586 keysym_modifiers_get_mask(struct wl_array *modifiers_map,