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_get_cairo_device(struct display *display);
84 struct wl_compositor *
85 display_get_compositor(struct display *display);
88 display_get_shell(struct display *display);
91 display_get_output(struct display *display);
94 display_get_serial(struct display *display);
96 typedef void (*display_global_handler_t)(struct display *display,
98 const char *interface,
99 uint32_t version, void *data);
102 display_set_global_handler(struct display *display,
103 display_global_handler_t handler);
105 display_bind(struct display *display, uint32_t name,
106 const struct wl_interface *interface, uint32_t version);
108 typedef void (*display_output_handler_t)(struct output *output, void *data);
111 * The output configure handler is called, when a new output is connected
112 * and we know its current mode, or when the current mode changes.
113 * Test and set the output user data in your handler to know, if the
114 * output is new. Note: 'data' in the configure handler is the display
118 display_set_output_configure_handler(struct display *display,
119 display_output_handler_t handler);
121 struct wl_data_source *
122 display_create_data_source(struct display *display);
124 #ifdef EGL_NO_DISPLAY
126 display_get_egl_display(struct display *d);
129 display_get_argb_egl_config(struct display *d);
132 display_acquire_window_surface(struct display *display,
133 struct window *window,
136 display_release_window_surface(struct display *display,
137 struct window *window);
140 #define SURFACE_OPAQUE 0x01
141 #define SURFACE_SHM 0x02
143 #define SURFACE_HINT_RESIZE 0x10
145 #define SURFACE_HINT_RGB565 0x100
148 display_create_surface(struct display *display,
149 struct wl_surface *surface,
150 struct rectangle *rectangle,
154 display_get_buffer_for_surface(struct display *display,
155 cairo_surface_t *surface);
157 struct wl_cursor_image *
158 display_get_pointer_image(struct display *display, int pointer);
161 display_defer(struct display *display, struct task *task);
164 display_watch_fd(struct display *display,
165 int fd, uint32_t events, struct task *task);
168 display_unwatch_fd(struct display *display, int fd);
171 display_run(struct display *d);
174 display_exit(struct display *d);
194 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
195 uint32_t time, uint32_t key, uint32_t unicode,
196 enum wl_keyboard_key_state state, void *data);
198 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
199 struct input *device, void *data);
201 typedef void (*window_data_handler_t)(struct window *window,
207 typedef void (*window_drop_handler_t)(struct window *window,
209 int32_t x, int32_t y, void *data);
211 typedef void (*window_close_handler_t)(struct window *window, void *data);
212 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
214 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
215 int enter, void *data);
217 typedef void (*widget_resize_handler_t)(struct widget *widget,
218 int32_t width, int32_t height,
220 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
222 typedef int (*widget_enter_handler_t)(struct widget *widget,
224 float x, float y, void *data);
225 typedef void (*widget_leave_handler_t)(struct widget *widget,
226 struct input *input, void *data);
227 typedef int (*widget_motion_handler_t)(struct widget *widget,
228 struct input *input, uint32_t time,
229 float x, float y, void *data);
230 typedef void (*widget_button_handler_t)(struct widget *widget,
231 struct input *input, uint32_t time,
233 enum wl_pointer_button_state state,
235 typedef void (*widget_axis_handler_t)(struct widget *widget,
236 struct input *input, uint32_t time,
242 window_create(struct display *display);
244 window_create_transient(struct display *display, struct window *parent,
245 int32_t x, int32_t y, uint32_t flags);
247 window_create_custom(struct display *display);
250 window_has_focus(struct window *window);
252 typedef void (*menu_func_t)(struct window *window, int index, void *data);
255 window_show_menu(struct display *display,
256 struct input *input, uint32_t time, struct window *parent,
257 int32_t x, int32_t y,
258 menu_func_t func, const char **entries, int count);
261 window_show_frame_menu(struct window *window,
262 struct input *input, uint32_t time);
265 window_get_buffer_transform(struct window *window);
268 window_set_buffer_transform(struct window *window,
269 enum wl_output_transform transform);
272 window_get_buffer_scale(struct window *window);
275 window_set_buffer_scale(struct window *window,
279 window_get_output_scale(struct window *window);
282 window_destroy(struct window *window);
285 window_add_widget(struct window *window, void *data);
287 enum subsurface_mode {
288 SUBSURFACE_SYNCHRONIZED,
289 SUBSURFACE_DESYNCHRONIZED
293 window_add_subsurface(struct window *window, void *data,
294 enum subsurface_mode default_mode);
296 typedef void (*data_func_t)(void *data, size_t len,
297 int32_t x, int32_t y, void *user_data);
300 window_get_display(struct window *window);
302 window_move(struct window *window, struct input *input, uint32_t time);
304 window_get_allocation(struct window *window, struct rectangle *allocation);
306 window_schedule_redraw(struct window *window);
308 window_schedule_resize(struct window *window, int width, int height);
311 window_damage(struct window *window, int32_t x, int32_t y,
312 int32_t width, int32_t height);
315 window_get_surface(struct window *window);
318 window_get_wl_surface(struct window *window);
320 struct wl_shell_surface *
321 window_get_wl_shell_surface(struct window *window);
323 enum window_buffer_type {
324 WINDOW_BUFFER_TYPE_EGL_WINDOW,
325 WINDOW_BUFFER_TYPE_SHM,
329 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
330 int32_t x, int32_t y, int32_t width, int32_t height);
333 window_set_buffer_type(struct window *window, enum window_buffer_type type);
336 window_is_fullscreen(struct window *window);
339 window_set_fullscreen(struct window *window, int fullscreen);
342 window_set_fullscreen_method(struct window *window,
343 enum wl_shell_surface_fullscreen_method method);
345 window_is_maximized(struct window *window);
348 window_set_maximized(struct window *window, int maximized);
351 window_set_user_data(struct window *window, void *data);
354 window_get_user_data(struct window *window);
357 window_set_key_handler(struct window *window,
358 window_key_handler_t handler);
361 window_set_keyboard_focus_handler(struct window *window,
362 window_keyboard_focus_handler_t handler);
365 window_set_data_handler(struct window *window,
366 window_data_handler_t handler);
369 window_set_drop_handler(struct window *window,
370 window_drop_handler_t handler);
373 window_set_close_handler(struct window *window,
374 window_close_handler_t handler);
376 window_set_fullscreen_handler(struct window *window,
377 window_fullscreen_handler_t handler);
379 window_set_output_handler(struct window *window,
380 window_output_handler_t handler);
383 window_set_title(struct window *window, const char *title);
386 window_get_title(struct window *window);
389 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
391 enum preferred_format {
392 WINDOW_PREFERRED_FORMAT_NONE,
393 WINDOW_PREFERRED_FORMAT_RGB565
397 window_set_preferred_format(struct window *window,
398 enum preferred_format format);
401 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
404 widget_destroy_tooltip(struct widget *parent);
407 widget_add_widget(struct widget *parent, void *data);
410 widget_destroy(struct widget *widget);
412 widget_set_default_cursor(struct widget *widget, int cursor);
414 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
417 widget_set_allocation(struct widget *widget,
418 int32_t x, int32_t y, int32_t width, int32_t height);
420 widget_set_size(struct widget *widget, int32_t width, int32_t height);
422 widget_set_transparent(struct widget *widget, int transparent);
424 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
427 widget_get_user_data(struct widget *widget);
430 widget_cairo_create(struct widget *widget);
433 widget_get_wl_surface(struct widget *widget);
436 widget_get_last_time(struct widget *widget);
439 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
442 widget_set_redraw_handler(struct widget *widget,
443 widget_redraw_handler_t handler);
445 widget_set_resize_handler(struct widget *widget,
446 widget_resize_handler_t handler);
448 widget_set_enter_handler(struct widget *widget,
449 widget_enter_handler_t handler);
451 widget_set_leave_handler(struct widget *widget,
452 widget_leave_handler_t handler);
454 widget_set_motion_handler(struct widget *widget,
455 widget_motion_handler_t handler);
457 widget_set_button_handler(struct widget *widget,
458 widget_button_handler_t handler);
460 widget_set_axis_handler(struct widget *widget,
461 widget_axis_handler_t handler);
464 widget_schedule_redraw(struct widget *widget);
467 frame_create(struct window *window, void *data);
470 frame_set_child_size(struct widget *widget, int child_width, int child_height);
473 input_set_pointer_image(struct input *input, int pointer);
476 input_get_position(struct input *input, int32_t *x, int32_t *y);
478 #define MOD_SHIFT_MASK 0x01
479 #define MOD_ALT_MASK 0x02
480 #define MOD_CONTROL_MASK 0x04
483 input_get_modifiers(struct input *input);
486 input_grab(struct input *input, struct widget *widget, uint32_t button);
489 input_ungrab(struct input *input);
492 input_get_focus_widget(struct input *input);
495 input_get_display(struct input *input);
498 input_get_seat(struct input *input);
500 struct wl_data_device *
501 input_get_data_device(struct input *input);
504 input_set_selection(struct input *input,
505 struct wl_data_source *source, uint32_t time);
508 input_accept(struct input *input, const char *type);
512 input_receive_drag_data(struct input *input, const char *mime_type,
513 data_func_t func, void *user_data);
516 input_receive_selection_data(struct input *input, const char *mime_type,
517 data_func_t func, void *data);
519 input_receive_selection_data_to_fd(struct input *input,
520 const char *mime_type, int fd);
523 output_set_user_data(struct output *output, void *data);
526 output_get_user_data(struct output *output);
529 output_set_destroy_handler(struct output *output,
530 display_output_handler_t handler);
533 output_get_allocation(struct output *output, struct rectangle *allocation);
536 output_get_wl_output(struct output *output);
538 enum wl_output_transform
539 output_get_transform(struct output *output);
542 output_get_scale(struct output *output);
545 keysym_modifiers_add(struct wl_array *modifiers_map,
549 keysym_modifiers_get_mask(struct wl_array *modifiers_map,