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,
246 typedef void (*widget_touch_up_handler_t)(struct widget *widget,
252 typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
259 typedef void (*widget_touch_frame_handler_t)(struct widget *widget,
260 struct input *input, void *data);
261 typedef void (*widget_touch_cancel_handler_t)(struct widget *widget,
262 struct input *input, void *data);
263 typedef void (*widget_axis_handler_t)(struct widget *widget,
264 struct input *input, uint32_t time,
270 window_create(struct display *display);
272 window_create_transient(struct display *display, struct window *parent,
273 int32_t x, int32_t y, uint32_t flags);
275 window_create_custom(struct display *display);
278 window_has_focus(struct window *window);
280 typedef void (*menu_func_t)(struct window *window,
281 struct input *input, int index, void *data);
284 window_show_menu(struct display *display,
285 struct input *input, uint32_t time, struct window *parent,
286 int32_t x, int32_t y,
287 menu_func_t func, const char **entries, int count);
290 window_show_frame_menu(struct window *window,
291 struct input *input, uint32_t time);
294 window_get_buffer_transform(struct window *window);
297 window_set_buffer_transform(struct window *window,
298 enum wl_output_transform transform);
301 window_get_buffer_scale(struct window *window);
304 window_set_buffer_scale(struct window *window,
308 window_get_output_scale(struct window *window);
311 window_destroy(struct window *window);
314 window_add_widget(struct window *window, void *data);
316 enum subsurface_mode {
317 SUBSURFACE_SYNCHRONIZED,
318 SUBSURFACE_DESYNCHRONIZED
322 window_add_subsurface(struct window *window, void *data,
323 enum subsurface_mode default_mode);
325 typedef void (*data_func_t)(void *data, size_t len,
326 int32_t x, int32_t y, void *user_data);
329 window_get_display(struct window *window);
331 window_move(struct window *window, struct input *input, uint32_t time);
333 window_touch_move(struct window *window, struct input *input, uint32_t time);
335 window_get_allocation(struct window *window, struct rectangle *allocation);
337 window_schedule_redraw(struct window *window);
339 window_schedule_resize(struct window *window, int width, int height);
342 window_damage(struct window *window, int32_t x, int32_t y,
343 int32_t width, int32_t height);
346 window_get_surface(struct window *window);
349 window_get_wl_surface(struct window *window);
351 struct wl_shell_surface *
352 window_get_wl_shell_surface(struct window *window);
354 enum window_buffer_type {
355 WINDOW_BUFFER_TYPE_EGL_WINDOW,
356 WINDOW_BUFFER_TYPE_SHM,
360 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
361 int32_t x, int32_t y, int32_t width, int32_t height);
364 window_set_buffer_type(struct window *window, enum window_buffer_type type);
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 input_grab(struct input *input, struct widget *widget, uint32_t button);
535 input_ungrab(struct input *input);
538 input_get_focus_widget(struct input *input);
541 input_get_display(struct input *input);
544 input_get_seat(struct input *input);
546 struct wl_data_device *
547 input_get_data_device(struct input *input);
550 input_set_selection(struct input *input,
551 struct wl_data_source *source, uint32_t time);
554 input_accept(struct input *input, const char *type);
558 input_receive_drag_data(struct input *input, const char *mime_type,
559 data_func_t func, void *user_data);
561 input_receive_drag_data_to_fd(struct input *input,
562 const char *mime_type, int fd);
565 input_receive_selection_data(struct input *input, const char *mime_type,
566 data_func_t func, void *data);
568 input_receive_selection_data_to_fd(struct input *input,
569 const char *mime_type, int fd);
572 output_set_user_data(struct output *output, void *data);
575 output_get_user_data(struct output *output);
578 output_set_destroy_handler(struct output *output,
579 display_output_handler_t handler);
582 output_get_allocation(struct output *output, struct rectangle *allocation);
585 output_get_wl_output(struct output *output);
587 enum wl_output_transform
588 output_get_transform(struct output *output);
591 output_get_scale(struct output *output);
594 keysym_modifiers_add(struct wl_array *modifiers_map,
598 keysym_modifiers_get_mask(struct wl_array *modifiers_map,