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