protocol: move sub-surfaces to Wayland
[platform/upstream/weston.git] / clients / window.h
1 /*
2  * Copyright © 2008 Kristian Høgsberg
3  *
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.
13  *
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
20  * OF THIS SOFTWARE.
21  */
22
23 #ifndef _WINDOW_H_
24 #define _WINDOW_H_
25
26 #include <xkbcommon/xkbcommon.h>
27 #include <wayland-client.h>
28 #include <cairo.h>
29 #include "../shared/config-parser.h"
30 #include "../shared/zalloc.h"
31
32 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
33
34 #define container_of(ptr, type, member) ({                              \
35         const __typeof__( ((type *)0)->member ) *__mptr = (ptr);        \
36         (type *)( (char *)__mptr - offsetof(type,member) );})
37
38 struct window;
39 struct widget;
40 struct display;
41 struct input;
42 struct output;
43
44 struct task {
45         void (*run)(struct task *task, uint32_t events);
46         struct wl_list link;
47 };
48
49 struct rectangle {
50         int32_t x;
51         int32_t y;
52         int32_t width;
53         int32_t height;
54 };
55
56 void *
57 fail_on_null(void *p);
58 void *
59 xmalloc(size_t s);
60 void *
61 xzalloc(size_t s);
62 char *
63 xstrdup(const char *s);
64
65 struct display *
66 display_create(int *argc, char *argv[]);
67
68 void
69 display_destroy(struct display *display);
70
71 void
72 display_set_user_data(struct display *display, void *data);
73
74 void *
75 display_get_user_data(struct display *display);
76
77 struct wl_display *
78 display_get_display(struct display *display);
79
80 int
81 display_has_subcompositor(struct display *display);
82
83 cairo_device_t *
84 display_get_cairo_device(struct display *display);
85
86 struct wl_compositor *
87 display_get_compositor(struct display *display);
88
89 struct output *
90 display_get_output(struct display *display);
91
92 uint32_t
93 display_get_serial(struct display *display);
94
95 typedef void (*display_global_handler_t)(struct display *display,
96                                          uint32_t name,
97                                          const char *interface,
98                                          uint32_t version, void *data);
99
100 void
101 display_set_global_handler(struct display *display,
102                            display_global_handler_t handler);
103 void
104 display_set_global_handler_remove(struct display *display,
105                            display_global_handler_t remove_handler);
106 void *
107 display_bind(struct display *display, uint32_t name,
108              const struct wl_interface *interface, uint32_t version);
109
110 typedef void (*display_output_handler_t)(struct output *output, void *data);
111
112 /*
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
117  * user data.
118  */
119 void
120 display_set_output_configure_handler(struct display *display,
121                                      display_output_handler_t handler);
122
123 struct wl_data_source *
124 display_create_data_source(struct display *display);
125
126 #ifdef EGL_NO_DISPLAY
127 EGLDisplay
128 display_get_egl_display(struct display *d);
129
130 EGLConfig
131 display_get_argb_egl_config(struct display *d);
132
133 int
134 display_acquire_window_surface(struct display *display,
135                                struct window *window,
136                                EGLContext ctx);
137 void
138 display_release_window_surface(struct display *display,
139                                struct window *window);
140 #endif
141
142 #define SURFACE_OPAQUE 0x01
143 #define SURFACE_SHM    0x02
144
145 #define SURFACE_HINT_RESIZE 0x10
146
147 #define SURFACE_HINT_RGB565 0x100
148
149 cairo_surface_t *
150 display_create_surface(struct display *display,
151                        struct wl_surface *surface,
152                        struct rectangle *rectangle,
153                        uint32_t flags);
154
155 struct wl_buffer *
156 display_get_buffer_for_surface(struct display *display,
157                                cairo_surface_t *surface);
158
159 struct wl_cursor_image *
160 display_get_pointer_image(struct display *display, int pointer);
161
162 void
163 display_defer(struct display *display, struct task *task);
164
165 void
166 display_watch_fd(struct display *display,
167                  int fd, uint32_t events, struct task *task);
168
169 void
170 display_unwatch_fd(struct display *display, int fd);
171
172 void
173 display_run(struct display *d);
174
175 void
176 display_exit(struct display *d);
177
178 enum cursor_type {
179         CURSOR_BOTTOM_LEFT,
180         CURSOR_BOTTOM_RIGHT,
181         CURSOR_BOTTOM,
182         CURSOR_DRAGGING,
183         CURSOR_LEFT_PTR,
184         CURSOR_LEFT,
185         CURSOR_RIGHT,
186         CURSOR_TOP_LEFT,
187         CURSOR_TOP_RIGHT,
188         CURSOR_TOP,
189         CURSOR_IBEAM,
190         CURSOR_HAND1,
191         CURSOR_WATCH,
192
193         CURSOR_BLANK
194 };
195
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);
199
200 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
201                                                 struct input *device, void *data);
202
203 typedef void (*window_data_handler_t)(struct window *window,
204                                       struct input *input,
205                                       float x, float y,
206                                       const char **types,
207                                       void *data);
208
209 typedef void (*window_drop_handler_t)(struct window *window,
210                                       struct input *input,
211                                       int32_t x, int32_t y, void *data);
212
213 typedef void (*window_close_handler_t)(void *data);
214 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
215
216 typedef void (*window_output_handler_t)(struct window *window, struct output *output,
217                                         int enter, void *data);
218
219 typedef void (*widget_resize_handler_t)(struct widget *widget,
220                                         int32_t width, int32_t height,
221                                         void *data);
222 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
223
224 typedef int (*widget_enter_handler_t)(struct widget *widget,
225                                       struct input *input,
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,
234                                         uint32_t button,
235                                         enum wl_pointer_button_state state,
236                                         void *data);
237 typedef void (*widget_touch_down_handler_t)(struct widget *widget,
238                                             struct input *input,
239                                             uint32_t serial,
240                                             uint32_t time,
241                                             int32_t id,
242                                             float x,
243                                             float y,
244                                             void *data);
245 typedef void (*widget_touch_up_handler_t)(struct widget *widget,
246                                           struct input *input,
247                                           uint32_t serial,
248                                           uint32_t time,
249                                           int32_t id,
250                                           void *data);
251 typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
252                                               struct input *input,
253                                               uint32_t time,
254                                               int32_t id,
255                                               float x,
256                                               float y,
257                                               void *data);
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,
264                                       uint32_t axis,
265                                       wl_fixed_t value,
266                                       void *data);
267
268 struct window *
269 window_create(struct display *display);
270 struct window *
271 window_create_transient(struct display *display, struct window *parent,
272                         int32_t x, int32_t y, uint32_t flags);
273 struct window *
274 window_create_custom(struct display *display);
275
276 int
277 window_has_focus(struct window *window);
278
279 typedef void (*menu_func_t)(struct window *window,
280                             struct input *input, int index, void *data);
281
282 void
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);
287
288 void
289 window_show_frame_menu(struct window *window,
290                        struct input *input, uint32_t time);
291
292 int
293 window_get_buffer_transform(struct window *window);
294
295 void
296 window_set_buffer_transform(struct window *window,
297                             enum wl_output_transform transform);
298
299 uint32_t
300 window_get_buffer_scale(struct window *window);
301
302 void
303 window_set_buffer_scale(struct window *window,
304                         int32_t scale);
305
306 uint32_t
307 window_get_output_scale(struct window *window);
308
309 void
310 window_destroy(struct window *window);
311
312 struct widget *
313 window_add_widget(struct window *window, void *data);
314
315 enum subsurface_mode {
316         SUBSURFACE_SYNCHRONIZED,
317         SUBSURFACE_DESYNCHRONIZED
318 };
319
320 struct widget *
321 window_add_subsurface(struct window *window, void *data,
322                       enum subsurface_mode default_mode);
323
324 typedef void (*data_func_t)(void *data, size_t len,
325                             int32_t x, int32_t y, void *user_data);
326
327 struct display *
328 window_get_display(struct window *window);
329 void
330 window_move(struct window *window, struct input *input, uint32_t time);
331 void
332 window_get_allocation(struct window *window, struct rectangle *allocation);
333 void
334 window_schedule_redraw(struct window *window);
335 void
336 window_schedule_resize(struct window *window, int width, int height);
337
338 void
339 window_damage(struct window *window, int32_t x, int32_t y,
340               int32_t width, int32_t height);
341
342 cairo_surface_t *
343 window_get_surface(struct window *window);
344
345 struct wl_surface *
346 window_get_wl_surface(struct window *window);
347
348 enum window_buffer_type {
349         WINDOW_BUFFER_TYPE_EGL_WINDOW,
350         WINDOW_BUFFER_TYPE_SHM,
351 };
352
353 void
354 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
355                        int32_t x, int32_t y, int32_t width, int32_t height);
356
357 void
358 window_set_buffer_type(struct window *window, enum window_buffer_type type);
359
360 int
361 window_is_fullscreen(struct window *window);
362
363 void
364 window_set_fullscreen(struct window *window, int fullscreen);
365
366 void
367 window_set_fullscreen_method(struct window *window,
368                              enum wl_shell_surface_fullscreen_method method);
369 int
370 window_is_maximized(struct window *window);
371
372 void
373 window_set_maximized(struct window *window, int maximized);
374
375 void
376 window_set_user_data(struct window *window, void *data);
377
378 void *
379 window_get_user_data(struct window *window);
380
381 void
382 window_set_key_handler(struct window *window,
383                        window_key_handler_t handler);
384
385 void
386 window_set_keyboard_focus_handler(struct window *window,
387                                   window_keyboard_focus_handler_t handler);
388
389 void
390 window_set_data_handler(struct window *window,
391                         window_data_handler_t handler);
392
393 void
394 window_set_drop_handler(struct window *window,
395                         window_drop_handler_t handler);
396
397 void
398 window_set_close_handler(struct window *window,
399                          window_close_handler_t handler);
400 void
401 window_set_fullscreen_handler(struct window *window,
402                               window_fullscreen_handler_t handler);
403 void
404 window_set_output_handler(struct window *window,
405                           window_output_handler_t handler);
406
407 void
408 window_set_title(struct window *window, const char *title);
409
410 const char *
411 window_get_title(struct window *window);
412
413 void
414 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
415
416 enum preferred_format {
417         WINDOW_PREFERRED_FORMAT_NONE,
418         WINDOW_PREFERRED_FORMAT_RGB565
419 };
420
421 void
422 window_set_preferred_format(struct window *window,
423                             enum preferred_format format);
424
425 int
426 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
427
428 void
429 widget_destroy_tooltip(struct widget *parent);
430
431 struct widget *
432 widget_add_widget(struct widget *parent, void *data);
433
434 void
435 widget_destroy(struct widget *widget);
436 void
437 widget_set_default_cursor(struct widget *widget, int cursor);
438 void
439 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
440
441 void
442 widget_set_allocation(struct widget *widget,
443                       int32_t x, int32_t y, int32_t width, int32_t height);
444 void
445 widget_set_size(struct widget *widget, int32_t width, int32_t height);
446 void
447 widget_set_transparent(struct widget *widget, int transparent);
448 void
449 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
450
451 void *
452 widget_get_user_data(struct widget *widget);
453
454 cairo_t *
455 widget_cairo_create(struct widget *widget);
456
457 struct wl_surface *
458 widget_get_wl_surface(struct widget *widget);
459
460 uint32_t
461 widget_get_last_time(struct widget *widget);
462
463 void
464 widget_input_region_add(struct widget *widget, const struct rectangle *rect);
465
466 void
467 widget_set_redraw_handler(struct widget *widget,
468                           widget_redraw_handler_t handler);
469 void
470 widget_set_resize_handler(struct widget *widget,
471                           widget_resize_handler_t handler);
472 void
473 widget_set_enter_handler(struct widget *widget,
474                          widget_enter_handler_t handler);
475 void
476 widget_set_leave_handler(struct widget *widget,
477                          widget_leave_handler_t handler);
478 void
479 widget_set_motion_handler(struct widget *widget,
480                           widget_motion_handler_t handler);
481 void
482 widget_set_button_handler(struct widget *widget,
483                           widget_button_handler_t handler);
484 void
485 widget_set_touch_down_handler(struct widget *widget,
486                               widget_touch_down_handler_t handler);
487 void
488 widget_set_touch_up_handler(struct widget *widget,
489                             widget_touch_up_handler_t handler);
490 void
491 widget_set_touch_motion_handler(struct widget *widget,
492                                 widget_touch_motion_handler_t handler);
493 void
494 widget_set_touch_frame_handler(struct widget *widget,
495                                widget_touch_frame_handler_t handler);
496 void
497 widget_set_touch_cancel_handler(struct widget *widget,
498                                 widget_touch_cancel_handler_t handler);
499 void
500 widget_set_axis_handler(struct widget *widget,
501                         widget_axis_handler_t handler);
502 void
503 widget_schedule_redraw(struct widget *widget);
504
505 struct widget *
506 window_frame_create(struct window *window, void *data);
507
508 void
509 window_frame_set_child_size(struct widget *widget, int child_width,
510                             int child_height);
511
512 void
513 input_set_pointer_image(struct input *input, int pointer);
514
515 void
516 input_get_position(struct input *input, int32_t *x, int32_t *y);
517
518 #define MOD_SHIFT_MASK          0x01
519 #define MOD_ALT_MASK            0x02
520 #define MOD_CONTROL_MASK        0x04
521
522 uint32_t
523 input_get_modifiers(struct input *input);
524
525 void
526 input_grab(struct input *input, struct widget *widget, uint32_t button);
527
528 void
529 input_ungrab(struct input *input);
530
531 struct widget *
532 input_get_focus_widget(struct input *input);
533
534 struct display *
535 input_get_display(struct input *input);
536
537 struct wl_seat *
538 input_get_seat(struct input *input);
539
540 struct wl_data_device *
541 input_get_data_device(struct input *input);
542
543 void
544 input_set_selection(struct input *input,
545                     struct wl_data_source *source, uint32_t time);
546
547 void
548 input_accept(struct input *input, const char *type);
549
550
551 void
552 input_receive_drag_data(struct input *input, const char *mime_type,
553                         data_func_t func, void *user_data);
554 int
555 input_receive_drag_data_to_fd(struct input *input,
556                               const char *mime_type, int fd);
557
558 int
559 input_receive_selection_data(struct input *input, const char *mime_type,
560                              data_func_t func, void *data);
561 int
562 input_receive_selection_data_to_fd(struct input *input,
563                                    const char *mime_type, int fd);
564
565 void
566 output_set_user_data(struct output *output, void *data);
567
568 void *
569 output_get_user_data(struct output *output);
570
571 void
572 output_set_destroy_handler(struct output *output,
573                            display_output_handler_t handler);
574
575 void
576 output_get_allocation(struct output *output, struct rectangle *allocation);
577
578 struct wl_output *
579 output_get_wl_output(struct output *output);
580
581 enum wl_output_transform
582 output_get_transform(struct output *output);
583
584 uint32_t
585 output_get_scale(struct output *output);
586
587 void
588 keysym_modifiers_add(struct wl_array *modifiers_map,
589                      const char *name);
590
591 xkb_mod_mask_t
592 keysym_modifiers_get_mask(struct wl_array *modifiers_map,
593                           const char *name);
594
595 #endif