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